Package com.sun.xml.wss

Interface XWSSProcessor

All Known Implementing Classes:
XWSSProcessor2_0Impl
public interface XWSSProcessor
XWSSProcessor interface defines methods for
  • Securing an outbound SOAPMessage
  • Verifying the security in an inbound SOAPMessage
An XWSSProcessor can add/verify Security in a SOAPMessage as defined by the OASIS WSS 1.0 specification.

  • Method Summary

    Modifier and Type
    Method
    Description
    ProcessingContext
    createProcessingContext(jakarta.xml.soap.SOAPMessage msg)
    Create a Processing Context initialized with the given SOAPMessage
    jakarta.xml.soap.SOAPMessage
    secureOutboundMessage(ProcessingContext messageCntxt)
    Adds Security to an outbound SOAPMessage according to the Security Policy inferred from the SecurityConfiguration with which this XWSSProcessor was initialized.
    jakarta.xml.soap.SOAPMessage
    verifyInboundMessage(ProcessingContext messageCntxt)
    Verifies Security in an inbound SOAPMessage according to the Security Policy inferred from the SecurityConfiguration with which this XWSSProcessor was initialized.

  • Method Details

    • secureOutboundMessage

      jakarta.xml.soap.SOAPMessage secureOutboundMessage(ProcessingContext messageCntxt) throws XWSSecurityException
      Adds Security to an outbound SOAPMessage according to the Security Policy inferred from the SecurityConfiguration with which this XWSSProcessor was initialized.
      Parameters:
      messageCntxt - the SOAP ProcessingContext containing the outgoing SOAPMessage to be secured
      Returns:
      the resultant Secure SOAPMessage
      Throws:
      XWSSecurityException - if there was an error in securing the message.

    • verifyInboundMessage

      jakarta.xml.soap.SOAPMessage verifyInboundMessage(ProcessingContext messageCntxt) throws XWSSecurityException
      Verifies Security in an inbound SOAPMessage according to the Security Policy inferred from the SecurityConfiguration with which this XWSSProcessor was initialized.
      Parameters:
      messageCntxt - the SOAP ProcessingContext containing the outgoing SOAPMessage to be secured
      Returns:
      the resultant SOAPMessage after successful verification of security in the message
      Throws:
      XWSSecurityException - if there was an unexpected error while verifying the message.OR if the security in the incoming message violates the Security policy that was applied to the message.
      WssSoapFaultException - when security in the incoming message is in direct violation of the OASIS WSS specification. When a WssSoapFaultException is thrown the getFaultCode() method on it will return a QName which would correspond to the WSS defined fault.

    • createProcessingContext

      ProcessingContext createProcessingContext(jakarta.xml.soap.SOAPMessage msg) throws XWSSecurityException
      Create a Processing Context initialized with the given SOAPMessage
      Parameters:
      msg - the SOAPMessage with which to initialize the ProcessingContext
      Returns:
      A ProcessingContext instance.
      Throws:
      XWSSecurityException