Class ConfigurationValidatorConfiguration

java.lang.Object

io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration

@ConfigurationProperties("micronaut.jsonschema.configuration.validator")
public final class ConfigurationValidatorConfiguration
extends Object

Runtime configuration for configuration validation support.

All configuration is under the "micronaut.jsonschema.configuration.validator" prefix.

Supported keys:

• micronaut.jsonschema.configuration.validator.cache
• micronaut.jsonschema.configuration.validator.fail-on-not-present
• micronaut.jsonschema.configuration.validator.suppressions
• micronaut.jsonschema.configuration.validator.endpoint.enabled

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_CACHE
static final boolean	DEFAULT_FAIL_ON_NOT_PRESENT
static final String	PREFIX	Configuration prefix.

Constructor Summary

Constructors

Constructor	Description
ConfigurationValidatorConfiguration()

Method Summary

Modifier and Type	Method	Description
List<String>	getSuppressions()	Patterns used to suppress validation errors.
boolean	isCache()	Whether the validation result should be cached.
boolean	isFailOnNotPresent()	Whether to fail when configuration contains keys not present in schema.
void	setCache(boolean cache)
void	setFailOnNotPresent(boolean failOnNotPresent)
void	setSuppressions(@Nullable List<String> suppressions)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PREFIX

public static final String PREFIX

Configuration prefix.

See Also:

• Constant Field Values

DEFAULT_CACHE

public static final boolean DEFAULT_CACHE

See Also:

• Constant Field Values

DEFAULT_FAIL_ON_NOT_PRESENT

public static final boolean DEFAULT_FAIL_ON_NOT_PRESENT

See Also:

• Constant Field Values

Constructor Details

ConfigurationValidatorConfiguration

public ConfigurationValidatorConfiguration()

Method Details

isCache

public boolean isCache()

Whether the validation result should be cached.

When enabled, the first computed validation result is cached and returned for subsequent invocations.

Returns:

Whether the validation result should be cached. Default value true

setCache

public void setCache(boolean cache)

Parameters:

cache - Whether the validation result should be cached.

isFailOnNotPresent

public boolean isFailOnNotPresent()

Whether to fail when configuration contains keys not present in schema.

Note that some schemas may also enforce this via additionalProperties: false.

Returns:

Whether to fail when configuration contains keys not present in schema. Default value true

setFailOnNotPresent

public void setFailOnNotPresent(boolean failOnNotPresent)

Parameters:

failOnNotPresent - Whether to fail when configuration contains keys not present in schema

getSuppressions

public List<String> getSuppressions()

Patterns used to suppress validation errors.

Matching errors are downgraded to warnings.

Returns:

Patterns used to suppress validation errors

setSuppressions

public void setSuppressions(@Nullable List<String> suppressions)

Parameters:

suppressions - Patterns used to suppress validation errors