PageRenderTime 47ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

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

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 285 lines | 235 code | 30 blank | 20 comment | 0 complexity | f9c1a10b5c14ef857826dbb7992fe93c 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. XmlRpcMetaDataHandler (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="XmlRpcMetaDataHandler (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/XmlRpcMetaDataHandler.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/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" title="class 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/XmlRpcMetaDataHandler.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="XmlRpcMetaDataHandler.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 XmlRpcMetaDataHandler</H2>
  84. <DL>
  85. <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc">XmlRpcHandler</A></DD>
  86. </DL>
  87. <DL>
  88. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xmlrpc/metadata/ReflectiveXmlRpcMetaDataHandler.html" title="class in org.apache.xmlrpc.metadata">ReflectiveXmlRpcMetaDataHandler</A></DD>
  89. </DL>
  90. <HR>
  91. <DL>
  92. <DT><PRE>public interface <B>XmlRpcMetaDataHandler</B><DT>extends <A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc">XmlRpcHandler</A></DL>
  93. </PRE>
  94. <P>
  95. A metadata handler is able to provide metadata about
  96. itself, 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/XmlRpcMetaDataHandler.html#getMethodHelp()">getMethodHelp</A></B>()</CODE>
  117. <BR>
  118. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method may be used to implement
  119. <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodHelp(String)</CODE></A>.</TD>
  120. </TR>
  121. <TR BGCOLOR="white" CLASS="TableRowColor">
  122. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  123. <CODE>&nbsp;java.lang.String[][]</CODE></FONT></TD>
  124. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getSignatures()">getSignatures</A></B>()</CODE>
  125. <BR>
  126. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method may be used to implement
  127. <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodSignature(String)</CODE></A>.</TD>
  128. </TR>
  129. </TABLE>
  130. &nbsp;<A NAME="methods_inherited_from_class_org.apache.xmlrpc.XmlRpcHandler"><!-- --></A>
  131. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  132. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  133. <TH ALIGN="left"><B>Methods inherited from interface org.apache.xmlrpc.<A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc">XmlRpcHandler</A></B></TH>
  134. </TR>
  135. <TR BGCOLOR="white" CLASS="TableRowColor">
  136. <TD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html#execute(org.apache.xmlrpc.XmlRpcRequest)">execute</A></CODE></TD>
  137. </TR>
  138. </TABLE>
  139. &nbsp;
  140. <P>
  141. <!-- ============ METHOD DETAIL ========== -->
  142. <A NAME="method_detail"><!-- --></A>
  143. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  144. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  145. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  146. <B>Method Detail</B></FONT></TH>
  147. </TR>
  148. </TABLE>
  149. <A NAME="getSignatures()"><!-- --></A><H3>
  150. getSignatures</H3>
  151. <PRE>
  152. java.lang.String[][] <B>getSignatures</B>()
  153. throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
  154. <DL>
  155. <DD><p>This method may be used to implement
  156. <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodSignature(String)</CODE></A>.
  157. Typically, the handler mapping will pick up the
  158. matching handler, invoke its method
  159. <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getSignatures()"><CODE>getSignatures()</CODE></A>, and return the result.</p>
  160. <p>Method handlers, which are created by the
  161. <A HREF="../../../../org/apache/xmlrpc/server/AbstractReflectiveHandlerMapping.html" title="class in org.apache.xmlrpc.server"><CODE>AbstractReflectiveHandlerMapping</CODE></A>, will typically
  162. return a single signature only.</p>
  163. <P>
  164. <DD><DL>
  165. </DL>
  166. </DD>
  167. <DD><DL>
  168. <DT><B>Returns:</B><DD>An array of arrays. Any element in the outer
  169. array is a signature. The elements in the inner array
  170. are being concatenated with commas. The inner arrays
  171. first element is the return type, followed by the
  172. parameter types.
  173. <DT><B>Throws:</B>
  174. <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL>
  175. </DD>
  176. </DL>
  177. <HR>
  178. <A NAME="getMethodHelp()"><!-- --></A><H3>
  179. getMethodHelp</H3>
  180. <PRE>
  181. java.lang.String <B>getMethodHelp</B>()
  182. throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
  183. <DL>
  184. <DD><p>This method may be used to implement
  185. <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodHelp(String)</CODE></A>.
  186. Typically, the handler mapping will pick up the
  187. matching handler, invoke its method
  188. <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getMethodHelp()"><CODE>getMethodHelp()</CODE></A>, and return the result.</p>
  189. <P>
  190. <DD><DL>
  191. </DL>
  192. </DD>
  193. <DD><DL>
  194. <DT><B>Throws:</B>
  195. <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL>
  196. </DD>
  197. </DL>
  198. <!-- ========= END OF CLASS DATA ========= -->
  199. <HR>
  200. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  201. <A NAME="navbar_bottom"><!-- --></A>
  202. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  203. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  204. <TR>
  205. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  206. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  207. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  208. <TR ALIGN="center" VALIGN="top">
  209. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  210. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  211. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  212. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcMetaDataHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  213. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  214. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  215. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  216. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  217. </TR>
  218. </TABLE>
  219. </TD>
  220. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  221. </EM>
  222. </TD>
  223. </TR>
  224. <TR>
  225. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  226. &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
  227. &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" title="class in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD>
  228. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  229. <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" target="_top"><B>FRAMES</B></A> &nbsp;
  230. &nbsp;<A HREF="XmlRpcMetaDataHandler.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  231. &nbsp;<SCRIPT type="text/javascript">
  232. <!--
  233. if(window==top) {
  234. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  235. }
  236. //-->
  237. </SCRIPT>
  238. <NOSCRIPT>
  239. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  240. </NOSCRIPT>
  241. </FONT></TD>
  242. </TR>
  243. <TR>
  244. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  245. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  246. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  247. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  248. </TR>
  249. </TABLE>
  250. <A NAME="skip-navbar_bottom"></A>
  251. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  252. <HR>
  253. Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
  254. </BODY>
  255. </HTML>