org.apache.gobblin.util

Class EmailUtils

java.lang.Object

org.apache.gobblin.util.EmailUtils

public class EmailUtils
extends Object

A utility class for sending emails.

Constructor Summary

Constructors

Constructor and Description
EmailUtils()

Method Summary

Modifier and Type	Method and Description
static void	sendEmail(State state, String subject, String message) A general method for sending emails.
static void	sendJobCancellationEmail(String jobId, String message, State jobState) Send a job cancellation notification email.
static void	sendJobCompletionEmail(String jobId, String message, String state, State jobState) Send a job completion notification email.
static void	sendJobFailureAlertEmail(String jobName, String message, int failures, State jobState) Send a job failure alert email.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailUtils

public EmailUtils()

Method Detail

sendEmail

public static void sendEmail(State state,
                             String subject,
                             String message)
                      throws org.apache.commons.mail.EmailException

A general method for sending emails.

Parameters:

state - a State object containing configuration properties

subject - email subject

message - email message

Throws:

org.apache.commons.mail.EmailException - if there is anything wrong sending the email

sendJobCompletionEmail

public static void sendJobCompletionEmail(String jobId,
                                          String message,
                                          String state,
                                          State jobState)
                                   throws org.apache.commons.mail.EmailException

Send a job completion notification email.

Parameters:

jobId - job name

message - email message

state - job state

jobState - a State object carrying job configuration properties

Throws:

org.apache.commons.mail.EmailException - if there is anything wrong sending the email

sendJobCancellationEmail

public static void sendJobCancellationEmail(String jobId,
                                            String message,
                                            State jobState)
                                     throws org.apache.commons.mail.EmailException

Send a job cancellation notification email.

Parameters:

jobId - job name

message - email message

jobState - a State object carrying job configuration properties

Throws:

org.apache.commons.mail.EmailException - if there is anything wrong sending the email

sendJobFailureAlertEmail

public static void sendJobFailureAlertEmail(String jobName,
                                            String message,
                                            int failures,
                                            State jobState)
                                     throws org.apache.commons.mail.EmailException

Send a job failure alert email.

Parameters:

jobName - job name

message - email message

failures - number of consecutive job failures

jobState - a State object carrying job configuration properties

Throws:

org.apache.commons.mail.EmailException - if there is anything wrong sending the email