PageRenderTime 64ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/docs/org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 320 lines | 267 code | 32 blank | 21 comment | 0 complexity | 5a3aff92f16cda23a4b6b978343c610f MD5 | raw file
Possible License(s): LGPL-3.0, Apache-2.0, GPL-3.0, GPL-2.0, AGPL-3.0, JSON, BSD-3-Clause
  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>
  8. XmlRpcStreamRequestConfig (Apache XML-RPC 3.1.2 API)
  9. </TITLE>
  10. <META NAME="date" CONTENT="2009-04-20">
  11. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  12. <SCRIPT type="text/javascript">
  13. function windowTitle()
  14. {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="XmlRpcStreamRequestConfig (Apache XML-RPC 3.1.2 API)";
  17. }
  18. }
  19. </SCRIPT>
  20. <NOSCRIPT>
  21. </NOSCRIPT>
  22. </HEAD>
  23. <BODY BGCOLOR="white" onload="windowTitle();">
  24. <HR>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <A NAME="navbar_top"><!-- --></A>
  27. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  28. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  29. <TR>
  30. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  31. <A NAME="navbar_top_firstrow"><!-- --></A>
  32. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  33. <TR ALIGN="center" VALIGN="top">
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcStreamRequestConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  40. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  41. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  42. </TR>
  43. </TABLE>
  44. </TD>
  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  46. </EM>
  47. </TD>
  48. </TR>
  49. <TR>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestProcessor.html" title="interface in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="XmlRpcStreamRequestConfig.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  56. &nbsp;<SCRIPT type="text/javascript">
  57. <!--
  58. if(window==top) {
  59. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  60. }
  61. //-->
  62. </SCRIPT>
  63. <NOSCRIPT>
  64. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  65. </NOSCRIPT>
  66. </FONT></TD>
  67. </TR>
  68. <TR>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  73. </TR>
  74. </TABLE>
  75. <A NAME="skip-navbar_top"></A>
  76. <!-- ========= END OF TOP NAVBAR ========= -->
  77. <HR>
  78. <!-- ======== START OF CLASS DATA ======== -->
  79. <H2>
  80. <FONT SIZE="-1">
  81. org.apache.xmlrpc.common</FONT>
  82. <BR>
  83. Interface XmlRpcStreamRequestConfig</H2>
  84. <DL>
  85. <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/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc">XmlRpcRequestConfig</A>, <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common">XmlRpcStreamConfig</A></DD>
  86. </DL>
  87. <DL>
  88. <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></DD>
  89. </DL>
  90. <DL>
  91. <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/common/XmlRpcHttpRequestConfigImpl.html" title="class in org.apache.xmlrpc.common">XmlRpcHttpRequestConfigImpl</A></DD>
  92. </DL>
  93. <HR>
  94. <DL>
  95. <DT><PRE>public interface <B>XmlRpcStreamRequestConfig</B><DT>extends <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common">XmlRpcStreamConfig</A>, <A HREF="../../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc">XmlRpcRequestConfig</A></DL>
  96. </PRE>
  97. <P>
  98. Interface of a client configuration for a transport, which
  99. is implemented by writing to a stream.
  100. <P>
  101. <P>
  102. <HR>
  103. <P>
  104. <!-- =========== FIELD SUMMARY =========== -->
  105. <A NAME="field_summary"><!-- --></A>
  106. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  107. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  108. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  109. <B>Field Summary</B></FONT></TH>
  110. </TR>
  111. </TABLE>
  112. &nbsp;<A NAME="fields_inherited_from_class_org.apache.xmlrpc.common.XmlRpcStreamConfig"><!-- --></A>
  113. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  114. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  115. <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>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD><CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html#UTF8_ENCODING">UTF8_ENCODING</A></CODE></TD>
  119. </TR>
  120. </TABLE>
  121. &nbsp;
  122. <!-- ========== METHOD SUMMARY =========== -->
  123. <A NAME="method_summary"><!-- --></A>
  124. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  125. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  126. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  127. <B>Method Summary</B></FONT></TH>
  128. </TR>
  129. <TR BGCOLOR="white" CLASS="TableRowColor">
  130. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  131. <CODE>&nbsp;boolean</CODE></FONT></TD>
  132. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html#isEnabledForExceptions()">isEnabledForExceptions</A></B>()</CODE>
  133. <BR>
  134. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns, whether the response should contain a "faultCause" element
  135. in case of errors.</TD>
  136. </TR>
  137. <TR BGCOLOR="white" CLASS="TableRowColor">
  138. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  139. <CODE>&nbsp;boolean</CODE></FONT></TD>
  140. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html#isGzipCompressing()">isGzipCompressing</A></B>()</CODE>
  141. <BR>
  142. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns, whether the request stream is being compressed.</TD>
  143. </TR>
  144. <TR BGCOLOR="white" CLASS="TableRowColor">
  145. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  146. <CODE>&nbsp;boolean</CODE></FONT></TD>
  147. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html#isGzipRequesting()">isGzipRequesting</A></B>()</CODE>
  148. <BR>
  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns, whether compression is requested for the response stream.</TD>
  150. </TR>
  151. </TABLE>
  152. &nbsp;<A NAME="methods_inherited_from_class_org.apache.xmlrpc.common.XmlRpcStreamConfig"><!-- --></A>
  153. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  154. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  155. <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>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD><CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html#getEncoding()">getEncoding</A></CODE></TD>
  159. </TR>
  160. </TABLE>
  161. &nbsp;<A NAME="methods_inherited_from_class_org.apache.xmlrpc.XmlRpcConfig"><!-- --></A>
  162. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  163. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  164. <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>
  165. </TR>
  166. <TR BGCOLOR="white" CLASS="TableRowColor">
  167. <TD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcConfig.html#getTimeZone()">getTimeZone</A>, <A HREF="../../../../org/apache/xmlrpc/XmlRpcConfig.html#isEnabledForExtensions()">isEnabledForExtensions</A></CODE></TD>
  168. </TR>
  169. </TABLE>
  170. &nbsp;
  171. <P>
  172. <!-- ============ METHOD DETAIL ========== -->
  173. <A NAME="method_detail"><!-- --></A>
  174. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  175. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  176. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  177. <B>Method Detail</B></FONT></TH>
  178. </TR>
  179. </TABLE>
  180. <A NAME="isGzipCompressing()"><!-- --></A><H3>
  181. isGzipCompressing</H3>
  182. <PRE>
  183. boolean <B>isGzipCompressing</B>()</PRE>
  184. <DL>
  185. <DD>Returns, whether the request stream is being compressed. Note,
  186. that the response stream may still be uncompressed.
  187. <P>
  188. <DD><DL>
  189. </DL>
  190. </DD>
  191. <DD><DL>
  192. <DT><B>Returns:</B><DD>Whether to use Gzip compression or not. Defaults to false.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html#isGzipRequesting()"><CODE>isGzipRequesting()</CODE></A></DL>
  193. </DD>
  194. </DL>
  195. <HR>
  196. <A NAME="isGzipRequesting()"><!-- --></A><H3>
  197. isGzipRequesting</H3>
  198. <PRE>
  199. boolean <B>isGzipRequesting</B>()</PRE>
  200. <DL>
  201. <DD>Returns, whether compression is requested for the response stream.
  202. Note, that the request is stull uncompressed, unless
  203. <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html#isGzipCompressing()"><CODE>isGzipCompressing()</CODE></A> is activated. Also note, that the
  204. server may still decide to send uncompressed data.
  205. <P>
  206. <DD><DL>
  207. </DL>
  208. </DD>
  209. <DD><DL>
  210. <DT><B>Returns:</B><DD>Whether to use Gzip compression or not. Defaults to false.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html#isGzipCompressing()"><CODE>isGzipCompressing()</CODE></A></DL>
  211. </DD>
  212. </DL>
  213. <HR>
  214. <A NAME="isEnabledForExceptions()"><!-- --></A><H3>
  215. isEnabledForExceptions</H3>
  216. <PRE>
  217. boolean <B>isEnabledForExceptions</B>()</PRE>
  218. <DL>
  219. <DD>Returns, whether the response should contain a "faultCause" element
  220. in case of errors. The "faultCause" is an exception, which the
  221. server has trapped and written into a byte stream as a serializable
  222. object.
  223. <P>
  224. <DD><DL>
  225. </DL>
  226. </DD>
  227. <DD><DL>
  228. </DL>
  229. </DD>
  230. </DL>
  231. <!-- ========= END OF CLASS DATA ========= -->
  232. <HR>
  233. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  234. <A NAME="navbar_bottom"><!-- --></A>
  235. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  236. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  237. <TR>
  238. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  239. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  240. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  241. <TR ALIGN="center" VALIGN="top">
  242. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  243. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  244. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  245. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcStreamRequestConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  246. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  247. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  248. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  249. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  250. </TR>
  251. </TABLE>
  252. </TD>
  253. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  254. </EM>
  255. </TD>
  256. </TR>
  257. <TR>
  258. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  259. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamConfig.html" title="interface in org.apache.xmlrpc.common"><B>PREV CLASS</B></A>&nbsp;
  260. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestProcessor.html" title="interface in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD>
  261. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  262. <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcStreamRequestConfig.html" target="_top"><B>FRAMES</B></A> &nbsp;
  263. &nbsp;<A HREF="XmlRpcStreamRequestConfig.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  264. &nbsp;<SCRIPT type="text/javascript">
  265. <!--
  266. if(window==top) {
  267. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  268. }
  269. //-->
  270. </SCRIPT>
  271. <NOSCRIPT>
  272. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  273. </NOSCRIPT>
  274. </FONT></TD>
  275. </TR>
  276. <TR>
  277. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  278. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  279. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  280. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  281. </TR>
  282. </TABLE>
  283. <A NAME="skip-navbar_bottom"></A>
  284. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  285. <HR>
  286. Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
  287. </BODY>
  288. </HTML>