/lib/docs/org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html
HTML | 285 lines | 235 code | 30 blank | 20 comment | 0 complexity | f9c1a10b5c14ef857826dbb7992fe93c 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> 8XmlRpcMetaDataHandler (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="XmlRpcMetaDataHandler (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> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcMetaDataHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A> 60 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" title="class 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/XmlRpcMetaDataHandler.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="XmlRpcMetaDataHandler.html" target="_top"><B>NO FRAMES</B></A> 64 <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | CONSTR | <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 XmlRpcMetaDataHandler</H2> 95<DL> 96<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc">XmlRpcHandler</A></DD> 97</DL> 98<DL> 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</DL> 101<HR> 102<DL> 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</PRE> 105 106<P> 107A metadata handler is able to provide metadata about 108 itself, 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> java.lang.String</CODE></FONT></TD> 132<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getMethodHelp()">getMethodHelp</A></B>()</CODE> 133 134<BR> 135 This method may be used to implement 136 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodHelp(String)</CODE></A>.</TD> 137</TR> 138<TR BGCOLOR="white" CLASS="TableRowColor"> 139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 140<CODE> java.lang.String[][]</CODE></FONT></TD> 141<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getSignatures()">getSignatures</A></B>()</CODE> 142 143<BR> 144 This method may be used to implement 145 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodSignature(String)</CODE></A>.</TD> 146</TR> 147</TABLE> 148 <A NAME="methods_inherited_from_class_org.apache.xmlrpc.XmlRpcHandler"><!-- --></A> 149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 150<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 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</TR> 153<TR BGCOLOR="white" CLASS="TableRowColor"> 154<TD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html#execute(org.apache.xmlrpc.XmlRpcRequest)">execute</A></CODE></TD> 155</TR> 156</TABLE> 157 158<P> 159 160<!-- ============ METHOD DETAIL ========== --> 161 162<A NAME="method_detail"><!-- --></A> 163<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 164<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 165<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 166<B>Method Detail</B></FONT></TH> 167</TR> 168</TABLE> 169 170<A NAME="getSignatures()"><!-- --></A><H3> 171getSignatures</H3> 172<PRE> 173java.lang.String[][] <B>getSignatures</B>() 174 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE> 175<DL> 176<DD><p>This method may be used to implement 177 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodSignature(String)</CODE></A>. 178 Typically, the handler mapping will pick up the 179 matching handler, invoke its method 180 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getSignatures()"><CODE>getSignatures()</CODE></A>, and return the result.</p> 181 <p>Method handlers, which are created by the 182 <A HREF="../../../../org/apache/xmlrpc/server/AbstractReflectiveHandlerMapping.html" title="class in org.apache.xmlrpc.server"><CODE>AbstractReflectiveHandlerMapping</CODE></A>, will typically 183 return a single signature only.</p> 184<P> 185<DD><DL> 186</DL> 187</DD> 188<DD><DL> 189 190<DT><B>Returns:</B><DD>An array of arrays. Any element in the outer 191 array is a signature. The elements in the inner array 192 are being concatenated with commas. The inner arrays 193 first element is the return type, followed by the 194 parameter types. 195<DT><B>Throws:</B> 196<DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL> 197</DD> 198</DL> 199<HR> 200 201<A NAME="getMethodHelp()"><!-- --></A><H3> 202getMethodHelp</H3> 203<PRE> 204java.lang.String <B>getMethodHelp</B>() 205 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE> 206<DL> 207<DD><p>This method may be used to implement 208 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodHelp(String)</CODE></A>. 209 Typically, the handler mapping will pick up the 210 matching handler, invoke its method 211 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html#getMethodHelp()"><CODE>getMethodHelp()</CODE></A>, and return the result.</p> 212<P> 213<DD><DL> 214</DL> 215</DD> 216<DD><DL> 217 218<DT><B>Throws:</B> 219<DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL> 220</DD> 221</DL> 222<!-- ========= END OF CLASS DATA ========= --> 223<HR> 224 225 226<!-- ======= START OF BOTTOM NAVBAR ====== --> 227<A NAME="navbar_bottom"><!-- --></A> 228<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 229<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 230<TR> 231<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 232<A NAME="navbar_bottom_firstrow"><!-- --></A> 233<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 234 <TR ALIGN="center" VALIGN="top"> 235 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 236 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 237 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 238 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcMetaDataHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 240 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 241 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 242 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 243 </TR> 244</TABLE> 245</TD> 246<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 247</EM> 248</TD> 249</TR> 250 251<TR> 252<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 253 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A> 254 <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" title="class in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD> 255<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 256 <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" target="_top"><B>FRAMES</B></A> 257 <A HREF="XmlRpcMetaDataHandler.html" target="_top"><B>NO FRAMES</B></A> 258 <SCRIPT type="text/javascript"> 259 <!-- 260 if(window==top) { 261 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 262 } 263 //--> 264</SCRIPT> 265<NOSCRIPT> 266 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 267</NOSCRIPT> 268 269 270</FONT></TD> 271</TR> 272<TR> 273<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 274 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 275<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 276DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 277</TR> 278</TABLE> 279<A NAME="skip-navbar_bottom"></A> 280<!-- ======== END OF BOTTOM NAVBAR ======= --> 281 282<HR> 283Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 284</BODY> 285</HTML>