com.gpudb.filesystem.download

Class DownloadIoJob

java.lang.Object

com.gpudb.filesystem.download.DownloadIoJob

public class DownloadIoJob
extends Object

This class models a an I/O operation of a specific OpMode i.e., UPLOAD or DOWNLOAD. 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 and 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) Static helper method to create new instance of DownloadIoJob
String	getDownloadFileName()
String	getDownloadLocalFileName()
String	getJobId()
ExecutorService	getThreadPool()
void	start() This method starts the job to download the multipart file by submitting different segments of the file according to the value returned by getFileSizeToSplit() method of GPUdbFileHandler.Options class.
List<Result>	stop() This method is used to stop all the running IoTask instances by shutting down the thread pool running them after they're completed.

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

Static helper method to create new instance of DownloadIoJob

Parameters:

db - - The GPUdb instance

fileHandlerOptions -

remoteFileName - - Name of the KIFS file to be downloaded

localFileName - - Name of the local file with directory

kifsFileInfo - - A KifsFileInfo object

downloadOptions - - A DownloadOptions object.

callback - - A FileDownloadListener implementation

Returns:

- A Pair of JobId and DownloadIoJob object.

Throws:

GPUdbException

getJobId

public String getJobId()

getThreadPool

public ExecutorService getThreadPool()

start

public void start()
           throws GPUdbException

This method starts the job to download the multipart file by submitting different segments of the file according to the value returned by getFileSizeToSplit() method of GPUdbFileHandler.Options class. Each segment of the file is submitted as a new IoTask which is run in an independent thread

Throws:

GPUdbException

See Also:

GPUdbFileHandler.getOptions()

stop

public List<Result> stop()

This method is used to stop all the running IoTask instances by shutting down the thread pool running them after they're completed. Each completed Future object will return a Result object which can be examined to get the exact status of the background job.

Returns:

- List - A list of Result objects.

See Also:

Result, CompletionService, - method terminateJobs().