Package com.pingidentity.sdk.notification

Class NotificationSenderPluginDescriptor

java.lang.Object

com.pingidentity.sdk.PluginDescriptor

com.pingidentity.sdk.notification.NotificationSenderPluginDescriptor

public class NotificationSenderPluginDescriptor
extends PluginDescriptor

This class is used to describe a Notification Publisher plugin implementation to the PingFederate server.

See NotificationPublisherPlugin for more details.

Since:

9.3

Field Summary

Fields inherited from class com.pingidentity.sdk.PluginDescriptor

UNDEFINED

Constructor Summary

Constructors

Constructor	Description
NotificationSenderPluginDescriptor(String type, Plugin plugin, GuiConfigDescriptor guiDescriptor, String version)	The constructor for the NotificationSenderPluginDescriptor class.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	getSupportsObjectData()	Returns whether the Notification Publisher supports constructing messages from Object Data.
int	hashCode()
void	setSupportsObjectData(boolean supportsObjectData)	Sets whether the Notification Publisher supports constructing messages from Object Data.

Methods inherited from class com.pingidentity.sdk.PluginDescriptor

getAttributeContractSet, getGuiConfigDescriptor, getGuiConfigDescriptorBuilder, getMetadata, getPluginClassName, getType, getVersion, isSupportsExtendedContract, setAttributeContactSet, setAttributeContractSet, setMetadata, setSupportsExtendedContract

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationSenderPluginDescriptor

public NotificationSenderPluginDescriptor(String type,
                                          Plugin plugin,
                                          GuiConfigDescriptor guiDescriptor,
                                          String version)

The constructor for the NotificationSenderPluginDescriptor class.

Parameters:

type - a text label for the plugin

plugin - the plugin instance

guiDescriptor - the graphical user interface descriptor used for expressing the configurable fields

version - the version

Method Detail

getSupportsObjectData

public boolean getSupportsObjectData()

Returns whether the Notification Publisher supports constructing messages from Object Data. If true, PingFederate will use the NotificationPublisherPlugin.publishNotificationWithObjectData(String, Map, Map) } method when sending a notification. If false, PingFederate will use the NotificationPublisherPlugin.publishNotification(String, Map, Map) method.

Returns:

true if the Notification Publisher supports constructing messages from Object data.

Since:

11.3 For PingFederate versions prior to 11.3, PingFederate will always use NotificationPublisherPlugin.publishNotification(String, Map, Map) when publishing notifications.

setSupportsObjectData

public void setSupportsObjectData(boolean supportsObjectData)

Sets whether the Notification Publisher supports constructing messages from Object Data. If true, PingFederate will use the NotificationPublisherPlugin.publishNotificationWithObjectData(String, Map, Map) } method when sending a notification. If false, PingFederate will use the NotificationPublisherPlugin.publishNotification(String, Map, Map) method.

Since:

11.3 For PingFederate versions prior to 11.3, PingFederate will always use NotificationPublisherPlugin.publishNotification(String, Map, Map) when publishing notifications

equals

public boolean equals(Object obj)

Overrides:

equals in class PluginDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class PluginDescriptor