/lib/docs/org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html
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
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.6.0_0) on Mon Apr 20 21:45:59 CEST 2009 -->
- <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <TITLE>
- XmlRpcListableHandlerMapping (Apache XML-RPC 3.1.2 API)
- </TITLE>
- <META NAME="date" CONTENT="2009-04-20">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="XmlRpcListableHandlerMapping (Apache XML-RPC 3.1.2 API)";
- }
- }
- </SCRIPT>
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" onload="windowTitle();">
- <HR>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcListableHandlerMapping.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/xmlrpc/metadata/Util.html" title="class in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" target="_top"><B>FRAMES</B></A>
- <A HREF="XmlRpcListableHandlerMapping.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.apache.xmlrpc.metadata</FONT>
- <BR>
- Interface XmlRpcListableHandlerMapping</H2>
- <DL>
- <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/server/XmlRpcHandlerMapping.html" title="interface in org.apache.xmlrpc.server">XmlRpcHandlerMapping</A></DD>
- </DL>
- <DL>
- <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>
- </DL>
- <HR>
- <DL>
- <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>
- </PRE>
- <P>
- A listable handler mapping is able to provide support for
- XML-RPC meta data, as specified
- <a href="http://scripts.incutio.com/xmlrpc/introspection.html">
- here</a>.<br>
- <P>
- <P>
- <DL>
- <DT><B>See Also:</B><DD><a href="http://scripts.incutio.com/xmlrpc/introspection.html">
- Specification of XML-RPC introspection</a></DL>
- <HR>
- <P>
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getListMethods()">getListMethods</A></B>()</CODE>
- <BR>
- This method implements the introspection method
- <code>system.listMethods</code>, which is specified
- as follows:
- <cite></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)">getMethodHelp</A></B>(java.lang.String pHandlerName)</CODE>
- <BR>
- This method implements the introspection method
- <code>system.methodSignature</code>, which is specified
- as follows:
- <cite></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[][]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)">getMethodSignature</A></B>(java.lang.String pHandlerName)</CODE>
- <BR>
- This method implements the introspection method
- <code>system.methodSignature</code>, which is specified
- as follows:
- <cite></TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_org.apache.xmlrpc.server.XmlRpcHandlerMapping"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><A HREF="../../../../org/apache/xmlrpc/server/XmlRpcHandlerMapping.html#getHandler(java.lang.String)">getHandler</A></CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="getListMethods()"><!-- --></A><H3>
- getListMethods</H3>
- <PRE>
- java.lang.String[] <B>getListMethods</B>()
- throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
- <DL>
- <DD>This method implements the introspection method
- <code>system.listMethods</code>, which is specified
- as follows:
- <cite>
- <p>This method may be used to enumerate the methods implemented
- by the XML-RPC server.</p>
- <p>The <code>system.listMethods</code> method requires no
- parameters. It returns an array of strings, each of which is
- the name of a method implemented by the server.
- </cite>
- <p>Note, that the specification doesn't require that the list
- must be exhaustive. We conclude, that a valid method
- "handlerName" doesn't need to be in the list. For example,
- a handler, which implements <A HREF="../../../../org/apache/xmlrpc/XmlRpcHandler.html" title="interface in org.apache.xmlrpc"><CODE>XmlRpcHandler</CODE></A>, but not
- <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><CODE>XmlRpcMetaDataHandler</CODE></A>, should possibly excluded:
- Otherwise, the listable handler mapping could not provide
- meaningful replies to <code>system.methodSignature</code>,
- and <code>system.methodHelp</code>.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Throws:</B>
- <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE> - An internal error occurred.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getMethodSignature(java.lang.String)"><!-- --></A><H3>
- getMethodSignature</H3>
- <PRE>
- java.lang.String[][] <B>getMethodSignature</B>(java.lang.String pHandlerName)
- throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
- <DL>
- <DD>This method implements the introspection method
- <code>system.methodSignature</code>, which is specified
- as follows:
- <cite>
- <p>This method takes one parameter, the name of a method
- implemented by the XML-RPC server. It returns an array
- of possible signatures for this method. A signature is
- an array of types. The first of these types is the return
- type of the method, the rest are parameters.</p>
- <p>Multiple signatures (ie. overloading) are permitted:
- this is the reason that an array of signatures are returned
- by this method.</p>
- <p>Signatures themselves are restricted to the top level
- parameters expected by a method. For instance if a method
- expects one array of structs as a parameter, and it returns
- a string, its signature is simply "string, array". If it
- expects three integers, its signature is
- "string, int, int, int".</p>
- <p>If no signature is defined for the method, a none-array
- value is returned. Therefore this is the way to test for a
- non-signature, if $resp below is the response object from
- a method call to system.methodSignature:
- <pre>
- $v=$resp->value();
- if ($v->kindOf()!="array") {
- // then the method did not have a signature defined
- }
- </pre>
- See the introspect.php demo included in this distribution
- for an example of using this method.</p>
- </cite>
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Throws:</B>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="getMethodHelp(java.lang.String)"><!-- --></A><H3>
- getMethodHelp</H3>
- <PRE>
- java.lang.String <B>getMethodHelp</B>(java.lang.String pHandlerName)
- throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
- <DL>
- <DD>This method implements the introspection method
- <code>system.methodSignature</code>, which is specified
- as follows:
- <cite>
- <p>This method takes one parameter, the name of a
- method implemented by the XML-RPC server. It
- returns a documentation string describing the
- use of that method. If no such string is available,
- an empty string is returned.</p>
- <p>The documentation string may contain HTML markup.</p>
- </cite>
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Throws:</B>
- <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcListableHandlerMapping.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/xmlrpc/metadata/Util.html" title="class in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" target="_top"><B>FRAMES</B></A>
- <A HREF="XmlRpcListableHandlerMapping.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
- </BODY>
- </HTML>