/lib/docs/org/apache/xmlrpc/XmlRpcHandler.html
HTML | 224 lines | 178 code | 26 blank | 20 comment | 0 complexity | a10dd496b784205a263029f362e7f2ef 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:55 CEST 2009 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8XmlRpcHandler (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="XmlRpcHandler (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/XmlRpcHandler.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/XmlRpcException.html" title="class in org.apache.xmlrpc"><B>PREV CLASS</B></A> 60 <A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../index.html?org/apache/xmlrpc/XmlRpcHandler.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="XmlRpcHandler.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</FONT> 93<BR> 94Interface XmlRpcHandler</H2> 95<DL> 96<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata">XmlRpcMetaDataHandler</A></DD> 97</DL> 98<DL> 99<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/xmlrpc/server/ReflectiveXmlRpcHandler.html" title="class in org.apache.xmlrpc.server">ReflectiveXmlRpcHandler</A>, <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>XmlRpcHandler</B></DL> 104</PRE> 105 106<P> 107The XML-RPC server uses this interface to call a method of an RPC handler. 108<P> 109 110<P> 111<HR> 112 113<P> 114 115<!-- ========== METHOD SUMMARY =========== --> 116 117<A NAME="method_summary"><!-- --></A> 118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 121<B>Method Summary</B></FONT></TH> 122</TR> 123<TR BGCOLOR="white" CLASS="TableRowColor"> 124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 125<CODE> java.lang.Object</CODE></FONT></TD> 126<TD><CODE><B><A HREF="../../../org/apache/xmlrpc/XmlRpcHandler.html#execute(org.apache.xmlrpc.XmlRpcRequest)">execute</A></B>(<A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest)</CODE> 127 128<BR> 129 Performs the request and returns the result object.</TD> 130</TR> 131</TABLE> 132 133<P> 134 135<!-- ============ METHOD DETAIL ========== --> 136 137<A NAME="method_detail"><!-- --></A> 138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 140<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 141<B>Method Detail</B></FONT></TH> 142</TR> 143</TABLE> 144 145<A NAME="execute(org.apache.xmlrpc.XmlRpcRequest)"><!-- --></A><H3> 146execute</H3> 147<PRE> 148java.lang.Object <B>execute</B>(<A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest) 149 throws <A HREF="../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE> 150<DL> 151<DD>Performs the request and returns the result object. 152<P> 153<DD><DL> 154<DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed (method name and 155 parameters.) 156<DT><B>Returns:</B><DD>The result object. 157<DT><B>Throws:</B> 158<DD><CODE><A HREF="../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE> - Performing the request failed.</DL> 159</DD> 160</DL> 161<!-- ========= END OF CLASS DATA ========= --> 162<HR> 163 164 165<!-- ======= START OF BOTTOM NAVBAR ====== --> 166<A NAME="navbar_bottom"><!-- --></A> 167<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 168<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 169<TR> 170<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 171<A NAME="navbar_bottom_firstrow"><!-- --></A> 172<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 173 <TR ALIGN="center" VALIGN="top"> 174 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 175 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 176 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 177 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 178 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 179 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 180 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 181 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 182 </TR> 183</TABLE> 184</TD> 185<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 186</EM> 187</TD> 188</TR> 189 190<TR> 191<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 192 <A HREF="../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc"><B>PREV CLASS</B></A> 193 <A HREF="../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc"><B>NEXT CLASS</B></A></FONT></TD> 194<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 195 <A HREF="../../../index.html?org/apache/xmlrpc/XmlRpcHandler.html" target="_top"><B>FRAMES</B></A> 196 <A HREF="XmlRpcHandler.html" target="_top"><B>NO FRAMES</B></A> 197 <SCRIPT type="text/javascript"> 198 <!-- 199 if(window==top) { 200 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 201 } 202 //--> 203</SCRIPT> 204<NOSCRIPT> 205 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 206</NOSCRIPT> 207 208 209</FONT></TD> 210</TR> 211<TR> 212<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 213 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 214<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 215DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 216</TR> 217</TABLE> 218<A NAME="skip-navbar_bottom"></A> 219<!-- ======== END OF BOTTOM NAVBAR ======= --> 220 221<HR> 222Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 223</BODY> 224</HTML>