net.gotev.uploadservice

Class BinaryUploadRequest

java.lang.Object

net.gotev.uploadservice.UploadRequest<B>

net.gotev.uploadservice.HttpUploadRequest<BinaryUploadRequest>

net.gotev.uploadservice.BinaryUploadRequest

public class BinaryUploadRequest
extends HttpUploadRequest<BinaryUploadRequest>

Binary file upload request. The binary upload uses a single file as the raw body of the upload request.

Constructor Summary

Constructors

Constructor and Description
BinaryUploadRequest(Context context, String serverUrl) Creates a new binaryupload request and automatically generates an upload id, that will be returned when you call UploadRequest.startUpload().
BinaryUploadRequest(Context context, String uploadId, String serverUrl) Creates a binary file upload request.

Method Summary

Modifier and Type	Method and Description
BinaryUploadRequest	addArrayParameter(String paramName, List<String> list) Adds a parameter with multiple values to this upload request.
BinaryUploadRequest	addArrayParameter(String paramName, String... array) Adds a parameter with multiple values to this upload request.
BinaryUploadRequest	addParameter(String paramName, String paramValue) Adds a parameter to this upload request.
BinaryUploadRequest	setFileToUpload(String path) Sets the file used as raw body of the upload request.
String	startUpload() Start the background file upload service.

Methods inherited from class net.gotev.uploadservice.HttpUploadRequest

addHeader, setBasicAuth, setCustomUserAgent, setMethod, setUsesFixedLengthStreamingMode

Methods inherited from class net.gotev.uploadservice.UploadRequest

setAutoDeleteFilesAfterSuccessfulUpload, setDelegate, setMaxRetries, setNotificationConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryUploadRequest

public BinaryUploadRequest(Context context,
                           String uploadId,
                           String serverUrl)
                    throws IllegalArgumentException,
                           MalformedURLException

Creates a binary file upload request.

Parameters:

context - application context

uploadId - unique ID to assign to this upload request.
It can be whatever string you want, as long as it's unique. If you set it to null or an empty string, an UUID will be automatically generated.
It's advised to keep a reference to it in your code, so when you receive status updates in UploadServiceBroadcastReceiver, you know to which upload they refer to.

serverUrl - URL of the server side script that will handle the multipart form upload. E.g.: http://www.yourcompany.com/your/script

Throws:

IllegalArgumentException - if one or more arguments are not valid

MalformedURLException - if the server URL is not valid

BinaryUploadRequest

public BinaryUploadRequest(Context context,
                           String serverUrl)
                    throws MalformedURLException,
                           IllegalArgumentException

Creates a new binaryupload request and automatically generates an upload id, that will be returned when you call UploadRequest.startUpload().

Parameters:

context - application context

serverUrl - URL of the server side script that will handle the multipart form upload. E.g.: http://www.yourcompany.com/your/script

Throws:

IllegalArgumentException - if one or more arguments are not valid

MalformedURLException - if the server URL is not valid

Method Detail

setFileToUpload

public BinaryUploadRequest setFileToUpload(String path)
                                    throws FileNotFoundException

Sets the file used as raw body of the upload request.

Parameters:

path - path to the file that you want to upload

Returns:

BinaryUploadRequest

Throws:

FileNotFoundException - if the file to upload does not exist

addParameter

public BinaryUploadRequest addParameter(String paramName,
                                        String paramValue)

Description copied from class: HttpUploadRequest

Adds a parameter to this upload request.

Overrides:

addParameter in class HttpUploadRequest<BinaryUploadRequest>

Parameters:

paramName - parameter name

paramValue - parameter value

Returns:

self instance

addArrayParameter

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

Description copied from class: HttpUploadRequest

Adds a parameter with multiple values to this upload request.

Overrides:

addArrayParameter in class HttpUploadRequest<BinaryUploadRequest>

Parameters:

paramName - parameter name

array - values

Returns:

self instance

addArrayParameter

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

Description copied from class: HttpUploadRequest

Adds a parameter with multiple values to this upload request.

Overrides:

addArrayParameter in class HttpUploadRequest<BinaryUploadRequest>

Parameters:

paramName - parameter name

list - values

Returns:

self instance

startUpload

public String startUpload()

Description copied from class: UploadRequest

Start the background file upload service.

Overrides:

startUpload in class UploadRequest<BinaryUploadRequest>

Returns:

the uploadId string. If you have passed your own uploadId in the constructor, this method will return that same uploadId, otherwise it will return the automatically generated uploadId