turbinexmlrpcservice.html

turbine教程

</TABLE>

<A NAME="isModernVersion"><!-- --></A><H3>
isModernVersion</H3>
<PRE>
protected boolean <B>isModernVersion</B></PRE>
<DL>
<DD>Whether a version of Apache's XML-RPC library greater than 1.1
 is available.</DL>
<HR>

<A NAME="webserver"><!-- --></A><H3>
webserver</H3>
<PRE>
protected org.apache.xmlrpc.WebServer <B>webserver</B></PRE>
<DL>
<DD>The standalone xmlrpc server.</DL>
<HR>

<A NAME="server"><!-- --></A><H3>
server</H3>
<PRE>
protected org.apache.xmlrpc.XmlRpcServer <B>server</B></PRE>
<DL>
<DD>The encapsulated xmlrpc server.</DL>
<HR>

<A NAME="port"><!-- --></A><H3>
port</H3>
<PRE>
protected int <B>port</B></PRE>
<DL>
<DD>The port to listen on.</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="TurbineXmlRpcService()"><!-- --></A><H3>
TurbineXmlRpcService</H3>
<PRE>
public <B>TurbineXmlRpcService</B>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="init(javax.servlet.ServletConfig)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(javax.servlet.ServletConfig&nbsp;config)
          throws <A HREF="../../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></PRE>
<DL>
<DD>This function initializes the XmlRpcService.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/TurbineBaseService.html#init(javax.servlet.ServletConfig)">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/turbine/services/TurbineBaseService.html">TurbineBaseService</A></CODE></DL>
</DD>
<DD>Following copied from class: <CODE>org.apache.turbine.services.TurbineBaseService</CODE></DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - A ServletConfing to use for initialization
 activities.<DT><B>Throws:</B><DD><CODE>InitializationException,</CODE> - if initialization of this
 class was not successful.</DL>
</DD>
</DL>
<HR>

<A NAME="registerHandler(java.lang.Object)"><!-- --></A><H3>
registerHandler</H3>
<PRE>
public void <B>registerHandler</B>(java.lang.Object&nbsp;handler)
                     throws org.apache.xmlrpc.XmlRpcException,
                            java.io.IOException</PRE>
<DL>
<DD>Register an Object as a default handler for the service.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html#registerHandler(java.lang.Object)">registerHandler</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>handler</CODE> - The handler to use.<DT><B>Throws:</B><DD><CODE>XmlRpcException.</CODE> - &nbsp;<DD><CODE>IOException.</CODE> - &nbsp;</DL>
</DD>
</DL>
<HR>

<A NAME="registerHandler(java.lang.String, java.lang.Object)"><!-- --></A><H3>
registerHandler</H3>
<PRE>
public void <B>registerHandler</B>(java.lang.String&nbsp;handlerName,
                            java.lang.Object&nbsp;handler)
                     throws org.apache.xmlrpc.XmlRpcException,
                            java.io.IOException</PRE>
<DL>
<DD>Register an Object as a handler for the service.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html#registerHandler(java.lang.String, java.lang.Object)">registerHandler</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>handlerName</CODE> - The name the handler is registered under.<DD><CODE>handler</CODE> - The handler to use.<DT><B>Throws:</B><DD><CODE>XmlRpcException.</CODE> - &nbsp;<DD><CODE>IOException.</CODE> - &nbsp;</DL>
</DD>
</DL>
<HR>

<A NAME="registerHandler(java.lang.String, java.lang.String)"><!-- --></A><H3>
registerHandler</H3>
<PRE>
public void <B>registerHandler</B>(java.lang.String&nbsp;handlerName,
                            java.lang.String&nbsp;handlerClass)
                     throws <A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></PRE>
<DL>
<DD>A helper method that tries to initialize a handler and register it.
 The purpose is to check for all the exceptions that may occur in
 dynamic class loading and throw an InitializationException on
 error.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>handlerName</CODE> - The name the handler is registered under.<DD><CODE>handlerClass</CODE> - The name of the class to use as a handler.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></CODE> - Couldn't instantiate handler.</DL>
</DD>
</DL>
<HR>

<A NAME="unregisterHandler(java.lang.String)"><!-- --></A><H3>
unregisterHandler</H3>
<PRE>
public void <B>unregisterHandler</B>(java.lang.String&nbsp;handlerName)</PRE>
<DL>
<DD>Unregister a handler.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html#unregisterHandler(java.lang.String)">unregisterHandler</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>handlerName</CODE> - The name of the handler to unregister.</DL>
</DD>
</DL>
<HR>

<A NAME="handleRequest(java.io.InputStream)"><!-- --></A><H3>
handleRequest</H3>
<PRE>
public byte[] <B>handleRequest</B>(java.io.InputStream&nbsp;is)</PRE>
<DL>
<DD>Handle an XML-RPC request using the encapsulated server.

 You can use this method to handle a request from within
 a Turbine screen.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html#handleRequest(java.io.InputStream)">handleRequest</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - the stream to read request data from.<DT><B>Returns:</B><DD>the response body that needs to be sent to the client.</DL>
</DD>
</DL>
<HR>

<A NAME="handleRequest(java.io.InputStream, java.lang.String, java.lang.String)"><!-- --></A><H3>
handleRequest</H3>
<PRE>
public byte[] <B>handleRequest</B>(java.io.InputStream&nbsp;is,
                            java.lang.String&nbsp;user,
                            java.lang.String&nbsp;password)</PRE>
<DL>
<DD>Handle an XML-RPC request using the encapsulated server with user
 authentication.

 You can use this method to handle a request from within
 a Turbine screen.

 <p> Note that the handlers need to implement AuthenticatedXmlRpcHandler
 interface to access the authentication infomration.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html#handleRequest(java.io.InputStream, java.lang.String, java.lang.String)">handleRequest</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - the stream to read request data from.<DD><CODE>user</CODE> - the user that is making the request.<DD><CODE>password</CODE> - the password given by user.<DT><B>Returns:</B><DD>the response body that needs to be sent to the client.</DL>
</DD>
</DL>
<HR>

<A NAME="executeRpc(java.net.URL, java.lang.String, java.util.Vector)"><!-- --></A><H3>
executeRpc</H3>
<PRE>
public java.lang.Object <B>executeRpc</B>(java.net.URL&nbsp;url,
                                   java.lang.String&nbsp;methodName,
                                   java.util.Vector&nbsp;params)
                            throws <A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></PRE>
<DL>
<DD>Client's interface to XML-RPC.

 The return type is Object which you'll need to cast to
 whatever you are expecting.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html#executeRpc(java.net.URL, java.lang.String, java.util.Vector)">executeRpc</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - A URL.<DD><CODE>methodName</CODE> - A String with the method name.<DD><CODE>params</CODE> - A Vector with the parameters.<DT><B>Returns:</B><DD>An Object.<DT><B>Throws:</B><DD><CODE>XmlRpcException.</CODE> - &nbsp;<DD><CODE>IOException.</CODE> - &nbsp;</DL>
</DD>
</DL>
<HR>

<A NAME="executeAuthenticatedRpc(java.net.URL, java.lang.String, java.lang.String, java.lang.String, java.util.Vector)"><!-- --></A><H3>
executeAuthenticatedRpc</H3>
<PRE>
public java.lang.Object <B>executeAuthenticatedRpc</B>(java.net.URL&nbsp;url,
                                                java.lang.String&nbsp;username,
                                                java.lang.String&nbsp;password,
                                                java.lang.String&nbsp;methodName,
                                                java.util.Vector&nbsp;params)
                                         throws <A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></PRE>
<DL>
<DD>Client's Authenticated interface to XML-RPC.

 The return type is Object which you'll need to cast to
 whatever you are expecting.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html#executeAuthenticatedRpc(java.net.URL, java.lang.String, java.lang.String, java.lang.String, java.util.Vector)">executeAuthenticatedRpc</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - A URL.<DD><CODE>username</CODE> - The username to try and authenticate with<DD><CODE>password</CODE> - The password to try and authenticate with<DD><CODE>methodName</CODE> - A String with the method name.<DD><CODE>params</CODE> - A Vector with the parameters.<DT><B>Returns:</B><DD>An Object.<DT><B>Throws:</B><DD><CODE>XmlRpcException.</CODE> - &nbsp;<DD><CODE>IOException.</CODE> - &nbsp;</DL>
</DD>
</DL>
<HR>

<A NAME="send(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>