Package eu.europa.esig.jws

Class AbstractJWSUtils

java.lang.Object

eu.europa.esig.jws.AbstractJWSUtils

Direct Known Subclasses:

JAdESUtils, JWSUtils

public abstract class AbstractJWSUtils
extends Object

Abstract class for JWS signature validation against JSON schemas

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJWSUtils()	Default constructor instantiating the object with null values

Method Summary

Modifier and Type	Method	Description
Map<URI,String>	getJSONSchemaDefinitions()	Returns a list of RFC 7515 and RFC 7517 definitions
com.github.erosb.jsonsKema.Schema	getJWSProtectedHeaderSchema()	Returns a JWS Protected Header Schema
abstract Map<URI,String>	getJWSProtectedHeaderSchemaDefinitions()	Returns a map of definition objects used for JWS Protected Header validation
abstract String	getJWSProtectedHeaderSchemaJSON()	Loads JSON schema for a JSON Protected Header validation
com.github.erosb.jsonsKema.Schema	getJWSSchema()	Returns a JWS Schema for a root signature element validation
abstract Map<URI,String>	getJWSSchemaDefinitions()	Returns a map of definition objects used for JWS validation
abstract String	getJWSSchemaJSON()	Returns a JSON schema for a root JWS element validation
com.github.erosb.jsonsKema.Schema	getJWSUnprotectedHeaderSchema()	Returns a JWS Protected Header Schema
abstract Map<URI,String>	getJWSUnprotectedHeaderSchemaDefinitions()	Returns a map of definition objects used for JWS Unprotected Header validation
abstract String	getJWSUnprotectedHeaderSchemaJSON()	Loads JSON schema for a JSON Unprotected Header validation
com.github.erosb.jsonsKema.Schema	loadSchema(String schemaJSON, Map<URI,String> definitions)	Loads schema with the given list of definitions (references)
com.github.erosb.jsonsKema.JsonObject	parseJson(InputStream inputStream)	Parses the JSON InputStream and returns a JsonObject
com.github.erosb.jsonsKema.JsonObject	parseJson(InputStream inputStream, URI uri)	Parses the JSON InputStream with the provided schema uri identifier, and returns a JsonObject.
com.github.erosb.jsonsKema.JsonObject	parseJson(String json)	Parses the JSON string and returns a JsonObject
com.github.erosb.jsonsKema.JsonObject	parseJson(String json, URI uri)	Parses the JSON string with the provided schema uri identifier, and returns a JsonObject.
List<String>	validateAgainstJWSProtectedHeaderSchema(com.github.erosb.jsonsKema.JsonObject json)	Validates a "protected" header of a JWS
List<String>	validateAgainstJWSProtectedHeaderSchema(InputStream is)	Validates a "protected" header of a JWS
List<String>	validateAgainstJWSProtectedHeaderSchema(String jsonString)	Validates a "protected" header of a JWS
List<String>	validateAgainstJWSSchema(com.github.erosb.jsonsKema.JsonObject json)	Validates a JSON against JWS Schema according to RFC 7515
List<String>	validateAgainstJWSSchema(InputStream is)	Validates a JSON against JWS Schema according to RFC 7515
List<String>	validateAgainstJWSSchema(String jsonString)	Validates a JSON against JWS Schema according to RFC 7515
List<String>	validateAgainstJWSUnprotectedHeaderSchema(com.github.erosb.jsonsKema.JsonValue json)	Validates an unprotected "header" of a JWS
List<String>	validateAgainstJWSUnprotectedHeaderSchema(InputStream is)	Validates an unprotected "header" of a JWS
List<String>	validateAgainstJWSUnprotectedHeaderSchema(String jsonString)	Validates an unprotected "header" of a JWS
List<String>	validateAgainstSchema(com.github.erosb.jsonsKema.JsonValue json, com.github.erosb.jsonsKema.Schema schema)	Validates a json against the provided JSON schema

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractJWSUtils

protected AbstractJWSUtils()

Default constructor instantiating the object with null values

Method Details

getJWSSchema

public com.github.erosb.jsonsKema.Schema getJWSSchema()

Returns a JWS Schema for a root signature element validation

Returns:

Schema for JWS root validation

getJWSProtectedHeaderSchema

public com.github.erosb.jsonsKema.Schema getJWSProtectedHeaderSchema()

Returns a JWS Protected Header Schema

Returns:

Schema for JWS Protected Header validation

getJWSUnprotectedHeaderSchema

public com.github.erosb.jsonsKema.Schema getJWSUnprotectedHeaderSchema()

Returns a JWS Protected Header Schema

Returns:

Schema for JWS Protected Header validation

getJWSSchemaJSON

public abstract String getJWSSchemaJSON()

Returns a JSON schema for a root JWS element validation

Returns:

String

getJWSSchemaDefinitions

public abstract Map<URI,String> getJWSSchemaDefinitions()

Returns a map of definition objects used for JWS validation

Returns:

JWS schema definitions map

getJWSProtectedHeaderSchemaJSON

public abstract String getJWSProtectedHeaderSchemaJSON()

Loads JSON schema for a JSON Protected Header validation

Returns:

String

getJWSProtectedHeaderSchemaDefinitions

public abstract Map<URI,String> getJWSProtectedHeaderSchemaDefinitions()

Returns a map of definition objects used for JWS Protected Header validation

Returns:

JWS Protected Header schema definitions map

getJWSUnprotectedHeaderSchemaJSON

public abstract String getJWSUnprotectedHeaderSchemaJSON()

Loads JSON schema for a JSON Unprotected Header validation

Returns:

String

getJWSUnprotectedHeaderSchemaDefinitions

public abstract Map<URI,String> getJWSUnprotectedHeaderSchemaDefinitions()

Returns a map of definition objects used for JWS Unprotected Header validation

Returns:

JWS Unprotected Header schema definitions map

validateAgainstJWSSchema

public List<String> validateAgainstJWSSchema(InputStream is)

Validates a JSON against JWS Schema according to RFC 7515

Parameters:

is - InputStream representing a JSON to validate

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSSchema

public List<String> validateAgainstJWSSchema(String jsonString)

Validates a JSON against JWS Schema according to RFC 7515

Parameters:

jsonString - String representing a JSON to validate

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSSchema

public List<String> validateAgainstJWSSchema(com.github.erosb.jsonsKema.JsonObject json)

Validates a JSON against JWS Schema according to RFC 7515

Parameters:

json - JsonObject representing a JSON to validate

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSProtectedHeaderSchema

public List<String> validateAgainstJWSProtectedHeaderSchema(InputStream is)

Validates a "protected" header of a JWS

Parameters:

is - InputStream representing a protected header of a JWS

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSProtectedHeaderSchema

public List<String> validateAgainstJWSProtectedHeaderSchema(String jsonString)

Validates a "protected" header of a JWS

Parameters:

jsonString - String representing a protected header of a JWS

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSProtectedHeaderSchema

public List<String> validateAgainstJWSProtectedHeaderSchema(com.github.erosb.jsonsKema.JsonObject json)

Validates a "protected" header of a JWS

Parameters:

json - JsonObject representing a protected header of a JWS

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSUnprotectedHeaderSchema

public List<String> validateAgainstJWSUnprotectedHeaderSchema(InputStream is)

Validates an unprotected "header" of a JWS

Parameters:

is - InputStream representing an unprotected header of a JWS

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSUnprotectedHeaderSchema

public List<String> validateAgainstJWSUnprotectedHeaderSchema(String jsonString)

Validates an unprotected "header" of a JWS

Parameters:

jsonString - String representing an unprotected header of a JWS

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstJWSUnprotectedHeaderSchema

public List<String> validateAgainstJWSUnprotectedHeaderSchema(com.github.erosb.jsonsKema.JsonValue json)

Validates an unprotected "header" of a JWS

Parameters:

json - JsonValue representing an unprotected header of a JWS

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

validateAgainstSchema

public List<String> validateAgainstSchema(com.github.erosb.jsonsKema.JsonValue json,
 com.github.erosb.jsonsKema.Schema schema)

Validates a json against the provided JSON schema

Parameters:

json - JsonValue to be validated against a schema

schema - Schema schema to validate against

Returns:

a list of String messages containing errors occurred during the validation process, empty list when validation succeeds

getJSONSchemaDefinitions

public Map<URI,String> getJSONSchemaDefinitions()

Returns a list of RFC 7515 and RFC 7517 definitions

Returns:

a map of definitions

parseJson

public com.github.erosb.jsonsKema.JsonObject parseJson(String json)

Parses the JSON string and returns a JsonObject

Parameters:

json - String to parse

Returns:

JsonObject

parseJson

public com.github.erosb.jsonsKema.JsonObject parseJson(String json,
 URI uri)

Parses the JSON string with the provided schema uri identifier, and returns a JsonObject. This method is used for a schema parsing.

Parameters:

json - String to parse

uri - URI of the schema

Returns:

JsonObject

parseJson

public com.github.erosb.jsonsKema.JsonObject parseJson(InputStream inputStream)

Parses the JSON InputStream and returns a JsonObject

Parameters:

inputStream - InputStream to parse

Returns:

JsonObject

parseJson

public com.github.erosb.jsonsKema.JsonObject parseJson(InputStream inputStream,
 URI uri)

Parses the JSON InputStream with the provided schema uri identifier, and returns a JsonObject. This method is used for a schema parsing.

Parameters:

inputStream - InputStream to parse

uri - URI of the schema

Returns:

JsonObject

loadSchema

public com.github.erosb.jsonsKema.Schema loadSchema(String schemaJSON,
 Map<URI,String> definitions)

Loads schema with the given list of definitions (references)

Parameters:

schemaJSON - JsonObject the schema object URI

definitions - a map containing definitions and their reference names

Returns:

Schema