Package org.keycloak.validate.validators

Class UriValidator

java.lang.Object

org.keycloak.validate.AbstractSimpleValidator

org.keycloak.validate.validators.UriValidator

All Implemented Interfaces:

ConfiguredProvider, Provider, ProviderFactory<Validator>, SimpleValidator, Validator, ValidatorFactory

public class UriValidator
extends AbstractSimpleValidator
implements ConfiguredProvider

URI validation - accepts URI, URL and single String. Null input is valid, use other validators (like NotBlankValidator or NotEmptyValidator to force field as required.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ALLOW_FRAGMENT
static final List<String>	DEFAULT_ALLOWED_SCHEMES
static final boolean	DEFAULT_REQUIRE_VALID_URL
static final String	ID
static final UriValidator	INSTANCE
static final String	KEY_ALLOW_FRAGMENT
static final String	KEY_ALLOWED_SCHEMES
static final String	KEY_REQUIRE_VALID_URL
static final String	MESSAGE_INVALID_FRAGMENT
static final String	MESSAGE_INVALID_SCHEME
static final String	MESSAGE_INVALID_URI

Fields inherited from class org.keycloak.validate.AbstractSimpleValidator

IGNORE_EMPTY_VALUE

Constructor Summary

Constructors

Constructor	Description
UriValidator()

Method Summary

Modifier and Type	Method	Description
protected void	doValidate(Object input, String inputHint, ValidationContext context, ValidatorConfig config)	Validate type, format, range of the value etc.
List<ProviderConfigProperty>	getConfigProperties()
String	getHelpText()
String	getId()
protected boolean	skipValidation(Object value, ValidatorConfig config)	Decide if validation of individual value should be skipped or not.
boolean	validateUri(URI uri, String inputHint, ValidationContext context, Set<String> allowedSchemes, boolean allowFragment, boolean requireValidUrl)
boolean	validateUri(URI uri, Set<String> allowedSchemes, boolean allowFragment, boolean requireValidUrl)

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

Methods inherited from interface org.keycloak.validate.ValidatorFactory

validateConfig

Field Details

INSTANCE

public static final UriValidator INSTANCE

KEY_ALLOWED_SCHEMES

public static final String KEY_ALLOWED_SCHEMES

See Also:

• Constant Field Values

KEY_ALLOW_FRAGMENT

public static final String KEY_ALLOW_FRAGMENT

See Also:

• Constant Field Values

KEY_REQUIRE_VALID_URL

public static final String KEY_REQUIRE_VALID_URL

See Also:

• Constant Field Values

DEFAULT_ALLOWED_SCHEMES

public static final List<String> DEFAULT_ALLOWED_SCHEMES

MESSAGE_INVALID_URI

public static final String MESSAGE_INVALID_URI

See Also:

• Constant Field Values

MESSAGE_INVALID_SCHEME

public static final String MESSAGE_INVALID_SCHEME

See Also:

• Constant Field Values

MESSAGE_INVALID_FRAGMENT

public static final String MESSAGE_INVALID_FRAGMENT

See Also:

• Constant Field Values

DEFAULT_ALLOW_FRAGMENT

public static final boolean DEFAULT_ALLOW_FRAGMENT

See Also:

• Constant Field Values

DEFAULT_REQUIRE_VALID_URL

public static final boolean DEFAULT_REQUIRE_VALID_URL

See Also:

• Constant Field Values

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

UriValidator

public UriValidator()

Method Details

getId

public String getId()

Specified by:

getId in interface ProviderFactory<Validator>

skipValidation

protected boolean skipValidation(Object value,
 ValidatorConfig config)

Description copied from class: AbstractSimpleValidator

Decide if validation of individual value should be skipped or not. It should be controlled by AbstractSimpleValidator.IGNORE_EMPTY_VALUE configuration option, see AbstractSimpleValidator.isIgnoreEmptyValuesConfigured(ValidatorConfig).

Specified by:

skipValidation in class AbstractSimpleValidator

Parameters:

value - currently validated we make decision for

config - to look for options in

Returns:

true if validation should be skipped for this value - AbstractSimpleValidator.doValidate(Object, String, ValidationContext, ValidatorConfig) is not called in this case.

See Also:

• AbstractSimpleValidator.doValidate(Object, String, ValidationContext, ValidatorConfig)

doValidate

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

Description copied from class: AbstractSimpleValidator

Validate type, format, range of the value etc. Always use ValidationContext.addError(ValidationError) to report error to the user! Can be called multiple time for one validation if input is Collection.

Specified by:

doValidate in class AbstractSimpleValidator

Parameters:

input - to be validated, never null

context - for the validation. Add errors into it.

config - of the validation if provided

See Also:

• AbstractSimpleValidator.skipValidation(Object, ValidatorConfig)

validateUri

public boolean validateUri(URI uri,
 Set<String> allowedSchemes,
 boolean allowFragment,
 boolean requireValidUrl)

validateUri

public boolean validateUri(URI uri,
 String inputHint,
 ValidationContext context,
 Set<String> allowedSchemes,
 boolean allowFragment,
 boolean requireValidUrl)
                    throws MalformedURLException

Throws:

MalformedURLException

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider