LdapAuthenticationErrorFieldDescriptor (PingFederate Server SDK)

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

All Implemented Interfaces:

Serializable
```
public class LdapAuthenticationErrorFieldDescriptor
extends SelectFieldDescriptor
```
A field descriptor that will render (in GUI configuration screen) a drop down selection of the LDAP authentication error codes.

Since:

6.11

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 String MESSAGE_PROPERTIES_KEY

static String MESSAGE_PROPERTIES_VALUE
- 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
`LdapAuthenticationErrorFieldDescriptor(String name, String description)`	Creates a new LdapAuthenticationErrorFieldDescriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AbstractSelectionFieldDescriptor.OptionValue>`	`getOptionValues()`	Gets the option values list to be displayed in the UI.

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 Detail
  - MESSAGE_PROPERTIES_KEY
```
public static final String MESSAGE_PROPERTIES_KEY
```
    See Also:
    
    Constant Field Values
  - MESSAGE_PROPERTIES_VALUE
```
public static final String MESSAGE_PROPERTIES_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LdapAuthenticationErrorFieldDescriptor
```
public LdapAuthenticationErrorFieldDescriptor(String name,
                                              String description)
```
    Creates a new LdapAuthenticationErrorFieldDescriptor.
    
    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 Detail
  - getOptionValues
```
public List<AbstractSelectionFieldDescriptor.OptionValue> getOptionValues()
```
    Gets the option values list to be displayed in the UI.
    
    Overrides:
    
    getOptionValues in class AbstractSelectionFieldDescriptor
    
    Returns:
    
    the option value list.