org.safs.android.messenger

Class MessengerService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

org.safs.android.messenger.MessengerService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, MessengerListener, MultipleParcelListener, RemoteClientListener, ConnectionListener, DebugListener, NamedListener

public class MessengerService
extends android.app.Service
implements RemoteClientListener, DebugListener, MessengerListener

TCP Messenger Service acting as intermediary between a remote test controller communicating over TCP Sockets and an Android test package expecting two-way communication for receiving test commands and returning test results and data. This Service allows a test package with no INTERNET permissions to effectively be remotely controlled via TCP Sockets.

This Service handles the TCP Sockets communication with the remote test controller and forwards all data exchanges with the local test package via the Inter-Process Communication Messenger facilities provided by the Android OS.

Currently, this service is accepting connections on port 2410. Currently, the remote controller server uses port 2411 to contact and attempt a connection to this service. Both sides eventually need to be able to use a broader range of ports to prevent conflicts with other system resources.

When using the Android Emulator, the emulator must be configured to "see" Socket requests on its local port 2410 coming from the controller on port 2411. Do this with the adb forwarding command to the running emulator as follows:

adb forward tcp:2411 tcp:2410

There is an initial handshake or verification that occurs between the remote controller server and this Service to confirm the device port owner is a SAFS TCP Messenger Service.

Since:

FEB 04, 2012 (CarlNagle) Initial version
APR 25, 2013 (LeiWang) Handle message of big size.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

org.safs.sockets.RemoteClientRunner

Field Summary

Fields

Modifier and Type	Field and Description
(package private) android.os.Messenger	engineMessenger
static java.lang.String	KEY_ENGINE_NAME
(package private) android.app.NotificationManager	mNM
(package private) MessengerHandler	mServiceHandler
(package private) android.os.Looper	mServiceLooper
static int	NOTIFICATION_DEFAULT_ID
static java.lang.CharSequence	NOTIFICATION_TEXT
(package private) Message	safs
(package private) android.os.Messenger	serviceMessenger
static java.lang.String	TAG
(package private) RemoteClientRunner	tcpServer

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
MessengerService()

Method Summary

Modifier and Type	Method and Description
protected void	debug(java.lang.String text)
java.lang.String	getListenerName() Unique name to identify the listener.
void	onAllParcelsHaveBeenHandled(java.lang.String messageID)
android.os.IBinder	onBind(android.content.Intent intent) Capture the Message handler for the test package that is binding with the Service.
void	onCreate()
void	onDestroy() Cancel any Notification we have as we die and shutdown our SocketServer.
void	onEngineDebug(java.lang.String message)
void	onEngineException(java.lang.String message)
void	onEngineMessage(java.lang.String message)
void	onEngineReady()
void	onEngineRegistered(android.os.Messenger messenger)
void	onEngineResult(int statuscode, java.lang.String statusinfo)
void	onEngineResultProps(char[] props)
void	onEngineRunning()
void	onEngineShutdown(int cause)
void	onEngineUnRegistered()
void	onMessengerDebug(java.lang.String message)
void	onParcelHasBeenHandled(java.lang.String messageID, int index)
void	onReceiveConnection() Called when a 2-way sockets connection has been established.
void	onReceiveDebug(java.lang.String text) A remote client has sent a Debug message to be logged by the listener.
void	onReceiveDispatchFile(java.lang.String filepath)
void	onReceiveDispatchProps(char[] props)
void	onReceiveLocalShutdown(int cause) The service has shutdown.
void	onReceiveMessage(java.lang.String message)
void	onReceiveRemoteShutdown(int cause) The controller has requested a shutdown.
int	onStartCommand(android.content.Intent intent, int flags, int startId) Automatically called when the Service is being started up--usually from the test package engine requesting to bind with the Service.
protected void	sendIPCMessage(int what)
protected void	sendIPCMessage(int what, char[] props)
protected void	sendIPCMessage(int what, java.lang.String msgobj)
protected void	sendServiceParcelAcknowledge(java.lang.String messageID, int index)
protected void	sendTCPMessage(java.lang.String message)

Methods inherited from class android.app.Service

dump, getApplication, onConfigurationChanged, onLowMemory, onRebind, onStart, onTaskRemoved, onTrimMemory, onUnbind, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

KEY_ENGINE_NAME

public static final java.lang.String KEY_ENGINE_NAME

See Also:

Constant Field Values

NOTIFICATION_TEXT

public static final java.lang.CharSequence NOTIFICATION_TEXT

NOTIFICATION_DEFAULT_ID

public static final int NOTIFICATION_DEFAULT_ID

See Also:

Constant Field Values

mNM

android.app.NotificationManager mNM

tcpServer

RemoteClientRunner tcpServer

mServiceLooper

android.os.Looper mServiceLooper

mServiceHandler

MessengerHandler mServiceHandler

serviceMessenger

android.os.Messenger serviceMessenger

engineMessenger

android.os.Messenger engineMessenger

safs

Message safs

Constructor Detail

MessengerService

public MessengerService()

Method Detail

debug

protected void debug(java.lang.String text)

onReceiveDebug

public void onReceiveDebug(java.lang.String text)

Description copied from interface: DebugListener

A remote client has sent a Debug message to be logged by the listener.

Specified by:

onReceiveDebug in interface DebugListener

onCreate

public void onCreate()

Overrides:

onCreate in class android.app.Service

See Also:

Service.onBind(android.content.Intent)

onStartCommand

public int onStartCommand(android.content.Intent intent,
                          int flags,
                          int startId)

Automatically called when the Service is being started up--usually from the test package engine requesting to bind with the Service.

Overrides:

onStartCommand in class android.app.Service

onBind

public android.os.IBinder onBind(android.content.Intent intent)

Capture the Message handler for the test package that is binding with the Service.

Specified by:

onBind in class android.app.Service

See Also:

Service.onBind(android.content.Intent)

onDestroy

public void onDestroy()

Cancel any Notification we have as we die and shutdown our SocketServer.

Overrides:

onDestroy in class android.app.Service

See Also:

Service.onDestroy()

sendTCPMessage

protected void sendTCPMessage(java.lang.String message)

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.

onMessengerDebug

public void onMessengerDebug(java.lang.String message)

Specified by:

onMessengerDebug in interface MessengerListener

onEngineDebug

public void onEngineDebug(java.lang.String message)

Specified by:

onEngineDebug in interface MessengerListener

onEngineException

public void onEngineException(java.lang.String message)

Specified by:

onEngineException in interface MessengerListener

onEngineMessage

public void onEngineMessage(java.lang.String message)

Specified by:

onEngineMessage in interface MessengerListener

onEngineResult

public void onEngineResult(int statuscode,
                           java.lang.String statusinfo)

Specified by:

onEngineResult in interface MessengerListener

onEngineResultProps

public void onEngineResultProps(char[] props)

Specified by:

onEngineResultProps in interface MessengerListener

onEngineShutdown

public void onEngineShutdown(int cause)

Specified by:

onEngineShutdown in interface MessengerListener

onEngineReady

public void onEngineReady()

Specified by:

onEngineReady in interface MessengerListener

onEngineRegistered

public void onEngineRegistered(android.os.Messenger messenger)

Specified by:

onEngineRegistered in interface MessengerListener

onEngineUnRegistered

public void onEngineUnRegistered()

Specified by:

onEngineUnRegistered in interface MessengerListener

onEngineRunning

public void onEngineRunning()

Specified by:

onEngineRunning in interface MessengerListener

sendIPCMessage

protected void sendIPCMessage(int what)

sendServiceParcelAcknowledge

protected void sendServiceParcelAcknowledge(java.lang.String messageID,
                                            int index)

sendIPCMessage

protected void sendIPCMessage(int what,
                              java.lang.String msgobj)

sendIPCMessage

protected void sendIPCMessage(int what,
                              char[] props)

onReceiveDispatchFile

public void onReceiveDispatchFile(java.lang.String filepath)

Specified by:

onReceiveDispatchFile in interface RemoteClientListener

onReceiveDispatchProps

public void onReceiveDispatchProps(char[] props)

Specified by:

onReceiveDispatchProps in interface RemoteClientListener

onReceiveMessage

public void onReceiveMessage(java.lang.String message)

Specified by:

onReceiveMessage in interface RemoteClientListener

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

onReceiveRemoteShutdown

public void onReceiveRemoteShutdown(int cause)

The controller has requested a shutdown.

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

onReceiveLocalShutdown

public void onReceiveLocalShutdown(int cause)

The service has shutdown. Catastrophic?

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

onAllParcelsHaveBeenHandled

public void onAllParcelsHaveBeenHandled(java.lang.String messageID)

Specified by:

onAllParcelsHaveBeenHandled in interface MultipleParcelListener

onParcelHasBeenHandled

public void onParcelHasBeenHandled(java.lang.String messageID,
                                   int index)

Specified by:

onParcelHasBeenHandled in interface MultipleParcelListener