Package org.nuxeo.ecm.core.scheduler

Class SchedulerServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.scheduler.SchedulerServiceImpl

All Implemented Interfaces:

SchedulerService, Adaptable, Component, Extensible, TimestampedService

public class SchedulerServiceImpl
extends DefaultComponent
implements SchedulerService

Schedule service implementation. Since the cleanup of the quartz job is done when service is activated, ( see https://jira.nuxeo.com/browse/NXP-7303 ) in cluster mode, the schedules contributions MUST be the same on all nodes. Due the fact that all jobs are removed when service starts on a node it may be a short period with no schedules in quartz table even other node is running.

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	CLUSTER_START_DELAY_DEFAULT	Default value is set to 5 seconds to delay the start by default
static final String	CLUSTER_START_DELAY_PROP
static final Duration	CLUSTER_START_DURATION_DEFAULT
static final String	CLUSTER_START_DURATION_PROP
protected RuntimeContext	context
protected final ScheduleExtensionRegistry	registry
protected org.quartz.Scheduler	scheduler

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
SchedulerServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(ComponentContext context)	Activates the component.
void	deactivate(ComponentContext context)	Deactivates the component.
RuntimeContext	getContext()
List<Schedule>	getSchedules()	Gets the list of the registered schedules.
boolean	hasApplicationStarted()	Checks if the framework has fully started.
void	pause()	Pause the scheduler service.
void	registerExtension(Extension extension)	Registers the given extension.
void	registerSchedule(Schedule schedule)	Registers a schedule.
void	registerSchedule(Schedule schedule, Map<String,Serializable> parameters)	Registers a schedule.
void	resume()	Resume the scheduler service.
protected void	schedule(String id, org.quartz.JobDetail job, org.quartz.Trigger trigger)
protected void	schedule(Schedule schedule, Map<String,Serializable> parameters)
protected void	setupScheduler()
protected void	shutdownScheduler()
void	start(ComponentContext context)	Start the component.
protected void	startScheduler()
void	stop(ComponentContext context)	Stop the component.
void	unregisterExtension(Extension extension)	Unregisters the given extension.
boolean	unregisterSchedule(String id)	UnRegisters a schedule.
boolean	unregisterSchedule(Schedule schedule)	UnRegisters a schedule.
protected boolean	unschedule(String id)
protected boolean	unschedule(String id, org.quartz.JobKey jobKey)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

addRuntimeMessage, addRuntimeMessage, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, setLastModified, setModifiedNow, setName, unregister, unregisterContribution

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

CLUSTER_START_DURATION_PROP

public static final String CLUSTER_START_DURATION_PROP

Since:

11.1

See Also:

• Constant Field Values

CLUSTER_START_DURATION_DEFAULT

public static final Duration CLUSTER_START_DURATION_DEFAULT

Since:

11.1

CLUSTER_START_DELAY_PROP

public static final String CLUSTER_START_DELAY_PROP

Since:

2021.19

See Also:

• Constant Field Values

CLUSTER_START_DELAY_DEFAULT

public static final Duration CLUSTER_START_DELAY_DEFAULT

Default value is set to 5 seconds to delay the start by default

Since:

2021.19

context

protected RuntimeContext context

scheduler

protected org.quartz.Scheduler scheduler

registry

protected final ScheduleExtensionRegistry registry

Constructor Details

SchedulerServiceImpl

public SchedulerServiceImpl()

Method Details

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

setupScheduler

protected void setupScheduler()
                       throws IOException,
org.quartz.SchedulerException

Throws:

IOException

org.quartz.SchedulerException

shutdownScheduler

protected void shutdownScheduler()

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

startScheduler

protected void startScheduler()

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

hasApplicationStarted

public boolean hasApplicationStarted()

Description copied from interface: SchedulerService

Checks if the framework has fully started.

Used to delay job execution until the framework has fully started.

Specified by:

hasApplicationStarted in interface SchedulerService

Returns:

true if the framework has started

registerExtension

public void registerExtension(Extension extension)

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

unregisterExtension

public void unregisterExtension(Extension extension)

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

getContext

public RuntimeContext getContext()

registerSchedule

public void registerSchedule(Schedule schedule)

Description copied from interface: SchedulerService

Registers a schedule.

Specified by:

registerSchedule in interface SchedulerService

Parameters:

schedule - the schedule

registerSchedule

public void registerSchedule(Schedule schedule,
 Map<String,Serializable> parameters)

Description copied from interface: SchedulerService

Registers a schedule. Add all parameters to eventContext.

Specified by:

registerSchedule in interface SchedulerService

schedule

protected void schedule(Schedule schedule,
 Map<String,Serializable> parameters)

unregisterSchedule

public boolean unregisterSchedule(String id)

Description copied from interface: SchedulerService

UnRegisters a schedule.

Specified by:

unregisterSchedule in interface SchedulerService

Parameters:

id - the schedule id

Returns:

true if schedule has been successfully removed.

schedule

protected void schedule(String id,
 org.quartz.JobDetail job,
 org.quartz.Trigger trigger)
                 throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

unschedule

protected boolean unschedule(String id)

unschedule

protected boolean unschedule(String id,
 org.quartz.JobKey jobKey)

unregisterSchedule

public boolean unregisterSchedule(Schedule schedule)

Description copied from interface: SchedulerService

UnRegisters a schedule.

Specified by:

unregisterSchedule in interface SchedulerService

Parameters:

schedule - to be unregistered

Returns:

true if schedule has been successfully removed.

getSchedules

public List<Schedule> getSchedules()

Description copied from interface: SchedulerService

Gets the list of the registered schedules.

Specified by:

getSchedules in interface SchedulerService

Returns:

the schedules list

pause

public void pause()

Description copied from interface: SchedulerService

Pause the scheduler service. The pause is cluster-wide and survives a node restart. See SchedulerService.resume() to resume the schedules service.

Specified by:

pause in interface SchedulerService

resume

public void resume()

Description copied from interface: SchedulerService

Resume the scheduler service.

Specified by:

resume in interface SchedulerService