Class ProviderConfigProperty

java.lang.Object
org.keycloak.provider.ProviderConfigProperty

public class ProviderConfigProperty extends Object
Configuration property metadata. Used to render generic configuration pages for Keycloak extensions in the admin console.
Version:
$Revision: 1 $
Author:
Bill Burke
  • Field Details

  • Constructor Details

    • ProviderConfigProperty

      public ProviderConfigProperty()
    • ProviderConfigProperty

      public ProviderConfigProperty(String name, String label, String helpText, String type, Object defaultValue)
    • ProviderConfigProperty

      public ProviderConfigProperty(String name, String label, String helpText, String type, Object defaultValue, String... options)
    • ProviderConfigProperty

      public ProviderConfigProperty(String name, String label, String helpText, String type, Object defaultValue, boolean secret)
    • ProviderConfigProperty

      public ProviderConfigProperty(String name, String label, String helpText, String type, Object defaultValue, boolean secret, boolean required)
  • Method Details

    • getName

      public String getName()
      Name of the config variable stored in the database
      Returns:
    • setName

      public void setName(String name)
    • getLabel

      public String getLabel()
      Label shown in the admin console when configuring the variable
      Returns:
    • setLabel

      public void setLabel(String label)
    • getType

      public String getType()
      Type of the variable. i.e. boolean, string etc. See the constants declared in this class for what your choices are.
      Returns:
    • setType

      public void setType(String type)
    • getDefaultValue

      public Object getDefaultValue()
      Default value for the variable
      Returns:
    • setDefaultValue

      public void setDefaultValue(Object defaultValue)
    • getOptions

      public List<String> getOptions()
      For list types, this is a list of choices to choose from.
      Returns:
    • setOptions

      public void setOptions(List<String> options)
    • getHelpText

      public String getHelpText()
      Help text that will be displayed in the admin console tooltip
      Returns:
    • setHelpText

      public void setHelpText(String helpText)
    • isSecret

      public boolean isSecret()
      If true, this variable is only writeable. It will never be viewable. This is important for things like passwords in which you never want to display them on the screen.
      Returns:
    • setSecret

      public void setSecret(boolean secret)
    • isRequired

      public boolean isRequired()
      If true, the configuration property must be specified
    • setRequired

      public void setRequired(boolean required)
    • setReadOnly

      public void setReadOnly(boolean readOnly)
    • isReadOnly

      public boolean isReadOnly()