ValidatorFactory (Keycloak Docs Distribution 21.1.1 API)

All Superinterfaces:

ProviderFactory<Validator>

All Known Subinterfaces:

SimpleValidator

All Known Implementing Classes:

AbstractNumberValidator, AbstractSimpleValidator, AbstractStringValidator, AttributeRequiredByMetadataValidator, BlankAttributeValidator, BrokeringFederatedUsernameHasValueValidator, DoubleValidator, DuplicateEmailValidator, DuplicateUsernameValidator, EmailExistsAsUsernameValidator, EmailValidator, ImmutableAttributeValidator, IntegerValidator, LengthValidator, LocalDateValidator, NotBlankValidator, NotEmptyValidator, OptionsValidator, PatternValidator, PersonNameProhibitedCharactersValidator, ReadOnlyAttributeUnchangedValidator, RegistrationEmailAsUsernameEmailValueValidator, RegistrationEmailAsUsernameUsernameValueValidator, RegistrationUsernameExistsValidator, UriValidator, UsernameHasValueValidator, UsernameIDNHomographValidator, UsernameMutationValidator, UsernameProhibitedCharactersValidator, ValidatorConfigValidator
```
public interface ValidatorFactory
extends ProviderFactory<Validator>
```
A factory for custom Validator implementations plugged-in through this SPI.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default void`	`close()`	This is called when the server shuts down.
`default ValidationResult`	`validateConfig(KeycloakSession session, ValidatorConfig config)`	Validates the given validation config.

Methods inherited from interface org.keycloak.provider.ProviderFactory
create, getConfigMetadata, getId, init, order, postInit

- Method Detail
  - validateConfig
```
default ValidationResult validateConfig(KeycloakSession session,
                                        ValidatorConfig config)
```
    Validates the given validation config.
    Implementations can use the KeycloakSession to validate the given ValidatorConfig.
    
    Parameters:
    
    session - the KeycloakSession
    
    config - the config to be validated
    
    Returns:
    
    the validation result
  - close
```
default void close()
```
    This is called when the server shuts down.
    
    Specified by:
    
    close in interface ProviderFactory<Validator>