org.jboss.aerogear.android.sync

Class SyncService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

android.app.IntentService

org.jboss.aerogear.android.sync.SyncService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

public class SyncService
extends android.app.IntentService

Activities can bind to this service and use it to send documents to a sync server instance. Additionally they can subscribe to update events from this service. To activate this service in your AndroidManifest.xml include the following:

         <service android:name="org.jboss.aerogear.android.sync.SyncService">
           <meta-data
               android:name="serverPort"
               android:value="8080" />
           <meta-data
               android:name="serverHost"
               android:value="10.0.2.2" />
           <meta-data
               android:name="serverPath"
               android:value="/websocket-wildfly-0.1-SNAPSHOT/hello" />
       </service>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncService.SyncServiceBinder This binder is used to retrieve a reference to the SyncService.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_INTENT
static String	SERVER_HOST
static String	SERVER_PATH
static String	SERVER_PORT

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

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_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_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, 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, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_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
SyncService()

Method Summary

Modifier and Type	Method and Description
void	addDocument(org.jboss.aerogear.sync.ClientDocument<com.fasterxml.jackson.databind.JsonNode> clientDocument) Adds a ClientDocument to this service's SyncClient.
void	diffAndSend(org.jboss.aerogear.sync.ClientDocument<com.fasterxml.jackson.databind.JsonNode> clientDocument) Sends a ClientDocument to the service's SyncClient to prepare a diff and send to the server.
String	getClientId() The clientId identifies a connection to the remote server.
android.os.IBinder	onBind(android.content.Intent intent)
void	onCreate()
void	onDestroy()
protected void	onHandleIntent(android.content.Intent serviceIntent) This handles intents send from the broadcast receiver.
int	onStartCommand(android.content.Intent intent, int flags, int startId)
void	subscribe(SyncServerConnectionListener<com.fasterxml.jackson.databind.JsonNode> observer) Registers an SyncServerConnectionListener to receive events from the sync server.
void	unsubscribe(SyncServerConnectionListener<com.fasterxml.jackson.databind.JsonNode> observer) Removes an SyncServerConnectionListener from the list of objects receiving sync and connection events..

Methods inherited from class android.app.IntentService

onStart, setIntentRedelivery

Methods inherited from class android.app.Service

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

Methods inherited from class android.content.ContextWrapper

attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isRestricted, 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

getDrawable, getString, getString, 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

SERVER_HOST

public static final String SERVER_HOST

See Also:

Constant Field Values

SERVER_PORT

public static final String SERVER_PORT

See Also:

Constant Field Values

SERVER_PATH

public static final String SERVER_PATH

See Also:

Constant Field Values

MESSAGE_INTENT

public static final String MESSAGE_INTENT

See Also:

Constant Field Values

Constructor Detail

SyncService

public SyncService()

Method Detail

addDocument

public void addDocument(org.jboss.aerogear.sync.ClientDocument<com.fasterxml.jackson.databind.JsonNode> clientDocument)

Adds a ClientDocument to this service's SyncClient.

Parameters:

clientDocument - the document to add to the SyncClient

diffAndSend

public void diffAndSend(org.jboss.aerogear.sync.ClientDocument<com.fasterxml.jackson.databind.JsonNode> clientDocument)

Sends a ClientDocument to the service's SyncClient to prepare a diff and send to the server.

Parameters:

clientDocument - the document to send a diff to the sync server

subscribe

public void subscribe(SyncServerConnectionListener<com.fasterxml.jackson.databind.JsonNode> observer)

Registers an SyncServerConnectionListener to receive events from the sync server. The observer will also receive connection events from the Service.

Parameters:

observer - the observer to subscribe.

unsubscribe

public void unsubscribe(SyncServerConnectionListener<com.fasterxml.jackson.databind.JsonNode> observer)

Removes an SyncServerConnectionListener from the list of objects receiving sync and connection events..

Parameters:

observer - the observer to remove.

onBind

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

Overrides:

onBind in class android.app.IntentService

onHandleIntent

protected void onHandleIntent(android.content.Intent serviceIntent)

This handles intents send from the broadcast receiver.

Specified by:

onHandleIntent in class android.app.IntentService

Parameters:

serviceIntent - The Intent from the broadcast receiver

onCreate

public void onCreate()

Overrides:

onCreate in class android.app.IntentService

onStartCommand

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

Overrides:

onStartCommand in class android.app.IntentService

onDestroy

public void onDestroy()

Overrides:

onDestroy in class android.app.IntentService

getClientId

public String getClientId()

The clientId identifies a connection to the remote server.

Returns:

the clientId