Package com.sun.xml.ws.addressing

Class WsaClientTube

  • All Implemented Interfaces:
    Pipe, Tube
    Direct Known Subclasses:
    MemberSubmissionWsaClientTube, W3CWsaClientTube
    public class WsaClientTube
extends AbstractFilterTubeImpl
    WsaClientTube appears in the Tubeline only if addressing is enabled. This tube checks the validity of addressing headers in the incoming messages based on the WSDL model.
    Author:
    Rama Pulavarthi, Arun Gupta

    • Field Detail

      • expectReply

        protected boolean expectReply

      • wsdlPort

        @NotNull
protected final WSDLPort wsdlPort
        Port that we are processing.

    • Method Detail

      • copy

        public WsaClientTube 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

        protected void validateAction​(Packet packet)

      • validateInboundHeaders

        protected Packet validateInboundHeaders​(Packet packet)
        Validates the inbound message. If an error is found, create a fault message and returns that. Otherwise it will pass through the parameter 'packet' object to the return value.

      • checkMessageAddressingProperties

        protected void checkMessageAddressingProperties​(Packet packet)
        This method checks all the WS-Addressing headers are valid and as per the spec definded rules. Mainly it checks the cardinality of the WSA headers and checks that mandatory headers exist. It also checks if the SOAPAction is equal to wsa:Action value when non-empty. Override this method if you need to additional checking of headers other than just existence of the headers. For ex: On server-side, check Anonymous and Non-Anonymous semantics in addition to checking cardinality. Override checkMandatoryHeaders(Packet p) to have different validation rules for different versions
        Parameters:
        packet -

      • checkCardinality

        protected void checkCardinality​(Packet packet)
        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.
        Parameters:
        packet - The inbound packet.
        Throws:
        jakarta.xml.ws.WebServiceException - if:
        • there is an error reading ReplyTo or FaultTo
        • WS-Addressing is required and Message within packet is null
        • WS-Addressing is required and no headers are found in the Message
        • an uknown WS-Addressing header is present

      • validateSOAPAction

        protected void validateSOAPAction​(Packet packet)

      • checkMandatoryHeaders

        protected void checkMandatoryHeaders​(Packet packet,
                                     boolean foundAction,
                                     boolean foundTo,
                                     boolean foundReplyTo,
                                     boolean foundFaultTo,
                                     boolean foundMessageId,
                                     boolean foundRelatesTo)
        This should be called only when Addressing is engaged. Checks only for presence of wsa:Action and validates that wsa:Action equals SOAPAction header when non-empty Should be overridden if other wsa headers need to be checked based on version.
        Parameters:
        packet -
        foundAction -
        foundTo -
        foundReplyTo -
        foundFaultTo -
        foundMessageId -
        foundRelatesTo -