Class SecurableSoapMessage

java.lang.Object
jakarta.xml.soap.SOAPMessage
com.sun.xml.wss.impl.SecurableSoapMessage

public final class SecurableSoapMessage extends jakarta.xml.soap.SOAPMessage
  • Constructor Details

    • SecurableSoapMessage

      public SecurableSoapMessage()
    • SecurableSoapMessage

      public SecurableSoapMessage(jakarta.xml.soap.SOAPMessage soapMessage) throws XWSSecurityException
      Throws:
      XWSSecurityException
  • Method Details

    • init

      public void init(jakarta.xml.soap.SOAPMessage soapMessage)
    • getEnvelope

      public jakarta.xml.soap.SOAPEnvelope getEnvelope() throws XWSSecurityException
      Throws:
      XWSSecurityException
    • findWsseSecurityHeaderBlock

      public SecurityHeader findWsseSecurityHeaderBlock(boolean doCreate, boolean mustUnderstand) throws XWSSecurityException
      Finds wsse:Security Header Block.
      Parameters:
      doCreate - create one if none exists
      Returns:
      wsse:Security header
      Throws:
      XWSSecurityException
    • findSecurityHeader

      public SecurityHeader findSecurityHeader() throws XWSSecurityException
      Finds wsse:Security Header
      Returns:
      returns null if wsse:Security header not found
      Throws:
      XWSSecurityException
    • findOrCreateSecurityHeader

      public SecurityHeader findOrCreateSecurityHeader() throws XWSSecurityException
      Finds or creates wsse:Security Header
      Returns:
      wsse:Security header
      Throws:
      XWSSecurityException
    • deleteSecurityHeader

      public void deleteSecurityHeader()
      Delete security header
    • resetMustUnderstandOnSecHeader

      public void resetMustUnderstandOnSecHeader()
      Make Security Header Non-MustUnderstand
    • generateSecurityHeaderException

      public void generateSecurityHeaderException(String exceptionMessage) throws XWSSecurityException
      Create and initialize a SecurityHeaderException, and throw a fault based on it. The faultstring for this exception is wsse:InvalidSecurity as per section 12 on Error Handling of the wss SOAPMessageSecurity spec (draft 17). This fault stands for An error was discovered processing the wsse:Security header.
      Throws:
      XWSSecurityException
    • newSOAPFaultException

      public static WssSoapFaultException newSOAPFaultException(String faultstring, Throwable th)
      Create and initialize a WssSoapFaultException. This method is used in conjunction with generateClientFault.
    • newSOAPFaultException

      public static WssSoapFaultException newSOAPFaultException(QName faultCode, String faultstring, Throwable th)
      Create and initialize a WssSoapFaultException. This method is used in conjunction with generateClientFault.
    • generateFault

      public void generateFault(WssSoapFaultException sfe) throws XWSSecurityException
      Throws:
      XWSSecurityException
    • getSOAPPart

      public jakarta.xml.soap.SOAPPart getSOAPPart()
      Specified by:
      getSOAPPart in class jakarta.xml.soap.SOAPMessage
    • getSOAPBody

      public jakarta.xml.soap.SOAPBody getSOAPBody() throws jakarta.xml.soap.SOAPException
      Overrides:
      getSOAPBody in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException
    • getSOAPMessage

      public jakarta.xml.soap.SOAPMessage getSOAPMessage()
    • setSOAPMessage

      public void setSOAPMessage(jakarta.xml.soap.SOAPMessage soapMsg) throws XWSSecurityException
      Throws:
      XWSSecurityException
    • addAttachmentPart

      public void addAttachmentPart(jakarta.xml.soap.AttachmentPart AttachmentPart)
      Specified by:
      addAttachmentPart in class jakarta.xml.soap.SOAPMessage
    • countAttachments

      public int countAttachments()
      Specified by:
      countAttachments in class jakarta.xml.soap.SOAPMessage
    • createAttachmentPart

      public jakarta.xml.soap.AttachmentPart createAttachmentPart()
      Specified by:
      createAttachmentPart in class jakarta.xml.soap.SOAPMessage
    • createAttachmentPart

      public jakarta.xml.soap.AttachmentPart createAttachmentPart(Object content, String contentType)
      Overrides:
      createAttachmentPart in class jakarta.xml.soap.SOAPMessage
    • createAttachmentPart

      public jakarta.xml.soap.AttachmentPart createAttachmentPart(jakarta.activation.DataHandler dataHandler)
      Overrides:
      createAttachmentPart in class jakarta.xml.soap.SOAPMessage
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • getAttachments

      public Iterator<jakarta.xml.soap.AttachmentPart> getAttachments()
      Specified by:
      getAttachments in class jakarta.xml.soap.SOAPMessage
    • getAttachments

      public Iterator<jakarta.xml.soap.AttachmentPart> getAttachments(jakarta.xml.soap.MimeHeaders headers)
      Specified by:
      getAttachments in class jakarta.xml.soap.SOAPMessage
    • getContentDescription

      public String getContentDescription()
      Specified by:
      getContentDescription in class jakarta.xml.soap.SOAPMessage
    • getMimeHeaders

      public jakarta.xml.soap.MimeHeaders getMimeHeaders()
      Specified by:
      getMimeHeaders in class jakarta.xml.soap.SOAPMessage
    • getProperty

      public Object getProperty(String property) throws jakarta.xml.soap.SOAPException
      Overrides:
      getProperty in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException
    • getSOAPHeader

      public jakarta.xml.soap.SOAPHeader getSOAPHeader() throws jakarta.xml.soap.SOAPException
      Overrides:
      getSOAPHeader in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • removeAllAttachments

      public void removeAllAttachments()
      Specified by:
      removeAllAttachments in class jakarta.xml.soap.SOAPMessage
    • saveRequired

      public boolean saveRequired()
      Specified by:
      saveRequired in class jakarta.xml.soap.SOAPMessage
    • setContentDescription

      public void setContentDescription(String description)
      Specified by:
      setContentDescription in class jakarta.xml.soap.SOAPMessage
    • setProperty

      public void setProperty(String property, Object value) throws jakarta.xml.soap.SOAPException
      Overrides:
      setProperty in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • writeTo

      public void writeTo(OutputStream out) throws jakarta.xml.soap.SOAPException, IOException
      Specified by:
      writeTo in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException
      IOException
    • saveChanges

      public void saveChanges() throws jakarta.xml.soap.SOAPException
      Specified by:
      saveChanges in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException
    • getNamespaceContext

      public NamespaceContext getNamespaceContext() throws XWSSecurityException
      Throws:
      XWSSecurityException
    • generateId

      public String generateId()
      Returns:
      an ID unique w.r.t this SOAPMessage
    • generateWsuId

      public void generateWsuId(Element element) throws XWSSecurityException
      Throws:
      XWSSecurityException
    • generateWsuId

      public void generateWsuId(Element element, String id)
      Parameters:
      id - ID specified should be unique in the message.
    • getElementByWsuId

      public jakarta.xml.soap.SOAPElement getElementByWsuId(String id) throws XWSSecurityException
      Throws:
      XWSSecurityException
    • getElementById

      public Element getElementById(String id) throws XWSSecurityException
      Throws:
      XWSSecurityException
    • getAttachmentPart

      public jakarta.xml.soap.AttachmentPart getAttachmentPart(String uri) throws XWSSecurityException
      Throws:
      XWSSecurityException
    • getIdFromFragmentRef

      public static String getIdFromFragmentRef(String ref)
    • getMessageParts

      public Object getMessageParts(Target target) throws XWSSecurityException
      Throws:
      XWSSecurityException
    • getAttachment

      public jakarta.xml.soap.AttachmentPart getAttachment(jakarta.xml.soap.SOAPElement element) throws jakarta.xml.soap.SOAPException
      Specified by:
      getAttachment in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException
    • removeAttachments

      public void removeAttachments(jakarta.xml.soap.MimeHeaders hdrs)
      Specified by:
      removeAttachments in class jakarta.xml.soap.SOAPMessage
    • isOptimized

      public boolean isOptimized()
    • setOptimized

      public void setOptimized(boolean optimized)
    • setDoNotSetMU

      public void setDoNotSetMU(boolean doNotSetMU)