| org.apache.axis2.engine.Handler
All known Subclasses: org.apache.axis2.description.SpeakingHandler1, org.apache.axis2.handlers.Handler2, org.apache.axis2.engine.Phase, org.apache.axis2.description.SpeakingHandler, org.apache.axis2.deployment.SpeakingHandler, org.apache.axis2.handlers.AbstractHandler, org.apache.axis2.registry.Handler3,
| Handler | | public interface Handler (Code) | | A Handler represents a piece of message processing functionality in Axis2.
Handlers are combined into chains and phases in order to provide customizable functionality
such as security, reliability, etc. Handlers must be multi-thread safe and should keep all
their state in Context objects (see the org.apache.axis2.context package).
|
| Inner Class :public class InvocationResponse | |
| cleanup | | public void cleanup()(Code) | | |
| flowComplete | | public void flowComplete(MessageContext msgContext)(Code) | | This method will be called on each registered handler that had its
invoke(...) method called during the processing of the message, once
the message processing has completed. During execution of the
flowComplete's, handlers are invoked in the opposite order that they
were invoked originally. Note that implementations SHOULD check
msgContext.getFailureReason() to see if this is an error or a normal
completion.
Parameters:
msgContext - the MessageContext to process with thisHandler. |
| getHandlerDesc | | public HandlerDescription getHandlerDesc()(Code) | | Gets the HandlerDescription of a handler.
Returns HandlerDescription. |
| getName | | public String getName()(Code) | | Return the name of this Handler
the handler's name as a String |
| getParameter | | public Parameter getParameter(String name)(Code) | | Get a Parameter from this Handler
Parameters:
name - the name of the desired value the Parameter, or null. |
| init | | public void init(HandlerDescription handlerDesc)(Code) | | Initialize a Handler.
Parameters:
handlerDesc - the HandlerDescription for this Handler |
| invoke | | public InvocationResponse invoke(MessageContext msgContext) throws AxisFault(Code) | | This method will be called on each registered handler when a message
needs to be processed. If the message processing is paused by the
handler, then this method will be called again for the handler that
paused the processing once it is resumed.
This method may be called concurrently from multiple threads.
Handlers that want to determine the type of message that is to be
processed (e.g. response vs request, inbound vs. outbound, etc.) can
retrieve that information from the MessageContext via
MessageContext.getFLOW() and
MessageContext.getAxisOperation().getMessageExchangePattern() APIs.
Parameters:
msgContext - the MessageContext to process with thisHandler. An InvocationResponse that indicates whatthe next step in the message processing should be.
throws:
AxisFault - if the handler encounters an error |
|
|