Fields and methods of the jala.XmlRpcRequest class.
A constructor for XmlRpc request objects
parameters
| String | url | The url of the XmlRpc entry point |
| String | methodName | The name of the method to call |
methods
- getUrl()
- setProxy(proxyString)
- getProxy()
- setCredentials(username, password)
- setTimeout(millis)
- setReadTimeout(millis)
- setEncoding(enc)
- setInputEncoding(enc)
- setOutputEncoding(enc)
- setDebug(flag)
- debug()
- execute()
Methods
Sets the proxy host and port. For Java runtimes < 1.5 this method
sets the appropriate system properties (so this has an effect on
all requests based on java.net.URL), for all others the proxy
is only set for this request.
parameters
| String | proxyString | The proxy string in the form 'fqdn:port' (eg. my.proxy.com:3128) |
Returns the proxy object. This method will only return
a value if using a java runtime > 1.5
returns
| The proxy to use for this request |
see
Sets the credentials for basic http authentication to
use with this request.
parameters
| String | username | The username |
| String | password | The password |
Returns the credentials of this request
returns
| The base46 encoded credentials of this request |
Sets the connection timeout to the specified milliseconds.
parameters
| Number | millis | The timeout to use as connection timeout |
Sets the socket timeout to the specified milliseconds.
parameters
| Number | millis | The timeout to use as socket timeout |
Returns the connection timeout of this request
returns
| The connection timeout value in milliseconds |
Returns the socket timeout of this request
returns
| The socket timeout value in milliseconds |
Returns the name of the remote function to call
returns
| The name of the remote function |
Sets both input and output encoding to the
specified encoding string
parameters
| String | enc | The encoding to use for both input and output. This must be a valid java encoding string. |
Sets the input encoding to the specified encoding string
parameters
| String | enc | The encoding to use for input. This must be a valid java encoding string. |
Sets the output encoding to the specified encoding string
parameters
| String | enc | The encoding to use for output. This must be a valid java encoding string. |
Returns the input encoding
returns
| The input encoding used by this request |
Returns the output encoding
returns
| The output encoding used by this request |
Enables or disables the debug mode. If enabled the xml source
of both request and response is included in the result properties
'requestXml' and 'responseXml'
parameters
| Boolean | flag | True or false. |
Returns true if debug is enabled for this request, false otherwise
returns
| True if debugging is enabled, false otherwise |
Calling this method executes the remote method using
the arguments specified.
returns
| The result of this XmlRpc request |
Helper method for converting a Javascript object into
its appropriate Java object.
parameters
| Object | obj | The Javascript object to convert |
returns
| The appropriate Java representation of the object |
Converts a Java object into its appropriate Javascript representation.
parameters
| java.lang.Object | obj | The Java object to convert |
returns
| The appropriate Javascript representation of the Java object |
Helper method to format an arguments array into
a string useable for debugging output.
parameters
| Object | args | An arguments array |
returns
| The arguments array formatted as string |