Package | Description |
---|---|
org.forgerock.audit.events |
Package contains audit events.
|
org.forgerock.audit.util |
This package contains utility classes used in the audit service.
|
org.forgerock.json |
Provides an API for the traversal and manipulation of JSON object model structures in Java.
|
org.forgerock.json.resource |
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
|
org.forgerock.json.schema.validator.exceptions |
Schema validator exceptions.
|
org.forgerock.json.schema.validator.helpers |
These classes are capable of helping the validators to check certain constraints.
|
org.forgerock.json.schema.validator.validators |
These classes are capable of validating the objects against the initially loaded schema.
|
org.forgerock.openig.openam |
Integration classes specifically for ForgeRock Access Management.
|
org.forgerock.util.query |
Provides a mechanism for implementing query filters.
|
Modifier and Type | Method and Description |
---|---|
static String |
AuditEventHelper.getPropertyType(JsonValue auditEvent,
JsonPointer property)
Gets a AuditEvent property type.
|
static boolean |
AuditEventHelper.isPropertyRequired(JsonValue auditEvent,
JsonPointer property)
Gets whether a AuditEvent property is required.
|
Modifier and Type | Method and Description |
---|---|
static JsonPointer |
ElasticsearchUtil.normalizeJsonPointer(JsonPointer ptr)
Replaces periods in
JsonPointer keys with underscore. |
Modifier and Type | Method and Description |
---|---|
static String |
JsonValueUtils.extractValueAsString(JsonValue json,
JsonPointer pointer)
Extracts String representation of field identified by
pointer from json object. |
static JsonPointer |
ElasticsearchUtil.normalizeJsonPointer(JsonPointer ptr)
Replaces periods in
JsonPointer keys with underscore. |
Modifier and Type | Field and Description |
---|---|
static JsonPointer |
JsonPatch.FROM_PTR
Path to the "from" attribute of a patch entry.
|
static JsonPointer |
JsonPatch.OP_PTR
Path to the "op" attribute of a patch entry.
|
static JsonPointer |
JsonPatch.PATH_PTR
Path to the "path" attribute of a patch entry.
|
static JsonPointer |
JsonPatch.VALUE_PTR
Path to the "value" attribute of a patch entry.
|
Modifier and Type | Method and Description |
---|---|
JsonPointer |
JsonPointer.child(int child)
Returns a new JSON pointer, which identifies a specified child element of the
array identified by this pointer.
|
JsonPointer |
JsonPointer.child(String child)
Returns a new JSON pointer, which identifies a specified child member of the
object identified by this pointer.
|
JsonPointer |
JsonPointer.concat(JsonPointer suffix)
Creates a new JSON pointer which is a descendant of this JSON pointer.
|
JsonPointer |
JsonValue.getPointer()
Returns the pointer of the JSON value in its JSON structure.
|
JsonPointer |
JsonPointer.parent()
Returns a pointer to the parent of the JSON value identified by this JSON pointer,
or
null if the pointer has no parent JSON value (i.e. |
static JsonPointer |
JsonPointer.ptr(Iterable<String> iterable)
Constructs a JSON pointer from an iterable collection of reference tokens.
|
static JsonPointer |
JsonPointer.ptr(String... tokens)
Constructs a JSON pointer from an array of reference tokens.
|
static JsonPointer |
JsonPointer.ptr(String pointer)
Constructs a JSON pointer, identifying the specified pointer value.
|
JsonPointer |
JsonPointer.relativePointer()
Returns a pointer containing all but the first reference token contained
in this pointer, or
/ if this pointer contains less than 2
reference tokens. |
JsonPointer |
JsonPointer.relativePointer(int sz)
Returns a pointer containing the last
sz reference tokens
contained in this pointer. |
Modifier and Type | Method and Description |
---|---|
static Function<JsonValue,JsonPointer,JsonValueException> |
JsonValueFunctions.pointer()
Returns the JSON string value as a JSON pointer.
|
Modifier and Type | Method and Description |
---|---|
JsonValue |
JsonValue.add(JsonPointer pointer,
Object object)
Adds the value identified by the specified pointer, relative to this
value as root.
|
JsonValue |
JsonValue.addPermissive(JsonPointer pointer,
Object object)
Adds the value identified by the specified pointer, relative to this
value as root.
|
JsonPointer |
JsonPointer.concat(JsonPointer suffix)
Creates a new JSON pointer which is a descendant of this JSON pointer.
|
JsonValue |
JsonValue.get(JsonPointer pointer)
Returns the specified child value with a pointer, relative to this value
as root.
|
JsonValue |
JsonValue.put(JsonPointer pointer,
Object object)
Sets the value identified by the specified pointer, relative to this
value as root.
|
JsonValue |
JsonValue.putPermissive(JsonPointer pointer,
Object object)
Sets the value identified by the specified pointer, relative to this
value as root.
|
void |
JsonValue.remove(JsonPointer pointer)
Removes the specified child value with a pointer, relative to this value
as root.
|
Constructor and Description |
---|
JsonValue(Object object,
JsonPointer pointer)
Constructs a JSON value object with a given object and pointer.
|
Modifier and Type | Method and Description |
---|---|
JsonPointer |
SortKey.getField()
Returns the sort key field.
|
JsonPointer |
PatchOperation.getField()
Returns the field targeted by the patch operation.
|
JsonPointer |
PatchOperation.getFrom()
Returns the source field for move and copy operations.
|
Modifier and Type | Method and Description |
---|---|
List<JsonPointer> |
UpdateRequest.getFields() |
List<JsonPointer> |
ResourceResponse.getFields()
Returns the list of fields which should be included in this JSON resource
after field filtering has occurred.
|
List<JsonPointer> |
Request.getFields()
Returns the list of fields which should be included with each JSON resource returned by this request.
|
List<JsonPointer> |
ReadRequest.getFields() |
List<JsonPointer> |
QueryRequest.getFields() |
List<JsonPointer> |
PatchRequest.getFields() |
List<JsonPointer> |
DeleteRequest.getFields() |
List<JsonPointer> |
CreateRequest.getFields() |
List<JsonPointer> |
ActionRequest.getFields() |
QueryFilter<JsonPointer> |
QueryRequest.getQueryFilter()
Returns the query filter which will be used for selecting which JSON resources will be returned.
|
static QueryFilter<JsonPointer> |
QueryFilters.parse(String query)
Parses the provided query string into a
QueryFilter . |
Modifier and Type | Method and Description |
---|---|
static PatchOperation |
PatchOperation.add(JsonPointer field,
Object value)
Creates a new "add" patch operation which will add the provided value(s)
to the specified field.
|
UpdateRequest |
UpdateRequest.addField(JsonPointer... fields) |
void |
ResourceResponse.addField(JsonPointer... fields)
Adds a field to the list of fields which should be included in this JSON
resource after field filtering has occurred.
|
Request |
Request.addField(JsonPointer... fields)
Adds one or more fields which should be included with each JSON resource returned by this request.
|
ReadRequest |
ReadRequest.addField(JsonPointer... fields) |
QueryRequest |
QueryRequest.addField(JsonPointer... fields) |
PatchRequest |
PatchRequest.addField(JsonPointer... fields) |
DeleteRequest |
DeleteRequest.addField(JsonPointer... fields) |
CreateRequest |
CreateRequest.addField(JsonPointer... fields) |
ActionRequest |
ActionRequest.addField(JsonPointer... fields) |
static SortKey |
SortKey.ascendingOrder(JsonPointer field)
Creates a new ascending-order sort key for the provided JSON field.
|
static PatchOperation |
PatchOperation.copy(JsonPointer from,
JsonPointer field)
Creates a new "copy" patch operation which will copy the value found at `from` to `path`.
|
static SortKey |
SortKey.descendingOrder(JsonPointer field)
Creates a new descending-order sort key for the provided JSON field.
|
static PatchOperation |
PatchOperation.increment(JsonPointer field,
Number amount)
Creates a new "increment" patch operation which will increment the
value(s) of the specified field by the amount provided.
|
static PatchOperation |
PatchOperation.move(JsonPointer from,
JsonPointer field)
Creates a new "move" patch operation which will move the value found at `from` to `path`.
|
static PatchOperation |
PatchOperation.operation(String operation,
JsonPointer field,
Object value)
Creates a new patch operation having the specified operation type, field,
and value(s).
|
static PatchOperation |
PatchOperation.remove(JsonPointer field)
Creates a new "remove" patch operation which will remove the specified
field.
|
static PatchOperation |
PatchOperation.remove(JsonPointer field,
Object value)
Creates a new "remove" patch operation which will remove the provided
value(s) from the specified field.
|
static PatchOperation |
PatchOperation.replace(JsonPointer field,
Object value)
Creates a new "replace" patch operation which will replace the value(s)
of the specified field with the provided value(s).
|
static PatchOperation |
PatchOperation.transform(JsonPointer field,
Object transform)
Creates a new "transform" patch operation which sets the value at field based on a
transformation.
|
Modifier and Type | Method and Description |
---|---|
static JsonValue |
Resources.filterResource(JsonValue resource,
Collection<JsonPointer> fields)
Returns a JSON object containing only the specified fields from the
provided JSON value.
|
static ResourceResponse |
Resources.filterResource(ResourceResponse resource,
Collection<JsonPointer> fields)
Returns a JSON object containing only the specified fields from the
provided resource.
|
QueryRequest |
QueryRequest.setQueryFilter(QueryFilter<JsonPointer> filter)
Sets the query filter which will be used for selecting which JSON resources will be returned.
|
Constructor and Description |
---|
ValidationException(Exception e,
JsonPointer path)
Create an exception with the given cause and path.
|
ValidationException(String message,
Exception e,
JsonPointer path)
Create an exception with the given message, cause and path.
|
ValidationException(String message,
JsonPointer path)
Create an exception with the given message and path.
|
ValidationException(String message,
JsonPointer path,
Object value)
Create an exception with the given message, value and path.
|
ValidationException(String string,
Throwable throwable,
JsonPointer path)
Create an exception with the given message, cause and path.
|
Modifier and Type | Method and Description |
---|---|
void |
MinimumHelper.validate(Number node,
JsonPointer at,
ErrorHandler handler) |
void |
MaximumHelper.validate(Number node,
JsonPointer at,
ErrorHandler handler) |
void |
DivisibleByHelper.validate(Number node,
JsonPointer at,
ErrorHandler handler) |
void |
FormatHelper.validate(Object node,
JsonPointer at,
ErrorHandler handler) |
void |
EnumHelper.validate(Object node,
JsonPointer at,
ErrorHandler handler) |
Modifier and Type | Method and Description |
---|---|
JsonPointer |
Validator.getJsonPointer()
Returns the JSON pointer locating where the validator was defined in the schema.
|
protected JsonPointer |
Validator.getPath(JsonPointer at,
String property)
Gets the valid JSONPath of the node or the given property.
|
Modifier and Type | Method and Description |
---|---|
protected JsonPointer |
Validator.getPath(JsonPointer at,
String property)
Gets the valid JSONPath of the node or the given property.
|
void |
UnionTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
StringTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
ReferenceTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
ObjectTypeValidator.validate(Object value,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
NumberTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
NullTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler) |
void |
IntegerTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
BooleanTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
ArrayTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
AnyTypeValidator.validate(Object node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
void |
SimpleValidator.validate(T node,
JsonPointer at,
ErrorHandler handler)
Validates the
node value against the embedded schema object. |
Modifier and Type | Method and Description |
---|---|
static Optional<String> |
JwtUtil.getValue(JwtClaimsSet claimsSet,
JsonPointer ptr)
Return a value from it's well-known location on the OAuth2 authorization JWT.
|
boolean |
JwtValidator.validateClaim(JwtClaimsSet claimsSet,
JsonPointer claimPointer,
Predicate<JsonValue> predicate)
Validate that a claim in the claim set is present and has a value that passes the supplied predicate.
|
boolean |
JwtValidator.validateClaim(JwtClaimsSet claimsSet,
JsonPointer claimPointer,
Predicate<JsonValue> predicate,
String failureMessage)
Validate that a claim in the claim set is present and has a value that passes the supplied predicate.
|
boolean |
JwtValidator.validateClaimPresent(JwtClaimsSet claimsSet,
JsonPointer claimPointer)
Validate that a claim in the claim set is present and has a value.
|
Modifier and Type | Method and Description |
---|---|
static QueryFilterVisitor<Boolean,JsonValue,JsonPointer> |
JsonValueFilterVisitor.jsonValueFilterVisitor()
Returns a
QueryFilterVisitor that can assess if a JsonValue resource matches a set
of criteria defined by a QueryFilter . |
Modifier and Type | Method and Description |
---|---|
Boolean |
JsonValueFilterVisitor.visitContainsFilter(JsonValue p,
JsonPointer field,
Object valueAssertion) |
Boolean |
JsonValueFilterVisitor.visitEqualsFilter(JsonValue p,
JsonPointer field,
Object valueAssertion) |
Boolean |
JsonValueFilterVisitor.visitExtendedMatchFilter(JsonValue p,
JsonPointer field,
String matchingRuleId,
Object valueAssertion) |
Boolean |
JsonValueFilterVisitor.visitGreaterThanFilter(JsonValue p,
JsonPointer field,
Object valueAssertion) |
Boolean |
JsonValueFilterVisitor.visitGreaterThanOrEqualToFilter(JsonValue p,
JsonPointer field,
Object valueAssertion) |
Boolean |
JsonValueFilterVisitor.visitLessThanFilter(JsonValue p,
JsonPointer field,
Object valueAssertion) |
Boolean |
JsonValueFilterVisitor.visitLessThanOrEqualToFilter(JsonValue p,
JsonPointer field,
Object valueAssertion) |
Boolean |
JsonValueFilterVisitor.visitPresentFilter(JsonValue p,
JsonPointer field) |
Boolean |
JsonValueFilterVisitor.visitStartsWithFilter(JsonValue p,
JsonPointer field,
Object valueAssertion) |
Modifier and Type | Method and Description |
---|---|
Boolean |
JsonValueFilterVisitor.visitAndFilter(JsonValue p,
List<QueryFilter<JsonPointer>> subFilters) |
Boolean |
JsonValueFilterVisitor.visitNotFilter(JsonValue p,
QueryFilter<JsonPointer> subFilter) |
Boolean |
JsonValueFilterVisitor.visitOrFilter(JsonValue p,
List<QueryFilter<JsonPointer>> subFilters) |
Copyright 2011-2017 ForgeRock AS.