org.apache.axis2.engine
Interface Handler

All Known Subinterfaces:

TransportSender

All Known Implementing Classes:

AbstractHandler, AbstractTransportSender, CommonsHTTPTransportSender, JMSSender, Phase

public interface Handler

Interface Handler

Nested Class Summary

static class

Handler.InvocationResponse This type encapsulates an enumeration of possible message processing instruction values that may be returned by a handler/phase within the runtime.

Method Summary

void	cleanup() Since this might change the whole behavior of Axis2 handlers, and since this is still under discussion (http://marc.theaimsgroup.com/?l=axis-dev&m=114504084929285&w=2) implementation of this method is deferred.
HandlerDescription	getHandlerDesc() Gets the HandlerDescription of a handler.
String	getName() Method getName.
Parameter	getParameter(String name) Method getParameter.
void	init(HandlerDescription handlerdesc) Method init.
Handler.InvocationResponse	invoke(MessageContext msgContext) Invoke is called to do the actual work of the Handler object.

Method Detail

cleanup

public void cleanup()

Since this might change the whole behavior of Axis2 handlers, and since this is still under discussion (http://marc.theaimsgroup.com/?l=axis-dev&m=114504084929285&w=2) implementation of this method is deferred. Note : This method will not be automatically called, from Axis2 engine, until this is fully implemented.

init

public void init(HandlerDescription handlerdesc)

Method init.

Parameters:

handlerdesc -

invoke

public Handler.InvocationResponse 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. N.B. This method may be called concurrently from multiple threads.

Parameters:

msgContext - the MessageContext to process with this Handler.

Returns:

An InvocationResponse that indicates what the next step in the message processing should be.

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 String getName()

Method getName.

Returns:

Returns String

getParameter

public Parameter getParameter(String name)

Method getParameter.

Parameters:

name -

Returns:

Returns Parameter.