Package org.opencms.scheduler.jobs
Class CmsCreateImageSizeJob
java.lang.Object
org.opencms.scheduler.jobs.CmsCreateImageSizeJob
- All Implemented Interfaces:
I_CmsScheduledJob
A schedulable OpenCms job to calculate image size information.
Image size information is stored in the
property
of an image file must have the format "h:x,w:y" with x and y being positive Integer vaulues.CmsPropertyDefinition.PROPERTY_IMAGE_SIZE
Job parameters:
downscale=true|false
- Controls if images are automatically downscaled according to the configured image
downscale settings, by default this is
false
.
- Since:
- 6.0.2
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
This job parameter controls if images are automatically downscaled according to the configured image downscale settings, by default this isfalse
. -
Constructor Summary
-
Method Summary
-
Field Details
-
PARAM_DOWNSCALE
This job parameter controls if images are automatically downscaled according to the configured image downscale settings, by default this isfalse
. Possible values aretrue
orfalse
(default). If this is set totrue
, then all images are checked against the configured image downscale settings (seeCmsImageLoader.CONFIGURATION_DOWNSCALE
). If the image is too large, it is automatically downscaled.- See Also:
-
-
Constructor Details
-
CmsCreateImageSizeJob
public CmsCreateImageSizeJob()
-
-
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:
-