SchemaValidatorsConfig (JsonSchemaValidator 1.0.80 API)

java.lang.Object
- com.networknt.schema.SchemaValidatorsConfig

public class SchemaValidatorsConfig
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static String ALL_KEYWORD_WALK_LISTENER_KEY

Fields
Modifier and Type	Field and Description
`static String`	`ALL_KEYWORD_WALK_LISTENER_KEY`

Constructor Summary

Constructors
Constructor and Description

SchemaValidatorsConfig()

Constructors
Constructor and Description
`SchemaValidatorsConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addItemWalkListener(JsonSchemaWalkListener itemWalkListener)`
`void`	`addItemWalkListeners(List<JsonSchemaWalkListener> itemWalkListeners)`
`void`	`addKeywordWalkListener(JsonSchemaWalkListener keywordWalkListener)`
`void`	`addKeywordWalkListener(String keyword, JsonSchemaWalkListener keywordWalkListener)`
`void`	`addKeywordWalkListeners(List<JsonSchemaWalkListener> keywordWalkListeners)`
`void`	`addKeywordWalkListeners(String keyword, List<JsonSchemaWalkListener> keywordWalkListeners)`
`void`	`addPropertyWalkListener(JsonSchemaWalkListener propertyWalkListener)`
`void`	`addPropertyWalkListeners(List<JsonSchemaWalkListener> propertyWalkListeners)`
`void`	`addUriTranslator(URITranslator uriTranslator)`
`boolean`	`doLoadCollectors()`
`ApplyDefaultsStrategy`	`getApplyDefaultsStrategy()`
`List<JsonSchemaWalkListener>`	`getArrayItemWalkListeners()`
`CollectorContext`	`getCollectorContext()`
`Map<String,List<JsonSchemaWalkListener>>`	`getKeywordWalkListenersMap()`
`PathType`	`getPathType()` Get the approach used to generate paths in messages, logs and errors.
`List<JsonSchemaWalkListener>`	`getPropertyWalkListeners()`
`Map<String,String>`	`getUriMappings()` Deprecated. Use `getUriTranslator()` instead
`URITranslator.CompositeURITranslator`	`getUriTranslator()`
`boolean`	`isEcma262Validator()`
`boolean`	`isFailFast()`
`boolean`	`isHandleNullableField()`
`boolean`	`isJavaSemantics()`
`boolean`	`isLosslessNarrowing()`
`boolean`	`isOpenAPI3StyleDiscriminators()` Indicates whether OpenAPI 3 style discriminators should be supported
`boolean`	`isResetCollectorContext()`
`boolean`	`isStrict(String keyword)` Answers whether a keyword's validators may relax their analysis.
`boolean`	`isTypeLoose()`
`boolean`	`isWriteMode()`
`void`	`setApplyDefaultsStrategy(ApplyDefaultsStrategy applyDefaultsStrategy)`
`void`	`setCollectorContext(CollectorContext collectorContext)`
`void`	`setEcma262Validator(boolean ecma262Validator)`
`void`	`setFailFast(boolean failFast)` When enabled, `JsonValidator.validate(JsonNode, JsonNode, String)` or `JsonValidator.validate(JsonNode)` doesn't return any `Set`<`ValidationMessage`>, instead a `JsonSchemaException` is thrown as soon as a validation errors is discovered.
`void`	`setHandleNullableField(boolean handleNullableField)`
`void`	`setJavaSemantics(boolean javaSemantics)`
`void`	`setLoadCollectors(boolean loadCollectors)`
`void`	`setLosslessNarrowing(boolean losslessNarrowing)`
`void`	`setOpenAPI3StyleDiscriminators(boolean openAPI3StyleDiscriminators)` When enabled, the validation of `anyOf` and `allOf` in polymorphism will respect OpenAPI 3 style discriminators as described in the OpenAPI 3.0.3 spec.
`void`	`setPathType(PathType pathType)` Set the approach used to generate paths in messages, logs and errors (default is PathType.LEGACY).
`void`	`setResetCollectorContext(boolean resetCollectorContext)`
`void`	`setStrict(String keyword, boolean strict)` Alters the strictness of validations for a specific keyword.
`void`	`setTypeLoose(boolean typeLoose)`
`void`	`setUriMappings(Map<String,String> uriMappings)` Deprecated. Use `addUriTranslator()` instead
`void`	`setWriteMode(boolean writeMode)` When set to true considers that schema is used to write data then ReadOnlyValidator is activated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ALL_KEYWORD_WALK_LISTENER_KEY
```
public static final String ALL_KEYWORD_WALK_LISTENER_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SchemaValidatorsConfig
```
public SchemaValidatorsConfig()
```
- Method Detail
  - isTypeLoose
```
public boolean isTypeLoose()
```
  - setTypeLoose
```
public void setTypeLoose(boolean typeLoose)
```
  - setFailFast
```
public void setFailFast(boolean failFast)
```
    When enabled, JsonValidator.validate(JsonNode, JsonNode, String) or JsonValidator.validate(JsonNode) doesn't return any Set<ValidationMessage>, instead a JsonSchemaException is thrown as soon as a validation errors is discovered.
    
    Parameters:
    
    failFast - boolean
  - isFailFast
```
public boolean isFailFast()
```
  - setApplyDefaultsStrategy
```
public void setApplyDefaultsStrategy(ApplyDefaultsStrategy applyDefaultsStrategy)
```
  - getApplyDefaultsStrategy
```
public ApplyDefaultsStrategy getApplyDefaultsStrategy()
```
  - getUriTranslator
```
public URITranslator.CompositeURITranslator getUriTranslator()
```
  - addUriTranslator
```
public void addUriTranslator(URITranslator uriTranslator)
```
  - getUriMappings
```
@Deprecated
public Map<String,String> getUriMappings()
```
    Deprecated. Use getUriTranslator() instead
    
    Returns:
    
    Map of public, normally internet accessible schema URLs
  - setUriMappings
```
@Deprecated
public void setUriMappings(Map<String,String> uriMappings)
```
    Deprecated. Use addUriTranslator() instead
    
    Parameters:
    
    uriMappings - Map of public, normally internet accessible schema URLs
  - isHandleNullableField
```
public boolean isHandleNullableField()
```
  - setHandleNullableField
```
public void setHandleNullableField(boolean handleNullableField)
```
  - isEcma262Validator
```
public boolean isEcma262Validator()
```
  - setEcma262Validator
```
public void setEcma262Validator(boolean ecma262Validator)
```
  - isJavaSemantics
```
public boolean isJavaSemantics()
```
  - setJavaSemantics
```
public void setJavaSemantics(boolean javaSemantics)
```
  - addKeywordWalkListener
```
public void addKeywordWalkListener(JsonSchemaWalkListener keywordWalkListener)
```
  - addKeywordWalkListener
```
public void addKeywordWalkListener(String keyword,
                                   JsonSchemaWalkListener keywordWalkListener)
```
  - addKeywordWalkListeners
```
public void addKeywordWalkListeners(List<JsonSchemaWalkListener> keywordWalkListeners)
```
  - addKeywordWalkListeners
```
public void addKeywordWalkListeners(String keyword,
                                    List<JsonSchemaWalkListener> keywordWalkListeners)
```
  - addPropertyWalkListeners
```
public void addPropertyWalkListeners(List<JsonSchemaWalkListener> propertyWalkListeners)
```
  - addPropertyWalkListener
```
public void addPropertyWalkListener(JsonSchemaWalkListener propertyWalkListener)
```
  - addItemWalkListener
```
public void addItemWalkListener(JsonSchemaWalkListener itemWalkListener)
```
  - addItemWalkListeners
```
public void addItemWalkListeners(List<JsonSchemaWalkListener> itemWalkListeners)
```
  - getPropertyWalkListeners
```
public List<JsonSchemaWalkListener> getPropertyWalkListeners()
```
  - getKeywordWalkListenersMap
```
public Map<String,List<JsonSchemaWalkListener>> getKeywordWalkListenersMap()
```
  - getArrayItemWalkListeners
```
public List<JsonSchemaWalkListener> getArrayItemWalkListeners()
```
  - getCollectorContext
```
public CollectorContext getCollectorContext()
```
  - setCollectorContext
```
public void setCollectorContext(CollectorContext collectorContext)
```
  - isLosslessNarrowing
```
public boolean isLosslessNarrowing()
```
  - setLosslessNarrowing
```
public void setLosslessNarrowing(boolean losslessNarrowing)
```
  - isOpenAPI3StyleDiscriminators
```
public boolean isOpenAPI3StyleDiscriminators()
```
    Indicates whether OpenAPI 3 style discriminators should be supported
    
    Returns:
    
    true in case discriminators are enabled
    
    Since:
    
    1.0.51
  - setOpenAPI3StyleDiscriminators
```
public void setOpenAPI3StyleDiscriminators(boolean openAPI3StyleDiscriminators)
```
    When enabled, the validation of anyOf and allOf in polymorphism will respect OpenAPI 3 style discriminators as described in the OpenAPI 3.0.3 spec. The presence of a discriminator configuration on the schema will lead to the following changes in the behavior:
    - for oneOf the spec is unfortunately very vague. Whether oneOf semantics should be affected by discriminators or not is not even 100% clear within the members of the OAS steering committee. Therefore oneOf at the moment ignores discriminators
    - for anyOf the validation will choose one of the candidate schemas for validation based on the discriminator property value and will pass validation when this specific schema passes. This is in particular useful when the payload could match multiple candidates in the anyOf list and could lead to ambiguity. Example: type B has all mandatory properties of A and adds more mandatory ones. Whether the payload is an A or B is determined via the discriminator property name. A payload indicating it is an instance of B then requires passing the validation of B and passing the validation of A would not be sufficient anymore.
    - for allOf use cases with discriminators defined on the copied-in parent type, it is possible to automatically validate against a subtype. Example: some schema specifies that there is a field of type A. A carries a discriminator field and B inherits from A. Then B is automatically a candidate for validation as well and will be chosen in case the discriminator property matches
    Parameters:
    
    openAPI3StyleDiscriminators - whether or not discriminators should be used. Defaults to false
    
    Since:
    
    1.0.51
  - setLoadCollectors
```
public void setLoadCollectors(boolean loadCollectors)
```
  - doLoadCollectors
```
public boolean doLoadCollectors()
```
  - isResetCollectorContext
```
public boolean isResetCollectorContext()
```
  - setResetCollectorContext
```
public void setResetCollectorContext(boolean resetCollectorContext)
```
  - isWriteMode
```
public boolean isWriteMode()
```
  - setWriteMode
```
public void setWriteMode(boolean writeMode)
```
    When set to true considers that schema is used to write data then ReadOnlyValidator is activated. Default true.
    
    Parameters:
    
    writeMode - true if schema is used to write data
  - setPathType
```
public void setPathType(PathType pathType)
```
    Set the approach used to generate paths in messages, logs and errors (default is PathType.LEGACY).
    
    Parameters:
    
    pathType - The path generation approach.
  - getPathType
```
public PathType getPathType()
```
    Get the approach used to generate paths in messages, logs and errors.
    
    Returns:
    
    The path generation approach.
  - isStrict
```
public boolean isStrict(String keyword)
```
    Answers whether a keyword's validators may relax their analysis. The default is to perform strict checking. One must explicitly allow a validator to be more permissive.
    Each validator has its own understanding of what is permissive and strict. Consult the keyword's documentation for details.
    
    Parameters:
    
    keyword - the keyword to adjust (not null)
    
    Returns:
    
    Whether to perform a strict validation.
  - setStrict
```
public void setStrict(String keyword,
                      boolean strict)
```
    Alters the strictness of validations for a specific keyword. When set to true, instructs the keyword's validators to perform strict validation. Otherwise, a validator may perform a more permissive check.
    
    Parameters:
    
    keyword - The keyword to adjust (not null)
    
    strict - Whether to perform strict validations

Class SchemaValidatorsConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALL_KEYWORD_WALK_LISTENER_KEY

Constructor Detail

SchemaValidatorsConfig

Method Detail

isTypeLoose

setTypeLoose

setFailFast

isFailFast

setApplyDefaultsStrategy

getApplyDefaultsStrategy

getUriTranslator

addUriTranslator

getUriMappings

setUriMappings

isHandleNullableField

setHandleNullableField

isEcma262Validator

setEcma262Validator

isJavaSemantics

setJavaSemantics

addKeywordWalkListener

addKeywordWalkListener

addKeywordWalkListeners

addKeywordWalkListeners

addPropertyWalkListeners

addPropertyWalkListener

addItemWalkListener

addItemWalkListeners

getPropertyWalkListeners

getKeywordWalkListenersMap

getArrayItemWalkListeners

getCollectorContext

setCollectorContext

isLosslessNarrowing

setLosslessNarrowing

isOpenAPI3StyleDiscriminators

setOpenAPI3StyleDiscriminators

setLoadCollectors

doLoadCollectors

isResetCollectorContext

setResetCollectorContext

isWriteMode

setWriteMode

setPathType

getPathType

isStrict

setStrict