PageRenderTime 93ms CodeModel.GetById 0ms 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. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0_0) on Mon Apr 20 21:45:59 CEST 2009 -->
    6. 

  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <TITLE>
    8. 

  8. XmlRpcMetaDataHandler (Apache XML-RPC 3.1.2 API)
    9. 

  9. </TITLE>
    10. 

  10. 

  11. <META NAME="date" CONTENT="2009-04-20">
    12. 

  12. 

  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    14. 

  14. 

  15. <SCRIPT type="text/javascript">
    16. 

  16. function windowTitle()
    17. 

  17. {
    18. 

  18.     if (location.href.indexOf('is-external=true') == -1) {
    19. 

  19.         parent.document.title="XmlRpcMetaDataHandler (Apache XML-RPC 3.1.2 API)";
    20. 

  20.     }
    21. 

  21. }
    22. 

  22. </SCRIPT>
    23. 

  23. <NOSCRIPT>
    24. 

  24. </NOSCRIPT>
    25. 

  25. 

  26. </HEAD>
    27. 

  27. 

  28. <BODY BGCOLOR="white" onload="windowTitle();">
    29. 

  29. <HR>
    30. 

  30. 

  31. 

  32. <!-- ========= START OF TOP NAVBAR ======= -->
    33. 

  33. <A NAME="navbar_top"><!-- --></A>
    34. 

  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    35. 

  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    36. 

  36. <TR>
    37. 

  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    38. 

  38. <A NAME="navbar_top_firstrow"><!-- --></A>
    39. 

  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    40. 

  40.   <TR ALIGN="center" VALIGN="top">
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlRpcMetaDataHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    47. 

  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    48. 

  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    49. 

  49.   </TR>
    50. 

  50. </TABLE>
    51. 

  51. </TD>
    52. 

  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    53. 

  53. </EM>
    54. 

  54. </TD>
    55. 

  55. </TR>
    56. 

  56. 

  57. <TR>
    58. 

  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    59. 

  59. &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
    60. 

  60. &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" title="class in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD>
    61. 

  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    62. 

  62.   <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    63. 

  63. &nbsp;<A HREF="XmlRpcMetaDataHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    64. 

  64. &nbsp;<SCRIPT type="text/javascript">
    65. 

  65.   <!--
    66. 

  66.   if(window==top) {
    67. 

  67.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    68. 

  68.   }
    69. 

  69.   //-->
    70. 

  70. </SCRIPT>
    71. 

  71. <NOSCRIPT>
    72. 

  72.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    73. 

  73. </NOSCRIPT>
    74. 

  74. 

  75. 

  76. </FONT></TD>
    77. 

  77. </TR>
    78. 

  78. <TR>
    79. 

  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    80. 

  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    81. 

  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    82. 

  82. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    83. 

  83. </TR>
    84. 

  84. </TABLE>
    85. 

  85. <A NAME="skip-navbar_top"></A>
    86. 

  86. <!-- ========= END OF TOP NAVBAR ========= -->
    87. 

  87. 

  88. <HR>
    89. 

  89. <!-- ======== START OF CLASS DATA ======== -->
    90. 

  90. <H2>
    91. 

  91. <FONT SIZE="-1">
    92. 

  92. org.apache.xmlrpc.metadata</FONT>
    93. 

  93. <BR>
    94. 

  94. Interface XmlRpcMetaDataHandler</H2>
    95. 

  95. <DL>
    96. 

  96. <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc">XmlRpcHandler</A></DD>
    97. 

  97. </DL>
    98. 

  98. <DL>
    99. 

  99. <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>
    100. 

  100. </DL>
    101. 

  101. <HR>
    102. 

  102. <DL>
    103. 

  103. <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>
    104. 

  104. </PRE>
    105. 

  105. 

  106. <P>
    107. 

  107. A metadata handler is able to provide metadata about
    108. 

  108.  itself, as specified
    109. 

  109.  <a href="http://scripts.incutio.com/xmlrpc/introspection.html">
    110. 

  110.  here</a>.<br>
    111. 

  111. <P>
    112. 

  112. 

  113. <P>
    114. 

  114. <DL>
    115. 

  115. <DT><B>See Also:</B><DD><a href="http://scripts.incutio.com/xmlrpc/introspection.html">
    116. 

  116.  Specification of XML-RPC introspection</a></DL>
    117. 

  117. <HR>
    118. 

  118. 

  119. <P>
    120. 

  120. 

  121. <!-- ========== METHOD SUMMARY =========== -->
    122. 

  122. 

  123. <A NAME="method_summary"><!-- --></A>
    124. 

  124. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    125. 

  125. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    126. 

  126. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    127. 

  127. <B>Method Summary</B></FONT></TH>
    128. 

  128. </TR>
    129. 

  129. <TR BGCOLOR="white" CLASS="TableRowColor">
    130. 

  130. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    131. 

  131. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
    132. 

  132. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getMethodHelp()">getMethodHelp</A></B>()</CODE>
    133. 

  133. 

  134. <BR>
    135. 

  135. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method may be used to implement
    136. 

  136.  <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodHelp(String)</CODE></A>.</TD>
    137. 

  137. </TR>
    138. 

  138. <TR BGCOLOR="white" CLASS="TableRowColor">
    139. 

  139. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    140. 

  140. <CODE>&nbsp;java.lang.String[][]</CODE></FONT></TD>
    141. 

  141. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getSignatures()">getSignatures</A></B>()</CODE>
    142. 

  142. 

  143. <BR>
    144. 

  144. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method may be used to implement
    145. 

  145.  <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodSignature(String)</CODE></A>.</TD>
    146. 

  146. </TR>
    147. 

  147. </TABLE>
    148. 

  148. &nbsp;<A NAME="methods_inherited_from_class_org.apache.xmlrpc.XmlRpcHandler"><!-- --></A>
    149. 

  149. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    150. 

  150. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    151. 

  151. <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>
    152. 

  152. </TR>
    153. 

  153. <TR BGCOLOR="white" CLASS="TableRowColor">
    154. 

  154. <TD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html#execute(org.apache.xmlrpc.XmlRpcRequest)">execute</A></CODE></TD>
    155. 

  155. </TR>
    156. 

  156. </TABLE>
    157. 

  157. &nbsp;
    158. 

  158. <P>
    159. 

  159. 

  160. <!-- ============ METHOD DETAIL ========== -->
    161. 

  161. 

  162. <A NAME="method_detail"><!-- --></A>
    163. 

  163. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    164. 

  164. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    165. 

  165. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    166. 

  166. <B>Method Detail</B></FONT></TH>
    167. 

  167. </TR>
    168. 

  168. </TABLE>
    169. 

  169. 

  170. <A NAME="getSignatures()"><!-- --></A><H3>
    171. 

  171. getSignatures</H3>
    172. 

  172. <PRE>
    173. 

  173. java.lang.String[][] <B>getSignatures</B>()
    174. 

  174.                                    throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
    175. 

  175. <DL>
    176. 

  176. <DD><p>This method may be used to implement
    177. 

  177.  <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodSignature(String)</CODE></A>.
    178. 

  178.  Typically, the handler mapping will pick up the
    179. 

  179.  matching handler, invoke its method
    180. 

  180.  <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getSignatures()"><CODE>getSignatures()</CODE></A>, and return the result.</p>
    181. 

  181.  <p>Method handlers, which are created by the
    182. 

  182.  <A HREF="../../../../org/apache/xmlrpc/server/AbstractReflectiveHandlerMapping.html" title="class in org.apache.xmlrpc.server"><CODE>AbstractReflectiveHandlerMapping</CODE></A>, will typically
    183. 

  183.  return a single signature only.</p>
    184. 

  184. <P>
    185. 

  185. <DD><DL>
    186. 

  186. </DL>
    187. 

  187. </DD>
    188. 

  188. <DD><DL>
    189. 

  189. 

  190. <DT><B>Returns:</B><DD>An array of arrays. Any element in the outer
    191. 

  191.  array is a signature. The elements in the inner array
    192. 

  192.  are being concatenated with commas. The inner arrays
    193. 

  193.  first element is the return type, followed by the
    194. 

  194.  parameter types.
    195. 

  195. <DT><B>Throws:</B>
    196. 

  196. <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL>
    197. 

  197. </DD>
    198. 

  198. </DL>
    199. 

  199. <HR>
    200. 

  200. 

  201. <A NAME="getMethodHelp()"><!-- --></A><H3>
    202. 

  202. getMethodHelp</H3>
    203. 

  203. <PRE>
    204. 

  204. java.lang.String <B>getMethodHelp</B>()
    205. 

  205.                                throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
    206. 

  206. <DL>
    207. 

  207. <DD><p>This method may be used to implement
    208. 

  208.  <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodHelp(String)</CODE></A>.
    209. 

  209.  Typically, the handler mapping will pick up the
    210. 

  210.  matching handler, invoke its method
    211. 

  211.  <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getMethodHelp()"><CODE>getMethodHelp()</CODE></A>, and return the result.</p>
    212. 

  212. <P>
    213. 

  213. <DD><DL>
    214. 

  214. </DL>
    215. 

  215. </DD>
    216. 

  216. <DD><DL>
    217. 

  217. 

  218. <DT><B>Throws:</B>
    219. 

  219. <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL>
    220. 

  220. </DD>
    221. 

  221. </DL>
    222. 

  222. <!-- ========= END OF CLASS DATA ========= -->
    223. 

  223. <HR>
    224. 

  224. 

  225. 

  226. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    227. 

  227. <A NAME="navbar_bottom"><!-- --></A>
    228. 

  228. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    229. 

  229. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    230. 

  230. <TR>
    231. 

  231. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    232. 

  232. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    233. 

  233. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    234. 

  234.   <TR ALIGN="center" VALIGN="top">
    235. 

  235.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    236. 

  236.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    237. 

  237.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    238. 

  238.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlRpcMetaDataHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    239. 

  239.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    240. 

  240.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    241. 

  241.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    242. 

  242.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    243. 

  243.   </TR>
    244. 

  244. </TABLE>
    245. 

  245. </TD>
    246. 

  246. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    247. 

  247. </EM>
    248. 

  248. </TD>
    249. 

  249. </TR>
    250. 

  250. 

  251. <TR>
    252. 

  252. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    253. 

  253. &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
    254. 

  254. &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" title="class in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD>
    255. 

  255. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    256. 

  256.   <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    257. 

  257. &nbsp;<A HREF="XmlRpcMetaDataHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    258. 

  258. &nbsp;<SCRIPT type="text/javascript">
    259. 

  259.   <!--
    260. 

  260.   if(window==top) {
    261. 

  261.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    262. 

  262.   }
    263. 

  263.   //-->
    264. 

  264. </SCRIPT>
    265. 

  265. <NOSCRIPT>
    266. 

  266.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    267. 

  267. </NOSCRIPT>
    268. 

  268. 

  269. 

  270. </FONT></TD>
    271. 

  271. </TR>
    272. 

  272. <TR>
    273. 

  273. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    274. 

  274.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    275. 

  275. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    276. 

  276. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    277. 

  277. </TR>
    278. 

  278. </TABLE>
    279. 

  279. <A NAME="skip-navbar_bottom"></A>
    280. 

  280. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    281. 

  281. 

  282. <HR>
    283. 

  283. Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
    284. 

  284. </BODY>
    285. 

  285. </HTML>
    286. 

  286.