fr.gouv.vitam.common.json

Class SchemaValidationUtils

java.lang.Object

fr.gouv.vitam.common.json.SchemaValidationUtils

public class SchemaValidationUtils
extends Object

SchemaValidationUtils

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_CONTRACT_SCHEMA_FILENAME access-contract-schema
static String	ACCESSION_REGISTER_DETAIL_SCHEMA_FILENAME accession-register-detail.schema
static String	ACCESSION_REGISTER_SUMMARY_SCHEMA_FILENAME accession-register-summary.schema
static String	AGENCIES_SCHEMA_FILENAME agencies.schema
static String	ARCHIVE_UNIT_PROFILE_SCHEMA_FILENAME archive-unit-profile.schema
static String	ARCHIVE_UNIT_SCHEMA_FILENAME archive-unit-schema
static Set<String>	AVAILABLE_MANAGEMENT_ATTRIBUTES
static String	CONTEXT_SCHEMA_FILENAME context.schema
static String	FILE_FORMAT_SCHEMA_FILENAME file-format.schema
static String	FILE_RULES_SCHEMA_FILENAME file-rules.schema
static String	INGEST_CONTRACT_SCHEMA_FILENAME ingest-contract.schema
static String	ONTOLOGY_SCHEMA_FILENAME ontology.schema
static String	PROFILE_SCHEMA_FILENAME profile.schema
static String	SECURITY_PROFILE_SCHEMA_FILENAME security-profile.schema
static String	TAG_ONTOLOGY_FIELDS schemaValidation
static String	TAG_SCHEMA_VALIDATION schemaValidation

Constructor Summary

Constructors

Modifier	Constructor and Description
	SchemaValidationUtils() Constructor with a default schema filename
protected	SchemaValidationUtils(String schema) Constructor with a specified schema filename
	SchemaValidationUtils(String schema, boolean external) Constructor with a specified schema filename or an external json schema as a string

Method Summary

Modifier and Type	Method and Description
List<String>	extractFieldsFromSchema(String schemaJsonAsString) Get fields list declared in schema
SchemaValidationStatus	validateInsertOrUpdateUnit(com.fasterxml.jackson.databind.JsonNode archiveUnit) Validate a json for insert or update with a schema
protected SchemaValidationStatus	validateJson(com.fasterxml.jackson.databind.JsonNode jsonNode) Validate a json with a schema
SchemaValidationStatus	validateJson(com.fasterxml.jackson.databind.JsonNode jsonNode, String collectionName) Validate the json against the schema of the specified collectionName
SchemaValidationStatus	validateUnit(com.fasterxml.jackson.databind.JsonNode archiveUnit) Validate a json with the schema archive-unit-schema
void	verifyAndReplaceFields(com.fasterxml.jackson.databind.JsonNode node, Map<String,OntologyModel> ontologyModelMap, List<String> errors) Verify and replace fields.

Methods inherited from class java.lang.Object

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

Field Detail

ARCHIVE_UNIT_SCHEMA_FILENAME

public static final String ARCHIVE_UNIT_SCHEMA_FILENAME

archive-unit-schema

See Also:

Constant Field Values

ACCESS_CONTRACT_SCHEMA_FILENAME

public static final String ACCESS_CONTRACT_SCHEMA_FILENAME

access-contract-schema

See Also:

Constant Field Values

ACCESSION_REGISTER_DETAIL_SCHEMA_FILENAME

public static final String ACCESSION_REGISTER_DETAIL_SCHEMA_FILENAME

accession-register-detail.schema

See Also:

Constant Field Values

ACCESSION_REGISTER_SUMMARY_SCHEMA_FILENAME

public static final String ACCESSION_REGISTER_SUMMARY_SCHEMA_FILENAME

accession-register-summary.schema

See Also:

Constant Field Values

AGENCIES_SCHEMA_FILENAME

public static final String AGENCIES_SCHEMA_FILENAME

agencies.schema

See Also:

Constant Field Values

ARCHIVE_UNIT_PROFILE_SCHEMA_FILENAME

public static final String ARCHIVE_UNIT_PROFILE_SCHEMA_FILENAME

archive-unit-profile.schema

See Also:

Constant Field Values

CONTEXT_SCHEMA_FILENAME

public static final String CONTEXT_SCHEMA_FILENAME

context.schema

See Also:

Constant Field Values

FILE_FORMAT_SCHEMA_FILENAME

public static final String FILE_FORMAT_SCHEMA_FILENAME

file-format.schema

See Also:

Constant Field Values

FILE_RULES_SCHEMA_FILENAME

public static final String FILE_RULES_SCHEMA_FILENAME

file-rules.schema

See Also:

Constant Field Values

INGEST_CONTRACT_SCHEMA_FILENAME

public static final String INGEST_CONTRACT_SCHEMA_FILENAME

ingest-contract.schema

See Also:

Constant Field Values

PROFILE_SCHEMA_FILENAME

public static final String PROFILE_SCHEMA_FILENAME

profile.schema

See Also:

Constant Field Values

SECURITY_PROFILE_SCHEMA_FILENAME

public static final String SECURITY_PROFILE_SCHEMA_FILENAME

security-profile.schema

See Also:

Constant Field Values

TAG_SCHEMA_VALIDATION

public static final String TAG_SCHEMA_VALIDATION

schemaValidation

See Also:

Constant Field Values

TAG_ONTOLOGY_FIELDS

public static final String TAG_ONTOLOGY_FIELDS

schemaValidation

See Also:

Constant Field Values

ONTOLOGY_SCHEMA_FILENAME

public static final String ONTOLOGY_SCHEMA_FILENAME

ontology.schema

See Also:

Constant Field Values

AVAILABLE_MANAGEMENT_ATTRIBUTES

public static Set<String> AVAILABLE_MANAGEMENT_ATTRIBUTES

Constructor Detail

SchemaValidationUtils

public SchemaValidationUtils()
                      throws FileNotFoundException,
                             com.github.fge.jsonschema.core.exceptions.ProcessingException,
                             InvalidParseOperationException

Constructor with a default schema filename

Throws:

FileNotFoundException

com.github.fge.jsonschema.core.exceptions.ProcessingException

InvalidParseOperationException

SchemaValidationUtils

protected SchemaValidationUtils(String schema)
                         throws FileNotFoundException,
                                com.github.fge.jsonschema.core.exceptions.ProcessingException,
                                InvalidParseOperationException

Constructor with a specified schema filename

Parameters:

schema - schemaFilename or external json schema as a string

Throws:

FileNotFoundException

com.github.fge.jsonschema.core.exceptions.ProcessingException

InvalidParseOperationException

SchemaValidationUtils

public SchemaValidationUtils(String schema,
                             boolean external)
                      throws FileNotFoundException,
                             com.github.fge.jsonschema.core.exceptions.ProcessingException,
                             InvalidParseOperationException

Constructor with a specified schema filename or an external json schema as a string

Parameters:

schema - schemaFilename or external json schema as a string

external - true if the schema is provided as a string

Throws:

FileNotFoundException

com.github.fge.jsonschema.core.exceptions.ProcessingException

InvalidParseOperationException

Method Detail

validateJson

public SchemaValidationStatus validateJson(com.fasterxml.jackson.databind.JsonNode jsonNode,
                                           String collectionName)
                                    throws FileNotFoundException,
                                           InvalidParseOperationException,
                                           com.github.fge.jsonschema.core.exceptions.ProcessingException

Validate the json against the schema of the specified collectionName

Parameters:

jsonNode -

collectionName -

Returns:

a status (SchemaValidationStatus)

Throws:

FileNotFoundException - if no schema has been found fot the specified collectionname

InvalidParseOperationException

com.github.fge.jsonschema.core.exceptions.ProcessingException

validateJson

protected SchemaValidationStatus validateJson(com.fasterxml.jackson.databind.JsonNode jsonNode)

Validate a json with a schema

Parameters:

jsonNode - the json to be validated

Returns:

a status (SchemaValidationStatus)

validateUnit

public SchemaValidationStatus validateUnit(com.fasterxml.jackson.databind.JsonNode archiveUnit)

Validate a json with the schema archive-unit-schema

Parameters:

archiveUnit - the json to be validated

Returns:

a status (SchemaValidationStatus)

validateInsertOrUpdateUnit

public SchemaValidationStatus validateInsertOrUpdateUnit(com.fasterxml.jackson.databind.JsonNode archiveUnit)

Validate a json for insert or update with a schema

Parameters:

archiveUnit - the json to be validated

Returns:

a status (SchemaValidationStatus)

extractFieldsFromSchema

public List<String> extractFieldsFromSchema(String schemaJsonAsString)
                                     throws InvalidParseOperationException

Get fields list declared in schema

Parameters:

schemaJsonAsString -

Returns:

a the list of fields declared in the schema

Throws:

InvalidParseOperationException

verifyAndReplaceFields

public void verifyAndReplaceFields(com.fasterxml.jackson.databind.JsonNode node,
                                   Map<String,OntologyModel> ontologyModelMap,
                                   List<String> errors)

Verify and replace fields.

Parameters:

node - to modify

ontologyModelMap - where are ontologies

errors - of replacement