com.sun.xml.ws.addressing
Class W3CWsaClientTube

java.lang.Object
  com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl
      com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
          com.sun.xml.ws.addressing.WsaClientTube
              com.sun.xml.ws.addressing.W3CWsaClientTube

All Implemented Interfaces:

Pipe, Tube

public class W3CWsaClientTube
extends WsaClientTube

Field Summary

protected AddressingVersion	addressingVersion
protected WSBinding	binding
protected SOAPVersion	soapVersion
protected WSDLPort	wsdlPort Port that we are processing.

Fields inherited from class com.sun.xml.ws.addressing.WsaClientTube

expectReply

Fields inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

next

Constructor Summary

W3CWsaClientTube(WsaClientTube that, TubeCloner cloner)

W3CWsaClientTube(WSDLPort wsdlPort, WSBinding binding, Tube next)

Method Summary

protected 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 foundReplyTo, boolean foundFaultTo, boolean foundMessageID, boolean foundRelatesTo) This should be called only when Addressing is engaged.
protected void	checkMessageAddressingProperties(Packet packet) This method checks all the WS-Addressing headers are valid and as per the spec definded rules.
W3CWsaClientTube	copy(TubeCloner cloner) Creates an identical clone of this Tube.
protected WsaTubeHelper	getTubeHelper()
protected WSDLBoundOperation	getWSDLBoundOperation(Packet packet)
NextAction	processException(java.lang.Throwable t) Default no-op implementation.
protected Packet	validateInboundHeaders(Packet packet) Validates the inbound message.
protected void	validateSOAPAction(Packet packet)

Methods inherited from class com.sun.xml.ws.addressing.WsaClientTube

processRequest, processResponse, validateAction

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, doSuspend, doSuspend, doSuspend, doThrow, doThrow, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

wsdlPort

@NotNull
protected final WSDLPort wsdlPort

Port that we are processing.

binding

protected final WSBinding binding

addressingVersion

@NotNull
protected final AddressingVersion addressingVersion

soapVersion

protected final SOAPVersion soapVersion

Constructor Detail

W3CWsaClientTube

public W3CWsaClientTube(WSDLPort wsdlPort,
                        WSBinding binding,
                        Tube next)

W3CWsaClientTube

public W3CWsaClientTube(WsaClientTube that,
                        TubeCloner cloner)

Method Detail

copy

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

Overrides:

copy in class WsaClientTube

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.

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.

processException

@NotNull
public NextAction processException(java.lang.Throwable t)

Description copied from class: AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processException in interface Tube

Overrides:

processException in class AbstractFilterTubeImpl

Returns:

A NextAction object that represents the next action to be taken by the JAX-WS runtime.

getTubeHelper

protected WsaTubeHelper getTubeHelper()

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:

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

getWSDLBoundOperation

protected final WSDLBoundOperation getWSDLBoundOperation(Packet packet)

validateSOAPAction

protected void validateSOAPAction(Packet packet)