SecretReferenceFieldDescriptor (PingFederate Server SDK)

java.lang.Object
- org.sourceid.saml20.adapter.gui.FieldDescriptor
- - org.sourceid.saml20.adapter.gui.AbstractTextFieldDescriptor
  - - org.sourceid.saml20.adapter.gui.TextFieldDescriptor
    - - org.sourceid.saml20.adapter.gui.SecretReferenceFieldDescriptor

All Implemented Interfaces:

Serializable
```
public class SecretReferenceFieldDescriptor
extends TextFieldDescriptor
```
A field descriptor that will render a text field for entering a secret reference on the GUI configuration screen.

The value of the field must be a valid secret reference as per SecretReferenceFieldValidator.

Since:

11.0

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.FieldDescriptor
  FieldDescriptor.FieldValidationWrapper

Constructor Summary

Constructors
Constructor	Description
`SecretReferenceFieldDescriptor(String name, String description)`	Create a new secret reference field descriptor with the given name and description.

Method Summary
- Methods inherited from class org.sourceid.saml20.adapter.gui.TextFieldDescriptor
  isEncrypted
- Methods inherited from class org.sourceid.saml20.adapter.gui.AbstractTextFieldDescriptor
  getSize, setSize
- Methods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor
  addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getFormattedValue, 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 Detail
  - SecretReferenceFieldDescriptor
```
public SecretReferenceFieldDescriptor(String name,
                                      String description)
```
    Create a new secret reference field descriptor with the given name and description.
    
    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.