org.opencms.scheduler.jobs

类 CmsSearchIndexOptimizeJob

java.lang.Object

org.opencms.scheduler.jobs.CmsSearchIndexOptimizeJob

所有已实现的接口:

I_CmsScheduledJob

public class CmsSearchIndexOptimizeJob
extends java.lang.Object
implements I_CmsScheduledJob

A schedulable OpenCms job that optimizes the Lucene based search indexes at runtime.

Only indexes which return true for 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.

从以下版本开始:

8.5.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PARAM_INDEXES_EXCLUDED Parameter to control which indexes are excluded from optimization.
static java.lang.String	PARAM_INDEXES_OPTIMIZED Parameter to control which indexes are optimized.

构造器概要

构造器

构造器和说明
CmsSearchIndexOptimizeJob()

方法概要

方法

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

PARAM_INDEXES_EXCLUDED

public static final java.lang.String PARAM_INDEXES_EXCLUDED

Parameter to control which indexes are excluded from optimization.

另请参阅:

常量字段值

PARAM_INDEXES_OPTIMIZED

public static final java.lang.String PARAM_INDEXES_OPTIMIZED

Parameter to control which indexes are optimized.

另请参阅:

常量字段值

构造器详细资料

CmsSearchIndexOptimizeJob

public CmsSearchIndexOptimizeJob()

方法详细资料

launch

public java.lang.String launch(CmsObject cms,
                      java.util.Map<java.lang.String,java.lang.String> parameters)
                        throws java.lang.Exception

从接口复制的说明: 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, on INFO log level.

指定者:

launch 在接口中 I_CmsScheduledJob

参数:

cms - will be initialized with the configured users cms context

parameters - the configured parameters

返回:

a String that will be written to the OpenCms logfile

抛出:

java.lang.Exception - if something goes wrong

另请参阅:

I_CmsScheduledJob.launch(CmsObject, Map)