Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ADDITIONALITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
additionalItems
field name. - ADDITIONALPROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
additionalProperties
field name. - AnyTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
AnyTypeValidator applies all the constraints of a
any
type. - AnyTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.AnyTypeValidator
-
Construct an any type validator.
- ArrayTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
ArrayTypeValidator applies all the constraints of a
array
type. - ArrayTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.ArrayTypeValidator
-
Default ctor.
- assembleException() - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
-
Deprecated.
- assembleException() - Method in class org.forgerock.json.schema.validator.ErrorHandler
-
Deprecated.
- assembleException() - Method in class org.forgerock.json.schema.validator.FailFastErrorHandler
-
Deprecated.
B
- BooleanTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
BooleanTypeValidator applies all the constraints of a
boolean
type. - BooleanTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.BooleanTypeValidator
-
Construct a boolean type validator.
C
- collectAllValidators(Collection<Validator>) - Method in class org.forgerock.json.schema.validator.validators.ArrayTypeValidator
-
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
- collectAllValidators(Collection<Validator>) - Method in class org.forgerock.json.schema.validator.validators.ObjectTypeValidator
-
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
- collectAllValidators(Collection<Validator>) - Method in class org.forgerock.json.schema.validator.validators.Validator
-
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
- collectAllValidators(Collection<Validator>, Collection<? extends Validator>) - Static method in class org.forgerock.json.schema.validator.validators.Validator
-
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
- collectAllValidators(Collection<Validator>, Map<?, ? extends Validator>) - Static method in class org.forgerock.json.schema.validator.validators.Validator
-
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
- CollectErrorsHandler - Class in org.forgerock.json.schema.validator
-
The CollectErrorsHandler implements the
ErrorHandler
and never throws any exception, but collects them so callers can retrieve all of them in one go. - CollectErrorsHandler() - Constructor for class org.forgerock.json.schema.validator.CollectErrorsHandler
- Constants - Class in org.forgerock.json.schema.validator
-
Constants is the collection of all constant values used by the object validator implementation.
D
- DEFAULT - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
default
field name. - DEFINITIONS - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
definitions
field name. - DEPENDENCIES - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
dependencies
field name. - DESCRIPTION - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
type
field name. - DISALLOW - Static variable in class org.forgerock.json.schema.validator.Constants
-
Deprecated.removed in JSON schema draft 04
- DIVISIBLEBY - Static variable in class org.forgerock.json.schema.validator.Constants
-
Deprecated.renamed to multipleOf in JSON schema draft 04
- DivisibleByHelper - Class in org.forgerock.json.schema.validator.helpers
-
This class checks a
Number
instance. - DivisibleByHelper() - Constructor for class org.forgerock.json.schema.validator.helpers.DivisibleByHelper
E
- ENUM - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
enum
field name. - EnumHelper - Class in org.forgerock.json.schema.validator.helpers
-
This class implements "enum" validation on all types of objects as defined in the paragraph 5.19 of the JSON Schema specification.
- EnumHelper(List<Object>) - Constructor for class org.forgerock.json.schema.validator.helpers.EnumHelper
-
Construct a new enum helper.
- error(ValidationException) - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
-
Receive notification of an error.
- error(ValidationException) - Method in class org.forgerock.json.schema.validator.ErrorHandler
-
Receive notification of an error.
- error(ValidationException) - Method in class org.forgerock.json.schema.validator.FailFastErrorHandler
-
Receive notification of an error.
- ERROR_MSG_ - Static variable in class org.forgerock.json.schema.validator.Constants
-
{}
- ERROR_MSG_ADDITIONAL_PROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
-
Value has additional properties.
- ERROR_MSG_ENUM_VIOLATION - Static variable in class org.forgerock.json.schema.validator.Constants
-
Value at {} does not have a value in the enumeration.
- ERROR_MSG_NULL_TYPE - Static variable in class org.forgerock.json.schema.validator.Constants
-
Value at {} MUST be null.
- ERROR_MSG_REQUIRED_PROPERTY - Static variable in class org.forgerock.json.schema.validator.Constants
-
Required property violation at {}.
- ERROR_MSG_TYPE_MISMATCH - Static variable in class org.forgerock.json.schema.validator.Constants
-
Type mismatch.
- ErrorHandler - Class in org.forgerock.json.schema.validator
-
ErrorHandler is the abstract base class for Validators.
- ErrorHandler() - Constructor for class org.forgerock.json.schema.validator.ErrorHandler
- EXCLUSIVEMAXIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
exclusiveMaximum
field name. - EXCLUSIVEMINIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
exclusiveMinimum
field name. - EXTENDS - Static variable in class org.forgerock.json.schema.validator.Constants
-
Deprecated.removed in JSON schema draft 04
F
- FailFastErrorHandler - Class in org.forgerock.json.schema.validator
-
FailFastErrorHandler implements the
ErrorHandler
in a way it re-throws the exception at first time. - FailFastErrorHandler() - Constructor for class org.forgerock.json.schema.validator.FailFastErrorHandler
- FORMAT - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
format
field name. - FORMAT_COLOR - Static variable in class org.forgerock.json.schema.validator.Constants
-
color This is a CSS color (like "#FF0000" or "red"), based on CSS 2.1 [W3C.CR-CSS21-20070719].
- FORMAT_DATE - Static variable in class org.forgerock.json.schema.validator.Constants
-
date This SHOULD be a date in the format of YYYY-MM-DD.
- FORMAT_DATE_TIME - Static variable in class org.forgerock.json.schema.validator.Constants
-
date-time This SHOULD be a date in ISO 8601 format of YYYY-MM- DDThh:mm:ssZ in UTC time.
- FORMAT_EMAIL - Static variable in class org.forgerock.json.schema.validator.Constants
-
email This SHOULD be an email address.
- FORMAT_HOST_NAME - Static variable in class org.forgerock.json.schema.validator.Constants
-
host-name This SHOULD be a host-name.
- FORMAT_IP_ADDRESS - Static variable in class org.forgerock.json.schema.validator.Constants
-
ip-address This SHOULD be an ip version 4 address.
- FORMAT_IPV6 - Static variable in class org.forgerock.json.schema.validator.Constants
-
ipv6 This SHOULD be an ip version 6 address.
- FORMAT_PHONE - Static variable in class org.forgerock.json.schema.validator.Constants
-
phone This SHOULD be a phone number (format MAY follow E.123).
- FORMAT_REGEX - Static variable in class org.forgerock.json.schema.validator.Constants
-
regex A regular expression, following the regular expression specification from ECMA 262/Perl 5.
- FORMAT_STYLE - Static variable in class org.forgerock.json.schema.validator.Constants
-
style This is a CSS style definition (like "color: red; background- color:#FFF"), based on CSS 2.1 [W3C.CR-CSS21-20070719].
- FORMAT_TIME - Static variable in class org.forgerock.json.schema.validator.Constants
-
time This SHOULD be a time in the format of hh:mm:ss.
- FORMAT_URI - Static variable in class org.forgerock.json.schema.validator.Constants
-
uri This value SHOULD be a URI.
- FORMAT_UTC_MILLISEC - Static variable in class org.forgerock.json.schema.validator.Constants
-
utc-millisec This SHOULD be the difference, measured in milliseconds, between the specified time and midnight, 00:00 of January 1, 1970 UTC.
- FormatHelper - Class in org.forgerock.json.schema.validator.helpers
-
This class implements "format" validation on primitive types of objects as defined in the paragraph 5.23 of the JSON Schema specification.
- FormatHelper(String) - Constructor for class org.forgerock.json.schema.validator.helpers.FormatHelper
-
Construct a new format helper.
G
- getException() - Method in exception org.forgerock.json.schema.validator.exceptions.SchemaException
-
Return the embedded exception, if any.
- getExceptions() - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
-
Returns the collected
ValidationException
s. - getJsonPointer() - Method in class org.forgerock.json.schema.validator.validators.Validator
-
Returns the JSON pointer locating where the validator was defined in the schema.
- getMessage() - Method in exception org.forgerock.json.schema.validator.exceptions.SchemaException
-
Return a detail message for this exception.
- getPath(JsonPointer, String) - Method in class org.forgerock.json.schema.validator.validators.Validator
-
Gets the valid JSONPath of the node or the given property.
- getReference() - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
-
Returns the reference to the pointed schema.
- getTypeValidator(String, Map<String, Object>, List<String>) - Static method in class org.forgerock.json.schema.validator.ObjectValidatorFactory
-
Instantiates a validator of the passed in type with the given schema.
- getTypeValidator(Map<String, Object>) - Static method in class org.forgerock.json.schema.validator.ObjectValidatorFactory
-
Returns a validator validating the schema.
- getTypeValidator(Map<String, Object>, List<String>) - Static method in class org.forgerock.json.schema.validator.ObjectValidatorFactory
-
Returns a validator validating the schema.
H
- hasError() - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
-
Get the final result of the validation.
- hasError() - Method in class org.forgerock.json.schema.validator.ErrorHandler
-
Get the final result of the validation.
I
- ID - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
id
field name. - IntegerTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
IntegerTypeValidator applies all the constraints of a
integer
type. - IntegerTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.IntegerTypeValidator
-
Create an integer type validator.
- isRequired() - Method in class org.forgerock.json.schema.validator.validators.Validator
-
Returns whether the schema represented by this validator is required.
- ITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
items
field name.
J
- JSON_HYPER_SCHEMA - Static variable in class org.forgerock.json.schema.validator.Constants
-
The hyper schema latest draft URI.
- JSON_HYPER_SCHEMA_DRAFT03 - Static variable in class org.forgerock.json.schema.validator.Constants
-
The hyper schema draft 03 URI.
- JSON_HYPER_SCHEMA_DRAFT04 - Static variable in class org.forgerock.json.schema.validator.Constants
-
The hyper schema draft 04 URI.
- JSON_LINKS - Static variable in class org.forgerock.json.schema.validator.Constants
-
The schema links latest draft URI.
- JSON_LINKS_DRAFT03 - Static variable in class org.forgerock.json.schema.validator.Constants
-
The schema links draft 03 URI.
- JSON_LINKS_DRAFT04 - Static variable in class org.forgerock.json.schema.validator.Constants
-
The schema links draft 04 URI.
- JSON_SCHEMA - Static variable in class org.forgerock.json.schema.validator.Constants
-
The schema latest draft URI.
- JSON_SCHEMA_DRAFT03 - Static variable in class org.forgerock.json.schema.validator.Constants
-
The schema draft 03 URI.
- JSON_SCHEMA_DRAFT04 - Static variable in class org.forgerock.json.schema.validator.Constants
-
The schema draft 04 URI.
M
- MAXIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
maximum
field name. - MaximumHelper - Class in org.forgerock.json.schema.validator.helpers
-
Helper compares two
Number
s to check the maximum constraint. - MaximumHelper(Number, boolean) - Constructor for class org.forgerock.json.schema.validator.helpers.MaximumHelper
-
Create a maximum helper.
- MAXITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
maxItems
field name. - MAXLENGTH - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
maxLength
field name. - MINIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
minimum
field name. - MinimumHelper - Class in org.forgerock.json.schema.validator.helpers
-
Helper compares two
Number
s to check the minimum constraint. - MinimumHelper(Number, boolean) - Constructor for class org.forgerock.json.schema.validator.helpers.MinimumHelper
-
Create a minimum helper.
- MINITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
minItems
field name. - MINLENGTH - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
minLength
field name. - MULTIPLEOF - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
multipleOf
field name.
N
- newList(List<String>, String...) - Method in class org.forgerock.json.schema.validator.validators.Validator
-
Returns a new
List
with the additional elements appended at the end. - NullTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
null Value MUST be null.
- NullTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.NullTypeValidator
-
Construct a null type validator.
- NumberTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
NumberTypeValidator applies all the constraints of a
number
type. - NumberTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.NumberTypeValidator
-
Construct a number type validator.
O
- ObjectTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
ObjectTypeValidator applies all the constraints of a
object
type. - ObjectTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.ObjectTypeValidator
-
Default ctor.
- ObjectValidator - Class in org.forgerock.json.schema.validator
-
The ObjectValidator is a sample implementation of how to use the validator.
- ObjectValidatorFactory - Class in org.forgerock.json.schema.validator
-
ObjectValidatorFactory initialises the validator instances for given schemas.
- ONEOF - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
oneOf
field name. - org.forgerock.json.schema.validator - package org.forgerock.json.schema.validator
-
These classes are the commonly used classes from other applications.
- org.forgerock.json.schema.validator.exceptions - package org.forgerock.json.schema.validator.exceptions
-
Schema validator exceptions.
- org.forgerock.json.schema.validator.helpers - package org.forgerock.json.schema.validator.helpers
-
These classes are capable of helping the validators to check certain constraints.
- org.forgerock.json.schema.validator.validators - package org.forgerock.json.schema.validator.validators
-
These classes are capable of validating the objects against the initially loaded schema.
P
- PATTERN - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
pattern
field name. - PATTERNPROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
patternProperties
field name. - PROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
properties
field name.
R
- REF - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
$ref
field name. - ReferenceTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
ReferenceTypeValidator holds a reference to another validator.
- ReferenceTypeValidator(Map<String, Object>, String, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
-
Default ctor.
- required - Variable in class org.forgerock.json.schema.validator.validators.Validator
-
Whether the schema represented by this validator is required.
- REQUIRED - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
required
field name. - resolveSchemaReferences() - Method in class org.forgerock.json.schema.validator.validators.Validator
-
Resolves schema references for this validator.
S
- SCHEMA - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
$schema
field name. - SchemaException - Exception in org.forgerock.json.schema.validator.exceptions
-
Encapsulate a general JSON validator error.
- SchemaException(JsonValue, Exception) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
-
Create a new SchemaException wrapping an existing exception.
- SchemaException(JsonValue, String) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
-
Create the exception with the given value and message.
- SchemaException(JsonValue, String, Exception) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
-
Create a new SchemaException from an existing exception.
- SchemaException(JsonValue, String, Throwable) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
-
Create the exception with the given value, message and cause.
- setReferencedValidator(Validator) - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
-
Sets the validator being referenced by this object.
- SimpleValidator<T> - Interface in org.forgerock.json.schema.validator.validators
-
SimpleValidator is a base interface for all validator implementation.
- StringTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
StringTypeValidator applies all the constraints of a
string
type. - StringTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.StringTypeValidator
-
Create a string type validator.
T
- TITLE - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
type
field name. - toString() - Method in exception org.forgerock.json.schema.validator.exceptions.SchemaException
-
Override toString to pick up any embedded exception.
- toString() - Method in class org.forgerock.json.schema.validator.validators.Validator
- TYPE - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
type
field name. - TYPE_ANY - Static variable in class org.forgerock.json.schema.validator.Constants
-
Deprecated.removed in JSON schema draft 04
- TYPE_ARRAY - Static variable in class org.forgerock.json.schema.validator.Constants
-
The array type.
- TYPE_BOOLEAN - Static variable in class org.forgerock.json.schema.validator.Constants
-
The boolean type.
- TYPE_INTEGER - Static variable in class org.forgerock.json.schema.validator.Constants
-
The integer type.
- TYPE_NULL - Static variable in class org.forgerock.json.schema.validator.Constants
-
The null type.
- TYPE_NUMBER - Static variable in class org.forgerock.json.schema.validator.Constants
-
The number type.
- TYPE_OBJECT - Static variable in class org.forgerock.json.schema.validator.Constants
-
The object type.
- TYPE_STRING - Static variable in class org.forgerock.json.schema.validator.Constants
-
The string type.
U
- UnionTypeValidator - Class in org.forgerock.json.schema.validator.validators
-
Union Types An array of two or more simple validators definitions.
- UnionTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.UnionTypeValidator
-
Create a union type validator.
- UNIQUEITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
-
The
uniqueItems
field name.
V
- validate(Number, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.DivisibleByHelper
- validate(Number, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.MaximumHelper
- validate(Number, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.MinimumHelper
- validate(Object, Map<String, Object>) - Static method in class org.forgerock.json.schema.validator.ObjectValidator
-
Validate the given
node
against theschema
- validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.EnumHelper
- validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.FormatHelper
- validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.AnyTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.ArrayTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.BooleanTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.IntegerTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.NullTypeValidator
- validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.NumberTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.ObjectTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.StringTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.UnionTypeValidator
-
Validates the
node
value against the embedded schema object. - validate(T, JsonPointer, ErrorHandler) - Method in interface org.forgerock.json.schema.validator.validators.SimpleValidator
-
Validates the
node
value against the embedded schema object. - ValidationException - Exception in org.forgerock.json.schema.validator.exceptions
-
Encapsulate a JSON validator error.
- ValidationException(Exception, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
-
Create an exception with the given cause and path.
- ValidationException(String) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
-
Create an exception with the given message.
- ValidationException(String, Exception, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
-
Create an exception with the given message, cause and path.
- ValidationException(String, Throwable) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
-
Create an exception with the given message and cause.
- ValidationException(String, Throwable, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
-
Create an exception with the given message, cause and path.
- ValidationException(String, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
-
Create an exception with the given message and path.
- ValidationException(String, JsonPointer, Object) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
-
Create an exception with the given message, value and path.
- Validator - Class in org.forgerock.json.schema.validator.validators
-
Validator is the abstract base class of all typed validator.
- Validator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.Validator
-
Default ctor.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form