org.jberet.schedule

Class JobScheduler

java.lang.Object

org.jberet.schedule.JobScheduler

Direct Known Subclasses:

ExecutorSchedulerImpl, TimerSchedulerBean

public abstract class JobScheduler
extends Object

This class defines operations for a job scheduler, and also static methods for obtaining an instance of JobScheduler.

Since:

1.3.0

See Also:

JobSchedule, JobScheduleConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALENDAR Feature name for calendar-based job schedule.
static String[]	EMPTY_STRING_ARRAY Convenience empty string array.
protected static String	MANAGED_EXECUTOR_SERVICE_LOOKUP Lookup name for the managed scheduled executor service.
static String	PERSISTENT Feature name for persistent job schedule.
protected static String	TIMER_SCHEDULER_LOOKUP Lookup name for EJB-Timer-based job scheduler implementation.
protected static TimeUnit	timeUnit Time unit for job schedule.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JobScheduler() Default no-arg constructor.

Method Summary

Modifier and Type	Method and Description
abstract boolean	cancel(String scheduleId) Cancels a job schedule by its id.
void	delete(String scheduleId) Deletes a job schedule by its id.
String[]	getFeatures() Gets the features supported by the current job scheduler.
static javax.batch.operations.JobOperator	getJobOperator() Convenience method for getting JobOperator.
abstract JobSchedule	getJobSchedule(String scheduleId) Gets the job schedule by its id.
static JobScheduler	getJobScheduler() Gets the job scheduler without passing any parameters.
static JobScheduler	getJobScheduler(Class<? extends JobScheduler> schedulerType, ConcurrentMap<String,JobSchedule> schedules, String managedScheduledExecutorServiceLookup) Gets the job scheduler, specifying scheduler type, ConcurrentMap<String, JobSchedule> for storing all job schedules, and the lookup name of ManagedScheduledExecutorService resource.
abstract List<JobSchedule>	getJobSchedules() Gets all job schedules known to the scheduler.
abstract JobSchedule	schedule(JobScheduleConfig scheduleConfig) submits a job schedule specified with the job schedule config.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING_ARRAY

public static final String[] EMPTY_STRING_ARRAY

Convenience empty string array.

PERSISTENT

public static final String PERSISTENT

Feature name for persistent job schedule.

See Also:

Constant Field Values

CALENDAR

public static final String CALENDAR

Feature name for calendar-based job schedule.

See Also:

Constant Field Values

timeUnit

protected static final TimeUnit timeUnit

Time unit for job schedule.

TIMER_SCHEDULER_LOOKUP

protected static final String TIMER_SCHEDULER_LOOKUP

Lookup name for EJB-Timer-based job scheduler implementation.

See Also:

Constant Field Values

MANAGED_EXECUTOR_SERVICE_LOOKUP

protected static final String MANAGED_EXECUTOR_SERVICE_LOOKUP

Lookup name for the managed scheduled executor service.

See Also:

Constant Field Values

Constructor Detail

JobScheduler

protected JobScheduler()

Default no-arg constructor.

Method Detail

getJobScheduler

public static JobScheduler getJobScheduler()

Gets the job scheduler without passing any parameters.

Returns:

job scheduler

See Also:

getJobScheduler(Class, ConcurrentMap, String)

getJobScheduler

public static JobScheduler getJobScheduler(Class<? extends JobScheduler> schedulerType,
                                           ConcurrentMap<String,JobSchedule> schedules,
                                           String managedScheduledExecutorServiceLookup)

Gets the job scheduler, specifying scheduler type, ConcurrentMap<String, JobSchedule> for storing all job schedules, and the lookup name of ManagedScheduledExecutorService resource. This method determines which type of job scheduler to use as follows:

• If schedulerType is specified, instantiate the specified type.
• Else if lookup of "java:module/TimerSchedulerBean" succeeds, use the job scheduler obtained from that lookup.
• Else if lookup of the resource specified by managedScheduledExecutorServiceLookup succeeds, creates ExecutorSchedulerImpl with the executor from that lookup.
• Else if lookup of "java:comp/DefaultManagedScheduledExecutorService" succeeds, creates ExecutorSchedulerImpl with the executor from that lookup.
• Else creates ExecutorSchedulerImpl.

Parameters:

schedulerType - fully-qualified class name of job scheduler type

schedules - ConcurrentMap<String, JobSchedule> for storing all job schedules

managedScheduledExecutorServiceLookup - lookup name of ManagedScheduledExecutorService resource

Returns:

job scheduler

getJobOperator

public static javax.batch.operations.JobOperator getJobOperator()

Convenience method for getting JobOperator.

Returns:

JobOperator

getFeatures

public String[] getFeatures()

Gets the features supported by the current job scheduler.

Returns:

feature names as a string array

See Also:

EMPTY_STRING_ARRAY, PERSISTENT, CALENDAR

delete

public void delete(String scheduleId)

Deletes a job schedule by its id. The default implementation of this method just calls cancel(String) method.

Parameters:

scheduleId - the schedule id to delete

Since:

1.3.0.Beta7

schedule

public abstract JobSchedule schedule(JobScheduleConfig scheduleConfig)

submits a job schedule specified with the job schedule config.

Parameters:

scheduleConfig - job schedule config

Returns:

the job schedule resulting from the submission

getJobSchedules

public abstract List<JobSchedule> getJobSchedules()

Gets all job schedules known to the scheduler. Some implementation may keep the job schedule record after its expiration or cancellation, and some may just remove them immediately.

Returns:

all job schedules

cancel

public abstract boolean cancel(String scheduleId)

Cancels a job schedule by its id.

Parameters:

scheduleId - the schedule id to cancel

Returns:

true if cancelled successfully; false otherwise

getJobSchedule

public abstract JobSchedule getJobSchedule(String scheduleId)

Gets the job schedule by its id.

Parameters:

scheduleId - id of the job schedule to retrieve

Returns:

the job schedule matching the specified id