Package org.keycloak.validate.validators
Class OptionsValidator
- java.lang.Object
-
- org.keycloak.validate.AbstractSimpleValidator
-
- org.keycloak.validate.AbstractStringValidator
-
- org.keycloak.validate.validators.OptionsValidator
-
- All Implemented Interfaces:
ConfiguredProvider
,Provider
,ProviderFactory<Validator>
,SimpleValidator
,Validator
,ValidatorFactory
public class OptionsValidator extends AbstractStringValidator implements ConfiguredProvider
Validation against list of allowed values - accepts plain string and collection of strings (every value is validated against allowed values), for basic behavior like null/blank values handling and collections support seeAbstractStringValidator
.Configuration have to be always provided using
KEY_OPTIONS
option, which have to containList
ofString
values.
-
-
Field Summary
Fields Modifier and Type Field Description static String
ID
static OptionsValidator
INSTANCE
static String
KEY_OPTIONS
-
Fields inherited from class org.keycloak.validate.AbstractSimpleValidator
IGNORE_EMPTY_VALUE
-
-
Constructor Summary
Constructors Constructor Description OptionsValidator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doValidate(String value, String inputHint, ValidationContext context, ValidatorConfig config)
List<ProviderConfigProperty>
getConfigProperties()
String
getHelpText()
String
getId()
ValidationResult
validateConfig(KeycloakSession session, ValidatorConfig config)
Validates the given validation config.-
Methods inherited from class org.keycloak.validate.AbstractStringValidator
doValidate, skipValidation
-
Methods inherited from class org.keycloak.validate.AbstractSimpleValidator
isIgnoreEmptyValuesConfigured, validate
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
-
Methods inherited from interface org.keycloak.validate.SimpleValidator
close, create, init, postInit
-
-
-
-
Field Detail
-
INSTANCE
public static final OptionsValidator INSTANCE
-
ID
public static final String ID
- See Also:
- Constant Field Values
-
KEY_OPTIONS
public static final String KEY_OPTIONS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<Validator>
-
doValidate
protected void doValidate(String value, String inputHint, ValidationContext context, ValidatorConfig config)
- Specified by:
doValidate
in classAbstractStringValidator
-
validateConfig
public ValidationResult validateConfig(KeycloakSession session, ValidatorConfig config)
Description copied from interface:ValidatorFactory
Validates the given validation config.Implementations can use the
KeycloakSession
to validate the givenValidatorConfig
.- Specified by:
validateConfig
in interfaceValidatorFactory
- Parameters:
session
- theKeycloakSession
config
- the config to be validated- Returns:
- the validation result
-
getHelpText
public String getHelpText()
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
-