Package org.apache.nifi.bootstrap.notification.email

Class EmailNotificationService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.bootstrap.notification.AbstractNotificationService

org.apache.nifi.bootstrap.notification.email.EmailNotificationService

All Implemented Interfaces:

NotificationService, ConfigurableComponent

public class EmailNotificationService
extends AbstractNotificationService

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyDescriptor	BCC
static final PropertyDescriptor	CC
static final PropertyDescriptor	CONTENT_TYPE
static final PropertyDescriptor	FROM
static final PropertyDescriptor	HEADER_XMAILER
private static final Map<String,PropertyDescriptor>	propertyToContext	Mapping of the mail properties to the NiFi PropertyDescriptors that will be evaluated at runtime
static final PropertyDescriptor	SMTP_AUTH
static final PropertyDescriptor	SMTP_HOSTNAME
static final PropertyDescriptor	SMTP_PASSWORD
static final PropertyDescriptor	SMTP_PORT
static final PropertyDescriptor	SMTP_SOCKET_FACTORY
static final PropertyDescriptor	SMTP_TLS
static final PropertyDescriptor	SMTP_USERNAME
static final PropertyDescriptor	TO

Constructor Summary

Constructors

Constructor	Description
EmailNotificationService()

Method Summary

Modifier and Type	Method	Description
private javax.mail.Session	createMailSession(Properties properties)	Based on the input properties, determine whether an authenticate or unauthenticated session should be used.
protected Collection<ValidationResult>	customValidate(ValidationContext context)
private Properties	getMailProperties(NotificationContext context)	Uses the mapping of javax.mail properties to NiFi PropertyDescriptors to build the required Properties object to be used for sending this email
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	notify(NotificationContext context, NotificationType notificationType, String subject, String messageText)	Notifies the configured recipients of some event
private static javax.mail.internet.InternetAddress[]	toInetAddresses(String val)	Creates an array of 0 or more InternetAddresses for the given String

Methods inherited from class org.apache.nifi.bootstrap.notification.AbstractNotificationService

getIdentifier, init, initialize

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Details

SMTP_HOSTNAME

public static final PropertyDescriptor SMTP_HOSTNAME

SMTP_PORT

public static final PropertyDescriptor SMTP_PORT

SMTP_USERNAME

public static final PropertyDescriptor SMTP_USERNAME

SMTP_PASSWORD

public static final PropertyDescriptor SMTP_PASSWORD

SMTP_AUTH

public static final PropertyDescriptor SMTP_AUTH

SMTP_TLS

public static final PropertyDescriptor SMTP_TLS

SMTP_SOCKET_FACTORY

public static final PropertyDescriptor SMTP_SOCKET_FACTORY

HEADER_XMAILER

public static final PropertyDescriptor HEADER_XMAILER

CONTENT_TYPE

public static final PropertyDescriptor CONTENT_TYPE

FROM

public static final PropertyDescriptor FROM

TO

public static final PropertyDescriptor TO

CC

public static final PropertyDescriptor CC

BCC

public static final PropertyDescriptor BCC

propertyToContext

private static final Map<String,PropertyDescriptor> propertyToContext

Mapping of the mail properties to the NiFi PropertyDescriptors that will be evaluated at runtime

Constructor Details

EmailNotificationService

public EmailNotificationService()

Method Details

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

notify

public void notify(NotificationContext context,
 NotificationType notificationType,
 String subject,
 String messageText)
            throws NotificationFailedException

Description copied from interface: NotificationService

Notifies the configured recipients of some event

Parameters:

context - the context that is relevant for this notification

notificationType - the notification type

subject - the subject of the message

messageText - the message to be provided to recipients

Throws:

NotificationFailedException

toInetAddresses

private static javax.mail.internet.InternetAddress[] toInetAddresses(String val)
                                                              throws javax.mail.internet.AddressException

Creates an array of 0 or more InternetAddresses for the given String

Parameters:

val - the String to parse for InternetAddresses

Returns:

an array of 0 or more InetAddresses

Throws:

javax.mail.internet.AddressException - if val contains an invalid address

getMailProperties

private Properties getMailProperties(NotificationContext context)

Uses the mapping of javax.mail properties to NiFi PropertyDescriptors to build the required Properties object to be used for sending this email

Parameters:

context - context

Returns:

mail properties

createMailSession

private javax.mail.Session createMailSession(Properties properties)

Based on the input properties, determine whether an authenticate or unauthenticated session should be used. If authenticated, creates a Password Authenticator for use in sending the email.

Parameters:

properties - mail properties

Returns:

session