com.sun.xml.ws.addressing
Class WsaServerTube

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.addressing.WsaTube
              extended by com.sun.xml.ws.addressing.WsaServerTube
All Implemented Interfaces:
Pipe, Tube

public final class WsaServerTube
extends WsaTube

Handles WS-Addressing for the server.


Field Summary
static String REQUEST_MESSAGE_ID
          Deprecated. Use JAXWSProperties.ADDRESSING_MESSAGEID.
 
Fields inherited from class com.sun.xml.ws.addressing.WsaTube
addressingVersion, binding, helper, soapVersion, wsdlPort
 
Fields inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
next
 
Constructor Summary
WsaServerTube(WsaServerTube that, TubeCloner cloner)
           
WsaServerTube(WSEndpoint endpoint, WSDLPort wsdlPort, WSBinding binding, Tube next)
           
 
Method Summary
(package private)  void checkAnonymousSemantics(WSDLBoundOperation wbo, WSEndpointReference replyTo, WSEndpointReference faultTo)
           
 void checkCardinality(Packet packet)
          Checks the cardinality of WS-Addressing headers on an inbound Packet.
protected  void checkMandatoryHeaders(Packet packet, boolean foundAction, boolean foundTo, boolean foundMessageId, boolean foundRelatesTo)
           
 WsaServerTube copy(TubeCloner cloner)
          Creates an identical clone of this Tube.
 NextAction processRequest(Packet request)
          Default no-op implementation.
 NextAction processResponse(Packet response)
          Default no-op implementation.
 void validateAction(Packet packet)
           
 
Methods inherited from class com.sun.xml.ws.addressing.WsaTube
getTubeHelper, getWSDLBoundOperation, isAddressingEngagedOrRequired, isInCurrentRole, processException, validateInboundHeaders, validateSOAPAction
 
Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
preDestroy
 
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
 

Field Detail

REQUEST_MESSAGE_ID

public static final String REQUEST_MESSAGE_ID
Deprecated. Use JAXWSProperties.ADDRESSING_MESSAGEID.
See Also:
Constant Field Values
Constructor Detail

WsaServerTube

public WsaServerTube(WSEndpoint endpoint,
                     @NotNull
                     WSDLPort wsdlPort,
                     WSBinding binding,
                     Tube next)

WsaServerTube

public WsaServerTube(WsaServerTube that,
                     TubeCloner cloner)
Method Detail

copy

public WsaServerTube 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.

processRequest

@NotNull
public NextAction processRequest(Packet request)
Description copied from class: AbstractFilterTubeImpl
Default no-op implementation.

Specified by:
processRequest in interface Tube
Overrides:
processRequest in class AbstractFilterTubeImpl
Parameters:
request - The packet that represents a request message. 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:
A NextAction object that represents the next action to be taken by the JAX-WS runtime.

processResponse

@NotNull
public NextAction processResponse(Packet response)
Description copied from class: AbstractFilterTubeImpl
Default no-op implementation.

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:
A NextAction object that represents the next action to be taken by the JAX-WS runtime.

validateAction

public void validateAction(Packet packet)
Specified by:
validateAction in class WsaTube

checkCardinality

public void checkCardinality(Packet packet)
Description copied from class: WsaTube
Checks the cardinality of WS-Addressing headers on an inbound Packet. This method checks for the cardinality if WS-Addressing is engaged (detected by the presence of wsa:Action header) or wsdl:required=true.

Overrides:
checkCardinality in class WsaTube
Parameters:
packet - The inbound packet.

checkMandatoryHeaders

protected void checkMandatoryHeaders(Packet packet,
                                     boolean foundAction,
                                     boolean foundTo,
                                     boolean foundMessageId,
                                     boolean foundRelatesTo)
Overrides:
checkMandatoryHeaders in class WsaTube

checkAnonymousSemantics

final void checkAnonymousSemantics(WSDLBoundOperation wbo,
                                   WSEndpointReference replyTo,
                                   WSEndpointReference faultTo)