org.opencms.scheduler

Interface I_CmsScheduledJob

All Known Implementing Classes:

CmsContentNotificationJob, CmsCreateImageSizeJob, CmsDeleteExpiredResourcesJob, CmsExternalLinksValidator, CmsHistoryClearJob, CmsImageCacheCleanupJob, CmsInternalRelationsValidationJob, CmsMemoryMonitor, CmsPublishJob, CmsPublishScheduledJob, CmsRemoveOldDbLogEntriesJob, CmsSearchIndexOptimizeJob, CmsSearchManager, CmsStaticExportJob, CmsUnsubscribeDeletedResourcesJob

public interface I_CmsScheduledJob

Identifies a class that can be scheduled with the OpenCms scheduler.

Please read the documentation for CmsScheduledJobInfo to learn how to schedule a job in OpenCms.

Since:

6.0.0

Method Summary

Methods

Modifier and Type	Method and 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.

Method Detail

launch

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

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.

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:

CmsScheduledJobInfo, CmsScheduledJobInfo.setReuseInstance(boolean)