public abstract class GenericHandler extends Object implements Handler
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.
Modifier | Constructor and Description |
---|---|
protected |
GenericHandler()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
destroy()
The
destroy method indicates the end of lifecycle
for a Handler instance. |
abstract QName[] |
getHeaders()
Gets the header blocks processed by this Handler instance.
|
boolean |
handleFault(MessageContext context)
The
handleFault method processes the SOAP faults
based on the SOAP message processing model. |
boolean |
handleRequest(MessageContext context)
The
handleRequest method processes the request
SOAP message. |
boolean |
handleResponse(MessageContext context)
The
handleResponse method processes the response
message. |
void |
init(HandlerInfo config)
The
init method to enable the Handler instance to
initialize itself. |
public boolean handleRequest(MessageContext context)
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.handleRequest
in interface Handler
context
- the message contextpublic boolean handleResponse(MessageContext context)
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.handleResponse
in interface Handler
context
- the message contextpublic boolean handleFault(MessageContext context)
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.handleFault
in interface Handler
context
- the message contextpublic void init(HandlerInfo config)
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.public void destroy()
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.public abstract QName[] getHeaders()
getHeaders
in interface Handler
QName
is the qualified name of the outermost element of the Header block.Copyright © The Apache Software Foundation. All Rights Reserved.