Class HashedTextFieldDescriptor

All Implemented Interfaces:
Serializable

public class HashedTextFieldDescriptor extends AbstractTextFieldDescriptor

A field descriptor that will render a password text field on the GUI configuration screen. Unlike the TextFieldDescriptor, the value's hash will be stored instead of the value itself.

The hash will be a salted password hash, and plugins are expected to use HashedField.checkSecret(String) to check a plaintext value against the hash.

Since:
7.2 R2
See Also:
  • Constructor Details

    • HashedTextFieldDescriptor

      public HashedTextFieldDescriptor(String name, String description)
      Create a new HashedTextFieldDescriptor.
      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.