org.apache.axis2.engine
Interface Handler

All Superinterfaces:
Serializable
All Known Subinterfaces:
TransportSender
All Known Implementing Classes:
AbstractHandler, AbstractTransportSender, CommonsHTTPTransportSender, JMSSender, Phase, Receiver, Sender, WSDoAllHandler

public interface Handler
extends Serializable

Interface Handler


Method Summary
 void cleanup()
          Method cleanup.
 HandlerDescription getHandlerDesc()
          Gets the HandlerDescription of a handler.
 QName getName()
          Method getName.
 Parameter getParameter(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

cleanup

public void cleanup()
             throws AxisFault
Method cleanup.

Throws:
AxisFault

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 class's '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

getHandlerDesc

public HandlerDescription getHandlerDesc()
Gets the HandlerDescription of a handler. This is used as an input to get phaseRule of a handler.

Returns:
Returns HandlerDescription.

getName

public QName getName()
Method getName.

Returns:
Returns QName

getParameter

public Parameter getParameter(String name)
Method getParameter.

Parameters:
name -
Returns:
Returns Parameter.