org.opencms.scheduler.jobs

类 CmsHistoryClearJob

java.lang.Object

org.opencms.scheduler.jobs.CmsHistoryClearJob

所有已实现的接口:

I_CmsScheduledJob

public class CmsHistoryClearJob
extends java.lang.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.

从以下版本开始:

7.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PARAM_CLEARDELETED Name of the parameter where to configure if versions of deleted resources are cleared.
static java.lang.String	PARAM_KEEPTIMERANGE Name of the parameter where to configure the number of days the versions will be kept.
static java.lang.String	PARAM_KEEPVERSIONS Name of the parameter where to configure how many versions are kept.

构造器概要

构造器

构造器和说明
CmsHistoryClearJob()

方法概要

方法

限定符和类型	方法和说明
java.lang.String	launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters) This method will be called when this scheduled job is executed.

从类继承的方法 java.lang.Object

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

字段详细资料

PARAM_KEEPVERSIONS

public static final java.lang.String PARAM_KEEPVERSIONS

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

另请参阅:

常量字段值

PARAM_CLEARDELETED

public static final java.lang.String PARAM_CLEARDELETED

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

另请参阅:

常量字段值

PARAM_KEEPTIMERANGE

public static final java.lang.String PARAM_KEEPTIMERANGE

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

另请参阅:

常量字段值

构造器详细资料

CmsHistoryClearJob

public CmsHistoryClearJob()

方法详细资料

launch

public java.lang.String launch(CmsObject cms,
                      java.util.Map<java.lang.String,java.lang.String> parameters)
                        throws java.lang.Exception

从接口复制的说明: 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.

指定者:

launch 在接口中 I_CmsScheduledJob

参数:

cms - will be initialized with the configured users cms context

parameters - the configured parameters

返回:

a String that will be written to the OpenCms logfile

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

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