Package org.sourceid.saml20.adapter.gui

Class LdapDatastoreFieldDescriptor

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.LdapDatastoreFieldDescriptor

All Implemented Interfaces:

Serializable

public class LdapDatastoreFieldDescriptor
extends SelectFieldDescriptor

A field descriptor that will render (in GUI configuration screen) a drop down selection of all the configured LDAP data stores.

The value of this field in the Configuration will be the PingFederate assigned identifier of the LDAP connection information.

You can use this id to retrieve the corresponding LDAP info via DataSourceAccessor. From the LDAP Info, you will be able to access the requested LDAP datastore.

See Also:

• DataSourceAccessor.getLdapInfo(String)
• 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 inherited from class org.sourceid.saml20.adapter.gui.SelectFieldDescriptor

DEFAULT, SELECT_ONE

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

NONE_SELECTED

Constructor Summary

Constructors

Constructor	Description
LdapDatastoreFieldDescriptor(String name, String description)	Create a new LdapDatastoreFieldDescriptor.

Method Summary

Modifier and Type	Method	Description
List<AbstractSelectionFieldDescriptor.OptionValue>	getOptionValues()	Gets the option values list constructed from all the LDAP data sources configured in the system.

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

Constructor Details

LdapDatastoreFieldDescriptor

public LdapDatastoreFieldDescriptor(String name,
 String description)

Create a new LdapDatastoreFieldDescriptor.

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 constructed from all the LDAP data sources configured in the system.

Overrides:

getOptionValues in class AbstractSelectionFieldDescriptor

Returns:

the option value list.