public abstract class SchedulerPluginWithUserTransactionSupport extends Object implements SchedulerPlugin
UserTransaction
. This is
often necessary if using the JobStoreCMT and the plugin interacts with
jobs/triggers.
The subclass should implement start(UserTransaction) and
shutdown(UserTransaction). The UserTransaction
will be
non-null if property wrapInUserTransaction is set to true.
For convenience, this base class also provides an initialize() implementation which saves the scheduler and plugin name, as well as getLog() for logging.
Constructor and Description |
---|
SchedulerPluginWithUserTransactionSupport() |
Modifier and Type | Method and Description |
---|---|
protected org.slf4j.Logger |
getLog()
Get the commons Logger for this class.
|
protected String |
getName()
Get the name of this plugin.
|
protected Scheduler |
getScheduler()
Get this plugin's
Scheduler . |
boolean |
getWrapInUserTransaction()
Wrap the start() and shutdown() methods in a UserTransaction.
|
void |
initialize(String name,
Scheduler scheduler)
Called during creation of the
Scheduler in order to give
the SchedulerPlugin a chance to initialize. |
void |
setWrapInUserTransaction(boolean wrapInUserTransaction)
Wrap the start() and shutdown() methods in a UserTransaction.
|
void |
shutdown()
Based on the value of wrapInUserTransaction, wraps the
call to shutdown(UserTransaction) in a UserTransaction.
|
protected void |
shutdown(UserTransaction userTransaction)
Called in order to inform the
SchedulerPlugin that it
should free up all of it's resources because the scheduler is shutting
down. |
void |
start()
Based on the value of wrapInUserTransaction, wraps the
call to start(UserTransaction) in a UserTransaction.
|
protected void |
start(UserTransaction userTransaction)
Called when the associated
Scheduler is started, in order
to let the plug-in know it can now make calls into the scheduler if it
needs to. |
public SchedulerPluginWithUserTransactionSupport()
protected void start(UserTransaction userTransaction)
Called when the associated Scheduler
is started, in order
to let the plug-in know it can now make calls into the scheduler if it
needs to.
If UserTransaction is not null, the plugin can call setRollbackOnly() on it to signal that the wrapped transaction should rollback.
userTransaction
- The UserTranaction object used to provide a
transaction around the start() operation. It will be null if
wrapInUserTransaction is false or if the transaction failed
to be started.protected void shutdown(UserTransaction userTransaction)
Called in order to inform the SchedulerPlugin
that it
should free up all of it's resources because the scheduler is shutting
down.
If UserTransaction is not null, the plugin can call setRollbackOnly() on it to signal that the wrapped transaction should rollback.
userTransaction
- The UserTranaction object used to provide a
transaction around the shutdown() operation. It will be null if
wrapInUserTransaction is false or if the transaction failed
to be started.protected org.slf4j.Logger getLog()
protected String getName()
protected Scheduler getScheduler()
Scheduler
. Set as part of initialize().public void initialize(String name, Scheduler scheduler) throws SchedulerException
SchedulerPlugin
Called during creation of the Scheduler
in order to give
the SchedulerPlugin
a chance to initialize.
At this point, the Scheduler's JobStore
is not yet
initialized.
If you need direct access your plugin, for example during Job
execution, you can have this method explicitly put a
reference to this plugin in the Scheduler
's
SchedulerContext
.
initialize
in interface SchedulerPlugin
name
- The name by which the plugin is identified.scheduler
- The scheduler to which the plugin is registered.SchedulerConfigException
- if there is an error initializing.SchedulerException
public boolean getWrapInUserTransaction()
public void setWrapInUserTransaction(boolean wrapInUserTransaction)
public void start()
start
in interface SchedulerPlugin
public void shutdown()
shutdown
in interface SchedulerPlugin
Copyright © 2017. All rights reserved.