net.gotev.uploadservice

Class HttpUploadRequest<B extends HttpUploadRequest<B>>

java.lang.Object

net.gotev.uploadservice.UploadRequest<B>

net.gotev.uploadservice.HttpUploadRequest<B>

Direct Known Subclasses:

BinaryUploadRequest, MultipartUploadRequest

public abstract class HttpUploadRequest<B extends HttpUploadRequest<B>>
extends UploadRequest<B>

Represents a generic HTTP upload request.
Subclass to create your own custom HTTP 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
B	addArrayParameter(String paramName, List<String> list) Adds a parameter with multiple values to this upload request.
B	addArrayParameter(String paramName, String... array) Adds a parameter with multiple values to this upload request.
B	addHeader(String headerName, String headerValue) Adds a header to this upload request.
B	addParameter(String paramName, String paramValue) Adds a parameter to this upload request.
B	setBasicAuth(String username, String password) Sets the HTTP Basic Authentication header.
B	setCustomUserAgent(String customUserAgent) Sets the custom user agent to use for this upload request.
B	setMethod(String method) Sets the HTTP method to use.
B	setUsesFixedLengthStreamingMode(boolean fixedLength) Sets if this upload request is using fixed length streaming mode.

Methods inherited from class net.gotev.uploadservice.UploadRequest

setAutoDeleteFilesAfterSuccessfulUpload, setDelegate, setMaxRetries, setNotificationConfig, startUpload

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)
                  throws MalformedURLException,
                         IllegalArgumentException

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

Throws:

IllegalArgumentException - if one or more arguments are not valid

MalformedURLException - if the server URL is not valid

Method Detail

addHeader

public B addHeader(String headerName,
                   String headerValue)

Adds a header to this upload request.

Parameters:

headerName - header name

headerValue - header value

Returns:

self instance

setBasicAuth

public B setBasicAuth(String username,
                      String password)

Sets the HTTP Basic Authentication header.

Parameters:

username - HTTP Basic Auth username

password - HTTP Basic Auth password

Returns:

self instance

addParameter

public B addParameter(String paramName,
                      String paramValue)

Adds a parameter to this upload request.

Parameters:

paramName - parameter name

paramValue - parameter value

Returns:

self instance

addArrayParameter

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

Adds a parameter with multiple values to this upload request.

Parameters:

paramName - parameter name

array - values

Returns:

self instance

addArrayParameter

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

Adds a parameter with multiple values to this upload request.

Parameters:

paramName - parameter name

list - values

Returns:

self instance

setMethod

public B setMethod(String method)

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

Parameters:

method - new HTTP method to use

Returns:

self instance

setCustomUserAgent

public B 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:

self instance

setUsesFixedLengthStreamingMode

public B 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:

self instance