Package org.opencms.scheduler.jobs

Class CmsHistoryClearJob

java.lang.Object

org.opencms.scheduler.jobs.CmsHistoryClearJob

All Implemented Interfaces:

I_CmsScheduledJob

public class CmsHistoryClearJob
extends Object
implements I_CmsScheduledJob

A schedulable OpenCms job to clear the history.

The user to execute the process should have have access to the required "Workplace manager" role.

If there is an Uri set for the scheduled job, which should only be folders, it will be used for clearing the history only in there (and the subfolders).

Job parameters:

keepVersions={Number/Integer}

Number/Integer to control how many versions will be kept.

clearDeleted=true|false

Boolean to configure if the versions of deleted resources should be cleared. The default is false.

keepTimeRange

Number/Integer to configure the number of days the versions of deleted resources will be kept. That means that all versions wich are older than the specified number will be deleted. This parameter is optional and only makes sense if the clearDeleted parameter is set to true.

Since:

7.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_CLEARDELETED	Name of the parameter where to configure if versions of deleted resources are cleared.
static final String	PARAM_KEEPTIMERANGE	Name of the parameter where to configure the number of days the versions will be kept.
static final String	PARAM_KEEPVERSIONS	Name of the parameter where to configure how many versions are kept.

Constructor Summary

Constructors

Constructor	Description
CmsHistoryClearJob()

Method Summary

Modifier and Type	Method	Description
String	launch(CmsObject cms, Map<String,String> parameters)	This method will be called when this scheduled job is executed.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_KEEPVERSIONS

public static final String PARAM_KEEPVERSIONS

Name of the parameter where to configure how many versions are kept.

See Also:

• Constant Field Values

PARAM_CLEARDELETED

public static final String PARAM_CLEARDELETED

Name of the parameter where to configure if versions of deleted resources are cleared.

See Also:

• Constant Field Values

PARAM_KEEPTIMERANGE

public static final String PARAM_KEEPTIMERANGE

Name of the parameter where to configure the number of days the versions will be kept.

See Also:

• Constant Field Values

Constructor Details

CmsHistoryClearJob

public CmsHistoryClearJob()

Method Details

launch

public String launch(CmsObject cms,
 Map<String,String> parameters)
              throws Exception

Description copied from interface: I_CmsScheduledJob

This method will be called when this scheduled job is executed.

Depending on the configuration of this job, a new instance of the configured class will be instantiated every time the job is launched, or a new instance will be generated only the first time the job is launched, and re-used afterwards.

The result String will be written to the OpenCms logfile in the org.opencms.scheduler.CmsScheduleManager channel, on INFO log level.

Specified by:

launch in interface I_CmsScheduledJob

Parameters:

cms - will be initialized with the configured users cms context

parameters - the configured parameters

Returns:

a String that will be written to the OpenCms logfile

Throws:

Exception - if something goes wrong

See Also:

• I_CmsScheduledJob.launch(org.opencms.file.CmsObject, java.util.Map)