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
NotificationPublisherPluginfor 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)booleangetSupportsObjectData()Returns whether the Notification Publisher supports constructing messages from Object Data.inthashCode()voidsetSupportsObjectData(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
-
-
-
-
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 pluginplugin- the plugin instanceguiDescriptor- the graphical user interface descriptor used for expressing the configurable fieldsversion- the version
-
-
Method Detail
-
getSupportsObjectData
public boolean getSupportsObjectData()
Returns whether the Notification Publisher supports constructing messages from Object Data. If true, PingFederate will use theNotificationPublisherPlugin.publishNotificationWithObjectData(String, Map, Map)} method when sending a notification. If false, PingFederate will use theNotificationPublisherPlugin.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 theNotificationPublisherPlugin.publishNotificationWithObjectData(String, Map, Map)} method when sending a notification. If false, PingFederate will use theNotificationPublisherPlugin.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:
equalsin classPluginDescriptor
-
hashCode
public int hashCode()
- Overrides:
hashCodein classPluginDescriptor
-
-