org.objectweb.jonas_lib.deployment.work.AbsCleanTask Class Reference

Inherited by org.objectweb.jonas_lib.deployment.work.EarCleanTask, and org.objectweb.jonas_lib.deployment.work.JarCleanTask.

Inheritance diagram for org.objectweb.jonas_lib.deployment.work.AbsCleanTask:

[legend]List of all members.

Public Member Functions
void	execute () throws CleanerException
Protected Member Functions
	AbsCleanTask ()
abstract boolean	isValidLogEntry (LogEntry logEntry) throws CleanerException
abstract void	removeLogEntry (LogEntry logEntry) throws CleanerException
abstract Vector	getLogEntries ()
abstract boolean	isDeployLogEntry (LogEntry logEntry) throws CleanerException
void	removeRecursiveDirectory (File file)
Static Protected Member Functions
Logger	getLogger ()

---

Detailed Description

Abstract Clean Task class which define a generic job executed by the cleaner thread

Author:

Benoit PELLETIER

Definition at line 44 of file AbsCleanTask.java.

---

Constructor & Destructor Documentation

org.objectweb.jonas_lib.deployment.work.AbsCleanTask.AbsCleanTask (   )  [protected]

Default constructor : Construct a new cleaner. Definition at line 54 of file AbsCleanTask.java.

---

Member Function Documentation

void org.objectweb.jonas_lib.deployment.work.AbsCleanTask.execute (   )  throws CleanerException

Run the clean task Exceptions: CleanerException  if it failed. Definition at line 99 of file AbsCleanTask.java. References org.objectweb.jonas_lib.deployment.work.LogEntry.getCopy(), and org.objectweb.jonas_lib.deployment.work.LogEntry.getOriginal(). Referenced by org.objectweb.jonas_lib.deployment.work.WorkCleaner.executeTasks().

Here is the call graph for this function:

abstract Vector org.objectweb.jonas_lib.deployment.work.AbsCleanTask.getLogEntries (   )  [protected, pure virtual]

Abstract method defined in the derived classes get the log entries Returns: the log entries Implemented in org.objectweb.jonas_lib.deployment.work.EarCleanTask, and org.objectweb.jonas_lib.deployment.work.JarCleanTask.

Logger org.objectweb.jonas_lib.deployment.work.AbsCleanTask.getLogger (   )  [static, protected]

Returns: the logger Definition at line 60 of file AbsCleanTask.java. Referenced by org.objectweb.jonas_lib.deployment.work.JarCleanTask.isValidLogEntry(), and org.objectweb.jonas_lib.deployment.work.EarCleanTask.isValidLogEntry().

abstract boolean org.objectweb.jonas_lib.deployment.work.AbsCleanTask.isDeployLogEntry (  LogEntry  logEntry  )  throws CleanerException [protected, pure virtual]

Check if the package pointed by the log entry is currently deploy Parameters: logEntry  entry in a deploy log Returns: true if the package pointed by the log entry is currently deployed Exceptions: CleanerException  if it fails Implemented in org.objectweb.jonas_lib.deployment.work.EarCleanTask, and org.objectweb.jonas_lib.deployment.work.JarCleanTask.

abstract boolean org.objectweb.jonas_lib.deployment.work.AbsCleanTask.isValidLogEntry (  LogEntry  logEntry  )  throws CleanerException [protected, pure virtual]

Abstract method defined in the derived classes return true if the work copy exist and is up to date Parameters: logEntry  entry in a deploy log Returns: true if the work copy exists and is up to date Exceptions: CleanerException  if it fails Implemented in org.objectweb.jonas_lib.deployment.work.EarCleanTask, and org.objectweb.jonas_lib.deployment.work.JarCleanTask.

abstract void org.objectweb.jonas_lib.deployment.work.AbsCleanTask.removeLogEntry (  LogEntry  logEntry  )  throws CleanerException [protected, pure virtual]

Abstract method defined in the derived classes remove the work copy specified in the log entry and the log entry Parameters: logEntry  entry in a deploy log Exceptions: CleanerException  if it fails Implemented in org.objectweb.jonas_lib.deployment.work.EarCleanTask, and org.objectweb.jonas_lib.deployment.work.JarCleanTask.

void org.objectweb.jonas_lib.deployment.work.AbsCleanTask.removeRecursiveDirectory (  File  file  )  [protected]

Remove a directory with all its child (recursive) Parameters: file  the file or directory which must be deleted Definition at line 143 of file AbsCleanTask.java. Referenced by org.objectweb.jonas_lib.deployment.work.JarCleanTask.removeLogEntry(), and org.objectweb.jonas_lib.deployment.work.EarCleanTask.removeLogEntry().

---

The documentation for this class was generated from the following file:

• src/org/objectweb/jonas_lib/deployment/work/AbsCleanTask.java

---