org.opencms.scheduler.jobs
Class CmsUnsubscribeDeletedResourcesJob

java.lang.Object
  org.opencms.scheduler.jobs.CmsUnsubscribeDeletedResourcesJob

All Implemented Interfaces:

I_CmsScheduledJob

public class CmsUnsubscribeDeletedResourcesJob
extends java.lang.Object
implements I_CmsScheduledJob

A scheduled OpenCms job to unsubscribe deleted resources.

Job parameters:

deleteddays={Number/Integer}

Amount of days a resource has to be deleted to be unsubscribed (defaults to 30).

Since:

8.0.0

Field Summary

static java.lang.String

PARAM_DELETEDDAYS Name of the parameter where to configure the amount of days a resource has to be expired before deletion.

Constructor Summary

CmsUnsubscribeDeletedResourcesJob()

Method Summary

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

Field Detail

PARAM_DELETEDDAYS

public static final java.lang.String PARAM_DELETEDDAYS

Name of the parameter where to configure the amount of days a resource has to be expired before deletion.

See Also:

Constant Field Values

Constructor Detail

CmsUnsubscribeDeletedResourcesJob

public CmsUnsubscribeDeletedResourcesJob()

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)