com.pingidentity.sdk.notification

Interface NotificationPublisherPlugin

All Superinterfaces:

ConfigurablePlugin, DescribablePlugin, Plugin

public interface NotificationPublisherPlugin
extends Plugin

This interface defines the methods that the PingFederate server calls to send a notification. This interface extends Plugin.

Since:

9.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	IN_PARAMETER_NAME_CONFIG_DESTINATION_ADDRESS The input parameter name for the destination address in the "data" map.
static String	IN_PARAMETER_NAME_CONFIG_EVENT_TYPE The input parameter name for the event type in the "configuration" map.
static String	IN_PARAMETER_NAME_CONFIG_LOCALE The input parameter name for the locale in the "configuration" map.
static String	IN_PARAMETER_NAME_CONFIG_TEMPLATE_NAME The input parameter name for the template type in the "configuration" map.

Method Summary

Modifier and Type	Method and Description
PublishResult	publishNotification(String eventType, Map<String,String> data, Map<String,String> configuration) Send a notification to the end user

Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin

configure

Methods inherited from interface com.pingidentity.sdk.DescribablePlugin

getPluginDescriptor

Field Detail

IN_PARAMETER_NAME_CONFIG_DESTINATION_ADDRESS

static final String IN_PARAMETER_NAME_CONFIG_DESTINATION_ADDRESS

The input parameter name for the destination address in the "data" map. The value is a String.

See Also:

Constant Field Values

IN_PARAMETER_NAME_CONFIG_LOCALE

static final String IN_PARAMETER_NAME_CONFIG_LOCALE

The input parameter name for the locale in the "configuration" map. The value is a String.

See Also:

Constant Field Values

IN_PARAMETER_NAME_CONFIG_TEMPLATE_NAME

static final String IN_PARAMETER_NAME_CONFIG_TEMPLATE_NAME

The input parameter name for the template type in the "configuration" map. The value is a String.

See Also:

Constant Field Values

IN_PARAMETER_NAME_CONFIG_EVENT_TYPE

static final String IN_PARAMETER_NAME_CONFIG_EVENT_TYPE

The input parameter name for the event type in the "configuration" map. The value is a String.

See Also:

Constant Field Values

Method Detail

publishNotification

PublishResult publishNotification(String eventType,
                                  Map<String,String> data,
                                  Map<String,String> configuration)

Send a notification to the end user

Parameters:

data - map of key/values from which we can construct the message

configuration - configuration metadata related to the notification

Returns:

result indicating the outcome of the attempt to send the notification.