com.sun.xml.ws.protocol.soap
Class ClientMUTube

java.lang.Object
  extended by com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl
      extended by com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
          extended by com.sun.xml.ws.protocol.soap.MUTube
              extended by com.sun.xml.ws.protocol.soap.ClientMUTube
All Implemented Interfaces:
Pipe, Tube

public class ClientMUTube
extends MUTube

Performs soap mustUnderstand processing for clients.


Field Summary
 
Fields inherited from class com.sun.xml.ws.protocol.soap.MUTube
logger, soapVersion
 
Fields inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
next
 
Constructor Summary
protected ClientMUTube(ClientMUTube that, TubeCloner cloner)
           
  ClientMUTube(WSBinding binding, Tube next)
           
 
Method Summary
 ClientMUTube copy(TubeCloner cloner)
          Creates an identical clone of this Tube.
 NextAction processResponse(Packet response)
          Do MU Header Processing on incoming message (response)
 
Methods inherited from class com.sun.xml.ws.protocol.soap.MUTube
createMUSOAPFaultException, createMUSOAPFaultMessage, getMisUnderstoodHeaders
 
Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
preDestroy, processException, processRequest
 
Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl
copy, doInvoke, doInvokeAndForget, doReturnWith, doSuspend, doThrow, process
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientMUTube

public ClientMUTube(WSBinding binding,
                    Tube next)

ClientMUTube

protected ClientMUTube(ClientMUTube that,
                       TubeCloner cloner)
Method Detail

processResponse

@NotNull
public NextAction processResponse(Packet response)
Do MU Header Processing on incoming message (response)

Specified by:
processResponse in interface Tube
Overrides:
processResponse in class AbstractFilterTubeImpl
Parameters:
response - 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 to Tube.processRequest(Packet) earlier.

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. TODO: exception handling semantics need more discussion

Returns:
if all the headers in the packet are understood, returns an action to call the previous pipes with response packet
Throws:
javax.xml.ws.soap.SOAPFaultException - if all the headers in the packet are not understood, throws SOAPFaultException

copy

public ClientMUTube copy(TubeCloner cloner)
Description copied from interface: Tube
Creates an identical clone of this Tube.

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 TubeCloner.add(Tube,Tube) to register the copied pipe with the original. This is required before you start copying the other Tube references you have, or else there's a risk of infinite recursion.

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

For limited number of Tubes 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 Tube 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 other process method. See the Codec.copy() for more discussion about this.

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