Package com.sun.xml.wss.provider.wsit

Class ClientSecurityTube

java.lang.Object

com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl

com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

com.sun.xml.wss.provider.wsit.ClientSecurityTube

All Implemented Interfaces:

Pipe, Tube, SecureConversationInitiator

public class ClientSecurityTube
extends AbstractFilterTubeImpl
implements SecureConversationInitiator

Field Summary

Fields

Modifier and Type	Field	Description
protected PipeHelper	helper
protected static Logger	log
protected X509Certificate	serverCert

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

next

Constructor Summary

Constructors

Modifier	Constructor	Description
	ClientSecurityTube(TubeConfiguration config, Tube nextTube)
protected	ClientSecurityTube(ClientSecurityTube that, TubeCloner cloner)
	ClientSecurityTube(Map<Object,Object> props, Tube next)

Method Summary

Modifier and Type	Method	Description
AbstractTubeImpl	copy(TubeCloner cloner)	Creates an identical clone of this Tube.
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.
NextAction	processException(Throwable t)	Default no-op implementation.
NextAction	processRequest(Packet packet)	Default no-op implementation.
NextAction	processResponse(Packet ret)	Default no-op implementation.
jakarta.xml.bind.JAXBElement	startSecureConversation(Packet packet)

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

helper

protected PipeHelper helper

serverCert

protected X509Certificate serverCert

log

protected static final Logger log

Constructor Detail

ClientSecurityTube

public ClientSecurityTube(TubeConfiguration config,
                          Tube nextTube)

ClientSecurityTube

public ClientSecurityTube(Map<Object,Object> props,
                          Tube next)

ClientSecurityTube

protected ClientSecurityTube(ClientSecurityTube that,
                             TubeCloner cloner)

Method Detail

copy

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

preDestroy

public void preDestroy()

Description copied from interface: 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 Pipe

Specified by:

preDestroy in interface Tube

Overrides:

preDestroy in class AbstractFilterTubeImpl

processRequest

public NextAction processRequest(Packet packet)

Description copied from class: AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processRequest in interface Tube

Overrides:

processRequest in class 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 NextAction processResponse(Packet ret)

Description copied from class: AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processResponse in interface Tube

Overrides:

processResponse in class 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.

processException

public NextAction processException(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.

startSecureConversation

public jakarta.xml.bind.JAXBElement startSecureConversation(Packet packet)
                                                     throws WSSecureConversationException

Specified by:

startSecureConversation in interface SecureConversationInitiator

Throws:

WSSecureConversationException