net.gotev.uploadservice

Class HttpUploadRequest

java.lang.Object

net.gotev.uploadservice.HttpUploadRequest

Direct Known Subclasses:

BinaryUploadRequest, MultipartUploadRequest

public abstract class HttpUploadRequest
extends Object

Represents a generic HTTP upload request.
Subclass to create your own custom upload request.

Constructor Summary

Constructors

Constructor and Description
HttpUploadRequest(Context context, String uploadId, String serverUrl) Creates a new http upload request.

Method Summary

Modifier and Type	Method and Description
HttpUploadRequest	addArrayParameter(String paramName, List<String> list) Adds a parameter with multiple values to this upload request.
HttpUploadRequest	addArrayParameter(String paramName, String... array) Adds a parameter with multiple values to this upload request.
HttpUploadRequest	addHeader(String headerName, String headerValue) Adds a header to this upload request.
HttpUploadRequest	addParameter(String paramName, String paramValue) Adds a parameter to this upload request.
HttpUploadRequest	setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles) Sets the automatic file deletion after successful upload.
HttpUploadRequest	setBasicAuth(String username, String password) Sets the HTTP Basic Authentication header.
HttpUploadRequest	setCustomUserAgent(String customUserAgent) Sets the custom user agent to use for this upload request.
HttpUploadRequest	setMaxRetries(int maxRetries) Sets the maximum number of retries that the library will do if an error occurs, before returning an error.
HttpUploadRequest	setMethod(String method) Sets the HTTP method to use.
HttpUploadRequest	setNotificationConfig(UploadNotificationConfig config) Sets custom notification configuration.
HttpUploadRequest	setUsesFixedLengthStreamingMode(boolean fixedLength) Sets if this upload request is using fixed length streaming mode.
String	startUpload() Start the background file upload service.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpUploadRequest

public HttpUploadRequest(Context context,
                         String uploadId,
                         String serverUrl)

Creates a new http upload request.

Parameters:

context - application context

uploadId - unique ID to assign to this upload request. If is null or empty, a random UUID will be automatically generated. It's used in the broadcast receiver when receiving updates.

serverUrl - URL of the server side script that handles the request

Method Detail

startUpload

public final String startUpload()
                         throws IllegalArgumentException,
                                MalformedURLException

Start the background file upload service.

Returns:

the uploadId string

Throws:

IllegalArgumentException - if one or more arguments passed are invalid

MalformedURLException - if the server URL is not valid

setNotificationConfig

public HttpUploadRequest setNotificationConfig(UploadNotificationConfig config)

Sets custom notification configuration. If you don't want to display a notification in Notification Center, either pass null as argument or don't call this method.

Parameters:

config - the upload configuration object or null if you don't want a notification to be displayed

Returns:

HttpUploadRequest

setAutoDeleteFilesAfterSuccessfulUpload

public HttpUploadRequest setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles)

Sets the automatic file deletion after successful upload.

Parameters:

autoDeleteFiles - true to auto delete files included in the request when the upload is completed successfully. By default this setting is set to false, and nothing gets deleted.

Returns:

HttpUploadRequest

addHeader

public HttpUploadRequest addHeader(String headerName,
                                   String headerValue)

Adds a header to this upload request.

Parameters:

headerName - header name

headerValue - header value

Returns:

HttpUploadRequest

setBasicAuth

public HttpUploadRequest setBasicAuth(String username,
                                      String password)

Sets the HTTP Basic Authentication header.

Parameters:

username - HTTP Basic Auth username

password - HTTP Basic Auth password

Returns:

HttpUploadRequest

addParameter

public HttpUploadRequest addParameter(String paramName,
                                      String paramValue)

Adds a parameter to this upload request.

Parameters:

paramName - parameter name

paramValue - parameter value

Returns:

HttpUploadRequest

addArrayParameter

public HttpUploadRequest addArrayParameter(String paramName,
                                           String... array)

Adds a parameter with multiple values to this upload request.

Parameters:

paramName - parameter name

array - values

Returns:

HttpUploadRequest

addArrayParameter

public HttpUploadRequest addArrayParameter(String paramName,
                                           List<String> list)

Adds a parameter with multiple values to this upload request.

Parameters:

paramName - parameter name

list - values

Returns:

HttpUploadRequest

setMethod

public HttpUploadRequest setMethod(String method)

Sets the HTTP method to use. By default it's set to POST.

Parameters:

method - new HTTP method to use

Returns:

HttpUploadRequest

setCustomUserAgent

public HttpUploadRequest setCustomUserAgent(String customUserAgent)

Sets the custom user agent to use for this upload request. Note! If you set the "User-Agent" header by using the "addHeader" method, that setting will be overwritten by the value set with this method.

Parameters:

customUserAgent - custom user agent string

Returns:

HttpUploadRequest

setMaxRetries

public HttpUploadRequest setMaxRetries(int maxRetries)

Sets the maximum number of retries that the library will do if an error occurs, before returning an error.

Parameters:

maxRetries - number of maximum retries on error

Returns:

HttpUploadRequest

setUsesFixedLengthStreamingMode

public HttpUploadRequest setUsesFixedLengthStreamingMode(boolean fixedLength)

Sets if this upload request is using fixed length streaming mode. If it uses fixed length streaming mode, then the value returned by HttpUploadTask.getBodyLength() will be automatically used to properly set the underlying HttpURLConnection, otherwise chunked streaming mode will be used.

Parameters:

fixedLength - true to use fixed length streaming mode (this is the default setting) or false to use chunked streaming mode.

Returns:

HttpUploadRequest