javax.xml.rpc.handler
Interface Handler
- GenericHandler
The javax.xml.rpc.handler.Handler
interface is
required to be implemented by a SOAP message handler. The
handleRequest
, handleResponse
and handleFault
methods for a SOAP message
handler get access to the SOAPMessage
from the
SOAPMessageContext
. The implementation of these
methods can modify the SOAPMessage
including the
headers and body elements.
abstract void | destroy() - The
destroy method indicates the end of lifecycle
for a Handler instance.
|
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 message.
|
boolean | handleResponse(MessageContext context) - The
handleResponse method processes the response SOAP message.
|
abstract void | init(HandlerInfo config) - The
init method enables the Handler instance to
initialize itself.
|
destroy
public abstract 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.
getHeaders
public QName[] getHeaders()
Gets the header blocks processed by this Handler instance.
- 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.
context
- MessageContext parameter provides access to
the SOAP message
- 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.
handleRequest
public boolean handleRequest(MessageContext context)
The handleRequest
method processes the request message.
context
- MessageContext parameter provides access to the request
message.
- 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 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.
handleResponse
public boolean handleResponse(MessageContext context)
The handleResponse
method processes the response SOAP message.
context
- MessageContext parameter provides access to
the response SOAP message
- 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.
init
public abstract 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.
config
- HandlerInfo configuration for the initialization of this
handler