org.apache.axis2.engine
Interface Handler

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
TransportSender
All Known Implementing Classes:
AbstractHandler, AbstractTransportSender, CommonsHTTPTransportSender, DispatchingChecker, WSDoAllHandler

public interface Handler
extends java.io.Serializable

Interface Handler


Method Summary
 void cleanup()
          Method cleanup
 HandlerDescription getHandlerDesc()
          To get the phaseRule of a handler it is required to get the HnadlerDescription of the handler so the argumnet pass when it call return as HnadlerDescription
 javax.xml.namespace.QName getName()
          Method getName
 Parameter getParameter(java.lang.String name)
          Method getParameter
 void init(HandlerDescription handlerdesc)
          Method init
 void invoke(MessageContext msgContext)
          Invoke is called to do the actual work of the Handler object.
 

Method Detail

init

public void init(HandlerDescription handlerdesc)
Method init

Parameters:
handlerdesc -

invoke

public void invoke(MessageContext msgContext)
            throws AxisFault
Invoke is called to do the actual work of the Handler object. If there is a fault during the processing of this method it is invoke's job to catch the exception and undo any partial work that has been completed. Once we leave 'invoke' if a fault is thrown, this classes 'onFault' method will be called. Invoke should rethrow any exceptions it catches, wrapped in an AxisFault.

Parameters:
msgContext - the MessageContext to process with this Handler.
Throws:
AxisFault - if the handler encounters an error

getName

public javax.xml.namespace.QName getName()
Method getName

Returns:

getParameter

public Parameter getParameter(java.lang.String name)
Method getParameter

Parameters:
name -
Returns:

cleanup

public void cleanup()
             throws AxisFault
Method cleanup

Throws:
AxisFault

getHandlerDesc

public HandlerDescription getHandlerDesc()
To get the phaseRule of a handler it is required to get the HnadlerDescription of the handler so the argumnet pass when it call return as HnadlerDescription

Returns: