org.jberet.schedule

Class TimerSchedulerBean

java.lang.Object

org.jberet.schedule.JobScheduler

org.jberet.schedule.TimerSchedulerBean

public class TimerSchedulerBean
extends JobScheduler

EJB-Timer-based job scheduler, as a singleton session bean. This job scheduler class supports single action, repeatable, and calendar-based job schedule. Persistent job schedule is also supported.

Since:

1.3.0

See Also:

JobScheduler

Field Summary

Fields inherited from class org.jberet.schedule.JobScheduler

CALENDAR, EMPTY_STRING_ARRAY, MANAGED_EXECUTOR_SERVICE_LOOKUP, PERSISTENT, TIMER_SCHEDULER_LOOKUP, timeUnit

Constructor Summary

Constructors

Constructor and Description
TimerSchedulerBean()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(String scheduleId) Cancels a job schedule by its id.
String[]	getFeatures() Gets the features supported by the current job scheduler.
JobSchedule	getJobSchedule(String scheduleId) Gets the job schedule by its id.
List<JobSchedule>	getJobSchedules() Gets all job schedules known to the scheduler.
JobSchedule	schedule(JobScheduleConfig scheduleConfig) submits a job schedule specified with the job schedule config.
protected void	timeout(javax.ejb.Timer timer) Timeout method, which starts the job, or restarts the job execution, and saves the new job execution id to JobSchedule.

Methods inherited from class org.jberet.schedule.JobScheduler

getJobOperator, getJobScheduler, getJobScheduler

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerSchedulerBean

public TimerSchedulerBean()

Method Detail

schedule

public JobSchedule schedule(JobScheduleConfig scheduleConfig)

Description copied from class: JobScheduler

submits a job schedule specified with the job schedule config.

Specified by:

schedule in class JobScheduler

Parameters:

scheduleConfig - job schedule config

Returns:

the job schedule resulting from the submission

getJobSchedules

public List<JobSchedule> getJobSchedules()

Description copied from class: JobScheduler

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.

Specified by:

getJobSchedules in class JobScheduler

Returns:

all job schedules

cancel

public boolean cancel(String scheduleId)

Description copied from class: JobScheduler

Cancels a job schedule by its id.

Specified by:

cancel in class JobScheduler

Parameters:

scheduleId - the schedule id to cancel

Returns:

true if cancelled successfully; false otherwise

getJobSchedule

public JobSchedule getJobSchedule(String scheduleId)

Description copied from class: JobScheduler

Gets the job schedule by its id.

Specified by:

getJobSchedule in class JobScheduler

Parameters:

scheduleId - id of the job schedule to retrieve

Returns:

the job schedule matching the specified id

getFeatures

public String[] getFeatures()

Description copied from class: JobScheduler

Gets the features supported by the current job scheduler.

Overrides:

getFeatures in class JobScheduler

Returns:

feature names as a string array

See Also:

JobScheduler.EMPTY_STRING_ARRAY, JobScheduler.PERSISTENT, JobScheduler.CALENDAR

timeout

protected void timeout(javax.ejb.Timer timer)

Timeout method, which starts the job, or restarts the job execution, and saves the new job execution id to JobSchedule.

Parameters:

timer - the current timer which has just expired