com.box.boxjavalibv2.httpentities

Class MultipartEntityWithProgressListener

java.lang.Object

org.apache.http.entity.mime.MultipartEntity

com.box.boxjavalibv2.httpentities.MultipartEntityWithProgressListener

All Implemented Interfaces:

org.apache.http.HttpEntity

public class MultipartEntityWithProgressListener
extends org.apache.http.entity.mime.MultipartEntity

This is a class wrappying MultipartEntity with a IFIleTransferListener so the writing progress of the entity can be monitored.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultipartEntityWithProgressListener.InterruptedMultipartException

Field Summary

Fields

Modifier and Type	Field and Description
static int	ON_PROGRESS_UPDATE_THRESHOLD Default minimum time between two progress messages being sent out.

Constructor Summary

Constructors

Constructor and Description
MultipartEntityWithProgressListener(org.apache.http.entity.mime.HttpMultipartMode mode)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBoxJSONStringEntityPart(java.lang.String name, IBoxJSONStringEntity entity)
void	addContentBodyPart(java.lang.String name, org.apache.http.entity.mime.content.ContentBody contentBody)
org.apache.http.entity.mime.content.ContentBody	getContentBodyPart(java.lang.String name)
IBoxJSONStringEntity	getJSONStringEntityPart(java.lang.String name)
void	prepareParts(IBoxJSONParser parser) Method to put all parts in to the multipart entity.
void	setListener(IFileTransferListener listener) Set upload listener.
static void	setOnProgressUpdateThreshold(int threshold) Set the threshold time for progress updating.
void	writeTo(java.io.OutputStream outstream)

Methods inherited from class org.apache.http.entity.mime.MultipartEntity

addPart, addPart, consumeContent, generateBoundary, generateContentType, getContent, getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable, isStreaming

Methods inherited from class java.lang.Object

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

Field Detail

ON_PROGRESS_UPDATE_THRESHOLD

public static final int ON_PROGRESS_UPDATE_THRESHOLD

Default minimum time between two progress messages being sent out.

See Also:

Constant Field Values

Constructor Detail

MultipartEntityWithProgressListener

public MultipartEntityWithProgressListener(org.apache.http.entity.mime.HttpMultipartMode mode)

Method Detail

addContentBodyPart

public void addContentBodyPart(java.lang.String name,
                      org.apache.http.entity.mime.content.ContentBody contentBody)

getContentBodyPart

public org.apache.http.entity.mime.content.ContentBody getContentBodyPart(java.lang.String name)

addBoxJSONStringEntityPart

public void addBoxJSONStringEntityPart(java.lang.String name,
                              IBoxJSONStringEntity entity)

getJSONStringEntityPart

public IBoxJSONStringEntity getJSONStringEntityPart(java.lang.String name)

prepareParts

public void prepareParts(IBoxJSONParser parser)
                  throws java.io.UnsupportedEncodingException,
                         BoxJSONException

Method to put all parts in to the multipart entity.

Throws:

BoxJSONException

java.io.UnsupportedEncodingException

setListener

public void setListener(IFileTransferListener listener)

Set upload listener.

Parameters:

listener - upload listener

setOnProgressUpdateThreshold

public static void setOnProgressUpdateThreshold(int threshold)

Set the threshold time for progress updating. This is the minimum time between two progress messages being sent out. If this method is not called, the default value is ON_PROGRESS_UPDATE_THRESHOLD

Parameters:

threshold - threshold

writeTo

public void writeTo(java.io.OutputStream outstream)
             throws java.io.IOException

Specified by:

writeTo in interface org.apache.http.HttpEntity

Overrides:

writeTo in class org.apache.http.entity.mime.MultipartEntity

Throws:

java.io.IOException