org.apache.nifi.bootstrap.notification.http

Class HttpNotificationService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.bootstrap.notification.AbstractNotificationService

org.apache.nifi.bootstrap.notification.http.HttpNotificationService

All Implemented Interfaces:

NotificationService, ConfigurableComponent

public class HttpNotificationService
extends AbstractNotificationService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NOTIFICATION_SUBJECT_KEY
static java.lang.String	NOTIFICATION_TYPE_KEY
static PropertyDescriptor	PROP_CONNECTION_TIMEOUT
static PropertyDescriptor	PROP_KEY_PASSWORD
static PropertyDescriptor	PROP_KEYSTORE
static PropertyDescriptor	PROP_KEYSTORE_PASSWORD
static PropertyDescriptor	PROP_KEYSTORE_TYPE
static PropertyDescriptor	PROP_TRUSTSTORE
static PropertyDescriptor	PROP_TRUSTSTORE_PASSWORD
static PropertyDescriptor	PROP_TRUSTSTORE_TYPE
static PropertyDescriptor	PROP_URL
static PropertyDescriptor	PROP_WRITE_TIMEOUT
static PropertyDescriptor	SSL_ALGORITHM
static java.lang.String	STORE_TYPE_JKS
static java.lang.String	STORE_TYPE_PKCS12

Constructor Summary

Constructors

Constructor and Description
HttpNotificationService()

Method Summary

Modifier and Type	Method and Description
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName) Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered.
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected void	init(NotificationInitializationContext context)
void	notify(NotificationContext context, NotificationType notificationType, java.lang.String subject, java.lang.String message) Notifies the configured recipients of some event

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

getIdentifier, initialize

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, 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 Detail

NOTIFICATION_TYPE_KEY

public static final java.lang.String NOTIFICATION_TYPE_KEY

See Also:

Constant Field Values

NOTIFICATION_SUBJECT_KEY

public static final java.lang.String NOTIFICATION_SUBJECT_KEY

See Also:

Constant Field Values

STORE_TYPE_JKS

public static final java.lang.String STORE_TYPE_JKS

See Also:

Constant Field Values

STORE_TYPE_PKCS12

public static final java.lang.String STORE_TYPE_PKCS12

See Also:

Constant Field Values

PROP_URL

public static final PropertyDescriptor PROP_URL

PROP_CONNECTION_TIMEOUT

public static final PropertyDescriptor PROP_CONNECTION_TIMEOUT

PROP_WRITE_TIMEOUT

public static final PropertyDescriptor PROP_WRITE_TIMEOUT

PROP_TRUSTSTORE

public static final PropertyDescriptor PROP_TRUSTSTORE

PROP_TRUSTSTORE_TYPE

public static final PropertyDescriptor PROP_TRUSTSTORE_TYPE

PROP_TRUSTSTORE_PASSWORD

public static final PropertyDescriptor PROP_TRUSTSTORE_PASSWORD

PROP_KEYSTORE

public static final PropertyDescriptor PROP_KEYSTORE

PROP_KEYSTORE_TYPE

public static final PropertyDescriptor PROP_KEYSTORE_TYPE

PROP_KEYSTORE_PASSWORD

public static final PropertyDescriptor PROP_KEYSTORE_PASSWORD

PROP_KEY_PASSWORD

public static final PropertyDescriptor PROP_KEY_PASSWORD

SSL_ALGORITHM

public static final PropertyDescriptor SSL_ALGORITHM

Constructor Detail

HttpNotificationService

public HttpNotificationService()

Method Detail

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName)

Description copied from class: AbstractConfigurableComponent

Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered. By default this method simply returns a null descriptor. By overriding this method processor implementations can support dynamic properties since this allows them to register properties on demand. It is acceptable for a dynamically generated property to indicate it is required so long as it is understood it is only required once set. Dynamic properties by definition cannot be required until used.

This method should be side effect free in the subclasses in terms of how often it is called for a given property name because there is guarantees how often it will be called for a given property name.

Default is null.

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

Parameters:

propertyDescriptorName - used to lookup if any property descriptors exist for that name

Returns:

new property descriptor if supported

init

protected void init(NotificationInitializationContext context)

Overrides:

init in class AbstractNotificationService

notify

public void notify(NotificationContext context,
                   NotificationType notificationType,
                   java.lang.String subject,
                   java.lang.String message)
            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

message - the message to be provided to recipients

Throws:

NotificationFailedException