Package com.logicaldoc.enterprise.cleaner

Class Cleaner

java.lang.Object

com.logicaldoc.enterprise.cleaner.Cleaner

All Implemented Interfaces:

com.logicaldoc.core.task.TaskListener, EventListener

Direct Known Subclasses:

ArchiveCleaner, AuditCleaner, BarcodeCleaner, CalendarCleaner, ChatCleaner, CoreCleaner, EmailCleaner, ImportFolderCleaner, OcrCleaner, ReportCleaner, RetentionCleaner, WorkflowCleaner, ZonalOCRCleaner

public abstract class Cleaner
extends Object
implements com.logicaldoc.core.task.TaskListener

A cleaner is a specialized class that perform a particular cleanup. For example deletes from db all logically deleted items.

Since:

4.0

Author:

Marco Meschieri - LogicalDOC

Method Summary

Modifier and Type	Method	Description
void	clean()	Performs the cleanup
String	getDbScript()	Gets the fully qualified name of the database script
void	progressChanged(long progress)
void	setConnection(Connection connection)
void	setDbScript(String dbScript)
void	setLogger(org.slf4j.Logger logger)
void	statusChanged(int status)

Methods inherited from class java.lang.Object

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

Method Details

setLogger

public void setLogger(org.slf4j.Logger logger)

setConnection

public void setConnection(Connection connection)

getDbScript

public String getDbScript()

Gets the fully qualified name of the database script

Returns:

name of the database script

setDbScript

public void setDbScript(String dbScript)

clean

public void clean()
           throws SQLException,
IOException

Performs the cleanup

Throws:

SQLException - Error in the database

IOException - I/O error

progressChanged

public void progressChanged(long progress)

Specified by:

progressChanged in interface com.logicaldoc.core.task.TaskListener

statusChanged

public void statusChanged(int status)

Specified by:

statusChanged in interface com.logicaldoc.core.task.TaskListener