org.safs.android.remotecontrol

Class RemoteControlUI

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.safs.android.remotecontrol.RemoteControlUI

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, ConnectionListener, NamedListener, SocketProtocolListener

public class RemoteControlUI
extends javax.swing.JFrame
implements SocketProtocolListener, java.awt.event.ActionListener

Crude Test app for initial manual testing of SAFS Robotium Remote Control extension. This app provides a minimalist crude UI for manually entering and sending messages using SAFSRemoteControl implementing a SocketProtocol to communicate and control Android automation on a remote device or emulator.

Note this has been tested on both a real device and the Emulator. To use the Emulator you must have a working Emulator and AVD.

SampleCommand used to launch the emulator with an appropriate AVD:

emulator -no-snapstorage -avd SprintEvo

Steps to test the remote control concept:

1. Insure the Android SAFS TCP Messenger APK has been built and installed on the device or emulator:

   ant debug
   adb install -r bin\SAFSTCPMessenger-debug.apk

2. Insure the SAFS Test Runner AndroidManifest.xml has the correct android:targetPackage setting for the application to be tested--whatever that is:
   

       <instrumentation android:name="org.safs.android.engine.DSAFSTestRunner"
                     android:targetPackage="com.android.example.spinner"
                     android:label="General-Purpose SAFS Test Runner"/>
    

3. Insure the SAFSTestRunner APK has been built and installed on the device or emulator:

   ant debug
   adb install -r bin\SAFSTestRunner-debug.apk

4. Insure the application to be tested has been installed on the device or emulator.

5. For the emulator, insure port forwarding has been activated:
   

   adb forward tcp:2411 tcp:2410
   

6. In a separate CMD window, monitor "adb logcat"

7. In a separate CMD window, launch the SAFS Test Runner:

   adb shell am instrument -w org.safs.android.engine/org.safs.android.engine.DSAFSTestRunner

   You should see a SAFS TCP Messenger notification appear in the notification area on the device\emulator and there should be logcat messages showing the status of the SAFS Test Runner registering with the SAFS TCP Messenger.

8. Launch the RemoteControlUI:

   java org.safs.android.remotecontrol.RemoteControlUI

9. Press the "Connect" button to attempt to establish remote control connection with the SAFS TCP Messenger on the device/emulator. Monitor the logcat to see the status of this. If everything worked the RemoteControlUI status line should read "REMOTE READY".

10. Type "launch" and press "Send". The target app launcher Activity should get launched.

11. Type "close" and press "Send". The target app should shutdown.

12. Press the "Dispatch" button to perform a roundtrip dispatch of a Properties object.
    The adb logcat window should show the properties received remotely on the Test Runner and the RemoteControlUI should then show a Dialog of the same properties PLUS statuscode and statusinfo properties returned back from the Test Runner.

13. Press the "Shutdown" button and the remote SAFS Test Runner and SAFS TCP Messenger should both shutdown and the Notification icon on the device/emulator should disappear.

14. RemoteControlUI will not be able to connect again until you relaunch the Instrumentation test again and the appropriate Notification is present on the emulator or device.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

SAFSRemoteControl, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) javax.swing.JTextField	cmdField
(package private) javax.swing.JLabel	cmdLabel
(package private) java.lang.String	connectAction
(package private) javax.swing.JButton	connectButton
(package private) javax.swing.JPanel	controls
(package private) java.lang.String	dispatchPropsAction
(package private) javax.swing.JButton	dispatchPropsButton
(package private) java.util.Properties	props
(package private) java.lang.String	sendAction
(package private) javax.swing.JButton	sendButton
(package private) SAFSRemoteControl	server
(package private) java.lang.String	shutdownAction
(package private) javax.swing.JButton	shutdownButton
(package private) javax.swing.JTextField	status

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.safs.sockets.SocketProtocolListener

DEFAULT_NAME

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
RemoteControlUI()
RemoteControlUI(java.lang.String title)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
(package private) void	createUI()
protected void	disableInteraction()
protected void	enableInteraction()
(package private) java.util.Properties	fillProperties()
java.lang.String	getListenerName() Unique name to identify the listener.
static void	main(java.lang.String[] args) java org.safs.android.RemoteControlUI
(package private) void	onConnectAction()
(package private) void	onDispatchPropsAction()
void	onReceiveConnection() Called when a 2-way sockets connection has been established.
void	onReceiveDebug(java.lang.String message)
void	onReceiveException(java.lang.String message) Remote client has thrown/issued an Exception message.
void	onReceiveLocalShutdown(int cause) A local source has issued a SHUTDOWN event/command.
void	onReceiveMessage(java.lang.String message) Remote client has sent an arbitrary message.
void	onReceiveReady() Remote client has issued the READY event
void	onReceiveRemoteShutdown(int cause) A remote source has issued a SHUTDOWN event/command.
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 result) 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.
(package private) void	onSendAction()
(package private) void	onShutdownAction()
protected void	shutdownRemoteControl()

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

server

SAFSRemoteControl server

controls

javax.swing.JPanel controls

cmdLabel

javax.swing.JLabel cmdLabel

cmdField

javax.swing.JTextField cmdField

sendAction

java.lang.String sendAction

connectAction

java.lang.String connectAction

shutdownAction

java.lang.String shutdownAction

dispatchPropsAction

java.lang.String dispatchPropsAction

sendButton

javax.swing.JButton sendButton

connectButton

javax.swing.JButton connectButton

shutdownButton

javax.swing.JButton shutdownButton

dispatchPropsButton

javax.swing.JButton dispatchPropsButton

status

javax.swing.JTextField status

props

java.util.Properties props

Constructor Detail

RemoteControlUI

public RemoteControlUI()
                throws java.awt.HeadlessException

Throws:

java.awt.HeadlessException

RemoteControlUI

public RemoteControlUI(java.lang.String title)
                throws java.awt.HeadlessException

Throws:

java.awt.HeadlessException

Method Detail

fillProperties

java.util.Properties fillProperties()

createUI

void createUI()

onConnectAction

void onConnectAction()

onSendAction

void onSendAction()

onDispatchPropsAction

void onDispatchPropsAction()

onShutdownAction

void onShutdownAction()

disableInteraction

protected void disableInteraction()

enableInteraction

protected void enableInteraction()

getListenerName

public java.lang.String getListenerName()

Description copied from interface: NamedListener

Unique name to identify the listener.

Specified by:

getListenerName in interface NamedListener

Returns:

name of listener. Might be null.

onReceiveConnection

public void onReceiveConnection()

Description copied from interface: ConnectionListener

Called when a 2-way sockets connection has been established.

Specified by:

onReceiveConnection in interface ConnectionListener

onReceiveDebug

public void onReceiveDebug(java.lang.String message)

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 result)

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

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

main

public static void main(java.lang.String[] args)

java org.safs.android.RemoteControlUI

Parameters:

args - -- none

shutdownRemoteControl

protected void shutdownRemoteControl()

onReceiveLocalShutdown

public void onReceiveLocalShutdown(int cause)

Description copied from interface: ConnectionListener

A local source has issued a SHUTDOWN event/command.

Specified by:

onReceiveLocalShutdown in interface ConnectionListener

Parameters:

cause - is used to indicate whether the shutdown is due to normal or abnormal circumstances.

See Also:

SocketProtocol.STATUS_SHUTDOWN_NORMAL, SocketProtocol.STATUS_SHUTDOWN_REMOTE_CLIENT

onReceiveRemoteShutdown

public void onReceiveRemoteShutdown(int cause)

Description copied from interface: ConnectionListener

A remote source has issued a SHUTDOWN event/command.

Specified by:

onReceiveRemoteShutdown in interface ConnectionListener

Parameters:

cause - is used to indicate whether the shutdown is due to normal or abnormal circumstances.

See Also:

SocketProtocol.STATUS_SHUTDOWN_NORMAL, SocketProtocol.STATUS_SHUTDOWN_REMOTE_CLIENT

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