Package org.sourceid.saml20.adapter.gui

Class SelectFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

org.sourceid.saml20.adapter.gui.SelectFieldDescriptor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BearerAccessTokenFieldDescriptor, CaptchaProviderFieldDescriptor, CertificateSelectionFieldDescriptor, CustomSourceFieldDescriptor, ExtendedPropertiesFileDescriptor, JdbcDatastoreFieldDescriptor, KerberosRealmFieldDescriptor, LdapAuthenticationErrorFieldDescriptor, LdapDatastoreFieldDescriptor, NotificationSenderFieldDescriptor, PasswordCredentialValidatorFieldDescriptor

public class SelectFieldDescriptor
extends AbstractSelectionFieldDescriptor

A field descriptor that will render a select (drop down) field on the GUI configuration screen.

See Also:

GuiConfigDescriptor.addField(FieldDescriptor), GuiConfigDescriptor.addAdvancedField(FieldDescriptor), TableDescriptor.addRowField(FieldDescriptor), 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 AbstractSelectionFieldDescriptor.OptionValue	DEFAULT	Add this OptionValue in the OptionValue list if you want the select box to contain a 'Default' option with 'Default' value.
static AbstractSelectionFieldDescriptor.OptionValue	SELECT_ONE	Add this OptionValue as the first in the OptionValue list if you want the select box to contain a '-- Select One --' option with an empty value.

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

NONE_SELECTED

Constructor Summary

Constructors

Constructor	Description
SelectFieldDescriptor(String name, String description, String[] optionValues)	Create a new SelectFieldDescriptor with the specified option values.
SelectFieldDescriptor(String name, String description, List<AbstractSelectionFieldDescriptor.OptionValue> optionValues)	Create a new SelectFieldDescriptor with the specified option values.

Method Summary

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

getFormattedValue, getOptionValues, 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 Detail

SELECT_ONE

public static final AbstractSelectionFieldDescriptor.OptionValue SELECT_ONE

Add this OptionValue as the first in the OptionValue list if you want the select box to contain a '-- Select One --' option with an empty value.

DEFAULT

public static final AbstractSelectionFieldDescriptor.OptionValue DEFAULT

Add this OptionValue in the OptionValue list if you want the select box to contain a 'Default' option with 'Default' value. This OptionValue should be used when the value to be used is determined at runtime where default configuration is applicable.

Constructor Detail

SelectFieldDescriptor

public SelectFieldDescriptor(String name,
                             String description,
                             String[] optionValues)

Create a new SelectFieldDescriptor with the specified option values.

Parameters:

name - the field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor).

description - a helpful description of the field.

optionValues - a String array to build the OptionValue list from. One OptionValue will be created for each value in the array and the name and value fields will be the same.

SelectFieldDescriptor

public SelectFieldDescriptor(String name,
                             String description,
                             List<AbstractSelectionFieldDescriptor.OptionValue> optionValues)

Create a new SelectFieldDescriptor with the specified option values.

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 - a helpful description of the field.

optionValues - a List of OptionValues that will make up the available options the user can choose from.