Package com.broadleafcommerce.scheduledjob.service

Class DefaultSchedulerService

java.lang.Object

com.broadleafcommerce.scheduledjob.service.DefaultSchedulerService

All Implemented Interfaces:

SchedulerService

public class DefaultSchedulerService
extends Object
implements SchedulerService

Author:

Chad Harchar (charchar)

Field Summary

Fields

Modifier and Type	Field	Description
static String	EVENT_PRODUCER_KEY
protected static String	JOB_DETAIL_JOB_KEY
static String	JOB_REPOSITORY_KEY
static String	JOB_SERVICE_KEY
protected static String	TYPE_FACTORY

Constructor Summary

Constructors

Constructor	Description
DefaultSchedulerService(ScheduledJobService<? extends ScheduledJob> jobService, ScheduledJobRepository<com.broadleafcommerce.data.tracking.core.Trackable> jobRepository, com.broadleafcommerce.common.messaging.notification.NotificationManager notificationManager, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ClusterProperties clusterProperties)	Initializes the scheduler service with an StdScheduler
DefaultSchedulerService(ScheduledJobService<? extends ScheduledJob> jobService, ScheduledJobRepository<com.broadleafcommerce.data.tracking.core.Trackable> jobRepository, com.broadleafcommerce.common.messaging.notification.NotificationManager notificationManager, com.broadleafcommerce.common.extension.TypeFactory typeFactory, org.quartz.Scheduler scheduler, ClusterProperties clusterProperties)

Method Summary

Modifier and Type	Method	Description
protected org.quartz.JobDetail	createJobDetail(ScheduledJob job)
protected Optional<org.quartz.Trigger>	createTrigger(ScheduledJob job)
protected void	deleteJobIfExists(ScheduledJob job, org.quartz.JobKey thisJobKey, Set<org.quartz.JobKey> jobKeys)
protected Optional<org.quartz.JobDetail>	establishTrigger(ScheduledJob job, org.quartz.JobKey thisJobKey, boolean isUpdate)
protected Class<? extends org.quartz.Job>	getJobClass()	The POJO that corresponds to the object that should execute when the quartz job is triggered.
protected void	initializeAndStartScheduler()
Optional<org.quartz.JobDetail>	processJob(ScheduledJob job)	Review a ScheduledJob and add scheduling and trigger information to the running quartz instance, if it's not already there.
void	schedule(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initiates the quartz scheduler to create, update, and delete quartz jobs according to the Scheduled Jobs defined in the database.
protected boolean	updateDetected(ScheduledJob job, org.quartz.JobKey thisJobKey)

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_PRODUCER_KEY

public static final String EVENT_PRODUCER_KEY

See Also:

Constant Field Values

JOB_SERVICE_KEY

public static final String JOB_SERVICE_KEY

See Also:

Constant Field Values

JOB_REPOSITORY_KEY

public static final String JOB_REPOSITORY_KEY

See Also:

Constant Field Values

JOB_DETAIL_JOB_KEY

protected static final String JOB_DETAIL_JOB_KEY

See Also:

Constant Field Values

TYPE_FACTORY

protected static final String TYPE_FACTORY

See Also:

Constant Field Values

Constructor Detail

DefaultSchedulerService

public DefaultSchedulerService(ScheduledJobService<? extends ScheduledJob> jobService,
                               ScheduledJobRepository<com.broadleafcommerce.data.tracking.core.Trackable> jobRepository,
                               com.broadleafcommerce.common.messaging.notification.NotificationManager notificationManager,
                               com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                               ClusterProperties clusterProperties)
                        throws org.quartz.SchedulerException

Initializes the scheduler service with an StdScheduler

Throws:

org.quartz.SchedulerException

DefaultSchedulerService

public DefaultSchedulerService(ScheduledJobService<? extends ScheduledJob> jobService,
                               ScheduledJobRepository<com.broadleafcommerce.data.tracking.core.Trackable> jobRepository,
                               com.broadleafcommerce.common.messaging.notification.NotificationManager notificationManager,
                               com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                               org.quartz.Scheduler scheduler,
                               ClusterProperties clusterProperties)
                        throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

Method Detail

schedule

public void schedule(@Nullable
                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SchedulerService

Initiates the quartz scheduler to create, update, and delete quartz jobs according to the Scheduled Jobs defined in the database.

Specified by:

schedule in interface SchedulerService

Parameters:

contextInfo - context information surrounding multitenant state

processJob

public Optional<org.quartz.JobDetail> processJob(ScheduledJob job)
                                          throws org.quartz.SchedulerException

Description copied from interface: SchedulerService

Review a ScheduledJob and add scheduling and trigger information to the running quartz instance, if it's not already there.

Specified by:

processJob in interface SchedulerService

Parameters:

job - The scheduled job entity

Returns:

The JobDetail resulting from Quartz scheduling, if the item was scheduled

Throws:

org.quartz.SchedulerException - Thrown if a problem occurs in Quartz during scheduling

initializeAndStartScheduler

protected void initializeAndStartScheduler()
                                    throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

establishTrigger

protected Optional<org.quartz.JobDetail> establishTrigger(ScheduledJob job,
                                                          org.quartz.JobKey thisJobKey,
                                                          boolean isUpdate)
                                                   throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

createJobDetail

protected org.quartz.JobDetail createJobDetail(ScheduledJob job)

deleteJobIfExists

protected void deleteJobIfExists(ScheduledJob job,
                                 org.quartz.JobKey thisJobKey,
                                 Set<org.quartz.JobKey> jobKeys)
                          throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

createTrigger

protected Optional<org.quartz.Trigger> createTrigger(ScheduledJob job)

updateDetected

protected boolean updateDetected(ScheduledJob job,
                                 org.quartz.JobKey thisJobKey)
                          throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getJobClass

protected Class<? extends org.quartz.Job> getJobClass()

The POJO that corresponds to the object that should execute when the quartz job is triggered.

Returns:

The POJO that corresponds to the object that should execute when the quartz job is triggered.