Package org.keycloak.provider
Class ProviderConfigProperty
java.lang.Object
org.keycloak.provider.ProviderConfigProperty
Configuration property metadata. Used to render generic configuration pages for Keycloak extensions in the admin console.
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
protected Object
static final String
static final String
protected String
protected String
static final String
Possibility to configure single String value, which needs to be chosen from the list of predefined values (HTML select)static final String
Configure multiple (key, value) pairsstatic final String
Possibility to configure multiple String values, which needs to be chosen from the list of predefined values (HTML select with multiple)static final String
Possibility to configure multiple String values of any value (something like "redirect_uris" for clients)protected String
static final String
protected boolean
static final String
static final String
protected boolean
static final String
static final String
textarea fieldprotected String
static final String
URL fieldstatic final String
Possibility to select from user attributes defined in the user-profile, but also still have an option to configure custom value -
Constructor Summary
ConstructorDescriptionProviderConfigProperty
(String name, String label, String helpText, String type, Object defaultValue) ProviderConfigProperty
(String name, String label, String helpText, String type, Object defaultValue, boolean secret) ProviderConfigProperty
(String name, String label, String helpText, String type, Object defaultValue, boolean secret, boolean required) ProviderConfigProperty
(String name, String label, String helpText, String type, Object defaultValue, String... options) -
Method Summary
Modifier and TypeMethodDescriptionDefault value for the variableHelp text that will be displayed in the admin console tooltipgetLabel()
Label shown in the admin console when configuring the variablegetName()
Name of the config variable stored in the databaseFor list types, this is a list of choices to choose from.getType()
Type of the variable.boolean
boolean
If true, the configuration property must be specifiedboolean
isSecret()
If true, this variable is only writeable.void
setDefaultValue
(Object defaultValue) void
setHelpText
(String helpText) void
void
void
setOptions
(List<String> options) void
setReadOnly
(boolean readOnly) void
setRequired
(boolean required) void
setSecret
(boolean secret) void
-
Field Details
-
BOOLEAN_TYPE
- See Also:
-
STRING_TYPE
- See Also:
-
MULTIVALUED_STRING_TYPE
Possibility to configure multiple String values of any value (something like "redirect_uris" for clients)- See Also:
-
SCRIPT_TYPE
- See Also:
-
FILE_TYPE
- See Also:
-
ROLE_TYPE
- See Also:
-
GROUP_TYPE
- See Also:
-
LIST_TYPE
Possibility to configure single String value, which needs to be chosen from the list of predefined values (HTML select)- See Also:
-
MULTIVALUED_LIST_TYPE
Possibility to configure multiple String values, which needs to be chosen from the list of predefined values (HTML select with multiple)- See Also:
-
CLIENT_LIST_TYPE
- See Also:
-
USER_PROFILE_ATTRIBUTE_LIST_TYPE
Possibility to select from user attributes defined in the user-profile, but also still have an option to configure custom value- See Also:
-
PASSWORD
- See Also:
-
TEXT_TYPE
textarea field- See Also:
-
MAP_TYPE
Configure multiple (key, value) pairs- See Also:
-
URL_TYPE
URL field- See Also:
-
name
-
label
-
helpText
-
type
-
defaultValue
-
options
-
secret
protected boolean secret -
required
protected boolean required
-
-
Constructor Details
-
ProviderConfigProperty
public ProviderConfigProperty() -
ProviderConfigProperty
-
ProviderConfigProperty
-
ProviderConfigProperty
-
ProviderConfigProperty
-
-
Method Details
-
getName
Name of the config variable stored in the database- Returns:
-
setName
-
getLabel
Label shown in the admin console when configuring the variable- Returns:
-
setLabel
-
getType
Type of the variable. i.e. boolean, string etc. See the constants declared in this class for what your choices are.- Returns:
-
setType
-
getDefaultValue
Default value for the variable- Returns:
-
setDefaultValue
-
getOptions
For list types, this is a list of choices to choose from.- Returns:
-
setOptions
-
getHelpText
Help text that will be displayed in the admin console tooltip- Returns:
-
setHelpText
-
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()
-