com.sun.xml.ws.dump
Class MessageDumpingTube

java.lang.Object
  extended by com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl
      extended by com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
          extended by com.sun.xml.ws.dump.MessageDumpingTube
All Implemented Interfaces:
Pipe, Tube

final class MessageDumpingTube
extends AbstractFilterTubeImpl


Field Summary
(package private) static String DEFAULT_MSGDUMP_LOGGING_ROOT
           
 
Fields inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
next
 
Constructor Summary
MessageDumpingTube(MessageDumpingTube that, TubeCloner cloner)
          Copy constructor.
MessageDumpingTube(Tube next, MessageDumpingFeature feature)
           
 
Method Summary
 MessageDumpingTube copy(TubeCloner cloner)
          Creates an identical clone of this Tube.
protected  void dump(MessageDumper.MessageType messageType, String message, String engineId)
           
 NextAction processException(Throwable t)
          Default no-op implementation.
 NextAction processRequest(Packet request)
          Default no-op implementation.
 NextAction processResponse(Packet response)
          Default no-op implementation.
 
Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl
preDestroy
 
Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl
copy, doInvoke, doInvokeAndForget, doReturnWith, doSuspend, doSuspend, doSuspend, doSuspend, doThrow, process
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_MSGDUMP_LOGGING_ROOT

static final String DEFAULT_MSGDUMP_LOGGING_ROOT
See Also:
Constant Field Values
Constructor Detail

MessageDumpingTube

MessageDumpingTube(Tube next,
                   MessageDumpingFeature feature)
Parameters:
name - Specify the name that identifies this MessageDumpingTube 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 DumpTubes print messages out.
out - The output to send dumps to.
next - The next Tube in the pipeline.

MessageDumpingTube

MessageDumpingTube(MessageDumpingTube that,
                   TubeCloner cloner)
Copy constructor.

Method Detail

copy

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

processRequest

public NextAction processRequest(Packet request)
Description copied from class: AbstractFilterTubeImpl
Default no-op implementation.

Specified by:
processRequest in interface Tube
Overrides:
processRequest in class AbstractFilterTubeImpl
Parameters:
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)

Returns:
A NextAction object that represents the next action to be taken by the JAX-WS runtime.

processResponse

public NextAction processResponse(Packet response)
Description copied from class: AbstractFilterTubeImpl
Default no-op implementation.

Specified by:
processResponse in interface Tube
Overrides:
processResponse in class AbstractFilterTubeImpl
Parameters:
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

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.

dump

protected final void dump(MessageDumper.MessageType messageType,
                          String message,
                          String engineId)


Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.