Package org.apache.unomi.schema.impl

Class SchemaServiceImpl

java.lang.Object

org.apache.unomi.schema.impl.SchemaServiceImpl

All Implemented Interfaces:

SchemaService

public class SchemaServiceImpl
extends Object
implements SchemaService

Constructor Summary

Constructors

Constructor	Description
SchemaServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	deleteSchema(String schemaId)	Delete a schema according to its id
void	destroy()
Set<String>	getInstalledJsonSchemaIds()	Get the list of installed Json Schema Ids
JsonSchemaWrapper	getSchema(String schemaId)	Get a schema matching by a schema id
JsonSchemaWrapper	getSchemaForEventType(String eventType)	Get the schema that is able to validate the specific event type
List<JsonSchemaWrapper>	getSchemasByTarget(String target)	Get a list a JsonSchemaWrapper
void	init()
boolean	isEventValid(String event)	Verify if the event is valid (This method is fail safe, if unexpected errors happens it will returns false)
boolean	isEventValid(String event, String eventType)	Deprecate (since 2.2.0).
boolean	isValid(String data, String schemaId)	Verify if a jsonNode is valid against a schema (This method is fail safe, if unexpected errors happens it will returns false)
void	loadPredefinedSchema(InputStream schemaStream)	Load a predefined schema into memory
void	refreshJSONSchemas()	Refresh the JSON schemas
void	saveSchema(String schema)	Save a new schema or update a schema
void	setJsonSchemaRefreshInterval(Integer jsonSchemaRefreshInterval)
void	setPersistenceService(PersistenceService persistenceService)
void	setScopeService(ScopeService scopeService)
boolean	unloadPredefinedSchema(InputStream schemaStream)	Unload a predefined schema into memory
Set<ValidationError>	validateEvent(String event)	perform a validation on the given event
Map<String,Set<ValidationError>>	validateEvents(String events)	perform a validation of a list of the given events

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaServiceImpl

public SchemaServiceImpl()

Method Detail

isValid

public boolean isValid(String data,
                       String schemaId)

Description copied from interface: SchemaService

Verify if a jsonNode is valid against a schema (This method is fail safe, if unexpected errors happens it will returns false)

Specified by:

isValid in interface SchemaService

Parameters:

data - to validate

schemaId - id of the schema used for the validation

Returns:

true is the object is valid, false otherwise, false also in case of unexpected errors !

isEventValid

public boolean isEventValid(String event,
                            String eventType)

Description copied from interface: SchemaService

Deprecate (since 2.2.0). the eventType is now directly extracted from the event source You can directly use sibling function: isEventValid(String event)

Specified by:

isEventValid in interface SchemaService

isEventValid

public boolean isEventValid(String event)

Description copied from interface: SchemaService

Verify if the event is valid (This method is fail safe, if unexpected errors happens it will returns false)

Specified by:

isEventValid in interface SchemaService

Parameters:

event - the event to check validity

Returns:

true is the event is valid, false otherwise, false also in case of unexpected errors !

validateEvent

public Set<ValidationError> validateEvent(String event)
                                   throws ValidationException

Description copied from interface: SchemaService

perform a validation on the given event

Specified by:

validateEvent in interface SchemaService

Parameters:

event - the event to validate

Returns:

The list of validation errors in case there is some, empty list otherwise

Throws:

ValidationException - in case something goes wrong and validation could not be performed.

validateEvents

public Map<String,Set<ValidationError>> validateEvents(String events)
                                                      throws ValidationException

Description copied from interface: SchemaService

perform a validation of a list of the given events

Specified by:

validateEvents in interface SchemaService

Parameters:

events - the events to validate

Returns:

The Map of validation errors group per event type in case there is some, empty map otherwise

Throws:

ValidationException - in case something goes wrong and validation could not be performed.

getSchema

public JsonSchemaWrapper getSchema(String schemaId)

Description copied from interface: SchemaService

Get a schema matching by a schema id

Specified by:

getSchema in interface SchemaService

Parameters:

schemaId - Id of the schema

Returns:

A JSON schema

getInstalledJsonSchemaIds

public Set<String> getInstalledJsonSchemaIds()

Description copied from interface: SchemaService

Get the list of installed Json Schema Ids

Specified by:

getInstalledJsonSchemaIds in interface SchemaService

Returns:

A Set of JSON schema ids

getSchemasByTarget

public List<JsonSchemaWrapper> getSchemasByTarget(String target)

Description copied from interface: SchemaService

Get a list a JsonSchemaWrapper

Specified by:

getSchemasByTarget in interface SchemaService

Parameters:

target - to filter the schemas

Returns:

a list of JSONSchema

getSchemaForEventType

public JsonSchemaWrapper getSchemaForEventType(String eventType)
                                        throws ValidationException

Description copied from interface: SchemaService

Get the schema that is able to validate the specific event type

Specified by:

getSchemaForEventType in interface SchemaService

Parameters:

eventType - the eventType

Returns:

The JSON Schema able to validate the given event type or null if not found.

Throws:

ValidationException

saveSchema

public void saveSchema(String schema)

Description copied from interface: SchemaService

Save a new schema or update a schema

Specified by:

saveSchema in interface SchemaService

Parameters:

schema - as a String value

deleteSchema

public boolean deleteSchema(String schemaId)

Description copied from interface: SchemaService

Delete a schema according to its id

Specified by:

deleteSchema in interface SchemaService

Parameters:

schemaId - id of the schema to delete

Returns:

true if the schema has been deleted

loadPredefinedSchema

public void loadPredefinedSchema(InputStream schemaStream)
                          throws IOException

Description copied from interface: SchemaService

Load a predefined schema into memory

Specified by:

loadPredefinedSchema in interface SchemaService

Parameters:

schemaStream - inputStream of the schema

Throws:

IOException

unloadPredefinedSchema

public boolean unloadPredefinedSchema(InputStream schemaStream)

Description copied from interface: SchemaService

Unload a predefined schema into memory

Specified by:

unloadPredefinedSchema in interface SchemaService

Parameters:

schemaStream - inputStream of the schema to delete

Returns:

true if the schema has been deleted

refreshJSONSchemas

public void refreshJSONSchemas()

Description copied from interface: SchemaService

Refresh the JSON schemas

Specified by:

refreshJSONSchemas in interface SchemaService

init

public void init()

destroy

public void destroy()

setPersistenceService

public void setPersistenceService(PersistenceService persistenceService)

setScopeService

public void setScopeService(ScopeService scopeService)

setJsonSchemaRefreshInterval

public void setJsonSchemaRefreshInterval(Integer jsonSchemaRefreshInterval)