|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.quartz.plugins.SchedulerPluginWithUserTransactionSupport
public abstract class SchedulerPluginWithUserTransactionSupport
Base class for plugins that wish to support having their start and
shutdown methods run within a 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 Summary | |
---|---|
SchedulerPluginWithUserTransactionSupport()
|
Method Summary | |
---|---|
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 pname,
Scheduler sched)
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.quartz.spi.SchedulerPlugin |
---|
initialize |
Constructor Detail |
---|
public SchedulerPluginWithUserTransactionSupport()
Method Detail |
---|
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 pname, Scheduler sched) throws SchedulerException
SchedulerException
public boolean getWrapInUserTransaction()
public void setWrapInUserTransaction(boolean wrapInUserTransaction)
public void start()
start
in interface SchedulerPlugin
public void shutdown()
shutdown
in interface SchedulerPlugin
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |