/lib/docs/org/apache/xmlrpc/common/XmlRpcHttpConfig.html
HTML | 295 lines | 244 code | 30 blank | 21 comment | 0 complexity | 97347f3c18f995cac4f78c46fc1ce38b 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:56 CEST 2009 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8XmlRpcHttpConfig (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="XmlRpcHttpConfig (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/XmlRpcHttpConfig.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/common/XmlRpcExtensionException.html" title="class in org.apache.xmlrpc.common"><B>PREV CLASS</B></A> 60 <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpRequestConfig.html" title="interface in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcHttpConfig.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="XmlRpcHttpConfig.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.common</FONT> 93<BR> 94Interface XmlRpcHttpConfig</H2> 95<DL> 96<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/XmlRpcConfig.html" title="interface in org.apache.xmlrpc">XmlRpcConfig</A>, <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common">XmlRpcStreamConfig</A></DD> 97</DL> 98<DL> 99<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcHttpClientConfig.html" title="interface in org.apache.xmlrpc.client">XmlRpcHttpClientConfig</A>, <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpRequestConfig.html" title="interface in org.apache.xmlrpc.common">XmlRpcHttpRequestConfig</A>, <A HREF="../../../../org/apache/xmlrpc/server/XmlRpcHttpServerConfig.html" title="interface in org.apache.xmlrpc.server">XmlRpcHttpServerConfig</A></DD> 100</DL> 101<DL> 102<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xmlrpc/webserver/RequestData.html" title="class in org.apache.xmlrpc.webserver">RequestData</A>, <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientConfigImpl.html" title="class in org.apache.xmlrpc.client">XmlRpcClientConfigImpl</A>, <A HREF="../../../../org/apache/xmlrpc/XmlRpcConfigImpl.html" title="class in org.apache.xmlrpc">XmlRpcConfigImpl</A>, <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpRequestConfigImpl.html" title="class in org.apache.xmlrpc.common">XmlRpcHttpRequestConfigImpl</A>, <A HREF="../../../../org/apache/xmlrpc/server/XmlRpcServerConfigImpl.html" title="class in org.apache.xmlrpc.server">XmlRpcServerConfigImpl</A></DD> 103</DL> 104<HR> 105<DL> 106<DT><PRE>public interface <B>XmlRpcHttpConfig</B><DT>extends <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common">XmlRpcStreamConfig</A></DL> 107</PRE> 108 109<P> 110Interface of a configuration for HTTP requests. 111<P> 112 113<P> 114<HR> 115 116<P> 117<!-- =========== FIELD SUMMARY =========== --> 118 119<A NAME="field_summary"><!-- --></A> 120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 123<B>Field Summary</B></FONT></TH> 124</TR> 125</TABLE> 126 <A NAME="fields_inherited_from_class_org.apache.xmlrpc.common.XmlRpcStreamConfig"><!-- --></A> 127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 128<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 129<TH ALIGN="left"><B>Fields inherited from interface org.apache.xmlrpc.common.<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common">XmlRpcStreamConfig</A></B></TH> 130</TR> 131<TR BGCOLOR="white" CLASS="TableRowColor"> 132<TD><CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html#UTF8_ENCODING">UTF8_ENCODING</A></CODE></TD> 133</TR> 134</TABLE> 135 136<!-- ========== METHOD SUMMARY =========== --> 137 138<A NAME="method_summary"><!-- --></A> 139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 142<B>Method Summary</B></FONT></TH> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 146<CODE> java.lang.String</CODE></FONT></TD> 147<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpConfig.html#getBasicEncoding()">getBasicEncoding</A></B>()</CODE> 148 149<BR> 150 Returns the encoding being used to convert the String "username:password" 151 into bytes.</TD> 152</TR> 153<TR BGCOLOR="white" CLASS="TableRowColor"> 154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 155<CODE> boolean</CODE></FONT></TD> 156<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpConfig.html#isContentLengthOptional()">isContentLengthOptional</A></B>()</CODE> 157 158<BR> 159 Returns, whether a "Content-Length" header may be 160 omitted.</TD> 161</TR> 162</TABLE> 163 <A NAME="methods_inherited_from_class_org.apache.xmlrpc.common.XmlRpcStreamConfig"><!-- --></A> 164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 165<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 166<TH ALIGN="left"><B>Methods inherited from interface org.apache.xmlrpc.common.<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common">XmlRpcStreamConfig</A></B></TH> 167</TR> 168<TR BGCOLOR="white" CLASS="TableRowColor"> 169<TD><CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html#getEncoding()">getEncoding</A></CODE></TD> 170</TR> 171</TABLE> 172 <A NAME="methods_inherited_from_class_org.apache.xmlrpc.XmlRpcConfig"><!-- --></A> 173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 174<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 175<TH ALIGN="left"><B>Methods inherited from interface org.apache.xmlrpc.<A HREF="../../../../org/apache/xmlrpc/XmlRpcConfig.html" title="interface in org.apache.xmlrpc">XmlRpcConfig</A></B></TH> 176</TR> 177<TR BGCOLOR="white" CLASS="TableRowColor"> 178<TD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcConfig.html#getTimeZone()">getTimeZone</A>, <A HREF="../../../../org/apache/xmlrpc/XmlRpcConfig.html#isEnabledForExtensions()">isEnabledForExtensions</A></CODE></TD> 179</TR> 180</TABLE> 181 182<P> 183 184<!-- ============ METHOD DETAIL ========== --> 185 186<A NAME="method_detail"><!-- --></A> 187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 188<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 189<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 190<B>Method Detail</B></FONT></TH> 191</TR> 192</TABLE> 193 194<A NAME="getBasicEncoding()"><!-- --></A><H3> 195getBasicEncoding</H3> 196<PRE> 197java.lang.String <B>getBasicEncoding</B>()</PRE> 198<DL> 199<DD>Returns the encoding being used to convert the String "username:password" 200 into bytes. 201<P> 202<DD><DL> 203</DL> 204</DD> 205<DD><DL> 206 207<DT><B>Returns:</B><DD>Encoding being used for basic HTTP authentication credentials, 208 or null, if the default encoding 209 (<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html#UTF8_ENCODING"><CODE>XmlRpcStreamConfig.UTF8_ENCODING</CODE></A>) 210 is being used.</DL> 211</DD> 212</DL> 213<HR> 214 215<A NAME="isContentLengthOptional()"><!-- --></A><H3> 216isContentLengthOptional</H3> 217<PRE> 218boolean <B>isContentLengthOptional</B>()</PRE> 219<DL> 220<DD>Returns, whether a "Content-Length" header may be 221 omitted. The XML-RPC specification demands, that such 222 a header be present. 223<P> 224<DD><DL> 225</DL> 226</DD> 227<DD><DL> 228 229<DT><B>Returns:</B><DD>True, if the content length may be omitted.</DL> 230</DD> 231</DL> 232<!-- ========= END OF CLASS DATA ========= --> 233<HR> 234 235 236<!-- ======= START OF BOTTOM NAVBAR ====== --> 237<A NAME="navbar_bottom"><!-- --></A> 238<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 239<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 240<TR> 241<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 242<A NAME="navbar_bottom_firstrow"><!-- --></A> 243<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 244 <TR ALIGN="center" VALIGN="top"> 245 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 246 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 247 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 248 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcHttpConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 249 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 250 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 251 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 252 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 253 </TR> 254</TABLE> 255</TD> 256<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 257</EM> 258</TD> 259</TR> 260 261<TR> 262<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 263 <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcExtensionException.html" title="class in org.apache.xmlrpc.common"><B>PREV CLASS</B></A> 264 <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcHttpRequestConfig.html" title="interface in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD> 265<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 266 <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcHttpConfig.html" target="_top"><B>FRAMES</B></A> 267 <A HREF="XmlRpcHttpConfig.html" target="_top"><B>NO FRAMES</B></A> 268 <SCRIPT type="text/javascript"> 269 <!-- 270 if(window==top) { 271 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 272 } 273 //--> 274</SCRIPT> 275<NOSCRIPT> 276 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 277</NOSCRIPT> 278 279 280</FONT></TD> 281</TR> 282<TR> 283<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 284 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 285<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 286DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 287</TR> 288</TABLE> 289<A NAME="skip-navbar_bottom"></A> 290<!-- ======== END OF BOTTOM NAVBAR ======= --> 291 292<HR> 293Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 294</BODY> 295</HTML>