Class XmlRpcClient


  • 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.

    Since:
    3.0
    • Constructor Detail

      • XmlRpcClient

        public XmlRpcClient()
    • Method Detail

      • execute

        public java.lang.Object execute​(java.lang.String pMethodName,
                                        java.lang.Object[] pParams)
                                 throws XmlRpcException
        Performs a request with the clients default configuration.
        Parameters:
        pMethodName - The method being performed.
        pParams - The parameters.
        Returns:
        The result object.
        Throws:
        XmlRpcException - Performing the request failed.
      • execute

        public java.lang.Object execute​(XmlRpcClientConfig pConfig,
                                        java.lang.String pMethodName,
                                        java.lang.Object[] pParams)
                                 throws XmlRpcException
        Performs a request with the given configuration.
        Parameters:
        pConfig - The request configuration.
        pMethodName - The method being performed.
        pParams - The parameters.
        Returns:
        The result object.
        Throws:
        XmlRpcException - Performing the request failed.
      • execute

        public java.lang.Object execute​(java.lang.String pMethodName,
                                        java.util.List pParams)
                                 throws XmlRpcException
        Performs a request with the clients default configuration.
        Parameters:
        pMethodName - The method being performed.
        pParams - The parameters.
        Returns:
        The result object.
        Throws:
        XmlRpcException - Performing the request failed.
      • execute

        public java.lang.Object execute​(XmlRpcClientConfig pConfig,
                                        java.lang.String pMethodName,
                                        java.util.List pParams)
                                 throws XmlRpcException
        Performs a request with the given configuration.
        Parameters:
        pConfig - The request configuration.
        pMethodName - The method being performed.
        pParams - The parameters.
        Returns:
        The result object.
        Throws:
        XmlRpcException - Performing the request failed.
      • execute

        public java.lang.Object execute​(XmlRpcRequest pRequest)
                                 throws XmlRpcException
        Performs a request with the clients default configuration.
        Parameters:
        pRequest - The request being performed.
        Returns:
        The result object.
        Throws:
        XmlRpcException - Performing the request failed.
      • executeAsync

        public void executeAsync​(java.lang.String pMethodName,
                                 java.lang.Object[] pParams,
                                 AsyncCallback pCallback)
                          throws XmlRpcException
        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.
        Throws:
        XmlRpcException - Performing the request failed.
      • executeAsync

        public void executeAsync​(XmlRpcClientConfig pConfig,
                                 java.lang.String pMethodName,
                                 java.lang.Object[] pParams,
                                 AsyncCallback pCallback)
                          throws XmlRpcException
        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.
        Throws:
        XmlRpcException - Performing the request failed.
      • executeAsync

        public void executeAsync​(java.lang.String pMethodName,
                                 java.util.List pParams,
                                 AsyncCallback pCallback)
                          throws XmlRpcException
        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.
        Throws:
        XmlRpcException - Performing the request failed.
      • executeAsync

        public void executeAsync​(XmlRpcClientConfig pConfig,
                                 java.lang.String pMethodName,
                                 java.util.List pParams,
                                 AsyncCallback pCallback)
                          throws XmlRpcException
        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.
        Throws:
        XmlRpcException - Performing the request failed.
      • executeAsync

        public void executeAsync​(XmlRpcRequest pRequest,
                                 AsyncCallback pCallback)
                          throws XmlRpcException
        Performs a request with the clients default configuration.
        Parameters:
        pRequest - The request being performed.
        pCallback - The callback being notified when the request is finished.
        Throws:
        XmlRpcException - Performing the request failed.
      • getXmlWriterFactory

        public XmlWriterFactory getXmlWriterFactory()
        Returns the clients instance of XmlWriterFactory.
        Returns:
        A factory for creating instances of XMLWriter.
      • setXmlWriterFactory

        public void setXmlWriterFactory​(XmlWriterFactory pFactory)
        Sets the clients instance of XmlWriterFactory.
        Parameters:
        pFactory - A factory for creating instances of XMLWriter.