Top Description Constructors Methods
javax.xml.rpc.handler

public abstract Class GenericHandler

extends Object
implements Handler
Class Inheritance
All Implemented Interfaces
javax.xml.rpc.handler.Handler
Imports
javax.xml.rpc.JAXRPCException, javax.xml.namespace.QName
The javax.xml.rpc.handler.GenericHandler class implements the Handler interface. SOAP Message Handler developers should typically subclass GenericHandler class unless the Handler class needs another class as a superclass.

The GenericHandler class is a convenience abstract class that makes writing Handlers easy. This class provides default implementations of the lifecycle methods init and destroy and also different handle methods. A Handler developer should only override methods that it needs to specialize as part of the derived Handler implementation class.

Author
Rahul Sharma
Version
1.0

Constructor Summary

AccessConstructor and Description
protected
GenericHandler()

Default constructor

Method Summary

Modifier and TypeMethod and Description
public void
destroy()

Implements javax.xml.rpc.handler.Handler.destroy.

The destroy method indicates the end of lifecycle for a Handler instance.
public abstract 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()

Redeclares javax.xml.rpc.handler.Handler.getHeaders.

Gets the header blocks processed by this Handler instance.
public boolean
handleFault(MessageContext
MessageContext parameter provides access to the SOAP message
context)

Implements javax.xml.rpc.handler.Handler.handleFault.

The handleFault method processes the SOAP faults based on the SOAP message processing model.
public boolean
handleRequest(MessageContext
MessageContext parameter provides access to the request message.
context)

Implements javax.xml.rpc.handler.Handler.handleRequest.

The handleRequest method processes the request SOAP message.
public boolean
handleResponse(MessageContext
MessageContext parameter provides access to the response SOAP message
context)

Implements javax.xml.rpc.handler.Handler.handleResponse.

The handleResponse method processes the response message.
public void
init(HandlerInfo
Configuration for the initialization of this handler
config)

Implements javax.xml.rpc.handler.Handler.init.

The init method to enable the Handler instance to initialize itself.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

GenericHandlerback to summary
protected GenericHandler()

Default constructor

Method Detail

destroyback to summary
public void destroy()

Implements javax.xml.rpc.handler.Handler.destroy.

The destroy method indicates the end of lifecycle for a Handler instance. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

See Also
javax.xml.rpc.handler.Handler#destroy
getHeadersback to summary
public abstract QName[] getHeaders()

Redeclares javax.xml.rpc.handler.Handler.getHeaders.

Gets the header blocks 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.

handleFaultback to summary
public boolean handleFault(MessageContext context)

Implements javax.xml.rpc.handler.Handler.handleFault.

The handleFault method processes the SOAP faults based on the SOAP message processing model. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the SOAP fault. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

Parameters
context:MessageContext

Doc from javax.xml.rpc.handler.Handler.handleFault.

MessageContext parameter provides access to the SOAP message

Returns:boolean

Doc from javax.xml.rpc.handler.Handler.handleFault.

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.
See Also
javax.xml.rpc.handler.Handler#handleFault
handleRequestback to summary
public boolean handleRequest(MessageContext context)

Implements javax.xml.rpc.handler.Handler.handleRequest.

The handleRequest method processes the request SOAP message. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the request SOAP message. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

Parameters
context:MessageContext

Doc from javax.xml.rpc.handler.Handler.handleRequest.

MessageContext parameter provides access to the request message.

Returns:boolean

Doc from javax.xml.rpc.handler.Handler.handleRequest.

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.
See Also
javax.xml.rpc.handler.Handler#handleRequest
handleResponseback to summary
public boolean handleResponse(MessageContext context)

Implements javax.xml.rpc.handler.Handler.handleResponse.

The handleResponse method processes the response message. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the response SOAP message. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

Parameters
context:MessageContext

Doc from javax.xml.rpc.handler.Handler.handleResponse.

MessageContext parameter provides access to the response SOAP message

Returns:boolean

Doc from javax.xml.rpc.handler.Handler.handleResponse.

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.
See Also
javax.xml.rpc.handler.Handler#handleResponse
initback to summary
public void init(HandlerInfo config)

Implements javax.xml.rpc.handler.Handler.init.

The init method to enable the Handler instance to initialize itself. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

Parameters
config:HandlerInfo

Doc from javax.xml.rpc.handler.Handler.init.

Configuration for the initialization of this handler

See Also
javax.xml.rpc.handler.Handler#init