Package com.amilesend.client.connection.file

Class ProgressReportingRequestBody.MultiPartBuilder

java.lang.Object

com.amilesend.client.connection.file.ProgressReportingRequestBody.MultiPartBuilder

Enclosing class:

ProgressReportingRequestBody

public static class ProgressReportingRequestBody.MultiPartBuilder
extends Object

The builder used to construct new ProgressReportingRequestBody instances for multipart uploads.

Method Summary

Modifier and Type	Method	Description
ProgressReportingRequestBody	build()	Builds a new RequestBody that tracks the transfer progress for multipart form-data transfer.
ProgressReportingRequestBody.MultiPartBuilder	callback(TransferProgressCallback callback)	The callback listener.
ProgressReportingRequestBody.MultiPartBuilder	contentType(String contentType)	The content type.
ProgressReportingRequestBody.MultiPartBuilder	destination(String destination)	The destination descriptor (i.e., the name of the service).
ProgressReportingRequestBody.MultiPartBuilder	fieldName(String fieldName)	The attribute field name for the form data in the request.
ProgressReportingRequestBody.MultiPartBuilder	file(Path file)	The file to upload.

Methods inherited from class java.lang.Object

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

Method Details

file

public ProgressReportingRequestBody.MultiPartBuilder file(Path file)

The file to upload.

Parameters:

file - the path of the file to upload

Returns:

the builder

fieldName

public ProgressReportingRequestBody.MultiPartBuilder fieldName(String fieldName)

The attribute field name for the form data in the request. Default is upload.

Parameters:

fieldName - the field name

Returns:

the builder

contentType

public ProgressReportingRequestBody.MultiPartBuilder contentType(String contentType)

The content type. The default is text/csv.

Parameters:

contentType - the content type

Returns:

the builder

destination

public ProgressReportingRequestBody.MultiPartBuilder destination(String destination)

The destination descriptor (i.e., the name of the service).

Parameters:

destination - the destination

Returns:

the builder

callback

public ProgressReportingRequestBody.MultiPartBuilder callback(TransferProgressCallback callback)

The callback listener. Default is a LogProgressCallback.

Parameters:

callback - the listener

Returns:

the builder

build

public ProgressReportingRequestBody build()
                                   throws IOException

Builds a new RequestBody that tracks the transfer progress for multipart form-data transfer.

Returns:

the request body

Throws:

IOException - if an error occurred while accessing the file to read