public class XmlRpcClient extends XmlRpcParser implements XmlRpcInvocationHandler
Constructor and Description |
---|
XmlRpcClient(java.lang.String host,
int port,
java.lang.String path)
Creates a new client with the ability to send XML-RPC messages
to the given host, on the given port and path.
|
XmlRpcClient(java.net.URL url)
Creates a new client with the ability to send XML-RPC messages
the the server at the given URL.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
invoke(java.lang.String method,
java.util.Collection arguments)
Invokes a method on the terminating XML-RPC end point.
|
java.lang.Object |
invoke(java.lang.String method,
java.lang.Object[] arguments)
Invokes a method on the terminating XML-RPC end point.
|
void |
invokeAsynchronously(java.lang.String method,
java.lang.Object arguments,
XmlRpcCallback callback)
A asynchronous version of invoke performing the call in a separate
thread and reporting responses, faults, and exceptions through the
supplied XmlRpcCallback.
|
boolean |
isFaultResponse()
Determines if the most previously XML-RPC response contained a
fault struct, in which case the return value of the most previous
invoke() call contains a hash table with this
fault struct. |
void |
setKeepAlive(boolean keepAlive)
Determines if the client object should try to keep the socket
connection to the server alive or not.
|
void |
setZipStream(boolean zipStream)
Determines if the XML payload sent to the server should be zipped
or not.
|
void |
startElement(java.lang.String name,
org.xml.sax.AttributeList attributes)
Override the startElement() method inherited from XmlRpcParser.
|
characters, endDocument, endElement, ignorableWhitespace, parse, processingInstruction, setDocumentLocator, setDriver, setDriver, startDocument
public XmlRpcClient(java.lang.String host, int port, java.lang.String path)
host
- The XML-RPC host (IP address or host name).port
- The port the host is accepting connections on.path
- The path to the service (e.g. "/RPC2").public XmlRpcClient(java.net.URL url)
url
- the URL at which the target server can be contactedpublic final boolean isFaultResponse()
invoke()
call contains a hash table with this
fault struct.public final java.lang.Object invoke(java.lang.String method, java.util.Collection arguments) throws XmlRpcException
invoke
in interface XmlRpcInvocationHandler
method
- The name of the method to call.arguments
- The arguments to encode in the call.XmlRpcException
- One or more of the supplied arguments are
unserializable. That is, the built-in serializer connot parse it
or find a custom serializer that can. There may also be problems
with the socket communication.public final java.lang.Object invoke(java.lang.String method, java.lang.Object[] arguments) throws XmlRpcException
method
- The name of the method to call.arguments
- The arguments to encode in the call.XmlRpcException
- One or more of the supplied arguments are
unserializable. That is, the built-in serializer connot parse it
or find a custom serializer that can. There may also be problems
with the socket communication.public final void invokeAsynchronously(java.lang.String method, java.lang.Object arguments, XmlRpcCallback callback)
method
- The name of the method at the server.arguments
- The arguments for the call. This may be either a java.util.Collection
descendant, or a java.lang.Object[] array.callback
- An object implementing the XmlRpcCallback interface. If callback is
null, the call will be performed but any results, faults, or exceptions
will be ignored (fire and forget).public void setKeepAlive(boolean keepAlive)
keepAlive
- -- true or false.public void setZipStream(boolean zipStream)
zipStream
- -- true or false.public void startElement(java.lang.String name, org.xml.sax.AttributeList attributes) throws org.xml.sax.SAXException
startElement
in interface org.xml.sax.DocumentHandler
startElement
in class XmlRpcParser
org.xml.sax.SAXException
documentation