- Author:
- Kohsuke Kawaguchi, Jitendra Kotamraju
-
Method Summary
Modifier and TypeMethodDescriptionstatic Tube
static Pipe
copy
(TubeCloner cloner) Creates an identical clone of thisTube
.void
Invoked before the last copy of the pipeline is about to be discarded, to giveTube
s a chance to clean up any resources.Acts on a exception and performs some clean up operations.Uses the current fiber and runs the whole pipe to the completion (meaning everything from now on will run synchronously.)Acts on a response and performs some protocol specific operation.toString()
Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl
copy, doInvoke, doInvokeAndForget, doReturnWith, doSuspend, doSuspend, doSuspend, doSuspend, doThrow, doThrow, process
-
Method Details
-
adapt
-
adapt
-
processRequest
Uses the current fiber and runs the whole pipe to the completion (meaning everything from now on will run synchronously.)- Parameters:
p
- The packet that represents a request message. If the packet has a non-null message, it must be a valid unconsumedMessage
. 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
Description copied from interface:Tube
Acts on a response and performs some protocol specific operation.Once a
Tube.processRequest(Packet)
is invoked, this method will be always invoked with the response, before thisTube
processes another request.- Parameters:
p
- If the packet has a non-null message, it must be a valid unconsumedMessage
. This message represents a response to the request message passed toTube.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
Description copied from interface:Tube
Acts on a exception and performs some clean up operations.If a
Tube.processRequest(Packet)
,Tube.processResponse(Packet)
,#processException(Throwable)
throws an exception, this method will be always invoked on all theTube
s in the remainingNextAction
s.On the server side, the
Throwable
thrown will be propagated to the top-most transport. The transport converts the exception to fault reply or simply logs in case of one-way MEP. If you are a filteringTube
likeAbstractTubeImpl
, you don't have to override the implementation). On the other hand, any intermediateTube
may want to convert the exception to a fault message.On the client side, the
Throwable
thrown will be propagated all the way back to the calling client applications. (The consequence of that is that if you are a filteringTube
likeAbstractTubeImpl
, you don't have to override the implementation)- Returns:
- A
NextAction
object that represents the next action to be taken by the JAX-WS runtime.
-
preDestroy
public void preDestroy()Description copied from interface:Tube
Invoked before the last copy of the pipeline is about to be discarded, to giveTube
s 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.
-
copy
Description copied from interface:Tube
Creates an identical clone of thisTube
.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 otherTube
references you have, or else there's a risk of infinite recursion.For most
Tube
implementations that delegate to anotherTube
, this method requires that you also copy theTube
that you delegate to.For limited number of
Tube
s that do not maintain any thread unsafe resource, it is allowed to simply returnthis
from this method (notice that even if you are stateless, if you got a delegatingTube
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 interfaceTube
- Specified by:
copy
in classAbstractTubeImpl
- Parameters:
cloner
- Use this object (in particular itsTubeCloner.copy(Tube)
method to clone other pipe references you have in your pipe. SeeTubeCloner
for more discussion about why.- Returns:
- always non-null
Tube
.
-
toString
-