| <!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:58 IST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| InvocationController (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="InvocationController (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/InvocationController.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"> |
| PREV CLASS |
| <A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationControllerFactory.html" title="interface in org.apache.axis2.jaxws.core.controller"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/axis2/jaxws/core/controller/InvocationController.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="InvocationController.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: NESTED | 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.jaxws.core.controller</FONT> |
| <BR> |
| Interface InvocationController</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/impl/AxisInvocationController.html" title="class in org.apache.axis2.jaxws.core.controller.impl">AxisInvocationController</A>, <A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/impl/InvocationControllerImpl.html" title="class in org.apache.axis2.jaxws.core.controller.impl">InvocationControllerImpl</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>InvocationController</B></DL> |
| </PRE> |
| |
| <P> |
| The <tt>InvocationController</tt> is an interface modeling the invocation of a |
| target web service. All of the information that the InvocationController needs |
| should exist within the InvocatonContext that is passed in to the various invoke |
| methods. |
| <p/> |
| The request information is passed in within the InvocationContext. The InvocationController |
| assumes that there is a MessageContext within that InvocationContext that is populated with all |
| of the information that it needs to invoke. If not, an error will be returned. Once the |
| response comes back, the information for that response will be held inside of the MessageContext |
| representing the response, that exists in the InvocationContext. |
| <p/> |
| The InvocationController supports four different invocation patterns: |
| <p/> |
| 1) synchronous - This is represented by the <A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invoke(org.apache.axis2.jaxws.core.InvocationContext)"><CODE>invoke(InvocationContext)</CODE></A> method. This is a |
| blocking, request/response call to the web service. |
| <p/> |
| 2) one-way - This is represented by the <A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)"><CODE>invokeOneWay(InvocationContext)</CODE></A> method. This is |
| a one-way invocation that only returns errors related to sending the message. If an error occurs |
| while processing, the client will not be notified. |
| <p/> |
| 3) asynchronous (callback) - <A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext, javax.xml.ws.AsyncHandler)"><CODE>invokeAsync(InvocationContext, AsyncHandler)</CODE></A> |
| <p/> |
| 4) asynchronous (polling) - <A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)"><CODE>invokeAsync(InvocationContext)</CODE></A> |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> <A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invoke(org.apache.axis2.jaxws.core.InvocationContext)">invoke</A></B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic)</CODE> |
| |
| <BR> |
| Performs a synchronous (blocking) invocation of a target service.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/ws/Response.html?is-external=true" title="class or interface in javax.xml.ws">Response</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)">invokeAsync</A></B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic)</CODE> |
| |
| <BR> |
| Performs an asynchronous (non-blocking) invocation of the client based on a callback model.</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/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</A><?></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext, javax.xml.ws.AsyncHandler)">invokeAsync</A></B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/ws/AsyncHandler.html?is-external=true" title="class or interface in javax.xml.ws">AsyncHandler</A> asyncHandler)</CODE> |
| |
| <BR> |
| Performs an asynchronous (non-blocking) invocation of the client based on a polling model.</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/jaxws/core/controller/InvocationController.html#invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)">invokeOneWay</A></B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic)</CODE> |
| |
| <BR> |
| Performs a one-way invocation of the client.</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="invoke(org.apache.axis2.jaxws.core.InvocationContext)"><!-- --></A><H3> |
| invoke</H3> |
| <PRE> |
| <A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> <B>invoke</B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic)</PRE> |
| <DL> |
| <DD>Performs a synchronous (blocking) invocation of a target service. The InvocationContext |
| passed in should contain a valid MessageContext containing the properties and message to be |
| sent for the request. The response contents will be processed and placed in the |
| InvocationContext as well. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ic</CODE> - |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)"><!-- --></A><H3> |
| invokeOneWay</H3> |
| <PRE> |
| void <B>invokeOneWay</B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Performs a one-way invocation of the client. This is SHOULD NOT be a robust invocation, so |
| any fault that occurs during the processing of the request will not be returned to the |
| client. Errors returned to the client are problems that occurred during the sending of the |
| message to the server. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ic</CODE> - |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)"><!-- --></A><H3> |
| invokeAsync</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/ws/Response.html?is-external=true" title="class or interface in javax.xml.ws">Response</A> <B>invokeAsync</B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic)</PRE> |
| <DL> |
| <DD>Performs an asynchronous (non-blocking) invocation of the client based on a callback model. |
| The AsyncHandler that is passed in is the callback that the client programmer supplied when |
| they invoked their JAX-WS Dispatch or their SEI-based dynamic proxy. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ic</CODE> - <DD><CODE>callback</CODE> - |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="invokeAsync(org.apache.axis2.jaxws.core.InvocationContext, javax.xml.ws.AsyncHandler)"><!-- --></A><H3> |
| invokeAsync</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</A><?> <B>invokeAsync</B>(<A HREF="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</A> ic, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/ws/AsyncHandler.html?is-external=true" title="class or interface in javax.xml.ws">AsyncHandler</A> asyncHandler)</PRE> |
| <DL> |
| <DD>Performs an asynchronous (non-blocking) invocation of the client based on a polling model. |
| The Response object that is returned allows the client programmer to poll against it to see |
| if a response has been sent back by the server. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ic</CODE> - |
| <DT><B>Returns:</B><DD></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/InvocationController.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"> |
| PREV CLASS |
| <A HREF="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationControllerFactory.html" title="interface in org.apache.axis2.jaxws.core.controller"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/axis2/jaxws/core/controller/InvocationController.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="InvocationController.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: NESTED | 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> |
