de.esprit.netsuite.rtask

Class AbstractFileTransferTask<C extends ClientContext,S extends ServerContext>

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.appsuite.launch.AbstractApplicationObject<C>

de.esprit.appsuite.task.AbstractAsyncExecutable<C>

de.esprit.appsuite.task.AbstractAsyncTask<C>

de.esprit.netsuite.rtask.AbstractClientTask<C>

de.esprit.netsuite.rtask.AbstractFileTransferTask<C,S>

All Implemented Interfaces:

ApplicationObject<C>, AsyncExecutable<C>, AsyncTask<C>, CancellableTask, LocalCancellableTask, TaskMonitorSupport, TaskIdHolder, SimpleLogSupport, Dumpable, Executable, ClientObject<C>, java.lang.Runnable

public abstract class AbstractFileTransferTask<C extends ClientContext,S extends ServerContext>
extends AbstractClientTask<C>

This task runs a FileTransferAgent with the jobs added

Author:

Rainer Buesch

Field Summary

Fields inherited from class de.esprit.appsuite.task.AbstractAsyncExecutable

childTaskRef, isTestMode, monitorController, resultRef, stateFlag

Constructor Summary

Constructors

Constructor and Description
AbstractFileTransferTask(C ctx)

Method Summary

Methods

Modifier and Type	Method and Description
void	addJob(FileTransferJob job) Adds a FileTransferJob to the underlying FileTransferAgent
void	cancel() Flags the task as being cancelled.
void	clearJobs()
protected FileTransferAgent<C,S>	createFileTransferAgent()
void	doOnStart() Is called when the task actually has started.
void	executeAsync() Must be overridden to perform the async part.
FileTransferAgent<C,S>	getAgent()
int	getJobCount()
java.util.List<FileTransferJob>	getJobList()
void	setTransferLocked(boolean isLocked)
TaskId	submit(java.util.concurrent.ExecutorService pool) Submits this task for execution to the given thread pool

Methods inherited from class de.esprit.netsuite.rtask.AbstractClientTask

executeSubTask, getClientContext, getSessionId

Methods inherited from class de.esprit.appsuite.task.AbstractAsyncTask

awaitFinished, awaitFinished, awaitStarted, createTaskId, deregisterTask, doOnFinish, doOnSuccess, executeChildTask, executeChildTask, getCurrentFuture, getMaxChildTasks, getPriority, getProcessingDuration, getStartTime, getStopWatch, handleFinish, handleStart, handleSuccess, isRegisterForCancel, isRunning, notifyProceeded, registerTask, releaseStart, run, setCurrentFuture, setMaxChildTasks, setPriority, setRegisterForCancel, setReleaseTimeout, submit, submitInternal, toString, wasSucceeded

Methods inherited from class de.esprit.appsuite.task.AbstractAsyncExecutable

addMonitor, checkCancelled, checkForErrorAndRethrow, clearMonitors, createRunStateFlag, doOnCancel, doOnFailure, execute, executeSubTask, getError, getMaxProgressSteps, getMonitorCount, getMonitors, getName, getProgressStepCount, getResult, getRunStateFlag, getTaskId, getType, handleCancellation, handleFailure, hasError, hasMonitor, isCancellable, registerTaskStateChange, removeMonitor, resetProgress, setCancellable, setLogLevel, setMaxProgressSteps, setMonitor, setName, setName, setResult, setRunStateFlag, setTaskId, setType, shouldFireMonitor, sleepChecked, wasCancelled

Methods inherited from class de.esprit.appsuite.launch.AbstractApplicationObject

getApplicationContext, getLogChannel, isLogDebug, isLogVerbose, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, setLogChannel

Methods inherited from class de.esprit.common.util.DumpableObject

configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toDumpString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.esprit.appsuite.task.AsyncTask

getError, hasError, setName

Methods inherited from interface de.esprit.appsuite.task.AsyncExecutable

checkCancelled, checkForErrorAndRethrow, executeSubTask, getName, getResult, getRunStateFlag, getTaskId, getType, handleCancellation, handleFailure, isCancellable, setCancellable, setName, setResult, setRunStateFlag, sleepChecked

Methods inherited from interface de.esprit.appsuite.launch.ApplicationObject

getApplicationContext

Methods inherited from interface de.esprit.common.type.Executable

execute

Methods inherited from interface de.esprit.appsuite.task.monitor.TaskMonitorSupport

addMonitor, clearMonitors, getMonitorCount, getMonitors, hasMonitor, removeMonitor

Methods inherited from interface de.esprit.common.log.SimpleLogSupport

getLogChannel, isLogDebug, isLogVerbose, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, setLogChannel

Methods inherited from interface de.esprit.appsuite.task.CancellableTask

wasCancelled

Methods inherited from interface de.esprit.appsuite.task.TaskIdHolder

getTaskId

Methods inherited from interface de.esprit.common.type.Dumpable

toDumpString, toDumpString, toString

Constructor Detail

AbstractFileTransferTask

public AbstractFileTransferTask(C ctx)

Method Detail

getAgent

public FileTransferAgent<C,S> getAgent()

createFileTransferAgent

protected FileTransferAgent<C,S> createFileTransferAgent()

doOnStart

public void doOnStart()
               throws java.lang.Exception

Description copied from class: AbstractAsyncTask

Is called when the task actually has started. Maybe overridden to perform any task preparation. Note that an Exception thrown here will cause the task to fail.

Overrides:

doOnStart in class AbstractAsyncTask<C extends ClientContext>

Throws:

java.lang.Exception

executeAsync

public void executeAsync()
                  throws java.lang.Exception

Description copied from class: AbstractAsyncTask

Must be overridden to perform the async part. From within this method you may directly call AbstractAsyncTask.notifyProceeded(Object, int, int, String) in order to notify about task progress. Note: the running task should periodically call AbstractAsyncExecutable.checkCancelled() in order to detect cancellation.

Specified by:

executeAsync in interface AsyncExecutable<C extends ClientContext>

Specified by:

executeAsync in class AbstractAsyncTask<C extends ClientContext>

Throws:

java.lang.Exception

See Also:

for synchronous execution

setTransferLocked

public void setTransferLocked(boolean isLocked)

submit

public TaskId submit(java.util.concurrent.ExecutorService pool)
              throws java.lang.Exception

Description copied from interface: AsyncTask

Submits this task for execution to the given thread pool

Specified by:

submit in interface AsyncTask<C extends ClientContext>

Overrides:

submit in class AbstractAsyncTask<C extends ClientContext>

Throws:

java.lang.Exception - if the pool is busy

addJob

public void addJob(FileTransferJob job)

Adds a FileTransferJob to the underlying FileTransferAgent

getJobCount

public int getJobCount()

clearJobs

public void clearJobs()

getJobList

public java.util.List<FileTransferJob> getJobList()

cancel

public void cancel()

Description copied from class: AbstractAsyncTask

Flags the task as being cancelled. The next call to AbstractAsyncExecutable.checkCancelled() will result a CancellationException being thrown. As a result AbstractAsyncExecutable.doOnCancel() is being called on the task.

Specified by:

cancel in interface LocalCancellableTask

Overrides:

cancel in class AbstractAsyncTask<C extends ClientContext>