com.sun.xml.xwss
Class XWSSServerTube

java.lang.Object
  com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl
      com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
          com.sun.xml.xwss.XWSSServerTube

All Implemented Interfaces:

com.sun.xml.ws.api.pipe.Pipe, com.sun.xml.ws.api.pipe.Tube

public class XWSSServerTube
extends com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

Field Summary

protected static java.lang.String	CONTEXT_WSDL_OPERATION
protected static java.lang.String	FAILURE
protected static java.lang.String	FALSE
protected boolean	isSOAP12
protected MessageFactory	messageFactory
protected SOAPFactory	soapFactory
protected com.sun.xml.ws.api.SOAPVersion	soapVersion
protected static java.lang.String	TRUE

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

next

Constructor Summary

XWSSServerTube(com.sun.xml.ws.api.server.WSEndpoint epoint, com.sun.xml.ws.api.model.wsdl.WSDLPort prt, com.sun.xml.ws.api.pipe.Tube nextTube)
Creates a new instance of XWSSServerPipe

XWSSServerTube(XWSSServerTube that, com.sun.xml.ws.api.pipe.TubeCloner cloner)

Method Summary

void	addFault(WssSoapFaultException sfe, SOAPMessage soapMessage, boolean isSOAP12)
com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl	copy(com.sun.xml.ws.api.pipe.TubeCloner cloner) Creates an identical clone of this Tube.
protected SOAPFault	getSOAPFault(WssSoapFaultException sfe)
SOAPFaultException	getSOAPFaultException(WssSoapFaultException sfe, boolean isSOAP12)
void	preDestroy() Invoked before the last copy of the pipeline is about to be discarded, to give Tubes a chance to clean up any resources.
com.sun.xml.ws.api.pipe.NextAction	processRequest(com.sun.xml.ws.api.message.Packet packet) Default no-op implementation.
com.sun.xml.ws.api.pipe.NextAction	processResponse(com.sun.xml.ws.api.message.Packet ret) Default no-op implementation.
com.sun.xml.ws.api.message.Packet	secureResponse(com.sun.xml.ws.api.message.Packet packet)
com.sun.xml.ws.api.message.Packet	validateRequest(com.sun.xml.ws.api.message.Packet packet)

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

processException

Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl

copy, doInvoke, doInvokeAndForget, doReturnWith, doSuspend, doSuspend, doThrow, process

Methods inherited from class java.lang.Object

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

Field Detail

soapFactory

protected SOAPFactory soapFactory

messageFactory

protected MessageFactory messageFactory

soapVersion

protected com.sun.xml.ws.api.SOAPVersion soapVersion

isSOAP12

protected boolean isSOAP12

FAILURE

protected static final java.lang.String FAILURE

See Also:

Constant Field Values

TRUE

protected static final java.lang.String TRUE

See Also:

Constant Field Values

FALSE

protected static final java.lang.String FALSE

See Also:

Constant Field Values

CONTEXT_WSDL_OPERATION

protected static final java.lang.String CONTEXT_WSDL_OPERATION

See Also:

Constant Field Values

Constructor Detail

XWSSServerTube

public XWSSServerTube(com.sun.xml.ws.api.server.WSEndpoint epoint,
                      com.sun.xml.ws.api.model.wsdl.WSDLPort prt,
                      com.sun.xml.ws.api.pipe.Tube nextTube)

Creates a new instance of XWSSServerPipe

XWSSServerTube

public XWSSServerTube(XWSSServerTube that,
                      com.sun.xml.ws.api.pipe.TubeCloner cloner)

Method Detail

preDestroy

public void preDestroy()

Description copied from interface: com.sun.xml.ws.api.pipe.Tube

Invoked before the last copy of the pipeline is about to be discarded, to give Tubes 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 com.sun.xml.ws.api.pipe.Pipe

Specified by:

preDestroy in interface com.sun.xml.ws.api.pipe.Tube

Overrides:

preDestroy in class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

validateRequest

public com.sun.xml.ws.api.message.Packet validateRequest(com.sun.xml.ws.api.message.Packet packet)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

secureResponse

public com.sun.xml.ws.api.message.Packet secureResponse(com.sun.xml.ws.api.message.Packet packet)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

addFault

public void addFault(WssSoapFaultException sfe,
                     SOAPMessage soapMessage,
                     boolean isSOAP12)
              throws SOAPException

Throws:

SOAPException

getSOAPFault

protected SOAPFault getSOAPFault(WssSoapFaultException sfe)

getSOAPFaultException

public SOAPFaultException getSOAPFaultException(WssSoapFaultException sfe,
                                                boolean isSOAP12)

copy

public com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl copy(com.sun.xml.ws.api.pipe.TubeCloner cloner)

Description copied from interface: com.sun.xml.ws.api.pipe.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 com.sun.xml.ws.api.pipe.Tube

Specified by:

copy in class com.sun.xml.ws.api.pipe.helper.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

public com.sun.xml.ws.api.pipe.NextAction processRequest(com.sun.xml.ws.api.message.Packet packet)

Description copied from class: com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processRequest in interface com.sun.xml.ws.api.pipe.Tube

Overrides:

processRequest in class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

Parameters:

packet - 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

public com.sun.xml.ws.api.pipe.NextAction processResponse(com.sun.xml.ws.api.message.Packet ret)

Description copied from class: com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processResponse in interface com.sun.xml.ws.api.pipe.Tube

Overrides:

processResponse in class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

Parameters:

ret - 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.