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