org.ros.internal.node.xmlrpc

Class XmlRpcClientFactory<T extends XmlRpcEndpoint>

java.lang.Object

org.ros.internal.node.xmlrpc.XmlRpcClientFactory<T>

Type Parameters:

T - the type of XmlRpcEndpoint to create clients for

public class XmlRpcClientFactory<T extends XmlRpcEndpoint>
extends java.lang.Object

Modified version of org.apache.xmlrpc.client.util.ClientFactory that requires timeouts in calls.

Constructor Summary

Constructors

Constructor and Description
XmlRpcClientFactory(org.apache.xmlrpc.client.XmlRpcClient pClient) Creates a new instance.
XmlRpcClientFactory(org.apache.xmlrpc.client.XmlRpcClient pClient, org.apache.xmlrpc.common.TypeConverterFactory pTypeConverterFactory) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.xmlrpc.client.XmlRpcClient	getClient() Returns the factories client.
boolean	isObjectMethodLocal() Returns, whether a method declared by the Object class is performed by the local object, rather than by the server.
java.lang.Object	newInstance(java.lang.ClassLoader pClassLoader, java.lang.Class<T> pClass, java.lang.String pRemoteName, int timeout) Creates an object, which is implementing the given interface.
void	setObjectMethodLocal(boolean pObjectMethodLocal) Sets, whether a method declared by the Object class is performed by the local object, rather than by the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlRpcClientFactory

public XmlRpcClientFactory(org.apache.xmlrpc.client.XmlRpcClient pClient,
                   org.apache.xmlrpc.common.TypeConverterFactory pTypeConverterFactory)

Creates a new instance.

Parameters:

pClient - A fully configured XML-RPC client, which is used internally to perform XML-RPC calls.

pTypeConverterFactory - Creates instances of TypeConverterFactory, which are used to transform the result object in its target representation.

XmlRpcClientFactory

public XmlRpcClientFactory(org.apache.xmlrpc.client.XmlRpcClient pClient)

Creates a new instance. Shortcut for

 new ClientFactory(pClient, new TypeConverterFactoryImpl());
 

Parameters:

pClient - A fully configured XML-RPC client, which is used internally to perform XML-RPC calls.

See Also:

TypeConverterFactoryImpl

Method Detail

getClient

public org.apache.xmlrpc.client.XmlRpcClient getClient()

Returns the factories client.

isObjectMethodLocal

public boolean isObjectMethodLocal()

Returns, whether a method declared by the Object class is performed by the local object, rather than by the server. Defaults to true.

setObjectMethodLocal

public void setObjectMethodLocal(boolean pObjectMethodLocal)

Sets, whether a method declared by the Object class is performed by the local object, rather than by the server. Defaults to true.

newInstance

public java.lang.Object newInstance(java.lang.ClassLoader pClassLoader,
                           java.lang.Class<T> pClass,
                           java.lang.String pRemoteName,
                           int timeout)

Creates an object, which is implementing the given interface. The objects methods are internally calling an XML-RPC server by using the factories client.

Parameters:

pClassLoader - The class loader, which is being used for loading classes, if required.

pClass - Interface, which is being implemented.

pRemoteName - Handler name, which is being used when calling the server. This is used for composing the method name. For example, if pRemoteName is "Foo" and you want to invoke the method "bar" in the handler, then the full method name would be "Foo.bar".