com.box.boxjavalibv2.filetransfer

Class BoxFileDownload

java.lang.Object

com.box.boxjavalibv2.filetransfer.BoxFileDownload

public class BoxFileDownload
extends java.lang.Object

Contains logic for downloading a user's file from Box API and supports using IFileTransferListener to monitor downloading progress.

Constructor Summary

Constructors

Constructor and Description
BoxFileDownload(IBoxConfig config, IBoxRESTClient restClient, java.lang.String fileId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(IBoxRequestAuth auth, java.io.File destination, IBoxJSONParser parser, BoxDefaultRequestObject requestObject) Execute a download.
java.io.InputStream	execute(IBoxRequestAuth auth, IBoxJSONParser parser, BoxDefaultRequestObject requestObject) Execute the download and return the raw InputStream.
void	execute(IBoxRequestAuth auth, java.io.OutputStream[] outputStreams, IBoxJSONParser parser, BoxDefaultRequestObject requestObject) Execute a download.
long	getBytesTransferred() Get bytes transferred.
void	setProgressListener(IFileTransferListener listener) Set the listener listening to download progress.
void	setProgressUpdateInterval(int time) Set the interval time you want the progress update to be reported.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxFileDownload

public BoxFileDownload(IBoxConfig config,
               IBoxRESTClient restClient,
               java.lang.String fileId)

Constructor.

Parameters:

config - config

restClient - REST client to make api calls.

fileId - Id of the file to be downloaded.

Method Detail

setProgressListener

public void setProgressListener(IFileTransferListener listener)

Set the listener listening to download progress.

Parameters:

listener - listener

setProgressUpdateInterval

public void setProgressUpdateInterval(int time)

Set the interval time you want the progress update to be reported.

Parameters:

time - interval time

execute

public void execute(IBoxRequestAuth auth,
           java.io.OutputStream[] outputStreams,
           IBoxJSONParser parser,
           BoxDefaultRequestObject requestObject)
             throws BoxRestException,
                    java.io.IOException,
                    BoxServerException,
                    java.lang.InterruptedException,
                    AuthFatalFailureException

Execute a download.

Parameters:

auth - auth

outputStreams - OutputStream's the file is going to be downloaded into.

parser - json parser

requestObject - request object

Throws:

BoxRestException - exception

java.io.IOException - exception

BoxServerException - exception

java.lang.InterruptedException - exception

AuthFatalFailureException - exception indicating authentication totally failed

execute

public void execute(IBoxRequestAuth auth,
           java.io.File destination,
           IBoxJSONParser parser,
           BoxDefaultRequestObject requestObject)
             throws BoxRestException,
                    java.io.IOException,
                    BoxServerException,
                    java.lang.InterruptedException,
                    AuthFatalFailureException

Execute a download.

Parameters:

auth - auth

destination - destination file

parser - json parser

-

requestObject - request object

Throws:

BoxRestException - exception

java.io.IOException - exception

BoxServerException - exception

java.lang.InterruptedException - exception

AuthFatalFailureException - exception indicating authentication totally failed

execute

public java.io.InputStream execute(IBoxRequestAuth auth,
                          IBoxJSONParser parser,
                          BoxDefaultRequestObject requestObject)
                            throws BoxRestException,
                                   BoxServerException,
                                   AuthFatalFailureException

Execute the download and return the raw InputStream. This method is not involved with download listeners and will not publish anything through download listeners. Instead caller handles the InputStream as she/he wishes.

Parameters:

auth - auth

parser - json parser

requestObject - request object

Returns:

InputStream

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getBytesTransferred

public long getBytesTransferred()

Get bytes transferred.

Returns:

the mBytesTransferred