public class CmsPublishScheduledJob extends java.lang.Object implements I_CmsScheduledJob
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
After running this job, the job is deleted. Therefore the job name is to set in the parameter
|Modifier and Type||Field and Description|
Job name parameter.
Mail to user parameter.
|Constructor and Description|
|Modifier and Type||Method and Description|
This method will be called when this scheduled job is executed.
public static final java.lang.String PARAM_JOBNAME
public static final java.lang.String PARAM_LINKCHECK
public java.lang.String launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters) throws java.lang.Exception
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
INFO log level.
cms- will be initialized with the configured users cms context
parameters- the configured parameters
java.lang.Exception- if something goes wrong