Package org.opencms.scheduler.jobs
Class CmsSearchIndexOptimizeJob
java.lang.Object
org.opencms.scheduler.jobs.CmsSearchIndexOptimizeJob
- All Implemented Interfaces:
I_CmsScheduledJob
A schedulable OpenCms job that optimizes the Lucene based search indexes at runtime.
Only indexes which return true
for
I_CmsSearchIndex.isUpdatedIncremental()
are being optimized.
By default, all such indexes are optimized if this job is run.
Job parameters:
optimizeIndexes={comma separated list of index names}
- Specifies list of indexes to be optimized. Only the indexes in this list are being optimized.
This parameter overrides an exclude list given with
excludeIndexes
. excludeIndexes={comma separated list of index names}
- Specifies list of indexes to be excluded from optimization.
- Since:
- 8.5.0
-
Field Details
-
PARAM_INDEXES_EXCLUDED
Parameter to control which indexes are excluded from optimization.- See Also:
-
PARAM_INDEXES_OPTIMIZED
Parameter to control which indexes are optimized.- See Also:
-
-
Constructor Details
-
CmsSearchIndexOptimizeJob
public CmsSearchIndexOptimizeJob()
-
-
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:
-