public class XmlRpcClient extends XmlRpcController
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 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.
Constructor and Description |
---|
XmlRpcClient() |
Modifier and Type | Method and Description |
---|---|
Object |
execute(String pMethodName,
List pParams)
Performs a request with the clients default configuration.
|
Object |
execute(String pMethodName,
Object[] pParams)
Performs a request with the clients default configuration.
|
Object |
execute(XmlRpcClientConfig pConfig,
String pMethodName,
List pParams)
Performs a request with the given configuration.
|
Object |
execute(XmlRpcClientConfig pConfig,
String pMethodName,
Object[] pParams)
Performs a request with the given configuration.
|
Object |
execute(XmlRpcRequest pRequest)
Performs a request with the clients default configuration.
|
void |
executeAsync(String pMethodName,
List pParams,
AsyncCallback pCallback)
Performs an asynchronous request with the clients default configuration.
|
void |
executeAsync(String pMethodName,
Object[] pParams,
AsyncCallback pCallback)
Performs an asynchronous request with the clients default configuration.
|
void |
executeAsync(XmlRpcClientConfig pConfig,
String pMethodName,
List pParams,
AsyncCallback pCallback)
Performs an asynchronous request with the given configuration.
|
void |
executeAsync(XmlRpcClientConfig pConfig,
String pMethodName,
Object[] pParams,
AsyncCallback pCallback)
Performs an asynchronous request with the given configuration.
|
void |
executeAsync(XmlRpcRequest pRequest,
AsyncCallback pCallback)
Performs a request with the clients default configuration.
|
XmlRpcClientConfig |
getClientConfig()
Returns the clients default configuration.
|
XmlRpcConfig |
getConfig()
Returns the clients default configuration.
|
protected XmlRpcWorkerFactory |
getDefaultXmlRpcWorkerFactory()
Creates the controllers default worker factory.
|
XmlRpcTransportFactory |
getTransportFactory()
Returns the clients transport factory.
|
XmlWriterFactory |
getXmlWriterFactory()
Returns the clients instance of
XmlWriterFactory . |
void |
setConfig(XmlRpcClientConfig pConfig)
Sets the clients default configuration.
|
void |
setTransportFactory(XmlRpcTransportFactory pFactory)
Sets the clients transport factory.
|
void |
setXmlWriterFactory(XmlWriterFactory pFactory)
Sets the clients instance of
XmlWriterFactory . |
getMaxThreads, getTypeFactory, getWorkerFactory, setMaxThreads, setTypeFactory, setWorkerFactory
protected XmlRpcWorkerFactory getDefaultXmlRpcWorkerFactory()
XmlRpcController
getDefaultXmlRpcWorkerFactory
in class XmlRpcController
public void setConfig(XmlRpcClientConfig pConfig)
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[])
.pConfig
- The default request configuration.public XmlRpcConfig getConfig()
execute(String, List)
,
execute(String, Object[])
.
You may overwrite this per request by using
execute(XmlRpcClientConfig, String, List)
,
or execute(XmlRpcClientConfig, String, Object[])
.getConfig
in class XmlRpcController
public XmlRpcClientConfig getClientConfig()
(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[])
public void setTransportFactory(XmlRpcTransportFactory pFactory)
XmlRpcTransportFactory.getTransport()
for any request.pFactory
- The clients transport factory.public XmlRpcTransportFactory getTransportFactory()
XmlRpcTransportFactory.getTransport()
for any request.public Object execute(String pMethodName, Object[] pParams) throws XmlRpcException
pMethodName
- The method being performed.pParams
- The parameters.XmlRpcException
- Performing the request failed.public Object execute(XmlRpcClientConfig pConfig, String pMethodName, Object[] pParams) throws XmlRpcException
pConfig
- The request configuration.pMethodName
- The method being performed.pParams
- The parameters.XmlRpcException
- Performing the request failed.public Object execute(String pMethodName, List pParams) throws XmlRpcException
pMethodName
- The method being performed.pParams
- The parameters.XmlRpcException
- Performing the request failed.public Object execute(XmlRpcClientConfig pConfig, String pMethodName, List pParams) throws XmlRpcException
pConfig
- The request configuration.pMethodName
- The method being performed.pParams
- The parameters.XmlRpcException
- Performing the request failed.public Object execute(XmlRpcRequest pRequest) throws XmlRpcException
pRequest
- The request being performed.XmlRpcException
- Performing the request failed.public void executeAsync(String pMethodName, Object[] pParams, AsyncCallback pCallback) throws XmlRpcException
pMethodName
- The method being performed.pParams
- The parameters.pCallback
- The callback being notified when the request is finished.XmlRpcException
- Performing the request failed.public void executeAsync(XmlRpcClientConfig pConfig, String pMethodName, Object[] pParams, AsyncCallback pCallback) throws XmlRpcException
pConfig
- The request configuration.pMethodName
- The method being performed.pParams
- The parameters.pCallback
- The callback being notified when the request is finished.XmlRpcException
- Performing the request failed.public void executeAsync(String pMethodName, List pParams, AsyncCallback pCallback) throws XmlRpcException
pMethodName
- The method being performed.pParams
- The parameters.pCallback
- The callback being notified when the request is finished.XmlRpcException
- Performing the request failed.public void executeAsync(XmlRpcClientConfig pConfig, String pMethodName, List pParams, AsyncCallback pCallback) throws XmlRpcException
pConfig
- The request configuration.pMethodName
- The method being performed.pParams
- The parameters.pCallback
- The callback being notified when the request is finished.XmlRpcException
- Performing the request failed.public void executeAsync(XmlRpcRequest pRequest, AsyncCallback pCallback) throws XmlRpcException
pRequest
- The request being performed.pCallback
- The callback being notified when the request is finished.XmlRpcException
- Performing the request failed.public XmlWriterFactory getXmlWriterFactory()
XmlWriterFactory
.XMLWriter
.public void setXmlWriterFactory(XmlWriterFactory pFactory)
XmlWriterFactory
.pFactory
- A factory for creating instances of
XMLWriter
.Copyright © 2001–2016 The Apache Software Foundation. All rights reserved.