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

Class AbstractTubeImpl

java.lang.Object

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

All Implemented Interfaces:

Pipe, Tube

Direct Known Subclasses:

AbstractFilterTubeImpl, DeferredTransportPipe, HttpTransportPipe, InvokerTube, PipeAdapter, TCPTransportPipe

public abstract class AbstractTubeImpl
extends Object
implements Tube, Pipe

Base class for Tube implementation.

This can be also used as a Pipe, and thus effectively making every Tube usable as a Pipe.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTubeImpl()	Default constructor.
protected	AbstractTubeImpl(AbstractTubeImpl that, TubeCloner cloner)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
AbstractTubeImpl	copy(PipeCloner cloner)	Needs to be implemented by the derived class, but we can't make it abstract without upsetting javac.
abstract AbstractTubeImpl	copy(TubeCloner cloner)	Creates an identical clone of this Tube.
protected NextAction	doInvoke(Tube next, Packet packet)
protected NextAction	doInvokeAndForget(Tube next, Packet packet)
protected NextAction	doReturnWith(Packet response)
protected NextAction	doSuspend()	Deprecated.
protected NextAction	doSuspend(Tube next)	Deprecated.
protected NextAction	doSuspend(Tube next, Runnable onExitRunnable)
protected NextAction	doSuspend(Runnable onExitRunnable)
protected NextAction	doThrow(Packet response, Throwable t)
protected NextAction	doThrow(Throwable t)
Packet	process(Packet p)	"Dual stack" compatibility mechanism.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.xml.ws.api.pipe.Pipe

preDestroy

Methods inherited from interface com.sun.xml.ws.api.pipe.Tube

preDestroy, processException, processRequest, processResponse

Constructor Detail

AbstractTubeImpl

protected AbstractTubeImpl()

Default constructor.

AbstractTubeImpl

protected AbstractTubeImpl(AbstractTubeImpl that,
                           TubeCloner cloner)

Copy constructor.

Method Detail

doInvoke

protected final NextAction doInvoke(Tube next,
                                    Packet packet)

doInvokeAndForget

protected final NextAction doInvokeAndForget(Tube next,
                                             Packet packet)

doReturnWith

protected final NextAction doReturnWith(Packet response)

doThrow

protected final NextAction doThrow(Packet response,
                                   Throwable t)

doSuspend

@Deprecated
protected final NextAction doSuspend()

Deprecated.

doSuspend

protected final NextAction doSuspend(Runnable onExitRunnable)

doSuspend

@Deprecated
protected final NextAction doSuspend(Tube next)

Deprecated.

doSuspend

protected final NextAction doSuspend(Tube next,
                                     Runnable onExitRunnable)

doThrow

protected final NextAction doThrow(Throwable t)

process

public Packet process(Packet p)

"Dual stack" compatibility mechanism. Allows Tube to be invoked from a Pipe.

Specified by:

process in interface Pipe

Parameters:

p - The packet that represents a request message. Must not be null. 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:

The packet that represents a response message. Must not be null. 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 as a parameter.

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.

copy

public final AbstractTubeImpl copy(PipeCloner cloner)

Needs to be implemented by the derived class, but we can't make it abstract without upsetting javac.

Specified by:

copy in interface Pipe

Parameters:

cloner - Use this object (in particular its PipeCloner.copy(Pipe) method to clone other pipe references you have in your pipe. See PipeCloner for more discussion about why.

Returns:

always non-null Pipe.

copy

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

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.