Package org.opencms.scheduler.jobs
Class CmsCreateImageSizeJob
- java.lang.Object
-
- org.opencms.scheduler.jobs.CmsCreateImageSizeJob
-
- All Implemented Interfaces:
I_CmsScheduledJob
public class CmsCreateImageSizeJob extends java.lang.Object implements 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
Fields Modifier and Type Field Description static java.lang.String
PARAM_DOWNSCALE
This job parameter controls if images are automatically downscaled according to the configured image downscale settings, by default this isfalse
.
-
Constructor Summary
Constructors Constructor Description CmsCreateImageSizeJob()
-
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.
-
-
-
Field Detail
-
PARAM_DOWNSCALE
public static final java.lang.String 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:
- Constant Field Values
-
-
Constructor Detail
-
CmsCreateImageSizeJob
public CmsCreateImageSizeJob()
-
-
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, 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:
java.lang.Exception
- if something goes wrong- See Also:
I_CmsScheduledJob.launch(CmsObject, Map)
-
-