org.opencms.scheduler

类 CmsScheduleManager

java.lang.Object

org.opencms.scheduler.CmsScheduleManager

所有已实现的接口:

org.quartz.Job

public class CmsScheduleManager
extends java.lang.Object
implements org.quartz.Job

Manages the OpenCms scheduled jobs.

Please see the documentation of the class CmsScheduledJobInfo for a full description of the OpenCms scheduling capabilities.

The OpenCms scheduler implementation internally uses the Quartz scheduler from the OpenSymphony project.

This manager class implements the org.quartz.Job interface and wraps all calls to the I_CmsScheduledJob implementing classes.

从以下版本开始:

6.0.0

另请参阅:

CmsScheduledJobInfo

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	SCHEDULER_JOB_INFO Key for the scheduled job description in the job data map.

构造器概要

构造器

构造器和说明
CmsScheduleManager() Default constructor for the scheduler manager, used only when a new job is scheduled.
CmsScheduleManager(java.util.List<CmsScheduledJobInfo> configuredJobs) Used by the configuration to create a new Scheduler during system startup.

方法概要

方法

限定符和类型	方法和说明
void	execute(org.quartz.JobExecutionContext context) Implementation of the Quartz job interface.
void	executeDirectly(java.lang.String jobId) Given a job ID, this directly executes the corresponding job.
protected void	executeJob(CmsScheduledJobInfo jobInfo) Executes the given job.
CmsScheduledJobInfo	getJob(java.lang.String id) Returns the currently scheduled job description identified by the given id.
java.util.List<CmsScheduledJobInfo>	getJobs() Returns the currently scheduled job descriptions in an unmodifiable list.
void	initialize(CmsObject adminCms) Initializes the OpenCms scheduler.
void	scheduleJob(CmsObject cms, CmsScheduledJobInfo jobInfo) Adds a new job to the scheduler.
void	shutDown() Shuts down this instance of the OpenCms scheduler manager.
CmsScheduledJobInfo	unscheduleJob(CmsObject cms, java.lang.String jobId) Removes a currently scheduled job from the scheduler.

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

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

字段详细资料

SCHEDULER_JOB_INFO

public static final java.lang.String SCHEDULER_JOB_INFO

Key for the scheduled job description in the job data map.

另请参阅:

常量字段值

构造器详细资料

CmsScheduleManager

public CmsScheduleManager()

Default constructor for the scheduler manager, used only when a new job is scheduled.

CmsScheduleManager

public CmsScheduleManager(java.util.List<CmsScheduledJobInfo> configuredJobs)

Used by the configuration to create a new Scheduler during system startup.

参数:

configuredJobs - the jobs from the configuration

方法详细资料

execute

public void execute(org.quartz.JobExecutionContext context)

Implementation of the Quartz job interface.

The architecture is that this scheduler manager generates a new (empty) instance of itself for every OpenCms job scheduled with Quartz. When the Quartz job is executed, the configured implementation of I_CmsScheduledJob will be called from this method.

指定者:

execute 在接口中 org.quartz.Job

另请参阅:

Job.execute(org.quartz.JobExecutionContext)

executeDirectly

public void executeDirectly(java.lang.String jobId)

Given a job ID, this directly executes the corresponding job.

参数:

jobId - the job id

getJob

public CmsScheduledJobInfo getJob(java.lang.String id)

Returns the currently scheduled job description identified by the given id.

参数:

id - the job id

返回:

a job or null if not found

getJobs

public java.util.List<CmsScheduledJobInfo> getJobs()

Returns the currently scheduled job descriptions in an unmodifiable list.

The objects in the List are of type CmsScheduledJobInfo.

返回:

the currently scheduled job descriptions in an unmodifiable list

initialize

public void initialize(CmsObject adminCms)
                throws CmsRoleViolationException

Initializes the OpenCms scheduler.

参数:

adminCms - an OpenCms context object that must have been initialized with "Admin" permissions

抛出:

CmsRoleViolationException - if the user has insufficient role permissions

scheduleJob

public void scheduleJob(CmsObject cms,
               CmsScheduledJobInfo jobInfo)
                 throws CmsRoleViolationException,
                        CmsSchedulerException

Adds a new job to the scheduler.

参数:

cms - an OpenCms context object that must have been initialized with "Admin" permissions

jobInfo - the job info describing the job to schedule

抛出:

CmsRoleViolationException - if the user has insufficient role permissions

CmsSchedulerException - if the job could not be scheduled for any reason

shutDown

public void shutDown()

Shuts down this instance of the OpenCms scheduler manager.

unscheduleJob

public CmsScheduledJobInfo unscheduleJob(CmsObject cms,
                                java.lang.String jobId)
                                  throws CmsRoleViolationException

Removes a currently scheduled job from the scheduler.

参数:

cms - an OpenCms context object that must have been initialized with "Admin" permissions

jobId - the id of the job to unschedule, obtained with CmsScheduledJobInfo.getId()

返回:

the CmsScheduledJobInfo of the sucessfully unscheduled job, or null if the job could not be unscheduled

抛出:

CmsRoleViolationException - if the user has insufficient role permissions

executeJob

protected void executeJob(CmsScheduledJobInfo jobInfo)

Executes the given job.

参数:

jobInfo - the job info bean