Package javax.xml.rpc.handler
Class GenericHandler
java.lang.Object
javax.xml.rpc.handler.GenericHandler
- All Implemented Interfaces:
Handler
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.
- Version:
- 1.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Thedestroy
method indicates the end of lifecycle for a Handler instance.abstract QName[]
Gets the header blocks processed by this Handler instance.boolean
handleFault
(MessageContext context) ThehandleFault
method processes the SOAP faults based on the SOAP message processing model.boolean
handleRequest
(MessageContext context) ThehandleRequest
method processes the request SOAP message.boolean
handleResponse
(MessageContext context) ThehandleResponse
method processes the response message.void
init
(HandlerInfo config) Theinit
method to enable the Handler instance to initialize itself.
-
Constructor Details
-
GenericHandler
protected GenericHandler()Default constructor.
-
-
Method Details
-
handleRequest
ThehandleRequest
method processes the request SOAP message. The default implementation of this method returnstrue
. 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.- Specified by:
handleRequest
in interfaceHandler
- Parameters:
context
- the message context- Returns:
- true/false
-
handleResponse
ThehandleResponse
method processes the response message. The default implementation of this method returnstrue
. 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.- Specified by:
handleResponse
in interfaceHandler
- Parameters:
context
- the message context- Returns:
- true/false
-
handleFault
ThehandleFault
method processes the SOAP faults based on the SOAP message processing model. The default implementation of this method returnstrue
. 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.- Specified by:
handleFault
in interfaceHandler
- Parameters:
context
- the message context- Returns:
- true/false
-
init
Theinit
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. -
destroy
public void destroy()Thedestroy
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. -
getHeaders
Gets the header blocks processed by this Handler instance.- Specified by:
getHeaders
in interfaceHandler
- 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.
-