Package com.logicaldoc.enterprise.cleaner

Class Cleaner

java.lang.Object

com.logicaldoc.enterprise.cleaner.Cleaner

Direct Known Subclasses:

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

public abstract class Cleaner
extends Object

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

Constructor Summary

Constructors

Constructor	Description
Cleaner()
Cleaner(Connection con)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Cleaner

public Cleaner(Connection con)

Cleaner

public Cleaner()

Method Detail

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 Exception

Performs the cleanup

Throws:

Exception - a generic error