com.pushtotest.tool.protocolhandler
Class XMLRPCProtocol

java.lang.Object
  com.pushtotest.tool.protocolhandler.ProtocolWrapper
      com.pushtotest.tool.protocolhandler.XMLRPCProtocol

All Implemented Interfaces:

Protocol, java.lang.Runnable

public class XMLRPCProtocol
extends ProtocolWrapper

This is the implementation of the XML-RPC Protocol handler. This is mostly a wrapper for the methods in the Apache XML-RPC library.

Field Summary

Fields inherited from class com.pushtotest.tool.protocolhandler.ProtocolWrapper

body, errno, header, host, name, pass, path, port, proxyHost, proxyPass, proxyPort, proxyUser, query, response, running, scheme, timeout, type, url

Fields inherited from interface com.pushtotest.tool.protocolhandler.Protocol

IOERROR, NOERROR, NOTREADY, OTHER, TIMEOUT

Constructor Summary

XMLRPCProtocol()

Method Summary

Response	connect() Calling this method actually causes the connection to be made.
java.lang.String	id() Returns an id for this protocol.
void	send() Calling this method actually causes the connection to be made.
void	setDebug(java.lang.String theDebugValue) Turns on debugging output for the XMLRPC library.
void	setKeepAlive(java.lang.String theValue) Turns on keep connection alive option for the XMLRPC library.

Methods inherited from class com.pushtotest.tool.protocolhandler.ProtocolWrapper

getBody, getErrno, getHost, getPassword, getResponse, getTimeout, getUrl, getUrl, getURL, getUsername, isRunning, parseUrl, run, setBody, setErrno, setHeader, setHost, setPassword, setPath, setPort, setProxyHost, setProxyPass, setProxyPort, setProxyUser, setQueryString, setScheme, setTimeout, setType, setUrl, setUsername, supports, supportsBody, supportsHeader, supportsResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLRPCProtocol

public XMLRPCProtocol()

Method Detail

id

public java.lang.String id()

Returns an id for this protocol. The id is a string that will be used to uniquily identify the protocol. For example

:// would be appropriate (without the "://")

.

Specified by:

id in interface Protocol

Specified by:

id in class ProtocolWrapper

Returns:

The id for this Protocol.

setDebug

public void setDebug(java.lang.String theDebugValue)

Turns on debugging output for the XMLRPC library. fcohen Apr. 19, 2002: This may be moved into ProtocolHandler to become a standard method for all Protocols

Parameters:

theDebugValue - Valid inputs: true, false XXX Why is this not a boolean?

setKeepAlive

public void setKeepAlive(java.lang.String theValue)

Turns on keep connection alive option for the XMLRPC library.

Parameters:

theValue - Valid inputs: true, false fcohen Apr. 19, 2002: This may be moved into ProtocolHandler to become a standard method for all Protocols XXX Why is this not a boolean?

connect

public Response connect()
                 throws NotReadyException,
                        NoSuchClassException,
                        ToolException,
                        java.io.IOException

Calling this method actually causes the connection to be made. It will do the work of making the connection and gathering the response.

Specified by:

connect in interface Protocol

Specified by:

connect in class ProtocolWrapper

Returns:

The response object that is the appropriate type for this Protocol.

Throws:

NotReadyException - If the connect is called without all of the proper pieces set that it needs to connect to the given protocol.

ConnectionTimeoutException - If a timeout was set and that timeout is reached before the connection is completed.

NoSuchClassException

ToolException

java.io.IOException

send

public void send()

Description copied from class: ProtocolWrapper

Calling this method actually causes the connection to be made. This is the same as the connect() method, however, send is meant for asynchronous calls to a host that does not expect a response value.

Specified by:

send in class ProtocolWrapper