org.apache.unomi.schema.rest

Class JsonSchemaEndPoint

java.lang.Object

org.apache.unomi.schema.rest.JsonSchemaEndPoint

@Produces(value="application/json;charset=UTF-8")
 @Path(value="/jsonSchema")
public class JsonSchemaEndPoint
extends Object

Constructor Summary

Constructors

Constructor and Description
JsonSchemaEndPoint()

Method Summary

Modifier and Type	Method and Description
Set<String>	getInstalledJsonSchemaIds() Get the list of installed Json Schema Ids
String	getSchema(String id) Get a schema by it's id
boolean	remove(String id) Deletes a JSON schema by it's id.
javax.ws.rs.core.Response	save(String jsonSchema) Save a JSON schema
void	setSchemaService(SchemaService schemaService)
Collection<ValidationError>	validateEvent(String event) Being able to validate a given event is useful when you want to develop custom events and associated schemas
Map<String,Set<ValidationError>>	validateEvents(String events) Being able to validate a given list of event is useful when you want to develop custom events and associated schemas

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchemaEndPoint

public JsonSchemaEndPoint()

Method Detail

setSchemaService

public void setSchemaService(SchemaService schemaService)

getInstalledJsonSchemaIds

@GET
 @Path(value="/")
public Set<String> getInstalledJsonSchemaIds()

Get the list of installed Json Schema Ids

Returns:

A Set of JSON schema ids

getSchema

@POST
 @Path(value="/query")
public String getSchema(String id)

Get a schema by it's id

Parameters:

id - of the schema

Returns:

Json schema matching the id

save

@POST
 @Path(value="/")
 @Consumes(value={"text/plain","application/json"})
 @Produces(value="application/json")
public javax.ws.rs.core.Response save(String jsonSchema)

Save a JSON schema

Parameters:

jsonSchema - the schema as string to save

Returns:

Response of the API call

remove

@POST
 @Path(value="/delete")
public boolean remove(String id)

Deletes a JSON schema by it's id.

Parameters:

id - the identifier of the JSON schema that we want to delete

validateEvent

@POST
 @Produces(value="application/json;charset=UTF-8")
 @Consumes(value={"text/plain","application/json"})
 @Path(value="/validateEvent")
public Collection<ValidationError> validateEvent(String event)

Being able to validate a given event is useful when you want to develop custom events and associated schemas

Parameters:

event - the event to be validated

Returns:

Validation error messages if there is some

validateEvents

@POST
 @Produces(value="application/json;charset=UTF-8")
 @Consumes(value={"text/plain","application/json"})
 @Path(value="/validateEvents")
public Map<String,Set<ValidationError>> validateEvents(String events)

Being able to validate a given list of event is useful when you want to develop custom events and associated schemas

Parameters:

events - the events to be validated

Returns:

Validation error messages if there is some grouped per event type