Package com.gpudb.filesystem.download

Class DownloadIoJob

java.lang.Object

com.gpudb.filesystem.download.DownloadIoJob

public class DownloadIoJob
extends Object

This is an internal class and not meant to be used by the end users of the filesystem API. The consequences of using this class directly in client code is not guaranteed and maybe undesirable. This class models a download OpMode. Different instances of this class will be created for different operations and no instance of this class will be shared.

Method Summary

Modifier and Type	Method	Description
static org.apache.commons.lang3.tuple.Pair<String,DownloadIoJob>	createNewJob(GPUdb db, GPUdbFileHandler.Options fileHandlerOptions, String remoteFileName, String localFileName, KifsFileInfo kifsFileInfo, DownloadOptions downloadOptions, FileDownloadListener callback)	Creates a new job for downloading a file.
String	getDownloadFileName()
String	getDownloadLocalFileName()
String	getJobId()
ExecutorService	getThreadPool()
void	start()	Starts the job to download the multipart file by submitting different segments of the file for download in an independent thread.
List<Result>	stop()	This method is used to stop all the running IoTask instances.

Methods inherited from class java.lang.Object

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

Method Detail

getDownloadFileName

public String getDownloadFileName()

getDownloadLocalFileName

public String getDownloadLocalFileName()

createNewJob

public static org.apache.commons.lang3.tuple.Pair<String,DownloadIoJob> createNewJob(GPUdb db,
                                                                                           GPUdbFileHandler.Options fileHandlerOptions,
                                                                                           String remoteFileName,
                                                                                           String localFileName,
                                                                                           KifsFileInfo kifsFileInfo,
                                                                                           DownloadOptions downloadOptions,
                                                                                           FileDownloadListener callback)
                                                                                    throws GPUdbException

Creates a new job for downloading a file.

Parameters:

db - The GPUdb instance used to access KiFS.

fileHandlerOptions - Options for setting up the files for download.

remoteFileName - Name of the KIFS file to be downloaded

localFileName - Fully-qualified name of the downloaded local file.

kifsFileInfo - a KifsFileInfo object

downloadOptions - options to use during the download.

callback - a FileDownloadListener that can trigger events at various stages of the download process.

Throws:

GPUdbException

getJobId

public String getJobId()

getThreadPool

public ExecutorService getThreadPool()

start

public void start()
           throws GPUdbException

Starts the job to download the multipart file by submitting different segments of the file for download in an independent thread.

Throws:

GPUdbException

stop

public List<Result> stop()

This method is used to stop all the running IoTask instances.