software.amazon.lambda.powertools.validation

Class ValidationUtils

java.lang.Object

software.amazon.lambda.powertools.validation.ValidationUtils

public class ValidationUtils
extends java.lang.Object

Validation utility, used to manually validate Json against Json Schema

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidationUtils.ValidationErrors

Method Summary

Modifier and Type	Method and Description
static com.networknt.schema.JsonSchema	getJsonSchema(java.lang.String schema) Retrieve JsonSchema from string (either the schema itself, either from the classpath). No validation of the schema will be performed (equivalent to
static com.networknt.schema.JsonSchema	getJsonSchema(java.lang.String schema, boolean validateSchema) Retrieve JsonSchema from string (either the schema itself, either from the classpath). Optional: validate the schema against the version specifications. Store it in memory to avoid reloading it.
static void	validate(com.fasterxml.jackson.databind.JsonNode jsonNode, com.networknt.schema.JsonSchema jsonSchema) Validate a json object (in JsonNode format) against a json schema. Perform the actual validation.
static void	validate(com.fasterxml.jackson.databind.JsonNode jsonNode, java.lang.String jsonSchema) Validate a json object (in JsonNode format) against a json schema. Perform the actual validation.
static void	validate(java.util.Map<java.lang.String,java.lang.Object> map, com.networknt.schema.JsonSchema jsonSchema) Validate a json object (in map format) against a json schema
static void	validate(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String jsonSchema) Validate a json object (in map format) against a json schema
static void	validate(java.lang.Object obj, com.networknt.schema.JsonSchema jsonSchema) Validate a json object against a json schema
static void	validate(java.lang.Object obj, com.networknt.schema.JsonSchema jsonSchema, java.lang.String envelope) Validate part of a json object against a json schema
static void	validate(java.lang.Object obj, java.lang.String jsonSchema) Validate a json object against a json schema
static void	validate(java.lang.Object obj, java.lang.String jsonSchema, java.lang.String envelope) Validate part of a json object against a json schema
static void	validate(java.lang.String json, com.networknt.schema.JsonSchema jsonSchema) Validate a json object (in string format) against a json schema
static void	validate(java.lang.String json, java.lang.String jsonSchema) Validate a json object (in string format) against a json schema

Methods inherited from class java.lang.Object

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

Method Detail

validate

public static void validate(java.lang.Object obj,
                            java.lang.String jsonSchema,
                            java.lang.String envelope)
                     throws ValidationException

Validate part of a json object against a json schema

Parameters:

obj - The object to validate

jsonSchema - The schema used to validate: either the schema itself or a path to file in the classpath: "classpath:/path/to/schema.json"

envelope - a path to a sub object within obj

Throws:

ValidationException

validate

public static void validate(java.lang.Object obj,
                            com.networknt.schema.JsonSchema jsonSchema,
                            java.lang.String envelope)
                     throws ValidationException

Validate part of a json object against a json schema

Parameters:

obj - The object to validate

jsonSchema - The schema used to validate

envelope - a path to a sub object within obj

Throws:

ValidationException

validate

public static void validate(java.lang.Object obj,
                            java.lang.String jsonSchema)
                     throws ValidationException

Validate a json object against a json schema

Parameters:

obj - Object to validate

jsonSchema - The schema used to validate: either the schema itself or a path to file in the classpath: "classpath:/path/to/schema.json"

Throws:

ValidationException - if validation fails

validate

public static void validate(java.lang.Object obj,
                            com.networknt.schema.JsonSchema jsonSchema)
                     throws ValidationException

Validate a json object against a json schema

Parameters:

obj - Object to validate

jsonSchema - The schema used to validate

Throws:

ValidationException - if validation fails

validate

public static void validate(java.lang.String json,
                            java.lang.String jsonSchema)
                     throws ValidationException

Validate a json object (in string format) against a json schema

Parameters:

json - Json in string format

jsonSchema - The schema used to validate: either the schema itself or a path to file in the classpath: "classpath:/path/to/schema.json"

Throws:

ValidationException - if validation fails

validate

public static void validate(java.lang.String json,
                            com.networknt.schema.JsonSchema jsonSchema)
                     throws ValidationException

Validate a json object (in string format) against a json schema

Parameters:

json - json in string format

jsonSchema - the schema used to validate json string

Throws:

ValidationException - if validation fails

validate

public static void validate(java.util.Map<java.lang.String,java.lang.Object> map,
                            java.lang.String jsonSchema)
                     throws ValidationException

Validate a json object (in map format) against a json schema

Parameters:

map - Map to be transformed in json and validated against the schema

jsonSchema - The schema used to validate: either the schema itself or a path to file in the classpath: "classpath:/path/to/schema.json"

Throws:

ValidationException - if validation fails

validate

public static void validate(java.util.Map<java.lang.String,java.lang.Object> map,
                            com.networknt.schema.JsonSchema jsonSchema)
                     throws ValidationException

Validate a json object (in map format) against a json schema

Parameters:

map - Map to be transformed in json and validated against the schema

jsonSchema - the schema used to validate json map

Throws:

ValidationException - if validation fails

validate

public static void validate(com.fasterxml.jackson.databind.JsonNode jsonNode,
                            java.lang.String jsonSchema)
                     throws ValidationException

Validate a json object (in JsonNode format) against a json schema.
Perform the actual validation.

Parameters:

jsonNode - Json to be validated against the schema

jsonSchema - The schema used to validate: either the schema itself or a path to file in the classpath: "classpath:/path/to/schema.json"

Throws:

ValidationException - if validation fails

validate

public static void validate(com.fasterxml.jackson.databind.JsonNode jsonNode,
                            com.networknt.schema.JsonSchema jsonSchema)
                     throws ValidationException

Validate a json object (in JsonNode format) against a json schema.
Perform the actual validation.

Parameters:

jsonNode - json to be validated against the schema

jsonSchema - the schema to validate json node

Throws:

ValidationException - if validation fails

getJsonSchema

public static com.networknt.schema.JsonSchema getJsonSchema(java.lang.String schema)

Retrieve JsonSchema from string (either the schema itself, either from the classpath).
No validation of the schema will be performed (equivalent to

getJsonSchema(schema, false)

Store it in memory to avoid reloading it.

Parameters:

schema - either the schema itself of a "classpath:/path/to/schema.json"

Returns:

the loaded json schema

getJsonSchema

public static com.networknt.schema.JsonSchema getJsonSchema(java.lang.String schema,
                                                            boolean validateSchema)

Retrieve JsonSchema from string (either the schema itself, either from the classpath).
Optional: validate the schema against the version specifications.
Store it in memory to avoid reloading it.

Parameters:

schema - either the schema itself of a "classpath:/path/to/schema.json"

validateSchema - specify if the schema itself must be validated against specifications

Returns:

the loaded json schema