Package org.opencms.scheduler.jobs

Class CmsHistoryClearJob

  • All Implemented Interfaces:
    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.
    Since:
    7.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • launch

        public java.lang.String launch​(CmsObject cms,
                               java.util.Map<java.lang.String,​java.lang.String> parameters)
                        throws java.lang.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:
        java.lang.Exception - if something goes wrong
        See Also:
        I_CmsScheduledJob.launch(org.opencms.file.CmsObject, java.util.Map)