net.gotev.uploadservice

Class UploadService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

net.gotev.uploadservice.UploadService

All Implemented Interfaces:

ComponentCallbacks, ComponentCallbacks2

public final class UploadService
extends Service

Service to upload files in background using HTTP POST with notification center progress display.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACKOFF_MULTIPLIER Sets the backoff timer multiplier.
static int	BUFFER_SIZE Buffer size in bytes used for data transfer by the upload tasks.
static boolean	EXECUTE_IN_FOREGROUND If set to true, the service will go in foreground mode when doing uploads, lowering the probability of being killed by the system on low memory.
static HttpStack	HTTP_STACK Sets the HTTP Stack to use to perform HTTP based upload requests.
static int	IDLE_TIMEOUT How many time to wait in idle (in milliseconds) before shutting down the service.
static int	INITIAL_RETRY_WAIT_TIME Sets the time to wait in milliseconds before the next attempt when an upload fails for the first time.
static int	KEEP_ALIVE_TIME_IN_SECONDS When the number of threads is greater than UPLOAD_POOL_SIZE, this is the maximum time that excess idle threads will wait for new tasks before terminating.
static int	MAX_RETRY_WAIT_TIME Sets the maximum time to wait in milliseconds between two upload attempts.
static String	NAMESPACE Sets the namespace used to broadcast events.
static int	UPLOAD_POOL_SIZE Sets how many threads to use to handle concurrent uploads.

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, COMPANION_DEVICE_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, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_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
UploadService()

Method Summary

Modifier and Type	Method and Description
static List<String>	getTaskList() Gets the list of the currently active upload tasks.
IBinder	onBind(Intent intent)
void	onCreate()
void	onDestroy()
int	onStartCommand(Intent intent, int flags, int startId)
static boolean	stop(Context context) Stops the service if no upload tasks are currently running
static boolean	stop(Context context, boolean forceStop) Stops the service.
static void	stopAllUploads() Stop all the active uploads.
static void	stopUpload(String uploadId) Stops the upload task with the given uploadId.

Methods inherited from class android.app.Service

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

Methods inherited from class android.content.ContextWrapper

bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createContextForSplit, 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, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startForegroundService, 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

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

Field Detail

UPLOAD_POOL_SIZE

public static int UPLOAD_POOL_SIZE

Sets how many threads to use to handle concurrent uploads.

KEEP_ALIVE_TIME_IN_SECONDS

public static int KEEP_ALIVE_TIME_IN_SECONDS

When the number of threads is greater than UPLOAD_POOL_SIZE, this is the maximum time that excess idle threads will wait for new tasks before terminating.

IDLE_TIMEOUT

public static int IDLE_TIMEOUT

How many time to wait in idle (in milliseconds) before shutting down the service. The service is idle when is running, but no tasks are running.

EXECUTE_IN_FOREGROUND

public static boolean EXECUTE_IN_FOREGROUND

If set to true, the service will go in foreground mode when doing uploads, lowering the probability of being killed by the system on low memory. This setting is used only when your uploads have a notification configuration. It's not possible to run in foreground without notifications, as per Android policy constraints, so if you set this to true, but you do upload tasks without a notification configuration, the service will simply run in background mode. NOTE: As of Android Oreo, this setting is ignored as it always has to be true, because the service must run in the foreground and expose a notification to the user. https://developer.android.com/reference/android/content/Context.html#startForegroundService(android.content.Intent)

NAMESPACE

public static String NAMESPACE

Sets the namespace used to broadcast events. Set this to your app namespace to avoid conflicts and unexpected behaviours.

HTTP_STACK

public static HttpStack HTTP_STACK

Sets the HTTP Stack to use to perform HTTP based upload requests. By default HurlStack implementation is used.

BUFFER_SIZE

public static int BUFFER_SIZE

Buffer size in bytes used for data transfer by the upload tasks.

INITIAL_RETRY_WAIT_TIME

public static int INITIAL_RETRY_WAIT_TIME

Sets the time to wait in milliseconds before the next attempt when an upload fails for the first time. From the second time onwards, this value will be multiplied by BACKOFF_MULTIPLIER to get the time to wait before the next attempt.

BACKOFF_MULTIPLIER

public static int BACKOFF_MULTIPLIER

Sets the backoff timer multiplier. By default is set to 2, so every time that an upload fails, the time to wait between retries will be multiplied by 2. E.g. if the first time the wait time is 1s, the second time it will be 2s and the third time it will be 4s.

MAX_RETRY_WAIT_TIME

public static int MAX_RETRY_WAIT_TIME

Sets the maximum time to wait in milliseconds between two upload attempts. This is useful because every time an upload fails, the wait time gets multiplied by BACKOFF_MULTIPLIER and it's not convenient that the value grows indefinitely.

Constructor Detail

UploadService

public UploadService()

Method Detail

stopUpload

public static void stopUpload(String uploadId)

Stops the upload task with the given uploadId.

Parameters:

uploadId - The unique upload id

getTaskList

public static List<String> getTaskList()

Gets the list of the currently active upload tasks.

Returns:

list of uploadIDs or an empty list if no tasks are currently running

stopAllUploads

public static void stopAllUploads()

Stop all the active uploads.

stop

public static boolean stop(Context context)

Stops the service if no upload tasks are currently running

Parameters:

context - application context

Returns:

true if the service is getting stopped, false otherwise

stop

public static boolean stop(Context context,
                           boolean forceStop)

Stops the service.

Parameters:

context - application context

forceStop - stops the service no matter if some tasks are running

Returns:

true if the service is getting stopped, false otherwise

onCreate

public void onCreate()

Overrides:

onCreate in class Service

onBind

public IBinder onBind(Intent intent)

Specified by:

onBind in class Service

onStartCommand

public int onStartCommand(Intent intent,
                          int flags,
                          int startId)

Overrides:

onStartCommand in class Service

onDestroy

public void onDestroy()

Overrides:

onDestroy in class Service