Package org.sourceid.saml20.adapter.gui

Class NotificationSenderFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

org.sourceid.saml20.adapter.gui.SelectFieldDescriptor

org.sourceid.saml20.adapter.gui.NotificationSenderFieldDescriptor

All Implemented Interfaces:

Serializable

public class NotificationSenderFieldDescriptor
extends SelectFieldDescriptor

A field descriptor that will render a dropdown of all available notification publishers configured in the PingFederate system.

Since:

9.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

AbstractSelectionFieldDescriptor.OptionValue

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

FieldDescriptor.FieldValidationWrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final AbstractSelectionFieldDescriptor.OptionValue	DEFAULT	'Default' option of the NotificationSenderFieldDescriptor with an empty value.
static final String	DESC_FIELD_NOTIFICATION_SENDER
static final String	FIELD_NOTIFICATION_SENDER_INSTANCE

Fields inherited from class org.sourceid.saml20.adapter.gui.SelectFieldDescriptor

SELECT_ONE

Fields inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

NONE_SELECTED

Constructor Summary

Constructors

Constructor	Description
NotificationSenderFieldDescriptor(String name, String description)	Creates a new NotificationSenderFieldDescriptor.

Method Summary

Modifier and Type	Method	Description
List<AbstractSelectionFieldDescriptor.OptionValue>	getOptionValues()	Gets the option values list
Boolean	getShowDefaultLabel()	Deprecated. setting no long has any effect.
void	setShowDefaultLabel(Boolean showDefaultLabel)	Deprecated. setting no long has any effect.

Methods inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

getFormattedValue, setOptionValues

Methods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabel

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DESC_FIELD_NOTIFICATION_SENDER

public static final String DESC_FIELD_NOTIFICATION_SENDER

See Also:

• Constant Field Values

FIELD_NOTIFICATION_SENDER_INSTANCE

public static final String FIELD_NOTIFICATION_SENDER_INSTANCE

See Also:

• Constant Field Values

DEFAULT

public static final AbstractSelectionFieldDescriptor.OptionValue DEFAULT

'Default' option of the NotificationSenderFieldDescriptor with an empty value. When selected, this OptionValue indicates that the current default notification sender plugin should be used.

Constructor Details

NotificationSenderFieldDescriptor

public NotificationSenderFieldDescriptor(String name,
 String description)

Creates a new NotificationSenderFieldDescriptor.

Parameters:

name - The field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor). This name will also be used as the label for the field in the administrative console. To ensure configuration can be read in future releases of a plugin, it is recommended to not change a field's name - instead use a label to rename it in the administrative console.

description - The field description displayed in the administrative console.

Method Details

getOptionValues

public List<AbstractSelectionFieldDescriptor.OptionValue> getOptionValues()

Gets the option values list

Overrides:

getOptionValues in class AbstractSelectionFieldDescriptor

Returns:

the option value list.

getShowDefaultLabel

@Deprecated
public Boolean getShowDefaultLabel()

Deprecated.

setting no long has any effect.

Returns:

Boolean: whether default will be shown.

setShowDefaultLabel

@Deprecated
public void setShowDefaultLabel(Boolean showDefaultLabel)

Deprecated.

setting no long has any effect.

Parameters:

showDefaultLabel - : set to true by default.