Class CmsPublishJob
- All Implemented Interfaces:
I_CmsScheduledJob
This class is called via the scheduled job backoffice to publish a project at a given time.
Per default, it publishes all new, edited and deleted resources in the project which are not locked.
To unlock all resources in the project before publishing, add the parameter unlock=true
in the scheduled job configuration. In addition 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
.
- Since:
- 6.0.0
-
Field Details
-
PARAM_LINKCHECK
Linkcheck parameter.- See Also:
-
PARAM_UNLOCK
Unlock parameter.- See Also:
-
PARAM_USER
Mail to user parameter.- See Also:
-
-
Constructor Details
-
CmsPublishJob
public CmsPublishJob()
-
-
Method Details
-
launch
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, onINFO
log level.- Specified by:
launch
in interfaceI_CmsScheduledJob
- Parameters:
cms
- will be initialized with the configured users cms contextparameters
- the configured parameters- Returns:
- a String that will be written to the OpenCms logfile
- Throws:
Exception
- if something goes wrong- See Also:
-