/lib/docs/org/apache/xmlrpc/client/XmlRpcTransport.html
HTML | 227 lines | 181 code | 26 blank | 20 comment | 0 complexity | 61d11d9c502f3099a52b67b42f277bfb MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_0) on Mon Apr 20 21:45:59 CEST 2009 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8XmlRpcTransport (Apache XML-RPC 3.1.2 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2009-04-20"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="XmlRpcTransport (Apache XML-RPC 3.1.2 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcTransport.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcSunHttpTransportFactory.html" title="class in org.apache.xmlrpc.client"><B>PREV CLASS</B></A> 60 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactory.html" title="interface in org.apache.xmlrpc.client"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?org/apache/xmlrpc/client/XmlRpcTransport.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="XmlRpcTransport.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92org.apache.xmlrpc.client</FONT> 93<BR> 94Interface XmlRpcTransport</H2> 95<DL> 96<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcCommonsTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcCommonsTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcHttpTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcHttpTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcLite14HttpTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcLite14HttpTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcLiteHttpTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcLiteHttpTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcLocalStreamTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcLocalStreamTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcLocalTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcLocalTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcStreamTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcStreamTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcSun14HttpTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcSun14HttpTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcSun15HttpTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcSun15HttpTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcSunHttpTransport.html" title="class in org.apache.xmlrpc.client">XmlRpcSunHttpTransport</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportImpl.html" title="class in org.apache.xmlrpc.client">XmlRpcTransportImpl</A></DD> 97</DL> 98<HR> 99<DL> 100<DT><PRE>public interface <B>XmlRpcTransport</B></DL> 101</PRE> 102 103<P> 104<p>Interface from XML-RPC to an underlying transport, most likely based on HTTP.</p> 105 Replaces the interface <code>org.apache.xmlrpc.client</code> from Apache XML-RPC 106 2.0, which has actually been a stream based transport. 107<P> 108 109<P> 110<DL> 111<DT><B>Since:</B></DT> 112 <DD>3.0</DD> 113</DL> 114<HR> 115 116<P> 117 118<!-- ========== METHOD SUMMARY =========== --> 119 120<A NAME="method_summary"><!-- --></A> 121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 123<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 124<B>Method Summary</B></FONT></TH> 125</TR> 126<TR BGCOLOR="white" CLASS="TableRowColor"> 127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 128<CODE> java.lang.Object</CODE></FONT></TD> 129<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransport.html#sendRequest(org.apache.xmlrpc.XmlRpcRequest)">sendRequest</A></B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest)</CODE> 130 131<BR> 132 Send an XML-RPC message.</TD> 133</TR> 134</TABLE> 135 136<P> 137 138<!-- ============ METHOD DETAIL ========== --> 139 140<A NAME="method_detail"><!-- --></A> 141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 143<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 144<B>Method Detail</B></FONT></TH> 145</TR> 146</TABLE> 147 148<A NAME="sendRequest(org.apache.xmlrpc.XmlRpcRequest)"><!-- --></A><H3> 149sendRequest</H3> 150<PRE> 151java.lang.Object <B>sendRequest</B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest) 152 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE> 153<DL> 154<DD>Send an XML-RPC message. This method is called to send a message to the 155 other party. 156<P> 157<DD><DL> 158<DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed. 159<DT><B>Returns:</B><DD>Result object, if invoking the remote method was successfull. 160<DT><B>Throws:</B> 161<DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE> - Performing the request failed.</DL> 162</DD> 163</DL> 164<!-- ========= END OF CLASS DATA ========= --> 165<HR> 166 167 168<!-- ======= START OF BOTTOM NAVBAR ====== --> 169<A NAME="navbar_bottom"><!-- --></A> 170<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 171<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 172<TR> 173<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 174<A NAME="navbar_bottom_firstrow"><!-- --></A> 175<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 176 <TR ALIGN="center" VALIGN="top"> 177 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 178 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 179 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 180 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcTransport.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 181 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 182 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 183 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 184 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 185 </TR> 186</TABLE> 187</TD> 188<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 189</EM> 190</TD> 191</TR> 192 193<TR> 194<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 195 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcSunHttpTransportFactory.html" title="class in org.apache.xmlrpc.client"><B>PREV CLASS</B></A> 196 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactory.html" title="interface in org.apache.xmlrpc.client"><B>NEXT CLASS</B></A></FONT></TD> 197<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 198 <A HREF="../../../../index.html?org/apache/xmlrpc/client/XmlRpcTransport.html" target="_top"><B>FRAMES</B></A> 199 <A HREF="XmlRpcTransport.html" target="_top"><B>NO FRAMES</B></A> 200 <SCRIPT type="text/javascript"> 201 <!-- 202 if(window==top) { 203 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 204 } 205 //--> 206</SCRIPT> 207<NOSCRIPT> 208 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 209</NOSCRIPT> 210 211 212</FONT></TD> 213</TR> 214<TR> 215<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 216 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 217<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 218DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 219</TR> 220</TABLE> 221<A NAME="skip-navbar_bottom"></A> 222<!-- ======== END OF BOTTOM NAVBAR ======= --> 223 224<HR> 225Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 226</BODY> 227</HTML>