er.quartzscheduler.foundation

Class ERQSJobListener

java.lang.Object

er.quartzscheduler.foundation.ERQSAbstractListener

er.quartzscheduler.foundation.ERQSJobListener

All Implemented Interfaces:

org.quartz.JobListener

public class ERQSJobListener
extends ERQSAbstractListener
implements org.quartz.JobListener

The job listener is called automatically before a job is executed and after it has been executed.

When a job is candidate to be executed, the job listener posts a notification JOB_WILL_RUN through the NSNotificationCenter. If you want to be notified, subscribe to the JOB_WILL_RUN notification name and read the notification userInfo to know which job will be executed.

When a job has been executed, the job listener posts a notification JOB_RAN through the NSNotificationCenter. Again, if you want to be notified, subscribe to the JOB_WILL_RUN notification name and read the notification userInfo to know which job. If the job fails, we can also get the exception from the userInfo with the key EXCEPTION_KEY.

Depending on the nature of the job description, you have to check the following keys when you access to the userInfo:

• ERQSJob.ENTERPRISE_OBJECT_KEY if the isEnterpriseObject() method of the job description returns true
• ERQSJob.NOT_PERSISTENT_OBJECT_KEY if the job description is not an enterprise object

When the job has been executed, the listener logs information and can send an email. The content of the log and the email are identical.

See Also:

jobToBeExecuted(org.quartz.JobExecutionContext), jobWasExecuted(org.quartz.JobExecutionContext, org.quartz.JobExecutionException), sendMail(java.lang.String, java.lang.String, com.webobjects.foundation.NSArray<java.lang.String>), logResult(org.quartz.JobExecutionContext, java.lang.String)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MAIL_ERROR_MESSAGE_TEMPLATE
static String	DEFAULT_MAIL_MESSAGE_WITH_MORE_INFOS_TEMPLATE
static String	DEFAULT_MAIL_SHORT_MESSAGE_TEMPLATE
static String	DEFAULT_MAIL_SUBJECT_TEMPLATE
static String	EXCEPTION_KEY
static String	JOB_RAN
static String	JOB_WILL_RUN

Fields inherited from class er.quartzscheduler.foundation.ERQSAbstractListener

log

Constructor Summary

Constructors

Constructor and Description
ERQSJobListener(ERQSSchedulerServiceFrameworkPrincipal schedulerFPInstance)

Method Summary

Modifier and Type	Method and Description
protected com.webobjects.foundation.NSTimestamp	dateToNSTimestamp(Date date) Utility method.
protected String	formattedDuration(long duration) Return a string used by the logger and the mail sending method.
protected String	getMailContent(org.quartz.JobExecutionContext jobexecutioncontext, String errorMsg) Return the mail content.
protected String	getMailSubject(org.quartz.JobExecutionContext jobexecutioncontext) Return the mail subject.
String	getName() This method is due to JobListener interface.
void	jobExecutionVetoed(org.quartz.JobExecutionContext jobexecutioncontext) This method is due to JobListener interface.
void	jobToBeExecuted(org.quartz.JobExecutionContext jobexecutioncontext) This method is due to JobListener interface.
void	jobWasExecuted(org.quartz.JobExecutionContext jobexecutioncontext, org.quartz.JobExecutionException jobexecutionexception) This method is due to JobListener interface.
protected ERXLocalizer	localizer()
protected void	logResult(org.quartz.JobExecutionContext jobexecutioncontext, String errorMsg) If log info is enabled, logResult logs informations about the job execution like the job duration.
protected NSArray<String>	recipients(org.quartz.JobExecutionContext jobexecutioncontext, boolean jobRanSuccessfully) Return a list of recipients depending on the good or bad execution of the job.
protected void	sendMail(String subject, String textContent, NSArray<String> recipients) Sends an plain text email to: the recipients passed as parameters.
protected void	updateJobDescription(org.quartz.JobExecutionContext jobexecutioncontext, ERQSJobDescription jobDescription) Update the first, last and next execution date attributes of jobDescription

Methods inherited from class er.quartzscheduler.foundation.ERQSAbstractListener

editingContext, getJobDescription, getSchedulerFPInstance

Methods inherited from class java.lang.Object

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

Field Detail

JOB_WILL_RUN

public static String JOB_WILL_RUN

JOB_RAN

public static String JOB_RAN

EXCEPTION_KEY

public static String EXCEPTION_KEY

DEFAULT_MAIL_SUBJECT_TEMPLATE

public static final String DEFAULT_MAIL_SUBJECT_TEMPLATE

See Also:

Constant Field Values

DEFAULT_MAIL_ERROR_MESSAGE_TEMPLATE

public static final String DEFAULT_MAIL_ERROR_MESSAGE_TEMPLATE

See Also:

Constant Field Values

DEFAULT_MAIL_SHORT_MESSAGE_TEMPLATE

public static final String DEFAULT_MAIL_SHORT_MESSAGE_TEMPLATE

See Also:

Constant Field Values

DEFAULT_MAIL_MESSAGE_WITH_MORE_INFOS_TEMPLATE

public static final String DEFAULT_MAIL_MESSAGE_WITH_MORE_INFOS_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

ERQSJobListener

public ERQSJobListener(ERQSSchedulerServiceFrameworkPrincipal schedulerFPInstance)

Method Detail

getName

public String getName()

This method is due to JobListener interface. Get the name of the JobListener.

Specified by:

getName in interface org.quartz.JobListener

jobExecutionVetoed

public void jobExecutionVetoed(org.quartz.JobExecutionContext jobexecutioncontext)

This method is due to JobListener interface.

Called by the Scheduler when a JobDetail was about to be executed (an associated Trigger has occured), but a TriggerListener vetoed it's execution.
The method is empty.

Specified by:

jobExecutionVetoed in interface org.quartz.JobListener

jobToBeExecuted

public void jobToBeExecuted(org.quartz.JobExecutionContext jobexecutioncontext)

This method is due to JobListener interface.

Called by the Scheduler when a JobDetail is about to be executed (an associated Trigger has occurred).

Posts the notification JOB_WILL_RUN and a userInfo with a global ID if the key is ERQSJob.ENTERPRISE_OBJECT_KEY or directly the ERQSJobDescription object with the key ERQSJob.NOT_PERSISTENT_OBJECT_KEY

Specified by:

jobToBeExecuted in interface org.quartz.JobListener

jobWasExecuted

public void jobWasExecuted(org.quartz.JobExecutionContext jobexecutioncontext,
                           org.quartz.JobExecutionException jobexecutionexception)

This method is due to JobListener interface. Called by the Scheduler after a JobDetail has been executed

It retrieve the ERQSJobDescription object from the datamap and updates the object.
It also send an email if er.quartzscheduler.ERQSJobListener.sendingmail=true

Specified by:

jobWasExecuted in interface org.quartz.JobListener

See Also:

recipients(JobExecutionContext, boolean)

recipients

protected NSArray<String> recipients(org.quartz.JobExecutionContext jobexecutioncontext,
                                     boolean jobRanSuccessfully)

Return a list of recipients depending on the good or bad execution of the job. If the job ran successfully, the recipients are:

• the recipients returned by the method recipients() of ERQSJobDescription
• the email set by the property er.quartzscheduler.ERQSJobListener.executionWithSuccess.to if any

If the job didn't run successfully, the recipients are:

• the recipients returned by the method recipients() of ERQSJobDescription
• the email set by the property er.quartzscheduler.ERQSJobListener.executionWithError.to if any

Parameters:

jobexecutioncontext -

jobRanSuccessfully -

Returns:

a list of recipients

See Also:

ERQSJobDescription.recipients(boolean)

updateJobDescription

protected void updateJobDescription(org.quartz.JobExecutionContext jobexecutioncontext,
                                    ERQSJobDescription jobDescription)

Update the first, last and next execution date attributes of jobDescription

Parameters:

jobexecutioncontext -

jobDescription -

logResult

protected void logResult(org.quartz.JobExecutionContext jobexecutioncontext,
                         String errorMsg)

If log info is enabled, logResult logs informations about the job execution like the job duration. It can also logs specific information if the job called the method setResult(message) before ending its duty.

But if something wrong happened, the log displays the message errorMsg.

Parameters:

jobexecutioncontext -

errorMsg -

getMailSubject

protected String getMailSubject(org.quartz.JobExecutionContext jobexecutioncontext)

Return the mail subject.

An interesting improvement will be to use a localized template. Currently, the default message is:
Job info: JobGroup.MyBeautifullJob is done.

Parameters:

jobexecutioncontext - (used to build the job full name)

Returns:

subject

getMailContent

protected String getMailContent(org.quartz.JobExecutionContext jobexecutioncontext,
                                String errorMsg)

Return the mail content.

An interesting improvement will be to use a localized template. Currently, the default content is:
More informations:blabla. It took 90s. if the job returns additional informations or just It took 90s.

Parameters:

jobexecutioncontext - (used to get the job duration)

errorMsg -

Returns:

subject

sendMail

protected void sendMail(String subject,
                        String textContent,
                        NSArray<String> recipients)

Sends an plain text email to:

• the recipients passed as parameters.
• the email stored in the properties file (er.quartzscheduler.ERQSJobListener.to=myEmail@domain.com)

The author is read from properties file (er.quartzscheduler.ERQSJobListener.from=myOtherEmail@domain.com)

Parameters:

subject -

textContent -

recipients -

Throws:

IllegalStateException - if from email is empty and the is no recipient at all.

formattedDuration

protected String formattedDuration(long duration)

Return a string used by the logger and the mail sending method.

If the duration is less than 180s, the duration is expressed in seconds otherwise there is a conversion in mn.

Parameters:

duration -

Returns:

the formatted duration

dateToNSTimestamp

protected com.webobjects.foundation.NSTimestamp dateToNSTimestamp(Date date)

Utility method.

Parameters:

date -

Returns:

the date in NSTimestamp format

localizer

protected ERXLocalizer localizer()