Package org.opencms.scheduler

Interface I_CmsScheduledJob

All Known Implementing Classes:
CmsContentNotificationJob, CmsCreateImageSizeJob, CmsDeleteExpiredResourcesJob, CmsExternalLinksValidator, CmsHistoryClearJob, CmsImageCacheCleanupJob, CmsInternalRelationsValidationJob, CmsLockInactiveAccountsJob, CmsMemoryMonitor, CmsPublishJob, CmsPublishScheduledJob, CmsRemoveOldDbLogEntriesJob, CmsSearchIndexOptimizeJob, CmsSearchManager, CmsStaticExportJob, CmsUnsubscribeDeletedResourcesJob, CmsUpdateXmlSitemapCacheJob
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

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

  • Method Details

    • launch

      String launch(CmsObject cms, Map<String,String> parameters) throws 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:
      Exception - if something goes wrong
      See Also: