public interface Handler
Modifier and Type | Method and Description |
---|---|
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 msgContext)
The handleFault method processes the SOAP faults based on the SOAP message processing model.
|
boolean |
handleRequest(MessageContext msgContext)
The handleRequest method processes the request message.
|
boolean |
handleResponse(MessageContext msgContext)
The handleResponse method processes the response SOAP message.
|
void |
init(HandlerInfo config)
The init method enables the Handler instance to initialize itself.
|
QName[] getHeaders()
void init(HandlerInfo config) throws JAXRPCException
config
- HandlerInfo configuration for the initialization of this handlerJAXRPCException
- - if initialization of the handler failsvoid destroy() throws JAXRPCException
JAXRPCException
- - if there was any error during destroyboolean handleRequest(MessageContext msgContext) throws JAXRPCException, SOAPFaultException
msgContext
- MessageContext parameter provides access to the request message.JAXRPCException
- - indicates a handler-specific runtime error.
If JAXRPCException is thrown by a handleRequest method, the HandlerChain terminates the further processing of this handler chain.
On the server side, the HandlerChain generates a SOAP fault that indicates that the message could not be processed
for reasons not directly attributable to the contents of the message itself but rather to a runtime error during
the processing of the message. On the client side, the exception is propagated to the client codeSOAPFaultException
- - indicates a SOAP fault. The Handler implementation class has the the responsibility
of setting the SOAP fault in the SOAP message in either handleRequest and/or handleFault method.
If SOAPFaultException is thrown by a server-side request handler's handleRequest method, the HandlerChain
terminates the further processing of the request handlers in this handler chain and invokes the handleFault
method on the HandlerChain with the SOAP message msgContext. Next, the HandlerChain invokes the handleFault method
on handlers registered in the handler chain, beginning with the Handler instance that threw the exception and
going backward in execution. The client-side request handler's handleRequest method should not throw the SOAPFaultException.boolean handleResponse(MessageContext msgContext)
msgContext
- MessageContext parameter provides access to the response SOAP messageJAXRPCException
- - indicates a handler specific runtime error. If JAXRPCException is thrown by a
handleResponse method, the HandlerChain terminates the further processing of this handler chain. On the server
side, the HandlerChain generates a SOAP fault that indicates that the message could not be processed for reasons
not directly attributable to the contents of the message itself but rather to a runtime error during the processing
of the message. On the client side, the runtime exception is propagated to the client code.boolean handleFault(MessageContext msgContext)
msgContext
- MessageContext parameter provides access to the SOAP messageJAXRPCException
- - indicates handler specific runtime error.
If JAXRPCException is thrown by a handleFault method, the HandlerChain terminates the further processing of this
handler chain. On the server side, the HandlerChain generates a SOAP fault that indicates that the message could
not be processed for reasons not directly attributable to the contents of the message itself but rather to a runtime
error during the processing of the message. On the client side, the JAXRPCException is propagated to the client code.Copyright © 2012 JBoss by Red Hat. All Rights Reserved.