Package com.sun.xml.wss.provider.wsit

Class ClientSecurityPipe

java.lang.Object
com.sun.xml.ws.api.pipe.helper.AbstractPipeImpl
com.sun.xml.ws.api.pipe.helper.AbstractFilterPipeImpl
com.sun.xml.wss.provider.wsit.ClientSecurityPipe
All Implemented Interfaces:
Pipe, SecureConversationInitiator
public class ClientSecurityPipe extends AbstractFilterPipeImpl implements SecureConversationInitiator
This pipe is used to do client side security for app server

  • Field Details

  • Constructor Details

  • Method Details

    • preDestroy

      public void preDestroy()
      Description copied from interface: Pipe
      Invoked before the last copy of the pipeline is about to be discarded, to give Pipes a chance to clean up any resources.

      This can be used to invoke PreDestroy lifecycle methods on user handler. The invocation of it is optional on the client side, but mandatory on the server side.

      When multiple copies of pipelines are created, this method is called only on one of them.

      Specified by:
      preDestroy in interface Pipe
      Overrides:
      preDestroy in class AbstractFilterPipeImpl

    • copy

      public final Pipe copy(PipeCloner cloner)
      Description copied from interface: Pipe
      Creates an identical clone of this Pipe.

      This method creates an identical pipeline that can be used concurrently with this pipeline. When the caller of a pipeline is multi-threaded and need concurrent use of the same pipeline, it can do so by creating copies through this method.

      Implementation Note

      It is the implementation's responsibility to call PipeCloner.add(Pipe,Pipe) to register the copied pipe with the original. This is required before you start copying the other Pipe references you have, or else there's a risk of infinite recursion.

      For most Pipe implementations that delegate to another Pipe, this method requires that you also copy the Pipe that you delegate to.

      For limited number of Pipes that do not maintain any thread unsafe resource, it is allowed to simply return this from this method (notice that even if you are stateless, if you got a delegating Pipe and that one isn't stateless, you still have to copy yourself.)

      Note that this method might be invoked by one thread while another thread is executing the Pipe.process(Packet) method. See the Codec.copy() for more discussion about this.

      Specified by:
      copy in interface Pipe
      Parameters:
      cloner - Use this object (in particular its PipeCloner.copy(Pipe) method to clone other pipe references you have in your pipe. See PipeCloner for more discussion about why.
      Returns:
      always non-null Pipe.

    • getPipeHelper

      public PipeHelper getPipeHelper()

    • process

      public Packet process(Packet request)
      Description copied from interface: Pipe
      Sends a Packet and returns a response Packet to it.
      Specified by:
      process in interface Pipe
      Overrides:
      process in class AbstractFilterPipeImpl
      Parameters:
      request - The packet that represents a request message. Must not be null. If the packet has a non-null message, it must be a valid unconsumed Message. This message represents the SOAP message to be sent as a request.

      The packet is also allowed to carry no message, which indicates that this is an output-only request. (that's called "solicit", right? - KK)

      Returns:
      The packet that represents a response message. Must not be null. If the packet has a non-null message, it must be a valid unconsumed Message. This message represents a response to the request message passed as a parameter.

      The packet is also allowed to carry no message, which indicates that there was no response. This is used for things like one-way message and/or one-way transports.

    • startSecureConversation

      public javax.xml.bind.JAXBElement startSecureConversation(Packet packet) throws WSSecureConversationException
      Specified by:
      startSecureConversation in interface SecureConversationInitiator
      Throws:
      WSSecureConversationException