com.gpudb.filesystem.upload

Class UploadIoJob

java.lang.Object

com.gpudb.filesystem.upload.UploadIoJob

public class UploadIoJob
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 an IO operation of a specific OpMode i.e., UPLOAD . Different instances of this class will be created for different operations and no instance of this class will be shared. This class handles only multi part upload. It uses a single threaded threadpool internally with an unbounded queue which is used to submit the background tasks modeled by an IoTask instance, since multi part upload has to be handled sequentially. An instance of this class is used to handle the upload of a single large file. If there are multiple large files to be uploaded each such file will be handled by a new instance of this class.

Method Summary

Modifier and Type	Method and Description
static org.apache.commons.lang3.tuple.Pair<String,UploadIoJob>	createNewJob(GPUdb db, GPUdbFileHandler.Options fileHandlerOptions, OpMode opMode, String dirName, String fileName, String remoteFileName, UploadOptions uploadOptions, FileUploadListener callback) Factory method for creating a new IoJob instance.
String	getJobId()
ExecutorService	getThreadPool()
void	start() This method starts the job to upload the multipart file by submitting different stages MultiPartUploadInfo.MultiPartOperation to indicate which stage is being executed.
List<Result>	stop() This method is used to stop all the running threadpool and return the result list.

Methods inherited from class java.lang.Object

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

Method Detail

createNewJob

public static org.apache.commons.lang3.tuple.Pair<String,UploadIoJob> createNewJob(GPUdb db,
                                                                                   GPUdbFileHandler.Options fileHandlerOptions,
                                                                                   OpMode opMode,
                                                                                   String dirName,
                                                                                   String fileName,
                                                                                   String remoteFileName,
                                                                                   UploadOptions uploadOptions,
                                                                                   FileUploadListener callback)
                                                                            throws GPUdbException

Factory method for creating a new IoJob instance.

Parameters:

db - - the GPUdb instance

fileHandlerOptions - - options to configure GPUdbFileHandler

opMode - - OpMode - Whether upload or download

dirName - - String - The KIFS directory name

fileName - - String - The fully qualified local file name

remoteFileName - - Name of the KIFS file

uploadOptions - - the UploadOptions object

callback - - the FileUploadListener object

Returns:

Pair of String (Job id) and IoJob instances

Throws:

GPUdbException

getJobId

public String getJobId()

getThreadPool

public ExecutorService getThreadPool()

start

public void start()
           throws GPUdbException

This method starts the job to upload the multipart file by submitting different stages MultiPartUploadInfo.MultiPartOperation to indicate which stage is being executed. Each stage is modeled as an IoTask which is an instance of Callable and the task instance is submitted to the handleUploadResult(IoTask) member of the class

Throws:

GPUdbException

stop

public List<Result> stop()

This method is used to stop all the running threadpool and return the result list.

Returns:

- A list of Result objects.

See Also:

Result, CompletionService, - method terminateJobs().