de.esprit.appsuite.io.archive.zip

Class ZipArchiverTask<C extends ApplicationContext>

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.appsuite.io.archive.zip.ZipArchiverTask<C>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractZipArchiverWFT

public class ZipArchiverTask<C extends ApplicationContext>
extends AbstractAsyncTask<C>

This task runs a ZipArchiver asynchronously

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
ZipArchiverTask(C ctx)
ZipArchiverTask(C ctx, LogChannel logCh)
ZipArchiverTask(C ctx, LogChannel logCh, java.lang.String name)
ZipArchiverTask(C ctx, LogChannel logCh, java.lang.String taskName, ZipArchiver archiver)
ZipArchiverTask(C ctx, LogChannel logCh, ZipArchiver archiver)
ZipArchiverTask(C ctx, java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	executeAsync() Must be overridden to perform the async part.
ZipArchiver	getArchiver()
java.io.File	getSourceRootDir()
void	setAchiver(ZipArchiver archiver) Sets the archiver to be run.
void	setArchiveFile(java.io.File zipOutFile)
void	setRemoveSourceFiles(boolean isRemove)
void	setSourceRootDir(java.io.File rootDir)

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

awaitFinished, awaitFinished, awaitStarted, cancel, createTaskId, deregisterTask, doOnFinish, doOnStart, doOnSuccess, executeChildTask, executeChildTask, getCurrentFuture, getMaxChildTasks, getPriority, getProcessingDuration, getStartTime, getStopWatch, handleFinish, handleStart, handleSuccess, isRegisterForCancel, isRunning, notifyProceeded, registerTask, releaseStart, run, setCurrentFuture, setMaxChildTasks, setPriority, setRegisterForCancel, setReleaseTimeout, submit, 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

ZipArchiverTask

public ZipArchiverTask(C ctx)

ZipArchiverTask

public ZipArchiverTask(C ctx,
               java.lang.String name)

ZipArchiverTask

public ZipArchiverTask(C ctx,
               LogChannel logCh)

ZipArchiverTask

public ZipArchiverTask(C ctx,
               LogChannel logCh,
               java.lang.String name)

ZipArchiverTask

public ZipArchiverTask(C ctx,
               LogChannel logCh,
               ZipArchiver archiver)

ZipArchiverTask

public ZipArchiverTask(C ctx,
               LogChannel logCh,
               java.lang.String taskName,
               ZipArchiver archiver)

Method Detail

setAchiver

public void setAchiver(ZipArchiver archiver)

Sets the archiver to be run.

getArchiver

public ZipArchiver getArchiver()

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 ApplicationContext>

Specified by:

executeAsync in class AbstractAsyncTask<C extends ApplicationContext>

Throws:

java.lang.Exception

See Also:

for synchronous execution

setArchiveFile

public void setArchiveFile(java.io.File zipOutFile)

setRemoveSourceFiles

public void setRemoveSourceFiles(boolean isRemove)

setSourceRootDir

public void setSourceRootDir(java.io.File rootDir)

getSourceRootDir

public java.io.File getSourceRootDir()