Package org.keycloak.validate.validators

Class LengthValidator

java.lang.Object
org.keycloak.validate.AbstractSimpleValidator
org.keycloak.validate.AbstractStringValidator
org.keycloak.validate.validators.LengthValidator
All Implemented Interfaces:
org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.validate.Validator>, org.keycloak.validate.SimpleValidator, org.keycloak.validate.Validator, org.keycloak.validate.ValidatorFactory
public class LengthValidator extends org.keycloak.validate.AbstractStringValidator implements org.keycloak.provider.ConfiguredProvider
String value length validation - accepts plain string and collection of strings, for basic behavior like null/blank values handling and collections support see AbstractStringValidator. Validator trims String value before the length validation, can be disabled by KEY_TRIM_DISABLED boolean configuration entry set to true.

Configuration have to be always provided, with at least one of KEY_MIN and KEY_MAX.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ID
     
    static final LengthValidator
    INSTANCE
     
    static final String
    KEY_MAX
     
    static final String
    KEY_MIN
     
    static final String
    KEY_TRIM_DISABLED
     
    static final String
    MESSAGE_INVALID_LENGTH
     
    static final String
    MESSAGE_INVALID_LENGTH_TOO_LONG
     
    static final String
    MESSAGE_INVALID_LENGTH_TOO_SHORT
     

    Fields inherited from class org.keycloak.validate.AbstractSimpleValidator

    IGNORE_EMPTY_VALUE

  • Constructor Summary

    Constructors
    Constructor
    Description
    LengthValidator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doValidate(String value, String inputHint, org.keycloak.validate.ValidationContext context, org.keycloak.validate.ValidatorConfig config)
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigProperties()
     
    String
    getHelpText()
     
    String
    getId()
     
    protected String
    selectErrorMessage(org.keycloak.validate.ValidatorConfig config)
    Select error message depending on the allowed length interval bound configuration.
    org.keycloak.validate.ValidationResult
    validateConfig(org.keycloak.models.KeycloakSession session, org.keycloak.validate.ValidatorConfig 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

    dependsOn, getConfigMetadata, order

    Methods inherited from interface org.keycloak.validate.SimpleValidator

    close, create, init, postInit

    Methods inherited from interface org.keycloak.validate.Validator

    validate, validate, validate, validate, validate

  • Field Details

  • Constructor Details

    • LengthValidator

      public LengthValidator()

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.validate.Validator>

    • doValidate

      protected void doValidate(String value, String inputHint, org.keycloak.validate.ValidationContext context, org.keycloak.validate.ValidatorConfig config)
      Specified by:
      doValidate in class org.keycloak.validate.AbstractStringValidator

    • selectErrorMessage

      protected String selectErrorMessage(org.keycloak.validate.ValidatorConfig config)
      Select error message depending on the allowed length interval bound configuration.

    • validateConfig

      public org.keycloak.validate.ValidationResult validateConfig(org.keycloak.models.KeycloakSession session, org.keycloak.validate.ValidatorConfig config)
      Specified by:
      validateConfig in interface org.keycloak.validate.ValidatorFactory

    • getHelpText

      public String getHelpText()
      Specified by:
      getHelpText in interface org.keycloak.provider.ConfiguredProvider

    • getConfigProperties

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
      Specified by:
      getConfigProperties in interface org.keycloak.provider.ConfiguredProvider