|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.quartz.plugins.history.LoggingJobHistoryPlugin
Logs a history of all job execytions via the Jakarta Commons-Logging framework.
The logged message is customizable by setting one of the
following message properties to a String that conforms to the syntax of
java.util.MessageFormat
.
TriggerFiredMessage - available message data are:
Element | Data Type | Description |
---|---|---|
0 | String | The Job's Name. |
1 | String | The Job's Group. |
2 | Date | The current time. |
3 | String | The Trigger's name. |
4 | String | The Triggers's group. |
5 | Date | The scheduled fire time. |
6 | Date | The next scheduled fire time. |
7 | Integer | The re-fire count from the JobExecutionContext. |
TriggerCompleteMessage - available message data are:
Element | Data Type | Description |
---|---|---|
0 | String | The Job's Name. |
1 | String | The Job's Group. |
2 | Date | The current time. |
3 | String | The Trigger's name. |
4 | String | The Triggers's group. |
5 | Date | The scheduled fire time. |
6 | Date | The next scheduled fire time. |
7 | Integer | The re-fire count from the JobExecutionContext. |
8 | String | The message from any thrown JobExecution Exception, or "NO ERRORS". |
Constructor Summary | |
LoggingJobHistoryPlugin()
|
Method Summary | |
java.lang.String |
getJobCompleteMessage()
Get the message that is logged when a Job completes its execution. |
java.lang.String |
getJobToBeFiredMessage()
Get the message that is logged when a Job is about to execute. |
protected static org.apache.commons.logging.Log |
getLog()
|
java.lang.String |
getName()
Get the name of the JobListener . |
void |
initialize(java.lang.String name,
Scheduler scheduler)
Called during creation of the Scheduler in order to give
the SchedulerPlugin a chance to initialize. |
void |
jobToBeExecuted(JobExecutionContext context)
Called by the when a
is about to be executed (an associated
has occured). |
void |
jobWasExecuted(JobExecutionContext context,
JobExecutionException jobException)
Called by the after a
has been executed, and be for the associated
Trigger 's triggered(xx) method has been
called. |
void |
setJobCompleteMessage(java.lang.String jobCompleteMessage)
Set the message that is logged when a Job completes its execution. |
void |
setJobToBeFiredMessage(java.lang.String jobToBeFiredMessage)
Set the message that is logged when a Job is about to execute. |
void |
shutdown()
Called in order to inform the SchedulerPlugin
that it should free up all of it's resources because the scheduler is
shutting down. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public LoggingJobHistoryPlugin()
Method Detail |
protected static org.apache.commons.logging.Log getLog()
public java.lang.String getJobCompleteMessage()
public java.lang.String getJobToBeFiredMessage()
public void setJobCompleteMessage(java.lang.String jobCompleteMessage)
jobCompleteMessage
- String in java.text.MessageFormat syntax.public void setJobToBeFiredMessage(java.lang.String jobToBeFiredMessage)
jobToBeFiredMessage
- String in java.text.MessageFormat syntax.public void initialize(java.lang.String name, Scheduler scheduler) throws SchedulerException
Called during creation of the Scheduler
in order to give
the SchedulerPlugin
a chance to initialize.
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 void shutdown()
Called in order to inform the SchedulerPlugin
that it should free up all of it's resources because the scheduler is
shutting down.
shutdown
in interface SchedulerPlugin
public java.lang.String getName()
JobListener
Get the name of the JobListener
.
getName
in interface JobListener
public void jobToBeExecuted(JobExecutionContext context)
JobListener
Called by the
when a
Scheduler
is about to be executed (an associated
JobDetail
has occured).Trigger
jobToBeExecuted
in interface JobListener
public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException)
JobListener
Called by the
after a
Scheduler
has been executed, and be for the associated
JobDetail
Trigger
's triggered(xx)
method has been
called.
jobWasExecuted
in interface JobListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |