org.keycloak.validate.validators

## Class PatternValidator

- java.lang.Object
- - org.keycloak.validate.AbstractSimpleValidator
  - - org.keycloak.validate.AbstractStringValidator
    - - org.keycloak.validate.validators.PatternValidator

- All Implemented Interfaces:
    ConfiguredProvider, Provider, ProviderFactory<Validator>, SimpleValidator, Validator, ValidatorFactory

      public class PatternValidator
      extends AbstractStringValidator
      implements ConfiguredProvider

  Validate String against configured RegEx pattern - accepts plain string and collection of strings, for basic behavior like null/blank values handling and collections support see `AbstractStringValidator`.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `CFG_ERROR_MESSAGE`
    `static String` | `CFG_PATTERN`
    `static String` | `ID`
    `static PatternValidator` | `INSTANCE`
    `static String` | `MESSAGE_NO_MATCH`

    - ### Fields inherited from class org.keycloak.validate.AbstractSimpleValidator

      `IGNORE_EMPTY_VALUE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PatternValidator()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and 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.validate.SimpleValidator

      `close, create, init, postInit`

    - ### Methods inherited from interface org.keycloak.validate.Validator

      `validate, validate, validate, validate, validate, validate`

    - ### Methods inherited from interface org.keycloak.provider.ProviderFactory

      `order`

- - ### Field Detail

    - #### ID

          public static final String ID

      See Also:
        Constant Field Values

    - #### INSTANCE

          public static final PatternValidator INSTANCE

    - #### CFG_PATTERN

          public static final String CFG_PATTERN

      See Also:
        Constant Field Values

    - #### MESSAGE_NO_MATCH

          public static final String MESSAGE_NO_MATCH

      See Also:
        Constant Field Values

    - #### CFG_ERROR_MESSAGE

          public static final String CFG_ERROR_MESSAGE

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### PatternValidator

          public PatternValidator()

  - ### Method Detail

    - #### getId

          public String getId()

      Specified by:
        `getId` in interface `ProviderFactory<Validator>`

    - #### doValidate

          protected void doValidate(String value,
                                    String inputHint,
                                    ValidationContext context,
                                    ValidatorConfig config)

      Specified by:
        `doValidate` in class `AbstractStringValidator`

    - #### 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 given `ValidatorConfig`.

      Specified by:
        `validateConfig` in interface `ValidatorFactory`
      Parameters:
        `session` - the `KeycloakSession`
        `config` - the config to be validated
      Returns:
        the validation result

    - #### getHelpText

          public String getHelpText()

      Specified by:
        `getHelpText` in interface `ConfiguredProvider`

    - #### getConfigProperties

          public List<ProviderConfigProperty> getConfigProperties()

      Specified by:
        `getConfigProperties` in interface `ConfiguredProvider`

Copyright © 2021 JBoss by Red Hat. All rights reserved.