Mercurial > hg > Members > nobuyasu > tightVNCProxy

comparison apache-xmlrpc-3.1.3/docs/apidocs/org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html @ 151:db5f735fd2b4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add xml-rpc.jar
author e085711
date Sat, 10 Sep 2011 04:13:50 +0900
parents
children
comparison
equal deleted inserted replaced
147:a2b5149bbbe6 151:db5f735fd2b4
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:28 CET 2010 -->
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <TITLE>
8 XmlRpcListableHandlerMapping (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="XmlRpcListableHandlerMapping (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>&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/XmlRpcListableHandlerMapping.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/metadata/Util.html" title="class in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
60 &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD>
61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62 <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" target="_top"><B>FRAMES</B></A> &nbsp;
63 &nbsp;<A HREF="XmlRpcListableHandlerMapping.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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">
92 org.apache.xmlrpc.metadata</FONT>
93 <BR>
94 Interface XmlRpcListableHandlerMapping</H2>
95 <DL>
96 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/server/XmlRpcHandlerMapping.html" title="interface in org.apache.xmlrpc.server">XmlRpcHandlerMapping</A></DD>
97 </DL>
98 <DL>
99 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xmlrpc/server/AbstractReflectiveHandlerMapping.html" title="class in org.apache.xmlrpc.server">AbstractReflectiveHandlerMapping</A>, <A HREF="../../../../org/apache/xmlrpc/server/PropertyHandlerMapping.html" title="class in org.apache.xmlrpc.server">PropertyHandlerMapping</A></DD>
100 </DL>
101 <HR>
102 <DL>
103 <DT><PRE>public interface <B>XmlRpcListableHandlerMapping</B><DT>extends <A HREF="../../../../org/apache/xmlrpc/server/XmlRpcHandlerMapping.html" title="interface in org.apache.xmlrpc.server">XmlRpcHandlerMapping</A></DL>
104 </PRE>
105
106 <P>
107 A listable handler mapping is able to provide support for
108 XML-RPC meta data, as specified
109 <a href="http://scripts.incutio.com/xmlrpc/introspection.html">
110 here</a>.<br>
111 <P>
112
113 <P>
114 <DL>
115 <DT><B>See Also:</B><DD><a href="http://scripts.incutio.com/xmlrpc/introspection.html">
116 Specification of XML-RPC introspection</a></DL>
117 <HR>
118
119 <P>
120
121 <!-- ========== METHOD SUMMARY =========== -->
122
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;java.lang.String[]</CODE></FONT></TD>
132 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getListMethods()">getListMethods</A></B>()</CODE>
133
134 <BR>
135 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method implements the introspection method
136 <code>system.listMethods</code>, which is specified
137 as follows:
138 <cite>
139 This method may be used to enumerate the methods implemented
140 by the XML-RPC server.</TD>
141 </TR>
142 <TR BGCOLOR="white" CLASS="TableRowColor">
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
145 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)">getMethodHelp</A></B>(java.lang.String&nbsp;pHandlerName)</CODE>
146
147 <BR>
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method implements the introspection method
149 <code>system.methodSignature</code>, which is specified
150 as follows:
151 <cite>
152 This method takes one parameter, the name of a
153 method implemented by the XML-RPC server.</TD>
154 </TR>
155 <TR BGCOLOR="white" CLASS="TableRowColor">
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157 <CODE>&nbsp;java.lang.String[][]</CODE></FONT></TD>
158 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)">getMethodSignature</A></B>(java.lang.String&nbsp;pHandlerName)</CODE>
159
160 <BR>
161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method implements the introspection method
162 <code>system.methodSignature</code>, which is specified
163 as follows:
164 <cite>
165 This method takes one parameter, the name of a method
166 implemented by the XML-RPC server.</TD>
167 </TR>
168 </TABLE>
169 &nbsp;<A NAME="methods_inherited_from_class_org.apache.xmlrpc.server.XmlRpcHandlerMapping"><!-- --></A>
170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
171 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
172 <TH ALIGN="left"><B>Methods inherited from interface org.apache.xmlrpc.server.<A HREF="../../../../org/apache/xmlrpc/server/XmlRpcHandlerMapping.html" title="interface in org.apache.xmlrpc.server">XmlRpcHandlerMapping</A></B></TH>
173 </TR>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD><CODE><A HREF="../../../../org/apache/xmlrpc/server/XmlRpcHandlerMapping.html#getHandler(java.lang.String)">getHandler</A></CODE></TD>
176 </TR>
177 </TABLE>
178 &nbsp;
179 <P>
180
181 <!-- ============ METHOD DETAIL ========== -->
182
183 <A NAME="method_detail"><!-- --></A>
184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
187 <B>Method Detail</B></FONT></TH>
188 </TR>
189 </TABLE>
190
191 <A NAME="getListMethods()"><!-- --></A><H3>
192 getListMethods</H3>
193 <PRE>
194 java.lang.String[] <B>getListMethods</B>()
195 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
196 <DL>
197 <DD>This method implements the introspection method
198 <code>system.listMethods</code>, which is specified
199 as follows:
200 <cite>
201 <p>This method may be used to enumerate the methods implemented
202 by the XML-RPC server.</p>
203 <p>The <code>system.listMethods</code> method requires no
204 parameters. It returns an array of strings, each of which is
205 the name of a method implemented by the server.
206 </cite>
207 <p>Note, that the specification doesn't require that the list
208 must be exhaustive. We conclude, that a valid method
209 "handlerName" doesn't need to be in the list. For example,
210 a handler, which implements <A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc"><CODE>XmlRpcHandler</CODE></A>, but not
211 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><CODE>XmlRpcMetaDataHandler</CODE></A>, should possibly excluded:
212 Otherwise, the listable handler mapping could not provide
213 meaningful replies to <code>system.methodSignature</code>,
214 and <code>system.methodHelp</code>.
215 <P>
216 <DD><DL>
217 </DL>
218 </DD>
219 <DD><DL>
220
221 <DT><B>Throws:</B>
222 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE> - An internal error occurred.</DL>
223 </DD>
224 </DL>
225 <HR>
226
227 <A NAME="getMethodSignature(java.lang.String)"><!-- --></A><H3>
228 getMethodSignature</H3>
229 <PRE>
230 java.lang.String[][] <B>getMethodSignature</B>(java.lang.String&nbsp;pHandlerName)
231 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
232 <DL>
233 <DD>This method implements the introspection method
234 <code>system.methodSignature</code>, which is specified
235 as follows:
236 <cite>
237 <p>This method takes one parameter, the name of a method
238 implemented by the XML-RPC server. It returns an array
239 of possible signatures for this method. A signature is
240 an array of types. The first of these types is the return
241 type of the method, the rest are parameters.</p>
242 <p>Multiple signatures (ie. overloading) are permitted:
243 this is the reason that an array of signatures are returned
244 by this method.</p>
245 <p>Signatures themselves are restricted to the top level
246 parameters expected by a method. For instance if a method
247 expects one array of structs as a parameter, and it returns
248 a string, its signature is simply "string, array". If it
249 expects three integers, its signature is
250 "string, int, int, int".</p>
251 <p>If no signature is defined for the method, a none-array
252 value is returned. Therefore this is the way to test for a
253 non-signature, if $resp below is the response object from
254 a method call to system.methodSignature:
255 <pre>
256 $v=$resp->value();
257 if ($v->kindOf()!="array") {
258 // then the method did not have a signature defined
259 }
260 </pre>
261 See the introspect.php demo included in this distribution
262 for an example of using this method.</p>
263 </cite>
264 <P>
265 <DD><DL>
266 </DL>
267 </DD>
268 <DD><DL>
269
270 <DT><B>Throws:</B>
271 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getSignatures()"><CODE>XmlRpcMetaDataHandler.getSignatures()</CODE></A></DL>
272 </DD>
273 </DL>
274 <HR>
275
276 <A NAME="getMethodHelp(java.lang.String)"><!-- --></A><H3>
277 getMethodHelp</H3>
278 <PRE>
279 java.lang.String <B>getMethodHelp</B>(java.lang.String&nbsp;pHandlerName)
280 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
281 <DL>
282 <DD>This method implements the introspection method
283 <code>system.methodSignature</code>, which is specified
284 as follows:
285 <cite>
286 <p>This method takes one parameter, the name of a
287 method implemented by the XML-RPC server. It
288 returns a documentation string describing the
289 use of that method. If no such string is available,
290 an empty string is returned.</p>
291 <p>The documentation string may contain HTML markup.</p>
292 </cite>
293 <P>
294 <DD><DL>
295 </DL>
296 </DD>
297 <DD><DL>
298
299 <DT><B>Throws:</B>
300 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL>
301 </DD>
302 </DL>
303 <!-- ========= END OF CLASS DATA ========= -->
304 <HR>
305
306
307 <!-- ======= START OF BOTTOM NAVBAR ====== -->
308 <A NAME="navbar_bottom"><!-- --></A>
309 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
310 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
311 <TR>
312 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
313 <A NAME="navbar_bottom_firstrow"><!-- --></A>
314 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
315 <TR ALIGN="center" VALIGN="top">
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
318 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcListableHandlerMapping.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
323 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
324 </TR>
325 </TABLE>
326 </TD>
327 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
328 </EM>
329 </TD>
330 </TR>
331
332 <TR>
333 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
334 &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/Util.html" title="class in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
335 &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD>
336 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
337 <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" target="_top"><B>FRAMES</B></A> &nbsp;
338 &nbsp;<A HREF="XmlRpcListableHandlerMapping.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
339 &nbsp;<SCRIPT type="text/javascript">
340 <!--
341 if(window==top) {
342 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
343 }
344 //-->
345 </SCRIPT>
346 <NOSCRIPT>
347 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
348 </NOSCRIPT>
349
350
351 </FONT></TD>
352 </TR>
353 <TR>
354 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
355 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
356 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
357 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
358 </TR>
359 </TABLE>
360 <A NAME="skip-navbar_bottom"></A>
361 <!-- ======== END OF BOTTOM NAVBAR ======= -->
362
363 <HR>
364 Copyright &#169; 2001-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
365 </BODY>
366 </HTML>