com.norconex.jef.mail
Class SuiteCompletedMailNotifier

java.lang.Object
  extended by com.norconex.jef.mail.AbstractMailNotifier
      extended by com.norconex.jef.mail.SuiteCompletedMailNotifier
All Implemented Interfaces:
ISuiteLifeCycleListener

public class SuiteCompletedMailNotifier
extends AbstractMailNotifier
implements ISuiteLifeCycleListener

Simple suite life-cycle listener notifying email recipients when a job suite completes.

Author:
Pascal Essiembre

Constructor Summary
SuiteCompletedMailNotifier(String host, String sender, String recipient)
           
SuiteCompletedMailNotifier(String host, String sender, String[] recipients)
           
 
Method Summary
 void suiteAborted(JobSuite suite)
          Invoked when a job suite is aborted.
 void suiteCompleted(JobSuite suite)
          Invoked when a job suite completes.
 void suiteStarted(JobSuite suite)
          Invoked when a job suite is started.
 void suiteStopped(JobSuite suite)
          Invoked when a job suite is stopped.
 void suiteStopping(JobSuite suite)
          Invoked when a job suite is stopping.
 void suiteTerminatedPrematuraly(JobSuite suite)
          Invoked when a job suite finished executing.
 
Methods inherited from class com.norconex.jef.mail.AbstractMailNotifier
getLogTail, getMailer, getRecipients
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SuiteCompletedMailNotifier

public SuiteCompletedMailNotifier(String host,
                                  String sender,
                                  String recipient)
See Also:
AbstractMailNotifier.AbstractMailNotifier(String, String, String)

SuiteCompletedMailNotifier

public SuiteCompletedMailNotifier(String host,
                                  String sender,
                                  String[] recipients)
See Also:
AbstractMailNotifier.AbstractMailNotifier(String, String, String[])
Method Detail

suiteAborted

public void suiteAborted(JobSuite suite)
Description copied from interface: ISuiteLifeCycleListener
Invoked when a job suite is aborted. This method offers little in terms of error handling. Refer to IErrorHandler to implement error handing.

Specified by:
suiteAborted in interface ISuiteLifeCycleListener
Parameters:
suite - job suite

suiteStarted

public void suiteStarted(JobSuite suite)
Description copied from interface: ISuiteLifeCycleListener
Invoked when a job suite is started.

Specified by:
suiteStarted in interface ISuiteLifeCycleListener
Parameters:
suite - job suite

suiteCompleted

public final void suiteCompleted(JobSuite suite)
Description copied from interface: ISuiteLifeCycleListener
Invoked when a job suite completes. A completed job suite is one where all job executions returned true and progress is at 100%. Given that jobs are implemented correctly, this is usually a good indication of success.

Specified by:
suiteCompleted in interface ISuiteLifeCycleListener
Parameters:
suite - job suite

suiteTerminatedPrematuraly

public void suiteTerminatedPrematuraly(JobSuite suite)
Description copied from interface: ISuiteLifeCycleListener
Invoked when a job suite finished executing. A job may finish without having completed successfully.

Specified by:
suiteTerminatedPrematuraly in interface ISuiteLifeCycleListener
Parameters:
suite - job suite

suiteStopped

public void suiteStopped(JobSuite suite)
Description copied from interface: ISuiteLifeCycleListener
Invoked when a job suite is stopped.

Specified by:
suiteStopped in interface ISuiteLifeCycleListener
Parameters:
suite - job suite

suiteStopping

public void suiteStopping(JobSuite suite)
Description copied from interface: ISuiteLifeCycleListener
Invoked when a job suite is stopping.

Specified by:
suiteStopping in interface ISuiteLifeCycleListener
Parameters:
suite - job suite


Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.