PageRenderTime 218ms CodeModel.GetById 131ms app.highlight 19ms RepoModel.GetById 62ms app.codeStats 0ms

/lib/docs/org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html

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