PageRenderTime 167ms CodeModel.GetById 64ms app.highlight 66ms RepoModel.GetById 11ms app.codeStats 0ms

/lib/docs/org/apache/xmlrpc/client/XmlRpcCommonsTransportFactory.html

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 335 lines | 277 code | 36 blank | 22 comment | 0 complexity | 32be984cd5ff71b76463d2f80d4bb63e 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:58 CEST 2009 -->
  6<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7<TITLE>
  8XmlRpcCommonsTransportFactory (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="XmlRpcCommonsTransportFactory (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>&nbsp;</TD>
 42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlRpcCommonsTransportFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 48  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcCommonsTransport.html" title="class in org.apache.xmlrpc.client"><B>PREV CLASS</B></A>&nbsp;
 60&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcHttpClientConfig.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/XmlRpcCommonsTransportFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 63&nbsp;<A HREF="XmlRpcCommonsTransportFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 64&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 82DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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>
 94Class XmlRpcCommonsTransportFactory</H2>
 95<PRE>
 96java.lang.Object
 97  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactoryImpl.html" title="class in org.apache.xmlrpc.client">org.apache.xmlrpc.client.XmlRpcTransportFactoryImpl</A>
 98      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.client.XmlRpcCommonsTransportFactory</B>
 99</PRE>
100<DL>
101<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactory.html" title="interface in org.apache.xmlrpc.client">XmlRpcTransportFactory</A></DD>
102</DL>
103<HR>
104<DL>
105<DT><PRE>public class <B>XmlRpcCommonsTransportFactory</B><DT>extends <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactoryImpl.html" title="class in org.apache.xmlrpc.client">XmlRpcTransportFactoryImpl</A></DL>
106</PRE>
107
108<P>
109An HTTP transport factory, which is based on the Jakarta Commons
110 HTTP Client.
111<P>
112
113<P>
114<HR>
115
116<P>
117
118<!-- ======== CONSTRUCTOR SUMMARY ======== -->
119
120<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcCommonsTransportFactory.html#XmlRpcCommonsTransportFactory(org.apache.xmlrpc.client.XmlRpcClient)">XmlRpcCommonsTransportFactory</A></B>(<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A>&nbsp;pClient)</CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance.</TD>
131</TR>
132</TABLE>
133&nbsp;
134<!-- ========== METHOD SUMMARY =========== -->
135
136<A NAME="method_summary"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
139<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
140<B>Method Summary</B></FONT></TH>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;org.apache.commons.httpclient.HttpClient</CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcCommonsTransportFactory.html#getHttpClient()">getHttpClient</A></B>()</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the factories <CODE>HttpClient</CODE>.</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransport.html" title="interface in org.apache.xmlrpc.client">XmlRpcTransport</A></CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcCommonsTransportFactory.html#getTransport()">getTransport</A></B>()</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an instance of <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransport.html" title="interface in org.apache.xmlrpc.client"><CODE>XmlRpcTransport</CODE></A>.</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;void</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcCommonsTransportFactory.html#setHttpClient(org.apache.commons.httpclient.HttpClient)">setHttpClient</A></B>(org.apache.commons.httpclient.HttpClient&nbsp;pHttpClient)</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the factories <CODE>HttpClient</CODE>.</TD>
165</TR>
166</TABLE>
167&nbsp;<A NAME="methods_inherited_from_class_org.apache.xmlrpc.client.XmlRpcTransportFactoryImpl"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
170<TH ALIGN="left"><B>Methods inherited from class org.apache.xmlrpc.client.<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactoryImpl.html" title="class in org.apache.xmlrpc.client">XmlRpcTransportFactoryImpl</A></B></TH>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD><CODE><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactoryImpl.html#getClient()">getClient</A></CODE></TD>
174</TR>
175</TABLE>
176&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
179<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
183</TR>
184</TABLE>
185&nbsp;
186<P>
187
188<!-- ========= CONSTRUCTOR DETAIL ======== -->
189
190<A NAME="constructor_detail"><!-- --></A>
191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
193<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
194<B>Constructor Detail</B></FONT></TH>
195</TR>
196</TABLE>
197
198<A NAME="XmlRpcCommonsTransportFactory(org.apache.xmlrpc.client.XmlRpcClient)"><!-- --></A><H3>
199XmlRpcCommonsTransportFactory</H3>
200<PRE>
201public <B>XmlRpcCommonsTransportFactory</B>(<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A>&nbsp;pClient)</PRE>
202<DL>
203<DD>Creates a new instance.
204<P>
205<DL>
206<DT><B>Parameters:</B><DD><CODE>pClient</CODE> - The client, which is controlling the factory.</DL>
207</DL>
208
209<!-- ============ METHOD DETAIL ========== -->
210
211<A NAME="method_detail"><!-- --></A>
212<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
214<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
215<B>Method Detail</B></FONT></TH>
216</TR>
217</TABLE>
218
219<A NAME="getTransport()"><!-- --></A><H3>
220getTransport</H3>
221<PRE>
222public <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransport.html" title="interface in org.apache.xmlrpc.client">XmlRpcTransport</A> <B>getTransport</B>()</PRE>
223<DL>
224<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransportFactory.html#getTransport()">XmlRpcTransportFactory</A></CODE></B></DD>
225<DD>Returns an instance of <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcTransport.html" title="interface in org.apache.xmlrpc.client"><CODE>XmlRpcTransport</CODE></A>. This may
226 be a singleton, but the caller should not depend on that:
227 A new instance may as well be created for any request.
228<P>
229<DD><DL>
230
231<DT><B>Returns:</B><DD>The configured transport.</DL>
232</DD>
233</DL>
234<HR>
235
236<A NAME="setHttpClient(org.apache.commons.httpclient.HttpClient)"><!-- --></A><H3>
237setHttpClient</H3>
238<PRE>
239public void <B>setHttpClient</B>(org.apache.commons.httpclient.HttpClient&nbsp;pHttpClient)</PRE>
240<DL>
241<DD><p>Sets the factories <CODE>HttpClient</CODE>. By default, a new instance
242 of <CODE>HttpClient</CODE> is created for any request.</p>
243 <p>Reusing the <CODE>HttpClient</CODE> is required, if you want to preserve
244 some state between requests. This applies, in particular, if you want
245 to use cookies: In that case, create an instance of <CODE>HttpClient</CODE>,
246 give it to the factory, and use <CODE>HttpClient.getState()</CODE> to
247 read or set cookies.
248<P>
249<DD><DL>
250</DL>
251</DD>
252</DL>
253<HR>
254
255<A NAME="getHttpClient()"><!-- --></A><H3>
256getHttpClient</H3>
257<PRE>
258public org.apache.commons.httpclient.HttpClient <B>getHttpClient</B>()</PRE>
259<DL>
260<DD><p>Returns the factories <CODE>HttpClient</CODE>. By default, a new instance
261 of <CODE>HttpClient</CODE> is created for any request.</p>
262 <p>Reusing the <CODE>HttpClient</CODE> is required, if you want to preserve
263 some state between requests. This applies, in particular, if you want
264 to use cookies: In that case, create an instance of <CODE>HttpClient</CODE>,
265 give it to the factory, and use <CODE>HttpClient.getState()</CODE> to
266 read or set cookies.
267<P>
268<DD><DL>
269</DL>
270</DD>
271</DL>
272<!-- ========= END OF CLASS DATA ========= -->
273<HR>
274
275
276<!-- ======= START OF BOTTOM NAVBAR ====== -->
277<A NAME="navbar_bottom"><!-- --></A>
278<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
279<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
280<TR>
281<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
282<A NAME="navbar_bottom_firstrow"><!-- --></A>
283<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
284  <TR ALIGN="center" VALIGN="top">
285  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
286  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
287  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
288  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlRpcCommonsTransportFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
289  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
290  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
291  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
292  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
293  </TR>
294</TABLE>
295</TD>
296<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
297</EM>
298</TD>
299</TR>
300
301<TR>
302<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
303&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcCommonsTransport.html" title="class in org.apache.xmlrpc.client"><B>PREV CLASS</B></A>&nbsp;
304&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcHttpClientConfig.html" title="interface in org.apache.xmlrpc.client"><B>NEXT CLASS</B></A></FONT></TD>
305<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
306  <A HREF="../../../../index.html?org/apache/xmlrpc/client/XmlRpcCommonsTransportFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
307&nbsp;<A HREF="XmlRpcCommonsTransportFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
308&nbsp;<SCRIPT type="text/javascript">
309  <!--
310  if(window==top) {
311    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
312  }
313  //-->
314</SCRIPT>
315<NOSCRIPT>
316  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
317</NOSCRIPT>
318
319
320</FONT></TD>
321</TR>
322<TR>
323<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
324  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
325<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
326DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
327</TR>
328</TABLE>
329<A NAME="skip-navbar_bottom"></A>
330<!-- ======== END OF BOTTOM NAVBAR ======= -->
331
332<HR>
333Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
334</BODY>
335</HTML>