Jakarta XML RPC API 1.1.4 · javax.xml.rpc.handler.Handler

Method Summary

Modifier and Type	Method and Description
public void	destroy() The `destroy` method indicates the end of lifecycle for a Handler instance.
public QName[]	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. getHeaders() Gets the header blocks that can be processed by this Handler instance.
public boolean	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. handleFault(MessageContext MessageContext parameter provides access to the SOAP message context) The `handleFault` method processes the SOAP faults based on the SOAP message processing model.
public boolean	Returns: 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 Jakarta XML 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. handleRequest(MessageContext `MessageContext` parameter provides access to the request message. context) The `handleRequest` method processes the request message.
public boolean	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. handleResponse(MessageContext MessageContext parameter provides access to the response SOAP message context) The `handleResponse` method processes the response SOAP message.
public void	init(HandlerInfo Configuration for the initialization of this handler config) The `init` method enables the Handler instance to initialize itself.

Method Detail

destroy back to summary

destroy	back to summary
public void destroy() The `destroy` method indicates the end of lifecycle for a Handler instance. The Handler implementation class should release its resources and perform cleanup in the implementation of the `destroy` method. Exceptions JAXRPCException: If any error during destroy

public void destroy()

The destroy method indicates the end of lifecycle for a Handler instance. The Handler implementation class should release its resources and perform cleanup in the implementation of the destroy method.

Exceptions

JAXRPCException:: If any error during destroy

getHeaders back to summary

getHeaders	back to summary
public QName[] getHeaders() Gets the header blocks that can be processed by this Handler instance. Returns:QName[] Array of QNames of header blocks processed by this handler instance. `QName` is the qualified name of the outermost element of the Header block.

public QName[] getHeaders()

Gets the header blocks that can be processed by this Handler instance.

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

handleFault back to summary

handleFault	back to summary
public boolean handleFault(MessageContext context) The `handleFault` method processes the SOAP faults based on the SOAP message processing model. Parameters context:MessageContext MessageContext parameter provides access to the SOAP message Returns:boolean 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. Exceptions JAXRPCException: Indicates handler specific runtime error. If JAXRPCException is thrown by a handleFault 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 JAXRPCException is propagated to the client code.

public boolean handleFault(MessageContext context)

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

Parameters

context:MessageContext: MessageContext parameter provides access to the SOAP message

Returns:boolean

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.

Exceptions

JAXRPCException:: Indicates handler specific runtime error. If JAXRPCException is thrown by a handleFault 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 JAXRPCException is propagated to the client code.

handleRequest back to summary

handleRequest	back to summary
public boolean handleRequest(MessageContext context) The `handleRequest` method processes the request message. Parameters context:MessageContext `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 Jakarta XML 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. Exceptions JAXRPCException: This exception indicates 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: This 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 context. 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.

public boolean handleRequest(MessageContext context)

The handleRequest method processes the request message.

Parameters

context:MessageContext: 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 Jakarta XML 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.

Exceptions

JAXRPCException:: This exception indicates 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:: This 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 context. 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 back to summary

handleResponse	back to summary
public boolean handleResponse(MessageContext context) The `handleResponse` method processes the response SOAP message. Parameters context:MessageContext MessageContext parameter provides access to the response SOAP message Returns:boolean 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. Exceptions JAXRPCException: Indicates handler specific runtime error. If JAXRPCException is thrown by a handleResponse 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 runtime exception is propagated to the client code.

public boolean handleResponse(MessageContext context)

The handleResponse method processes the response SOAP message.

Parameters

context:MessageContext: MessageContext parameter provides access to the response SOAP message

Returns:boolean

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.

Exceptions

JAXRPCException:: Indicates handler specific runtime error. If JAXRPCException is thrown by a handleResponse 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 runtime exception is propagated to the client code.

init back to summary

init	back to summary
public void init(HandlerInfo config) The `init` method enables the Handler instance to initialize itself. The `init` method passes the handler configuration as a `HandlerInfo` instance. The HandlerInfo is used to configure the Handler (for example: setup access to an external resource or service) during the initialization. In the init method, the Handler class may get access to any resources (for example; access to a logging service or database) and maintain these as part of its instance variables. Note that these instance variables must not have any state specific to the SOAP message processing performed in the various handle method. Parameters config:HandlerInfo Configuration for the initialization of this handler Exceptions JAXRPCException: If initialization of the handler fails

public void init(HandlerInfo config)

The init method enables the Handler instance to initialize itself. The init method passes the handler configuration as a HandlerInfo instance. The HandlerInfo is used to configure the Handler (for example: setup access to an external resource or service) during the initialization.

In the init method, the Handler class may get access to any resources (for example; access to a logging service or database) and maintain these as part of its instance variables. Note that these instance variables must not have any state specific to the SOAP message processing performed in the various handle method.

Parameters

config:HandlerInfo: Configuration for the initialization of this handler

Exceptions

JAXRPCException:: If initialization of the handler fails

public Interface Handler

Method Summary

Method Detail