net.gotev.uploadservice

Class MultipartUploadRequest

java.lang.Object

net.gotev.uploadservice.UploadRequest<B>

net.gotev.uploadservice.HttpUploadRequest<MultipartUploadRequest>

net.gotev.uploadservice.MultipartUploadRequest

public class MultipartUploadRequest
extends HttpUploadRequest<MultipartUploadRequest>

HTTP/Multipart upload request. This is the most common way to upload files on a server. It's the same kind of request that browsers do when you use the <form> tag with one or more files.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MultipartUploadRequest	addFileToUpload(String path, String parameterName) Adds a file to this upload request, without setting file name and content type.
MultipartUploadRequest	addFileToUpload(String path, String parameterName, String fileName) Adds a file to this upload request, without setting the content type, which will be automatically detected from the file extension.
MultipartUploadRequest	addFileToUpload(String filePath, String parameterName, String fileName, String contentType) Adds a file to this upload request.
MultipartUploadRequest	setUtf8Charset() Sets the charset for this multipart request to UTF-8.

Methods inherited from class net.gotev.uploadservice.HttpUploadRequest

addArrayParameter, addArrayParameter, addHeader, addParameter, setBasicAuth, setCustomUserAgent, setMethod, setUsesFixedLengthStreamingMode

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

MultipartUploadRequest

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

Creates a new multipart 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

MultipartUploadRequest

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

Creates a new multipart upload 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

addFileToUpload

public MultipartUploadRequest addFileToUpload(String filePath,
                                              String parameterName,
                                              String fileName,
                                              String contentType)
                                       throws FileNotFoundException,
                                              IllegalArgumentException

Adds a file to this upload request.

Parameters:

filePath - path to the file that you want to upload

parameterName - Name of the form parameter that will contain file's data

fileName - File name seen by the server side script. If null, the original file name will be used

contentType - Content type of the file. You can use constants defined in ContentType class. Set this to null or empty string to try to automatically detect the mime type from the file. If the mime type can't be detected, application/octet-stream will be used by default

Returns:

MultipartUploadRequest

Throws:

FileNotFoundException - if the file does not exist at the specified path

IllegalArgumentException - if one or more parameters are not valid

addFileToUpload

public MultipartUploadRequest addFileToUpload(String path,
                                              String parameterName,
                                              String fileName)
                                       throws FileNotFoundException,
                                              IllegalArgumentException

Adds a file to this upload request, without setting the content type, which will be automatically detected from the file extension. If you want to manually set the content type, use addFileToUpload(String, String, String, String).

Parameters:

path - Absolute path to the file that you want to upload

parameterName - Name of the form parameter that will contain file's data

fileName - File name seen by the server side script. If null, the original file name will be used

Returns:

MultipartUploadRequest

Throws:

FileNotFoundException - if the file does not exist at the specified path

IllegalArgumentException - if one or more parameters are not valid

addFileToUpload

public MultipartUploadRequest addFileToUpload(String path,
                                              String parameterName)
                                       throws FileNotFoundException,
                                              IllegalArgumentException

Adds a file to this upload request, without setting file name and content type. The original file name will be used instead. If you want to manually set the file name seen by the server side script and the content type, use addFileToUpload(String, String, String, String)

Parameters:

path - Absolute path to the file that you want to upload

parameterName - Name of the form parameter that will contain file's data

Returns:

MultipartUploadRequest

Throws:

FileNotFoundException - if the file does not exist at the specified path

IllegalArgumentException - if one or more parameters are not valid

setUtf8Charset

public MultipartUploadRequest setUtf8Charset()

Sets the charset for this multipart request to UTF-8. If not set, the standard US-ASCII charset will be used.

Returns:

request instance