Package jmri.server.json.schema

Class JsonSchemaServiceCache

java.lang.Object

jmri.server.json.schema.JsonSchemaServiceCache

All Implemented Interfaces:

InstanceManagerAutoDefault

public class JsonSchemaServiceCache
extends Object
implements InstanceManagerAutoDefault

Cache for mapping JsonHttpServices to types for getting schemas.

Constructor Summary

Constructors

Constructor	Description
JsonSchemaServiceCache()

Method Summary

Modifier and Type	Method	Description
com.networknt.schema.JsonSchema	getClientSchema(String type, Locale locale, int id)	Deprecated. since 4.19.2; use getClientSchema(String, JsonRequest) instead
com.networknt.schema.JsonSchema	getClientSchema(String type, JsonRequest request)	Get the client schema for JSON messages or for specific JSON data schema.
Set<String>	getClientTypes()	Deprecated. since 4.19.2; use getClientTypes(String) instead
Set<String>	getClientTypes(String version)	Get the types of JSON messages expected from clients.
com.networknt.schema.JsonSchema	getServerSchema(String type, Locale locale, int id)	Deprecated. since 4.19.2; use getServerSchema(String, JsonRequest) instead
com.networknt.schema.JsonSchema	getServerSchema(String type, JsonRequest request)	Get the server schema for JSON messages or for specific JSON data schema.
Set<String>	getServerTypes()	Deprecated. since 4.19.2; use getServerTypes(String) instead
Set<String>	getServerTypes(String version)	Get the types of JSON messages this application sends.
Set<JsonHttpService>	getServices(String type)	Deprecated. since 4.19.2; use getServices(String, String) instead
Set<JsonHttpService>	getServices(String type, String version)	Get the services known to this cache that support a specific JSON type.
Set<String>	getTypes()	Deprecated. since 4.19.2; use getTypes(String) instead
Set<String>	getTypes(String version)	Get all types of JSON messages.
void	validateData(String type, com.fasterxml.jackson.databind.JsonNode data, boolean server, Locale locale, int id)	Deprecated. since 4.19.2; use validateData(String, JsonNode, boolean, JsonRequest) instead
void	validateData(String type, com.fasterxml.jackson.databind.JsonNode data, boolean server, JsonRequest request)	Validate a JSON data object against the schema for JSON messages and data.
void	validateMessage(com.fasterxml.jackson.databind.JsonNode message, boolean server, Locale locale, int id)	Deprecated. since 4.19.2; use validateMessage(JsonNode, boolean, JsonRequest) instead
void	validateMessage(com.fasterxml.jackson.databind.JsonNode message, boolean server, JsonRequest request)	Validate a JSON message against the schema for JSON messages and data.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonSchemaServiceCache

public JsonSchemaServiceCache()

Method Details

getServices

@Nonnull public Set<JsonHttpService> getServices(@Nonnull String type, @Nonnull String version)

Get the services known to this cache that support a specific JSON type.

Parameters:

type - the JSON type requested

version - the JSON protocol version requested

Returns:

the supporting services or an empty set if none

Throws:

NullPointerException - if version is not a known version

getServices

@Deprecated @Nonnull public Set<JsonHttpService> getServices(@Nonnull String type)

Deprecated.

since 4.19.2; use getServices(String, String) instead

Get the services known to this cache that support a specific JSON type for version 5 of the JSON protocol.

Parameters:

type - the JSON type requested

Returns:

the supporting services or an empty set if none

getTypes

@Nonnull public Set<String> getTypes(String version)

Get all types of JSON messages.

Parameters:

version - the JSON protocol version

Returns:

the union of the results from getClientTypes() and getServerTypes()

getClientTypes

@Nonnull public Set<String> getClientTypes(String version)

Get the types of JSON messages expected from clients.

Parameters:

version - the JSON protocol version

Returns:

the message types

getServerTypes

@Nonnull public Set<String> getServerTypes(String version)

Get the types of JSON messages this application sends.

Parameters:

version - the JSON protocol version

Returns:

the message types

getTypes

@Deprecated @Nonnull public Set<String> getTypes()

Deprecated.

since 4.19.2; use getTypes(String) instead

Get all types of JSON messages.

Returns:

the union of the results from getClientTypes() and getServerTypes()

getClientTypes

@Deprecated @Nonnull public Set<String> getClientTypes()

Deprecated.

since 4.19.2; use getClientTypes(String) instead

Get the types of JSON messages expected from clients.

Returns:

the message types

getServerTypes

@Deprecated @Nonnull public Set<String> getServerTypes()

Deprecated.

since 4.19.2; use getServerTypes(String) instead

Get the types of JSON messages this application sends.

Returns:

the message types

getClientSchema

@Nonnull public com.networknt.schema.JsonSchema getClientSchema(@Nonnull String type, @Nonnull JsonRequest request) throws JsonException

Get the client schema for JSON messages or for specific JSON data schema.

Parameters:

type - the type; use JSON.JSON to get the schema for messages, or any other value for a data schema

request - the JSON request

Returns:

the requested schema

Throws:

JsonException - if unable to get schema due to errors processing schema

IllegalArgumentException - if no JSON service provides schemas for type

getClientSchema

@Deprecated @Nonnull public com.networknt.schema.JsonSchema getClientSchema(@Nonnull String type, @Nonnull Locale locale, int id) throws JsonException

Deprecated.

since 4.19.2; use getClientSchema(String, JsonRequest) instead

Get the client schema for JSON messages or for specific JSON data schema.

Parameters:

type - the type; use JSON.JSON to get the schema for messages, or any other value for a data schema

locale - the locale for error messages, if any

id - message id set by client

Returns:

the requested schema

Throws:

JsonException - if unable to get schema due to errors processing schema

IllegalArgumentException - if no JSON service provides schemas for type

getServerSchema

@Nonnull public com.networknt.schema.JsonSchema getServerSchema(@Nonnull String type, @Nonnull JsonRequest request) throws JsonException

Get the server schema for JSON messages or for specific JSON data schema.

Parameters:

type - the type; use JSON.JSON to get the schema for messages, or any other value for a data schema

request - the JSON request

Returns:

the requested schema

Throws:

JsonException - if unable to get schema due to errors processing schema

IllegalArgumentException - if no JSON service provides schemas for type

getServerSchema

@Deprecated @Nonnull public com.networknt.schema.JsonSchema getServerSchema(@Nonnull String type, @Nonnull Locale locale, int id) throws JsonException

Deprecated.

since 4.19.2; use getServerSchema(String, JsonRequest) instead

Get the server schema for JSON messages or for specific JSON data schema.

Parameters:

type - the type; use JSON.JSON to get the schema for messages, or any other value for a data schema

locale - the locale for error messages, if any

id - message id set by client

Returns:

the requested schema

Throws:

JsonException - if unable to get schema due to errors processing schema

IllegalArgumentException - if no JSON service provides schemas for type

validateMessage

public void validateMessage(@Nonnull com.fasterxml.jackson.databind.JsonNode message, boolean server, @Nonnull JsonRequest request) throws JsonException

Validate a JSON message against the schema for JSON messages and data.

Parameters:

message - the message to validate

server - true if message is from the JSON server; false otherwise

request - the JSON request

Throws:

JsonException - if the message does not validate

validateMessage

@Deprecated public void validateMessage(@Nonnull com.fasterxml.jackson.databind.JsonNode message, boolean server, @Nonnull Locale locale, int id) throws JsonException

Deprecated.

since 4.19.2; use validateMessage(JsonNode, boolean, JsonRequest) instead

Validate a JSON message against the schema for JSON messages and data.

Parameters:

message - the message to validate

server - true if message is from the JSON server; false otherwise

locale - the locale for any exceptions that need to be reported to clients

id - the id to be included with any exceptions reported to clients

Throws:

JsonException - if the message does not validate

validateData

public void validateData(@Nonnull String type, @Nonnull com.fasterxml.jackson.databind.JsonNode data, boolean server, @Nonnull JsonRequest request) throws JsonException

Validate a JSON data object against the schema for JSON messages and data.

Parameters:

type - the type of data object

data - the data object to validate

server - true if message is from the JSON server; false otherwise

request - the JSON request

Throws:

JsonException - if the message does not validate

validateData

@Deprecated public void validateData(@Nonnull String type, @Nonnull com.fasterxml.jackson.databind.JsonNode data, boolean server, @Nonnull Locale locale, int id) throws JsonException

Deprecated.

since 4.19.2; use validateData(String, JsonNode, boolean, JsonRequest) instead

Validate a JSON data object against the schema for JSON messages and data.

Parameters:

type - the type of data object

data - the data object to validate

server - true if message is from the JSON server; false otherwise

locale - the locale for any exceptions that need to be reported to clients

id - the id to be included with any exceptions reported to clients

Throws:

JsonException - if the message does not validate