|
||||||||||
PREV CLASS NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This 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.
Method Summary | |
void |
destroy()
The destroy method indicates the end of lifecycle for a Handler instance. |
QName (src) [] |
getHeaders()
Gets the header blocks processed by this Handler instance. |
boolean |
handleFault(MessageContext (src) msgContext)
The handleFault method processes the SOAP faults based on the SOAP message processing model. |
boolean |
handleRequest(MessageContext (src) msgContext)
The handleRequest method processes the request message. |
boolean |
handleResponse(MessageContext (src) msgContext)
The handleResponse method processes the response SOAP message. |
void |
init(HandlerInfo (src) config)
The init method enables the Handler instance to initialize itself. |
Method Detail |
public QName (src) [] getHeaders()
public void init(HandlerInfo (src) config) throws JAXRPCException (src)
config
- HandlerInfo configuration for the initialization of this handler
JAXRPCException (src)
- - if initialization of the handler failspublic void destroy() throws JAXRPCException (src)
JAXRPCException (src)
- - if there was any error during destroypublic boolean handleRequest(MessageContext (src) msgContext) throws JAXRPCException (src) , SOAPFaultException (src)
msgContext
- MessageContext parameter provides access to the request message.
JAXRPCException (src)
- - 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 code
SOAPFaultException (src)
- - 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.public boolean handleResponse(MessageContext (src) msgContext)
msgContext
- MessageContext parameter provides access to the response SOAP message
JAXRPCException (src)
- - 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.public boolean handleFault(MessageContext (src) msgContext)
msgContext
- MessageContext parameter provides access to the SOAP message
JAXRPCException (src)
- - 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.
|
||||||||||
PREV CLASS NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |