public class DumpTube extends AbstractFilterTubeImpl
Pipe
that dumps messages that pass through.next
Modifier | Constructor and Description |
---|---|
protected |
DumpTube(DumpTube that,
TubeCloner cloner)
Copy constructor.
|
|
DumpTube(String name,
PrintStream out,
Tube next) |
Modifier and Type | Method and Description |
---|---|
AbstractTubeImpl |
copy(TubeCloner cloner)
Creates an identical clone of this
Tube . |
protected void |
dump(String header,
com.sun.xml.ws.api.message.Packet packet) |
NextAction |
processRequest(com.sun.xml.ws.api.message.Packet request)
Default no-op implementation.
|
NextAction |
processResponse(com.sun.xml.ws.api.message.Packet response)
Default no-op implementation.
|
preDestroy, processException
copy, doInvoke, doInvokeAndForget, doReturnWith, doSuspend, doSuspend, doSuspend, doSuspend, doThrow, doThrow, process
public DumpTube(String name, PrintStream out, Tube next)
name
- Specify the name that identifies this DumpTube
instance. This string will be printed when this pipe
dumps messages, and allows people to distinguish which
pipe instance is dumping a message when multiple
DumpTube
s print messages out.out
- The output to send dumps to.next
- The next Tube
in the pipeline.protected DumpTube(DumpTube that, TubeCloner cloner)
public NextAction processRequest(com.sun.xml.ws.api.message.Packet request)
AbstractFilterTubeImpl
processRequest
in interface Tube
processRequest
in class AbstractFilterTubeImpl
request
- 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)
NextAction
object that represents the next action
to be taken by the JAX-WS runtime.public NextAction processResponse(com.sun.xml.ws.api.message.Packet response)
AbstractFilterTubeImpl
processResponse
in interface Tube
processResponse
in class AbstractFilterTubeImpl
response
- 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
NextAction
object that represents the next action
to be taken by the JAX-WS runtime.protected void dump(String header, com.sun.xml.ws.api.message.Packet packet)
public AbstractTubeImpl copy(TubeCloner cloner)
Tube
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.
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 Tube
s 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.
copy
in interface Tube
copy
in class AbstractTubeImpl
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.Tube
.Copyright © 2015 Oracle Corporation. All rights reserved.