|
151
|
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_17) on Sat Feb 06 17:11:27 CET 2010 -->
|
|
|
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
|
7 <TITLE>
|
|
|
8 XmlRpcRequest (Apache XML-RPC 3.1.3 API)
|
|
|
9 </TITLE>
|
|
|
10
|
|
|
11 <META NAME="date" CONTENT="2010-02-06">
|
|
|
12
|
|
|
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
|
|
14
|
|
|
15 <SCRIPT type="text/javascript">
|
|
|
16 function windowTitle()
|
|
|
17 {
|
|
|
18 if (location.href.indexOf('is-external=true') == -1) {
|
|
|
19 parent.document.title="XmlRpcRequest (Apache XML-RPC 3.1.3 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/XmlRpcRequest.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/XmlRpcHandler.html" title="interface in org.apache.xmlrpc"><B>PREV CLASS</B></A>
|
|
|
60 <A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
62 <A HREF="../../../index.html?org/apache/xmlrpc/XmlRpcRequest.html" target="_top"><B>FRAMES</B></A>
|
|
|
63 <A HREF="XmlRpcRequest.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">
|
|
|
82 DETAIL: 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">
|
|
|
92 org.apache.xmlrpc</FONT>
|
|
|
93 <BR>
|
|
|
94 Interface XmlRpcRequest</H2>
|
|
|
95 <DL>
|
|
|
96 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/xmlrpc/client/XmlRpcClientRequestImpl.html" title="class in org.apache.xmlrpc.client">XmlRpcClientRequestImpl</A></DD>
|
|
|
97 </DL>
|
|
|
98 <HR>
|
|
|
99 <DL>
|
|
|
100 <DT><PRE>public interface <B>XmlRpcRequest</B></DL>
|
|
|
101 </PRE>
|
|
|
102
|
|
|
103 <P>
|
|
|
104 Interface to an XML-RPC request made by a client. Replaces the
|
|
|
105 class <code>org.apache.xmlrpc.XmlRpcClientRequest</code> from
|
|
|
106 Apache XML-RPC 2.0.
|
|
|
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> <A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc">XmlRpcRequestConfig</A></CODE></FONT></TD>
|
|
|
129 <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getConfig()">getConfig</A></B>()</CODE>
|
|
|
130
|
|
|
131 <BR>
|
|
|
132 Returns the request configuration.</TD>
|
|
|
133 </TR>
|
|
|
134 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
136 <CODE> java.lang.String</CODE></FONT></TD>
|
|
|
137 <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getMethodName()">getMethodName</A></B>()</CODE>
|
|
|
138
|
|
|
139 <BR>
|
|
|
140 Returns the requests method name.</TD>
|
|
|
141 </TR>
|
|
|
142 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
144 <CODE> java.lang.Object</CODE></FONT></TD>
|
|
|
145 <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getParameter(int)">getParameter</A></B>(int pIndex)</CODE>
|
|
|
146
|
|
|
147 <BR>
|
|
|
148 Returns the parameter with index <code>pIndex</code>.</TD>
|
|
|
149 </TR>
|
|
|
150 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
152 <CODE> int</CODE></FONT></TD>
|
|
|
153 <TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getParameterCount()">getParameterCount</A></B>()</CODE>
|
|
|
154
|
|
|
155 <BR>
|
|
|
156 Returns the number of parameters.</TD>
|
|
|
157 </TR>
|
|
|
158 </TABLE>
|
|
|
159
|
|
|
160 <P>
|
|
|
161
|
|
|
162 <!-- ============ METHOD DETAIL ========== -->
|
|
|
163
|
|
|
164 <A NAME="method_detail"><!-- --></A>
|
|
|
165 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
166 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
167 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
168 <B>Method Detail</B></FONT></TH>
|
|
|
169 </TR>
|
|
|
170 </TABLE>
|
|
|
171
|
|
|
172 <A NAME="getConfig()"><!-- --></A><H3>
|
|
|
173 getConfig</H3>
|
|
|
174 <PRE>
|
|
|
175 <A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc">XmlRpcRequestConfig</A> <B>getConfig</B>()</PRE>
|
|
|
176 <DL>
|
|
|
177 <DD>Returns the request configuration.
|
|
|
178 <P>
|
|
|
179 <DD><DL>
|
|
|
180
|
|
|
181 <DT><B>Returns:</B><DD>The request configuration.</DL>
|
|
|
182 </DD>
|
|
|
183 </DL>
|
|
|
184 <HR>
|
|
|
185
|
|
|
186 <A NAME="getMethodName()"><!-- --></A><H3>
|
|
|
187 getMethodName</H3>
|
|
|
188 <PRE>
|
|
|
189 java.lang.String <B>getMethodName</B>()</PRE>
|
|
|
190 <DL>
|
|
|
191 <DD>Returns the requests method name.
|
|
|
192 <P>
|
|
|
193 <DD><DL>
|
|
|
194
|
|
|
195 <DT><B>Returns:</B><DD>Name of the method being invoked.</DL>
|
|
|
196 </DD>
|
|
|
197 </DL>
|
|
|
198 <HR>
|
|
|
199
|
|
|
200 <A NAME="getParameterCount()"><!-- --></A><H3>
|
|
|
201 getParameterCount</H3>
|
|
|
202 <PRE>
|
|
|
203 int <B>getParameterCount</B>()</PRE>
|
|
|
204 <DL>
|
|
|
205 <DD>Returns the number of parameters.
|
|
|
206 <P>
|
|
|
207 <DD><DL>
|
|
|
208
|
|
|
209 <DT><B>Returns:</B><DD>Number of parameters.</DL>
|
|
|
210 </DD>
|
|
|
211 </DL>
|
|
|
212 <HR>
|
|
|
213
|
|
|
214 <A NAME="getParameter(int)"><!-- --></A><H3>
|
|
|
215 getParameter</H3>
|
|
|
216 <PRE>
|
|
|
217 java.lang.Object <B>getParameter</B>(int pIndex)</PRE>
|
|
|
218 <DL>
|
|
|
219 <DD>Returns the parameter with index <code>pIndex</code>.
|
|
|
220 <P>
|
|
|
221 <DD><DL>
|
|
|
222 <DT><B>Parameters:</B><DD><CODE>pIndex</CODE> - Number between 0 and <A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html#getParameterCount()"><CODE>getParameterCount()</CODE></A>-1.
|
|
|
223 <DT><B>Returns:</B><DD>Parameter being sent to the server.</DL>
|
|
|
224 </DD>
|
|
|
225 </DL>
|
|
|
226 <!-- ========= END OF CLASS DATA ========= -->
|
|
|
227 <HR>
|
|
|
228
|
|
|
229
|
|
|
230 <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
231 <A NAME="navbar_bottom"><!-- --></A>
|
|
|
232 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
233 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
234 <TR>
|
|
|
235 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
236 <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
237 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
238 <TR ALIGN="center" VALIGN="top">
|
|
|
239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
240 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
241 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
242 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcRequest.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
243 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
244 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
245 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
246 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
247 </TR>
|
|
|
248 </TABLE>
|
|
|
249 </TD>
|
|
|
250 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
251 </EM>
|
|
|
252 </TD>
|
|
|
253 </TR>
|
|
|
254
|
|
|
255 <TR>
|
|
|
256 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
257 <A HREF="../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc"><B>PREV CLASS</B></A>
|
|
|
258 <A HREF="../../../org/apache/xmlrpc/XmlRpcRequestConfig.html" title="interface in org.apache.xmlrpc"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
259 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
260 <A HREF="../../../index.html?org/apache/xmlrpc/XmlRpcRequest.html" target="_top"><B>FRAMES</B></A>
|
|
|
261 <A HREF="XmlRpcRequest.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
262 <SCRIPT type="text/javascript">
|
|
|
263 <!--
|
|
|
264 if(window==top) {
|
|
|
265 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
266 }
|
|
|
267 //-->
|
|
|
268 </SCRIPT>
|
|
|
269 <NOSCRIPT>
|
|
|
270 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
271 </NOSCRIPT>
|
|
|
272
|
|
|
273
|
|
|
274 </FONT></TD>
|
|
|
275 </TR>
|
|
|
276 <TR>
|
|
|
277 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
278 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
279 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
280 DETAIL: FIELD | CONSTR | <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
|
|
|
286 <HR>
|
|
|
287 Copyright © 2001-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
|
|
|
288 </BODY>
|
|
|
289 </HTML>
|
