fr.gouv.vitam.functional.administration.ontologies.core

Class OntologyManager

java.lang.Object

fr.gouv.vitam.functional.administration.ontologies.core.OntologyManager

public class OntologyManager
extends Object

This class manage validation and log operation of Ontology service

Constructor Summary

Constructors

Constructor and Description
OntologyManager(LogbookOperationsClient logbookClient, GUID eip, Map<String,List<ErrorReportOntologies>> errors)

Method Summary

Modifier and Type	Method and Description
void	addError(String identifier, ErrorReportOntologies error, Map<String,List<ErrorReportOntologies>> errors) Add an error to the report
OntologyValidator	createCheckDuplicateInDatabaseValidator() Check if the ontology identifier already exists in DB or is equal to a sedafield in DB Check is done for the current tenant and the admin tenant ontologies
OntologyValidator	createCheckIdentifierValidator() Check if the ontology identifier against un regular expression For an identifier to be valid, it must not contain a white space, nor begin by "_" or "#"
OntologyValidator	createCheckUsedByDocumentTypeValidator() Check if the ontology is used in a document type
OntologyValidator	createMandatoryParamsValidator() Validate that the ontology has not a missing mandatory parameter
OntologyValidator	createWrongFieldFormatValidator() Set a default value if null and check for wrong data type/format/value for fields
void	logFatalError(String eventType, String objectId, String errorsDetails) log fatal error (system or technical error)
void	logStarted(String eventType, String objectId) log start process
void	logSuccess(String eventType, String objectId, String message) log end success process
void	logValidationError(String eventType, String objectId, String errorsDetails) Log validation error (business error)
boolean	validateCreateExternalOntology(String identifier, OntologyModel ontology) Validate the creation of an EXTERNAL ontology
boolean	validateCreateInternalOntology(String identifier, OntologyModel ontology) Validate the creation of an INTERNAL ontology
boolean	validateDeleteOntology(String identifier, OntologyModel ontology) Validate the deletion of an ontology
boolean	validateUpdateExternalOntology(String identifier, OntologyModel ontology) Validate the update of an EXTERNAL ontology
boolean	validateUpdateInternalOntology(String identifier, OntologyModel ontology) Validate the update of an INTERNAL ontology

Methods inherited from class java.lang.Object

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

Constructor Detail

OntologyManager

public OntologyManager(LogbookOperationsClient logbookClient,
                       GUID eip,
                       Map<String,List<ErrorReportOntologies>> errors)

Method Detail

validateCreateInternalOntology

public boolean validateCreateInternalOntology(String identifier,
                                              OntologyModel ontology)

Validate the creation of an INTERNAL ontology

Parameters:

identifier -

ontology -

Returns:

validateCreateExternalOntology

public boolean validateCreateExternalOntology(String identifier,
                                              OntologyModel ontology)

Validate the creation of an EXTERNAL ontology

Parameters:

identifier -

ontology -

Returns:

validateUpdateExternalOntology

public boolean validateUpdateExternalOntology(String identifier,
                                              OntologyModel ontology)

Validate the update of an EXTERNAL ontology

Parameters:

identifier -

ontology -

Returns:

validateUpdateInternalOntology

public boolean validateUpdateInternalOntology(String identifier,
                                              OntologyModel ontology)

Validate the update of an INTERNAL ontology

Parameters:

identifier -

ontology -

Returns:

validateDeleteOntology

public boolean validateDeleteOntology(String identifier,
                                      OntologyModel ontology)

Validate the deletion of an ontology

Parameters:

identifier -

ontology -

Returns:

addError

public void addError(String identifier,
                     ErrorReportOntologies error,
                     Map<String,List<ErrorReportOntologies>> errors)

Add an error to the report

Parameters:

identifier -

error -

logValidationError

public void logValidationError(String eventType,
                               String objectId,
                               String errorsDetails)
                        throws VitamException

Log validation error (business error)

Parameters:

errorsDetails -

Throws:

VitamException

logFatalError

public void logFatalError(String eventType,
                          String objectId,
                          String errorsDetails)
                   throws VitamException

log fatal error (system or technical error)

Parameters:

errorsDetails -

Throws:

VitamException

logStarted

public void logStarted(String eventType,
                       String objectId)
                throws VitamException

log start process

Throws:

VitamException

logSuccess

public void logSuccess(String eventType,
                       String objectId,
                       String message)
                throws VitamException

log end success process

Throws:

VitamException

createMandatoryParamsValidator

public OntologyValidator createMandatoryParamsValidator()

Validate that the ontology has not a missing mandatory parameter

Returns:

createWrongFieldFormatValidator

public OntologyValidator createWrongFieldFormatValidator()

Set a default value if null and check for wrong data type/format/value for fields

Returns:

the validator with thrown errors

createCheckDuplicateInDatabaseValidator

public OntologyValidator createCheckDuplicateInDatabaseValidator()

Check if the ontology identifier already exists in DB or is equal to a sedafield in DB Check is done for the current tenant and the admin tenant ontologies

Returns:

createCheckUsedByDocumentTypeValidator

public OntologyValidator createCheckUsedByDocumentTypeValidator()

Check if the ontology is used in a document type

Returns:

createCheckIdentifierValidator

public OntologyValidator createCheckIdentifierValidator()

Check if the ontology identifier against un regular expression For an identifier to be valid, it must not contain a white space, nor begin by "_" or "#"

Returns: