com.jayway.android.robotium.remotecontrol.solo

Class SoloRemoteControlRunner

java.lang.Object

org.safs.sockets.AbstractProtocolRunner

com.jayway.android.robotium.remotecontrol.solo.SoloRemoteControlRunner

All Implemented Interfaces:

java.lang.Runnable, ConnectionListener, DebugListener, NamedListener, SocketProtocolListener

Direct Known Subclasses:

SAFSRemoteControlRunner

public class SoloRemoteControlRunner
extends AbstractProtocolRunner
implements SocketProtocolListener

Field Summary

Fields

Modifier and Type	Field and Description
DroidSocketProtocol	droidprotocolserver a convenient wrapper to AbstractProtocolRunner.protocolserver we should use this field instead of AbstractProtocolRunner.protocolserver

Fields inherited from class org.safs.sockets.AbstractProtocolRunner

_debugEnabled, protocolserver, runnerlisteners

Fields inherited from interface org.safs.sockets.SocketProtocolListener

DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
SoloRemoteControlRunner(SocketProtocolListener listener)

Method Summary

Modifier and Type	Method and Description
void	onReceiveException(java.lang.String message) Remote client has thrown/issued an Exception message.
void	onReceiveMessage(java.lang.String message) Remote client has sent an arbitrary message.
void	onReceiveReady() Remote client has issued the READY event
void	onReceiveResult(int rc, java.lang.String info) Remote client has issued the RESULT event and is returning a simple statuscode and statusinfo response.
void	onReceiveResultProperties(java.util.Properties props) Remote client has issued the RESULT event and is returning result information in Properties.
void	onReceiveRunning() Remote client has issued the RUNNING event--usually resulting from a DISPATCH event.
void	processProtocolMessage(java.lang.String message) Concrete implementations must insert the parsing and processing of the messages received from the underlying SocketProtocol.
boolean	sendDispatchFile(java.lang.String filepath) Send the remote client a dispatch file message with the filepath to a file that should be readable by the remote client.
boolean	sendDispatchProps(java.util.Properties trd) Send the remote client a dispatch Properties message containing a Serialized Properties object containing all the data needed for the execution of the Dispatch.
boolean	sendMessage(java.lang.String message) Send the remote client and arbitrary MESSAGE content.
boolean	sendShutdown() Send a shutdown command to the remote client.

Methods inherited from class org.safs.sockets.AbstractProtocolRunner

addListener, debug, getListenerName, onReceiveConnection, onReceiveDebug, onReceiveLocalShutdown, onReceiveRemoteShutdown, removeListener, run, sendProtocolMessage, setListenerName, shutdownThread

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.sockets.ConnectionListener

onReceiveConnection, onReceiveLocalShutdown, onReceiveRemoteShutdown

Methods inherited from interface org.safs.sockets.NamedListener

getListenerName

Field Detail

droidprotocolserver

public DroidSocketProtocol droidprotocolserver

a convenient wrapper to AbstractProtocolRunner.protocolserver we should use this field instead of AbstractProtocolRunner.protocolserver

Constructor Detail

SoloRemoteControlRunner

public SoloRemoteControlRunner(SocketProtocolListener listener)

Method Detail

processProtocolMessage

public void processProtocolMessage(java.lang.String message)

Description copied from class: AbstractProtocolRunner

Concrete implementations must insert the parsing and processing of the messages received from the underlying SocketProtocol. Subclasses of AbstractProtocolRunner will usually define the message content and syntax to be appropriate for whatever the application is trying to accomplish. That is, different applications will send and receive different messages.

Specified by:

processProtocolMessage in class AbstractProtocolRunner

onReceiveReady

public void onReceiveReady()

Description copied from interface: SocketProtocolListener

Remote client has issued the READY event

Specified by:

onReceiveReady in interface SocketProtocolListener

onReceiveRunning

public void onReceiveRunning()

Description copied from interface: SocketProtocolListener

Remote client has issued the RUNNING event--usually resulting from a DISPATCH event.

Specified by:

onReceiveRunning in interface SocketProtocolListener

onReceiveResult

public void onReceiveResult(int rc,
                            java.lang.String info)

Description copied from interface: SocketProtocolListener

Remote client has issued the RESULT event and is returning a simple statuscode and statusinfo response.

Specified by:

onReceiveResult in interface SocketProtocolListener

Parameters:

rc - -- int statuscode

info - -- String statusinfo. Can be null. Can be an empty string.

onReceiveResultProperties

public void onReceiveResultProperties(java.util.Properties props)

Description copied from interface: SocketProtocolListener

Remote client has issued the RESULT event and is returning result information in Properties.

Specified by:

onReceiveResultProperties in interface SocketProtocolListener

onReceiveMessage

public void onReceiveMessage(java.lang.String message)

Description copied from interface: SocketProtocolListener

Remote client has sent an arbitrary message. This is for custom communication between an engine and a remote client.

Specified by:

onReceiveMessage in interface SocketProtocolListener

onReceiveException

public void onReceiveException(java.lang.String message)

Description copied from interface: SocketProtocolListener

Remote client has thrown/issued an Exception message.

Specified by:

onReceiveException in interface SocketProtocolListener

sendShutdown

public boolean sendShutdown()

Description copied from class: AbstractProtocolRunner

Send a shutdown command to the remote client. The format or syntax of this will be implementation specific.

A remote client Protocol Runner would implement this as a do-nothing method.

Specified by:

sendShutdown in class AbstractProtocolRunner

Returns:

true if the message was successfully sent.

sendDispatchProps

public boolean sendDispatchProps(java.util.Properties trd)

Description copied from class: AbstractProtocolRunner

Send the remote client a dispatch Properties message containing a Serialized Properties object containing all the data needed for the execution of the Dispatch. The format or syntax of this will be implementation specific.

A remote client Protocol Runner would implement this as a do-nothing method.

Specified by:

sendDispatchProps in class AbstractProtocolRunner

Returns:

true if the message was sent successfully.

sendDispatchFile

public boolean sendDispatchFile(java.lang.String filepath)

Description copied from class: AbstractProtocolRunner

Send the remote client a dispatch file message with the filepath to a file that should be readable by the remote client. The format or syntax of this will be implementation specific.

A remote client Protocol Runner would implement this as a do-nothing method.

Specified by:

sendDispatchFile in class AbstractProtocolRunner

Parameters:

filepath - path to a remote client readable file.

Returns:

true if the message was successfully sent.

sendMessage

public boolean sendMessage(java.lang.String message)

Send the remote client and arbitrary MESSAGE content.

The remote client is expected to forward the message to the test app with the "message:" prefix stripped off. These messages are NOT part of the standard protocol and it is up to the local and remote code to know what to do with them.

Parameters:

message -

Returns:

true if the message was successfully sent.