Package org.opencms.scheduler.jobs

Class CmsPublishScheduledJob

  • All Implemented Interfaces:
    I_CmsScheduledJob
    public class CmsPublishScheduledJob
extends java.lang.Object
implements I_CmsScheduledJob
    Scheduled job for time based publishing.

    This class is called via the front end to publish scheduled a file at a given time.

    Per default, it publishes all new, edited and deleted resources in the project which are locked in the current project. For all resources in the project which are not locked by the current user is the lock changed. You are able to perform a link validation before publishing the project by adding the parameter linkcheck=true. It is possible to send an email to a user in OpenCms in case somthing went wrong during this process. To do so specifiy a parametermail-to-user=username_in_opencms. After running this job, the job is deleted. Therefore the job name is to set in the parameter jobname

    Since:
    7.5.1

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PARAM_JOBNAME
      Job name parameter.
      static java.lang.String PARAM_LINKCHECK
      Linkcheck parameter.
      static java.lang.String PARAM_UNLOCK_LIST
      Optional parameter containing comma-separated list of structure ids of resources to explicitly unlock at the end of the job (only necessary for resources that don't get published).
      static java.lang.String PARAM_USER
      Mail to user parameter.

    • 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)