javax.xml.rpc.handler
Class GenericHandler
java.lang.Object
javax.xml.rpc.handler.GenericHandler
- Handler
public abstract class GenericHandler
extends java.lang.Object
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.
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.
|
GenericHandler
protected GenericHandler()
Default constructor.
destroy
public void 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.
- destroy in interface Handler
getHeaders
public abstract QName[] getHeaders()
Gets the header blocks processed by this Handler instance.
- getHeaders in interface Handler
- 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
public boolean handleFault(MessageContext context)
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.
- handleFault in interface Handler
context
- the message context
handleRequest
public boolean handleRequest(MessageContext context)
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.
- handleRequest in interface Handler
context
- the message context
handleResponse
public boolean handleResponse(MessageContext context)
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.
- handleResponse in interface Handler
context
- the message context
init
public void init(HandlerInfo config)
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.
- init in interface Handler
config
- handler configuration
Copyright © 2005 Apache Web Services Project. All Rights Reserved.