org.jboss.ws.core.jaxrpc.handler

Class HandlerWrapper

java.lang.Object

org.jboss.ws.core.jaxrpc.handler.HandlerWrapper

All Implemented Interfaces:

Handler

public class HandlerWrapper
extends Object
implements Handler

A wrapper arround a Handler that takes care of its lifecycle.

Author:

thomas.diesler@jboss.org

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOES_NOT_EXIST
static int	METHOD_READY

Constructor Summary

Constructors

Constructor and Description
HandlerWrapper(Handler handler) Delegate to the given handler

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() The destroy method indicates the end of lifecycle for a Handler instance.
QName[]	getHeaders() Gets the header blocks processed by this Handler instance.
int	getState() Get the current state
String	getStateAsString() Get the current state as string
boolean	handleFault(MessageContext msgContext) The handleFault method processes the SOAP faults based on the SOAP message processing model.
boolean	handleRequest(MessageContext msgContext) The handleRequest method processes the request message.
boolean	handleResponse(MessageContext msgContext) The handleResponse method processes the response SOAP message.
int	hashCode() Returns a hash code value for the object.
void	init(HandlerInfo config) The init method enables the Handler instance to initialize itself.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

DOES_NOT_EXIST

public static final int DOES_NOT_EXIST

See Also:

Constant Field Values

METHOD_READY

public static final int METHOD_READY

See Also:

Constant Field Values

Constructor Detail

HandlerWrapper

public HandlerWrapper(Handler handler)

Delegate to the given handler

Method Detail

getState

public int getState()

Get the current state

getStateAsString

public String getStateAsString()

Get the current state as string

getHeaders

public QName[] getHeaders()

Gets the header blocks processed by this Handler instance.

Specified by:

getHeaders in interface Handler

Returns:

Array of QNames of header blocks processed by this handler instance. QName is the qualified name of the outermost element of the Header block.

init

public void init(HandlerInfo config)
          throws JAXRPCException

The init method enables the Handler instance to initialize itself.

Specified by:

init in interface Handler

Parameters:

config - HandlerInfo configuration for the initialization of this handler

Throws:

JAXRPCException - - if initialization of the handler fails

destroy

public void destroy()
             throws JAXRPCException

The destroy method indicates the end of lifecycle for a Handler instance.

Specified by:

destroy in interface Handler

Throws:

JAXRPCException - - if there was any error during destroy

handleRequest

public boolean handleRequest(MessageContext msgContext)
                      throws JAXRPCException,
                             SOAPFaultException

The handleRequest method processes the request message.

Specified by:

handleRequest in interface Handler

Parameters:

msgContext - MessageContext parameter provides access to the request message.

Returns:

boolean boolean Indicates the processing mode

• Return true to indicate continued processing of the request handler chain. The HandlerChain takes the responsibility of invoking the next entity. The next entity may be the next handler in the HandlerChain or if this handler is the last handler in the chain, the next entity is the service endpoint object.
• Return false to indicate blocking of the request handler chain. In this case, further processing of the request handler chain is blocked and the target service endpoint is not dispatched. The JAX-RPC runtime system takes the responsibility of invoking the response handler chain next with the SOAPMessageContext. The Handler implementation class has the the responsibility of setting the appropriate response SOAP message in either handleRequest and/or handleResponse method. In the default processing model, the response handler chain starts processing from the same Handler instance (that returned false) and goes backward in the execution sequence.

Throws:

JAXRPCException - - indicates a handler-specific runtime error. If JAXRPCException is thrown by a handleRequest method, the HandlerChain terminates the further processing of this handler chain. On the server side, the HandlerChain generates a SOAP fault that indicates that the message could not be processed for reasons not directly attributable to the contents of the message itself but rather to a runtime error during the processing of the message. On the client side, the exception is propagated to the client code

SOAPFaultException - - indicates a SOAP fault. The Handler implementation class has the the responsibility of setting the SOAP fault in the SOAP message in either handleRequest and/or handleFault method. If SOAPFaultException is thrown by a server-side request handler's handleRequest method, the HandlerChain terminates the further processing of the request handlers in this handler chain and invokes the handleFault method on the HandlerChain with the SOAP message msgContext. Next, the HandlerChain invokes the handleFault method on handlers registered in the handler chain, beginning with the Handler instance that threw the exception and going backward in execution. The client-side request handler's handleRequest method should not throw the SOAPFaultException.

handleResponse

public boolean handleResponse(MessageContext msgContext)

The handleResponse method processes the response SOAP message.

Specified by:

handleResponse in interface Handler

Parameters:

msgContext - MessageContext parameter provides access to the response SOAP message

Returns:

boolean Indicates the processing mode

• Return true to indicate continued processing ofthe response handler chain. The HandlerChain invokes the handleResponse method on the next Handler in the handler chain.
• Return false to indicate blocking of the response handler chain. In this case, no other response handlers in the handler chain are invoked.

handleFault

public boolean handleFault(MessageContext msgContext)

The handleFault method processes the SOAP faults based on the SOAP message processing model.

Specified by:

handleFault in interface Handler

Parameters:

msgContext - MessageContext parameter provides access to the SOAP message

Returns:

boolean Indicates the processing mode

• Return true to indicate continued processing of SOAP Fault. The HandlerChain invokes the handleFault method on the next Handler in the handler chain.
• Return false to indicate end of the SOAP fault processing. In this case, no other handlers in the handler chain are invoked.

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object