public class TriggerOperator
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
TriggerOperator.ScheduledTriggerJob
A quartz job that is executed every time a
Trigger is invoked. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TRIGGER_KEY |
static java.lang.String |
TRIGGER_OPERATOR_KEY |
Constructor and Description |
---|
TriggerOperator(int threadPoolSize)
Constructor
|
TriggerOperator(TriggerDao triggerDao,
int threadPoolSize)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
deleteTrigger(java.lang.String triggerGroup,
java.lang.String triggerId)
Deletes/Removes the
Trigger . |
void |
deleteTrigger(java.lang.String triggerGroup,
Trigger trigger)
Deletes/Removes the
Trigger . |
void |
destroy() |
void |
disableTrigger(java.lang.String triggerId)
Disables the
Trigger . |
void |
disableTrigger(Trigger trigger)
Disables the
Trigger . |
void |
enableTrigger(java.lang.String triggerId)
Enables the
Trigger . |
void |
enableTrigger(Trigger trigger)
Enables the
Trigger |
void |
execute(java.lang.String triggerId)
Executes the
Trigger . |
void |
execute(Trigger trigger)
Executes the
Trigger . |
static TriggerOperator |
getInstance()
Returns a default instance of
TriggerOperator with sensible default values. |
static TriggerOperator |
getInstance(int threadPoolSize) |
static TriggerOperator |
getInstance(TriggerDao triggerDao,
int threadPoolSize) |
Trigger |
getTrigger(java.lang.String triggerId)
Returns the
Trigger based on the unique trigger id. |
java.util.List<Trigger> |
getTriggers()
Returns a list of all the
Trigger s registered with the trigger service. |
java.util.List<Trigger> |
getTriggers(java.lang.String triggerGroup)
Returns a list of
Trigger s registered with the trigger service for the given triggerGroup. |
void |
initialize()
Users of this class must call
initialize() before they use this class. |
boolean |
isScheduled(ScheduledTrigger scheduledTrigger)
Checks if a
ScheduledTrigger is scheduled in the scheduler or not. |
java.lang.String |
registerTrigger(java.lang.String triggerGroup,
Trigger trigger)
Registers a
Trigger with trigger service. |
void |
scheduleTrigger(ScheduledTrigger scheduledTrigger)
Schedules the
Trigger using the scheduler. |
void |
unscheduleTrigger(ScheduledTrigger scheduledTrigger)
Un-schedules the
Trigger . |
public static final java.lang.String TRIGGER_KEY
public static final java.lang.String TRIGGER_OPERATOR_KEY
public TriggerOperator(int threadPoolSize)
threadPoolSize
- the thread pool size for the schedulerpublic TriggerOperator(TriggerDao triggerDao, int threadPoolSize)
triggerDao
- dao implementation for Trigger
threadPoolSize
- the thread pool size for the scheduler@PostConstruct public void initialize() throws SchedulerException
initialize()
before they use this class.SchedulerException
@PreDestroy public void destroy() throws SchedulerException
SchedulerException
public static TriggerOperator getInstance()
TriggerOperator
with sensible default values.
Uses an in-memory implementation of Dao.public static TriggerOperator getInstance(int threadPoolSize)
threadPoolSize
- public static TriggerOperator getInstance(TriggerDao triggerDao, int threadPoolSize)
triggerDao
- threadPoolSize
- public Trigger getTrigger(java.lang.String triggerId)
Trigger
based on the unique trigger id.triggerId
- the string that uniquely identifies the Trigger
Trigger
that matches triggerId
public java.lang.String registerTrigger(java.lang.String triggerGroup, Trigger trigger) throws SchedulerException
Trigger
with trigger service.triggerGroup
- trigger
- SchedulerException
public void disableTrigger(java.lang.String triggerId) throws TriggerNotFoundException, SchedulerException
Trigger
. If the Trigger
is disabled it will not execute.triggerId
- the string that uniquely identifies the Trigger
to be disabledTriggerNotFoundException
- if there is no Trigger
that matches triggerId
SchedulerException
public void disableTrigger(Trigger trigger) throws SchedulerException
Trigger
. If the Trigger
is disabled it will not execute.trigger
- the Trigger
to be disabledSchedulerException
public void enableTrigger(java.lang.String triggerId) throws TriggerNotFoundException, SchedulerException
Trigger
.triggerId
- the string that uniquely identifies the Trigger
to be enabledTriggerNotFoundException
- if there is no Trigger
that matches triggerId
SchedulerException
public void enableTrigger(Trigger trigger) throws SchedulerException
Trigger
trigger
- the Trigger
to be enabledSchedulerException
public void deleteTrigger(java.lang.String triggerGroup, java.lang.String triggerId) throws TriggerNotFoundException, SchedulerException
Trigger
. If it is a ScheduledTrigger
then it is also un-scheduled from
scheduler.triggerId
- the string that uniquely identifies the Trigger
to be removedTriggerNotFoundException
- if there is no Trigger
that matches triggerId
SchedulerException
public void deleteTrigger(java.lang.String triggerGroup, Trigger trigger) throws SchedulerException
Trigger
. If it is a ScheduledTrigger
then it is also un-scheduled from
scheduler.trigger
- the Trigger
to be removedSchedulerException
public void scheduleTrigger(ScheduledTrigger scheduledTrigger) throws SchedulerException
Trigger
using the scheduler.scheduledTrigger
- SchedulerException
public boolean isScheduled(ScheduledTrigger scheduledTrigger) throws SchedulerException
ScheduledTrigger
is scheduled in the scheduler or not.scheduledTrigger
- SchedulerException
public void unscheduleTrigger(ScheduledTrigger scheduledTrigger) throws SchedulerException
Trigger
.scheduledTrigger
- SchedulerException
public java.util.List<Trigger> getTriggers(java.lang.String triggerGroup)
Trigger
s registered with the trigger service for the given triggerGroup.triggerGroup
- public java.util.List<Trigger> getTriggers()
Trigger
s registered with the trigger service.Trigger
s that are registered with the trigger servicepublic void execute(java.lang.String triggerId) throws java.lang.Exception
Trigger
.triggerId
- the string that uniquely identifies the Trigger
to be executedTriggerNotFoundException
- if there is no Trigger
that matches triggerId
java.lang.Exception
- if an exception occurred during the execution of the Trigger
public void execute(Trigger trigger) throws java.lang.Exception
Trigger
.trigger
- the Trigger
to be executedjava.lang.Exception
- if an exception occurred during the execution of the Trigger