| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_22) on Tue Apr 17 18:33:30 IST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| Handler (Apache Axis2 - Root 1.6.2 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-04-17"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Handler (Apache Axis2 - Root 1.6.2 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Handler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/axis2/engine/DispatchPhase.html" title="class in org.apache.axis2.engine"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/axis2/engine/Handler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Handler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.axis2.engine</FONT> |
| <BR> |
| Interface Handler</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/axis2/transport/TransportSender.html" title="interface in org.apache.axis2.transport">TransportSender</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/axis2/engine/AbstractDispatcher.html" title="class in org.apache.axis2.engine">AbstractDispatcher</A>, <A HREF="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</A>, <A HREF="../../../../org/apache/axis2/dispatchers/AbstractOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">AbstractOperationDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/AbstractServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">AbstractServiceDispatcher</A>, <A HREF="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">AbstractTemplatedHandler</A>, <A HREF="../../../../org/apache/axis2/dispatchers/ActionBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">ActionBasedOperationDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/AddressingBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">AddressingBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/AddressingBasedDispatcher.html" title="class in org.apache.axis2.engine">AddressingBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/handlers/addressing/AddressingInFaultHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingInFaultHandler</A>, <A HREF="../../../../org/apache/axis2/handlers/addressing/AddressingInHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingInHandler</A>, <A HREF="../../../../org/apache/axis2/handlers/addressing/AddressingOutHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingOutHandler</A>, <A HREF="../../../../org/apache/axis2/handlers/addressing/AddressingValidationHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingValidationHandler</A>, <A HREF="../../../../org/apache/axis2/transport/http/CommonsHTTPTransportSender.html" title="class in org.apache.axis2.transport.http">CommonsHTTPTransportSender</A>, <A HREF="../../../../org/apache/axis2/jaxws/client/dispatch/DispatchOperationHandler.html" title="class in org.apache.axis2.jaxws.client.dispatch">DispatchOperationHandler</A>, <A HREF="../../../../org/apache/axis2/engine/DispatchPhase.html" title="class in org.apache.axis2.engine">DispatchPhase</A>, <A HREF="../../../../org/apache/axis2/jaxws/dispatchers/GenericProviderDispatcher.html" title="class in org.apache.axis2.jaxws.dispatchers">GenericProviderDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/HTTPLocationBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">HTTPLocationBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/HTTPLocationBasedDispatcher.html" title="class in org.apache.axis2.engine">HTTPLocationBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/InstanceDispatcher.html" title="class in org.apache.axis2.engine">InstanceDispatcher</A>, <A HREF="../../../../org/apache/axis2/transport/java/JavaTransportSender.html" title="class in org.apache.axis2.transport.java">JavaTransportSender</A>, <A HREF="../../../../org/apache/axis2/transport/local/LocalResponder.html" title="class in org.apache.axis2.transport.local">LocalResponder</A>, <A HREF="../../../../org/apache/axis2/transport/local/LocalTransportSender.html" title="class in org.apache.axis2.transport.local">LocalTransportSender</A>, <A HREF="../../../../org/apache/axis2/mtompolicy/MTOMInHandler.html" title="class in org.apache.axis2.mtompolicy">MTOMInHandler</A>, <A HREF="../../../../org/apache/axis2/mtompolicy/MTOMOutHandler.html" title="class in org.apache.axis2.mtompolicy">MTOMOutHandler</A>, <A HREF="../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html" title="class in org.apache.axis2.jaxws.dispatchers">MustUnderstandChecker</A>, <A HREF="../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandValidationDispatcher.html" title="class in org.apache.axis2.jaxws.dispatchers">MustUnderstandValidationDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/Phase.html" title="class in org.apache.axis2.engine">Phase</A>, <A HREF="../../../../org/apache/axis2/dispatchers/RelatesToBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">RelatesToBasedOperationDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/RelatesToBasedServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">RelatesToBasedServiceDispatcher</A>, <A HREF="../../../../org/apache/axis2/clustering/RequestBlockingHandler.html" title="class in org.apache.axis2.clustering">RequestBlockingHandler</A>, <A HREF="../../../../org/apache/axis2/dispatchers/RequestURIBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/RequestURIBasedDispatcher.html" title="class in org.apache.axis2.engine">RequestURIBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/RequestURIBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIBasedOperationDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/RequestURIBasedServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIBasedServiceDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/RequestURIOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIOperationDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/RequestURIOperationDispatcher.html" title="class in org.apache.axis2.engine">RequestURIOperationDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/SOAPActionBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPActionBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/SOAPActionBasedDispatcher.html" title="class in org.apache.axis2.engine">SOAPActionBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/SOAPMessageBodyBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPMessageBodyBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/engine/SOAPMessageBodyBasedDispatcher.html" title="class in org.apache.axis2.engine">SOAPMessageBodyBasedDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/SOAPMessageBodyBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPMessageBodyBasedOperationDispatcher</A>, <A HREF="../../../../org/apache/axis2/dispatchers/SOAPMessageBodyBasedServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPMessageBodyBasedServiceDispatcher</A>, <A HREF="../../../../org/apache/axis2/handlers/soapmonitor/SOAPMonitorHandler.html" title="class in org.apache.axis2.handlers.soapmonitor">SOAPMonitorHandler</A>, <A HREF="../../../../org/apache/axis2/saaj/util/UnderstandAllHeadersHandler.html" title="class in org.apache.axis2.saaj.util">UnderstandAllHeadersHandler</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>Handler</B></DL> |
| </PRE> |
| |
| <P> |
| 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). |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</A></B></CODE> |
| |
| <BR> |
| This type encapsulates an enumeration of possible message processing |
| instruction values that may be returned by a handler/phase within the |
| runtime.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.html#cleanup()">cleanup</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>This method will be going away after the 1.3 release, it was never used.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</A></B>(<A HREF="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</A> msgContext)</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.html#getHandlerDesc()">getHandlerDesc</A></B>()</CODE> |
| |
| <BR> |
| Gets the HandlerDescription of a handler.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Return the name of this Handler</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.html#getParameter(java.lang.String)">getParameter</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| Get a Parameter from this Handler</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.html#init(org.apache.axis2.description.HandlerDescription)">init</A></B>(<A HREF="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</A> handlerDesc)</CODE> |
| |
| <BR> |
| Initialize a Handler.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/engine/Handler.html#invoke(org.apache.axis2.context.MessageContext)">invoke</A></B>(<A HREF="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</A> msgContext)</CODE> |
| |
| <BR> |
| This method will be called on each registered handler when a message |
| needs to be processed.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="cleanup()"><!-- --></A><H3> |
| cleanup</H3> |
| <PRE> |
| void <B>cleanup</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>This method will be going away after the 1.3 release, it was never used.</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="init(org.apache.axis2.description.HandlerDescription)"><!-- --></A><H3> |
| init</H3> |
| <PRE> |
| void <B>init</B>(<A HREF="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</A> handlerDesc)</PRE> |
| <DL> |
| <DD>Initialize a Handler. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>handlerDesc</CODE> - the HandlerDescription for this Handler</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="invoke(org.apache.axis2.context.MessageContext)"><!-- --></A><H3> |
| invoke</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</A> <B>invoke</B>(<A HREF="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</A> msgContext) |
| throws <A HREF="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</A></PRE> |
| <DL> |
| <DD>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. |
| <p/> |
| This method may be called concurrently from multiple threads. |
| <p/> |
| 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. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>msgContext</CODE> - the <code>MessageContext</code> to process with this |
| <code>Handler</code>. |
| <DT><B>Returns:</B><DD>An InvocationResponse that indicates what |
| the next step in the message processing should be. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</A></CODE> - if the handler encounters an error</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="flowComplete(org.apache.axis2.context.MessageContext)"><!-- --></A><H3> |
| flowComplete</H3> |
| <PRE> |
| void <B>flowComplete</B>(<A HREF="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</A> msgContext)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>msgContext</CODE> - the <code>MessageContext</code> to process with this |
| <code>Handler</code>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHandlerDesc()"><!-- --></A><H3> |
| getHandlerDesc</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</A> <B>getHandlerDesc</B>()</PRE> |
| <DL> |
| <DD>Gets the HandlerDescription of a handler. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns HandlerDescription.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE> |
| <DL> |
| <DD>Return the name of this Handler |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the handler's name as a String</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParameter(java.lang.String)"><!-- --></A><H3> |
| getParameter</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</A> <B>getParameter</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD>Get a Parameter from this Handler |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the desired value |
| <DT><B>Returns:</B><DD>the Parameter, or null.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Handler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/axis2/engine/DispatchPhase.html" title="class in org.apache.axis2.engine"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/axis2/engine/Handler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Handler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
