Inheritance diagram for org.apache.xmlrpc.client.XmlRpcClient:

Public Member Functions
Object	execute (String pMethodName, Object[] pParams) throws XmlRpcException
Object	execute (XmlRpcClientConfig pConfig, String pMethodName, Object[] pParams) throws XmlRpcException
Object	execute (String pMethodName, List pParams) throws XmlRpcException
Object	execute (XmlRpcClientConfig pConfig, String pMethodName, List pParams) throws XmlRpcException
Object	execute (XmlRpcRequest pRequest) throws XmlRpcException
void	executeAsync (String pMethodName, Object[] pParams, AsyncCallback pCallback) throws XmlRpcException
void	executeAsync (XmlRpcClientConfig pConfig, String pMethodName, Object[] pParams, AsyncCallback pCallback) throws XmlRpcException
void	executeAsync (String pMethodName, List pParams, AsyncCallback pCallback) throws XmlRpcException
void	executeAsync (XmlRpcClientConfig pConfig, String pMethodName, List pParams, AsyncCallback pCallback) throws XmlRpcException
void	executeAsync (XmlRpcRequest pRequest, AsyncCallback pCallback) throws XmlRpcException
XmlRpcClientConfig	getClientConfig ()
XmlRpcConfig	getConfig ()
XmlRpcTransportFactory	getTransportFactory ()
XmlWriterFactory	getXmlWriterFactory ()
void	setConfig (XmlRpcClientConfig pConfig)
void	setTransportFactory (XmlRpcTransportFactory pFactory)
void	setXmlWriterFactory (XmlWriterFactory pFactory)
Protected Member Functions
XmlRpcWorkerFactory	getDefaultXmlRpcWorkerFactory ()
Private Attributes
XmlRpcClientConfig	config = XmlRpcClientDefaults.newXmlRpcClientConfig()
XmlRpcTransportFactory	transportFactory = XmlRpcClientDefaults.newTransportFactory(this)
XmlWriterFactory	xmlWriterFactory = XmlRpcClientDefaults.newXmlWriterFactory()

Detailed Description

The main access point of an XML-RPC client. This object serves mainly as an object factory. It is designed with singletons in mind: Basically, an application should be able to hold a single instance of XmlRpcClient in a static variable, unless you would be working with different factories.

Until Apache XML-RPC 2.0, this object was used both as an object factory and as a place, where configuration details (server URL, suggested encoding, user credentials and the like) have been stored. In Apache XML-RPC 3.0, the configuration details has been moved to the org.apache.xmlrpc.client.XmlRpcClientConfig object. The configuration object is designed for being passed through the actual worker methods.

A configured XmlRpcClient object is thread safe: In other words, the suggested use is, that you configure the client using setTransportFactory(XmlRpcTransportFactory) and similar methods, store it in a field and never modify it again. Without modifications, the client may be used for an arbitrary number of concurrent requests.

Since:: 3.0

Definition at line 51 of file XmlRpcClient.java.

Member Function Documentation

Object org.apache.xmlrpc.client.XmlRpcClient.execute	(	String	pMethodName,
		Object[]	pParams
	)		throws XmlRpcException `[inline]`

Performs a request with the clients default configuration.

Parameters:

pMethodName	The method being performed.
pParams	The parameters.

Returns:: The result object.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 125 of file XmlRpcClient.java.

Object org.apache.xmlrpc.client.XmlRpcClient.execute	(	XmlRpcClientConfig	pConfig,
		String	pMethodName,
		Object[]	pParams
	)		throws XmlRpcException `[inline]`

Performs a request with the given configuration.

Parameters:

pConfig	The request configuration.
pMethodName	The method being performed.
pParams	The parameters.

Returns:: The result object.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 136 of file XmlRpcClient.java.

Object org.apache.xmlrpc.client.XmlRpcClient.execute	(	String	pMethodName,
		List	pParams
	)		throws XmlRpcException `[inline]`

Performs a request with the clients default configuration.

Parameters:

pMethodName	The method being performed.
pParams	The parameters.

Returns:: The result object.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 146 of file XmlRpcClient.java.

Object org.apache.xmlrpc.client.XmlRpcClient.execute	(	XmlRpcClientConfig	pConfig,
		String	pMethodName,
		List	pParams
	)		throws XmlRpcException `[inline]`

Performs a request with the given configuration.

Parameters:

pConfig	The request configuration.
pMethodName	The method being performed.
pParams	The parameters.

Returns:: The result object.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 157 of file XmlRpcClient.java.

Object org.apache.xmlrpc.client.XmlRpcClient.execute ( XmlRpcRequest pRequest ) throws XmlRpcException [inline]

Performs a request with the clients default configuration.

Parameters:

pRequest The request being performed.

Returns:: The result object.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 166 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.executeAsync	(	String	pMethodName,
		Object[]	pParams,
		AsyncCallback	pCallback
	)		throws XmlRpcException `[inline]`

Performs an asynchronous request with the clients default configuration.

Parameters:

pMethodName	The method being performed.
pParams	The parameters.
pCallback	The callback being notified when the request is finished.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 176 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.executeAsync	(	XmlRpcClientConfig	pConfig,
		String	pMethodName,
		Object[]	pParams,
		AsyncCallback	pCallback
	)		throws XmlRpcException `[inline]`

Performs an asynchronous request with the given configuration.

Parameters:

pConfig	The request configuration.
pMethodName	The method being performed.
pParams	The parameters.
pCallback	The callback being notified when the request is finished.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 188 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.executeAsync	(	String	pMethodName,
		List	pParams,
		AsyncCallback	pCallback
	)		throws XmlRpcException `[inline]`

Performs an asynchronous request with the clients default configuration.

Parameters:

pMethodName	The method being performed.
pParams	The parameters.
pCallback	The callback being notified when the request is finished.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 201 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.executeAsync	(	XmlRpcClientConfig	pConfig,
		String	pMethodName,
		List	pParams,
		AsyncCallback	pCallback
	)		throws XmlRpcException `[inline]`

Performs an asynchronous request with the given configuration.

Parameters:

pConfig	The request configuration.
pMethodName	The method being performed.
pParams	The parameters.
pCallback	The callback being notified when the request is finished.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 213 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.executeAsync	(	XmlRpcRequest	pRequest,
		AsyncCallback	pCallback
	)		throws XmlRpcException `[inline]`

Performs a request with the clients default configuration.

Parameters:

pRequest	The request being performed.
pCallback	The callback being notified when the request is finished.

Exceptions:

XmlRpcException Performing the request failed.

Definition at line 224 of file XmlRpcClient.java.

XmlRpcClientConfig org.apache.xmlrpc.client.XmlRpcClient.getClientConfig ( ) [inline]

Returns the clients default configuration. Shortcut for (XmlRpcClientConfig) getConfig(). This configuration is used by the methods execute(String, List), execute(String, Object[]). You may overwrite this per request by using execute(XmlRpcClientConfig, String, List), or execute(XmlRpcClientConfig, String, Object[])

Returns:: The default request configuration.

Definition at line 97 of file XmlRpcClient.java.

XmlRpcConfig org.apache.xmlrpc.client.XmlRpcClient.getConfig ( ) [inline, virtual]

Returns the clients default configuration. This configuration is used by the methods execute(String, List), execute(String, Object[]). You may overwrite this per request by using execute(XmlRpcClientConfig, String, List), or execute(XmlRpcClientConfig, String, Object[]).

Returns:: The default request configuration.

Implements org.apache.xmlrpc.common.XmlRpcController.

Definition at line 83 of file XmlRpcClient.java.

XmlRpcWorkerFactory org.apache.xmlrpc.client.XmlRpcClient.getDefaultXmlRpcWorkerFactory ( ) [inline, protected, virtual]

Creates the controllers default worker factory.

Returns:: The default factory for workers.

Implements org.apache.xmlrpc.common.XmlRpcController.

Definition at line 56 of file XmlRpcClient.java.

XmlRpcTransportFactory org.apache.xmlrpc.client.XmlRpcClient.getTransportFactory ( ) [inline]

Returns the clients transport factory. The client will use this factory for invocation of XmlRpcTransportFactory#getTransport() for any request.

Returns:: The clients transport factory.

Definition at line 115 of file XmlRpcClient.java.

XmlWriterFactory org.apache.xmlrpc.client.XmlRpcClient.getXmlWriterFactory ( ) [inline]

Returns the clients instance of org.apache.xmlrpc.serializer.XmlWriterFactory.

Returns:: A factory for creating instances of org.apache.ws.commons.serialize.XMLWriter.

Definition at line 235 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.setConfig ( XmlRpcClientConfig pConfig ) [inline]

Sets the clients default configuration. This configuration is used by the methods execute(String, List), execute(String, Object[]), and execute(XmlRpcRequest). You may overwrite this per request by using execute(XmlRpcClientConfig, String, List), or execute(XmlRpcClientConfig, String, Object[]).

Parameters:

pConfig The default request configuration.

Definition at line 70 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.setTransportFactory ( XmlRpcTransportFactory pFactory ) [inline]

Sets the clients transport factory. The client will invoke the factory method XmlRpcTransportFactory#getTransport() for any request.

Parameters:

pFactory The clients transport factory.

Definition at line 106 of file XmlRpcClient.java.

void org.apache.xmlrpc.client.XmlRpcClient.setXmlWriterFactory ( XmlWriterFactory pFactory ) [inline]

Sets the clients instance of org.apache.xmlrpc.serializer.XmlWriterFactory.

Parameters:

pFactory A factory for creating instances of org.apache.ws.commons.serialize.XMLWriter.

Definition at line 244 of file XmlRpcClient.java.

Member Data Documentation

XmlRpcClientConfig org.apache.xmlrpc.client.XmlRpcClient.config = XmlRpcClientDefaults.newXmlRpcClientConfig() [private]

Definition at line 53 of file XmlRpcClient.java.

XmlRpcTransportFactory org.apache.xmlrpc.client.XmlRpcClient.transportFactory = XmlRpcClientDefaults.newTransportFactory(this) [private]

Definition at line 52 of file XmlRpcClient.java.

XmlWriterFactory org.apache.xmlrpc.client.XmlRpcClient.xmlWriterFactory = XmlRpcClientDefaults.newXmlWriterFactory() [private]

Definition at line 54 of file XmlRpcClient.java.

The documentation for this class was generated from the following file:

XmlRpcClient.java

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation