/lib/docs/org/apache/xmlrpc/client/util/ClientFactory.html
HTML | 426 lines | 361 code | 43 blank | 22 comment | 0 complexity | 26d994afb564f7a599a6952d061ab23d 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>
- ClientFactory (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="ClientFactory (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/ClientFactory.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">
- PREV CLASS
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/xmlrpc/client/util/ClientFactory.html" target="_top"><B>FRAMES</B></A>
- <A HREF="ClientFactory.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.client.util</FONT>
- <BR>
- Class ClientFactory</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.client.util.ClientFactory</B>
- </PRE>
- <HR>
- <DL>
- <DT><PRE>public class <B>ClientFactory</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- <p>The <A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html" title="class in org.apache.xmlrpc.client.util"><CODE>ClientFactory</CODE></A> is a useful tool for simplifying the
- use of Apache XML-RPC. The rough idea is as follows: All XML-RPC
- handlers are implemented as interfaces. The server uses the actual
- implementation. The client uses the <A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html" title="class in org.apache.xmlrpc.client.util"><CODE>ClientFactory</CODE></A> to
- obtain an implementation, which is based on running XML-RPC calls.</p>
- <P>
- <P>
- <HR>
- <P>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <A NAME="constructor_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>Constructor Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#ClientFactory(org.apache.xmlrpc.client.XmlRpcClient)">ClientFactory</A></B>(<A HREF="../../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A> pClient)</CODE>
- <BR>
- Creates a new instance.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#ClientFactory(org.apache.xmlrpc.client.XmlRpcClient, org.apache.xmlrpc.common.TypeConverterFactory)">ClientFactory</A></B>(<A HREF="../../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A> pClient,
- <A HREF="../../../../../org/apache/xmlrpc/common/TypeConverterFactory.html" title="interface in org.apache.xmlrpc.common">TypeConverterFactory</A> pTypeConverterFactory)</CODE>
- <BR>
- Creates a new instance.</TD>
- </TR>
- </TABLE>
-
- <!-- ========== 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> <A HREF="../../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#getClient()">getClient</A></B>()</CODE>
- <BR>
- Returns the factories client.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#isObjectMethodLocal()">isObjectMethodLocal</A></B>()</CODE>
- <BR>
- Returns, whether a method declared by the <CODE>Object class</CODE> is performed by the local object, rather than
- by the server.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.Object</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#newInstance(java.lang.Class)">newInstance</A></B>(java.lang.Class pClass)</CODE>
- <BR>
- Creates an object, which is implementing the given interface.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.Object</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#newInstance(java.lang.ClassLoader, java.lang.Class)">newInstance</A></B>(java.lang.ClassLoader pClassLoader,
- java.lang.Class pClass)</CODE>
- <BR>
- Creates an object, which is implementing the given interface.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.Object</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#newInstance(java.lang.ClassLoader, java.lang.Class, java.lang.String)">newInstance</A></B>(java.lang.ClassLoader pClassLoader,
- java.lang.Class pClass,
- java.lang.String pRemoteName)</CODE>
- <BR>
- Creates an object, which is implementing the given interface.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/apache/xmlrpc/client/util/ClientFactory.html#setObjectMethodLocal(boolean)">setObjectMethodLocal</A></B>(boolean pObjectMethodLocal)</CODE>
- <BR>
- Sets, whether a method declared by the <CODE>Object class</CODE> is performed by the local object, rather than
- by the server.</TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <A NAME="constructor_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>Constructor Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="ClientFactory(org.apache.xmlrpc.client.XmlRpcClient, org.apache.xmlrpc.common.TypeConverterFactory)"><!-- --></A><H3>
- ClientFactory</H3>
- <PRE>
- public <B>ClientFactory</B>(<A HREF="../../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A> pClient,
- <A HREF="../../../../../org/apache/xmlrpc/common/TypeConverterFactory.html" title="interface in org.apache.xmlrpc.common">TypeConverterFactory</A> pTypeConverterFactory)</PRE>
- <DL>
- <DD>Creates a new instance.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>pClient</CODE> - A fully configured XML-RPC client, which is
- used internally to perform XML-RPC calls.<DD><CODE>pTypeConverterFactory</CODE> - Creates instances of <A HREF="../../../../../org/apache/xmlrpc/common/TypeConverterFactory.html" title="interface in org.apache.xmlrpc.common"><CODE>TypeConverterFactory</CODE></A>,
- which are used to transform the result object in its target representation.</DL>
- </DL>
- <HR>
- <A NAME="ClientFactory(org.apache.xmlrpc.client.XmlRpcClient)"><!-- --></A><H3>
- ClientFactory</H3>
- <PRE>
- public <B>ClientFactory</B>(<A HREF="../../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A> pClient)</PRE>
- <DL>
- <DD>Creates a new instance. Shortcut for
- <pre>
- new ClientFactory(pClient, new TypeConverterFactoryImpl());
- </pre>
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>pClient</CODE> - A fully configured XML-RPC client, which is
- used internally to perform XML-RPC calls.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/xmlrpc/common/TypeConverterFactoryImpl.html" title="class in org.apache.xmlrpc.common"><CODE>TypeConverterFactoryImpl</CODE></A></DL>
- </DL>
- <!-- ============ 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="getClient()"><!-- --></A><H3>
- getClient</H3>
- <PRE>
- public <A HREF="../../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client">XmlRpcClient</A> <B>getClient</B>()</PRE>
- <DL>
- <DD>Returns the factories client.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isObjectMethodLocal()"><!-- --></A><H3>
- isObjectMethodLocal</H3>
- <PRE>
- public boolean <B>isObjectMethodLocal</B>()</PRE>
- <DL>
- <DD>Returns, whether a method declared by the <CODE>Object class</CODE> is performed by the local object, rather than
- by the server. Defaults to true.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setObjectMethodLocal(boolean)"><!-- --></A><H3>
- setObjectMethodLocal</H3>
- <PRE>
- public void <B>setObjectMethodLocal</B>(boolean pObjectMethodLocal)</PRE>
- <DL>
- <DD>Sets, whether a method declared by the <CODE>Object class</CODE> is performed by the local object, rather than
- by the server. Defaults to true.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="newInstance(java.lang.Class)"><!-- --></A><H3>
- newInstance</H3>
- <PRE>
- public java.lang.Object <B>newInstance</B>(java.lang.Class pClass)</PRE>
- <DL>
- <DD>Creates an object, which is implementing the given interface.
- The objects methods are internally calling an XML-RPC server
- by using the factories client; shortcut for
- <pre>
- newInstance(Thread.currentThread().getContextClassLoader(),
- pClass)
- </pre>
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="newInstance(java.lang.ClassLoader, java.lang.Class)"><!-- --></A><H3>
- newInstance</H3>
- <PRE>
- public java.lang.Object <B>newInstance</B>(java.lang.ClassLoader pClassLoader,
- java.lang.Class pClass)</PRE>
- <DL>
- <DD>Creates an object, which is implementing the given interface.
- The objects methods are internally calling an XML-RPC server
- by using the factories client; shortcut for
- <pre>
- newInstance(pClassLoader, pClass, pClass.getName())
- </pre>
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="newInstance(java.lang.ClassLoader, java.lang.Class, java.lang.String)"><!-- --></A><H3>
- newInstance</H3>
- <PRE>
- public java.lang.Object <B>newInstance</B>(java.lang.ClassLoader pClassLoader,
- java.lang.Class pClass,
- java.lang.String pRemoteName)</PRE>
- <DL>
- <DD>Creates an object, which is implementing the given interface.
- The objects methods are internally calling an XML-RPC server
- by using the factories client.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>pClassLoader</CODE> - The class loader, which is being used for
- loading classes, if required.<DD><CODE>pClass</CODE> - Interface, which is being implemented.<DD><CODE>pRemoteName</CODE> - Handler name, which is being used when
- calling the server. This is used for composing the
- method name. For example, if <code>pRemoteName</code>
- is "Foo" and you want to invoke the method "bar" in
- the handler, then the full method name would be "Foo.bar".</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/ClientFactory.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">
- PREV CLASS
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/apache/xmlrpc/client/util/ClientFactory.html" target="_top"><B>FRAMES</B></A>
- <A HREF="ClientFactory.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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>