Uses of Class
org.forgerock.json.JsonPointer

Packages that use JsonPointer

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.openig.tools	Common tools used in policy service.
org.forgerock.util.query	Provides a mechanism for implementing query filters.

Uses of JsonPointer in org.forgerock.audit.events

Methods in org.forgerock.audit.events that return types with arguments of type JsonPointer

Modifier and Type	Method	Description
List<JsonPointer>	EventTopicsMetaData.getIncludeIfFilters(String topic)	Returns JSON Pointers to fields which should be automatically whitelisted for a given topic's schema.

Methods in org.forgerock.audit.events with parameters of type JsonPointer

Modifier and Type	Method	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.

Uses of JsonPointer in org.forgerock.audit.util

Methods in org.forgerock.audit.util that return JsonPointer

Modifier and Type	Method	Description
static JsonPointer	ElasticsearchUtil.normalizeJsonPointer(JsonPointer ptr)	Replaces periods in JsonPointer keys with underscore.

Methods in org.forgerock.audit.util with parameters of type JsonPointer

Modifier and Type	Method	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.

Uses of JsonPointer in org.forgerock.json

Fields in org.forgerock.json declared as JsonPointer

Modifier and Type	Field	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.

Methods in org.forgerock.json that return JsonPointer

Modifier and Type	Method	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.head(int endIndex)	Returns a pointer which is a subsequence of the path elements contained in this pointer beginning with the first element (0) and ending with the element at position endIndex-1.
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 pointer)	Constructs a JSON pointer, identifying the specified pointer value.
static JsonPointer	JsonPointer.ptr(String... tokens)	Constructs a JSON pointer from an array of reference tokens.
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.
static JsonPointer	JsonPointer.rootPtr()	Returns a JSON pointer identifying the root value of a JSON structure.

Methods in org.forgerock.json that return types with arguments of type JsonPointer

Modifier and Type	Method	Description
static Function<JsonValue,JsonPointer,JsonValueException>	JsonValueFunctions.pointer()	Returns the JSON string value as a JSON pointer.

Methods in org.forgerock.json with parameters of type JsonPointer

Modifier and Type	Method	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.
boolean	JsonPointer.isPrefixOf(JsonPointer candidate)	Checks whether candidate is an extension of this JSON Pointer.
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.

Constructors in org.forgerock.json with parameters of type JsonPointer

Constructor	Description
JsonValue(Object object, JsonPointer pointer)	Constructs a JSON value object with a given object and pointer.

Uses of JsonPointer in org.forgerock.json.resource

Fields in org.forgerock.json.resource declared as JsonPointer

Modifier and Type	Field	Description
static JsonPointer	Resources.FIELD_VALUE_ALL_PTR	JsonPointer used in fields to denote "all fields", i.e., no filtering.

Methods in org.forgerock.json.resource that return JsonPointer

Modifier and Type	Method	Description
JsonPointer	PatchOperation.getField()	Returns the field targeted by the patch operation.
JsonPointer	SortKey.getField()	Returns the sort key field.
JsonPointer	PatchOperation.getFrom()	Returns the source field for move and copy operations.

Methods in org.forgerock.json.resource that return types with arguments of type JsonPointer

Modifier and Type	Method	Description
List<JsonPointer>	ActionRequest.getFields()
List<JsonPointer>	CreateRequest.getFields()
List<JsonPointer>	DeleteRequest.getFields()
List<JsonPointer>	PatchRequest.getFields()
List<JsonPointer>	QueryRequest.getFields()
List<JsonPointer>	ReadRequest.getFields()
List<JsonPointer>	Request.getFields()	Returns the list of fields which should be included with each JSON resource returned by this request.
List<JsonPointer>	ResourceResponse.getFields()	Returns the list of fields which should be included in this JSON resource after field filtering has occurred.
List<JsonPointer>	UpdateRequest.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.
static Function<JsonValue,QueryFilter<JsonPointer>,JsonValueException>	JsonValueFunctions.queryFilter()	Parses and returns the JSON string value as a QueryFilter.

Methods in org.forgerock.json.resource with parameters of type JsonPointer

Modifier and Type	Method	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.
ActionRequest	ActionRequest.addField(JsonPointer... fields)
CreateRequest	CreateRequest.addField(JsonPointer... fields)
DeleteRequest	DeleteRequest.addField(JsonPointer... fields)
PatchRequest	PatchRequest.addField(JsonPointer... fields)
QueryRequest	QueryRequest.addField(JsonPointer... fields)
ReadRequest	ReadRequest.addField(JsonPointer... fields)
Request	Request.addField(JsonPointer... fields)	Adds one or more fields which should be included with each JSON resource returned by this request.
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.
UpdateRequest	UpdateRequest.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.

Method parameters in org.forgerock.json.resource with type arguments of type JsonPointer

Modifier and Type	Method	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.

Uses of JsonPointer in org.forgerock.openig.tools

Fields in org.forgerock.openig.tools declared as JsonPointer

Modifier and Type	Field	Description
static JsonPointer	JwtUtil.PTR_AUD	Claim-set audience JSON pointer.
static JsonPointer	JwtUtil.PTR_EXP	Claim-set expiry JSON pointer.
static JsonPointer	JwtUtil.PTR_ISS	Claim-set issuer JSON pointer.
static JsonPointer	JwtUtil.PTR_NONCE	Claim-set nonce JSON pointer.
static JsonPointer	JwtUtil.PTR_TOKEN_NAME	Claim-set tokenName JSON pointer.

Methods in org.forgerock.openig.tools with parameters of type JsonPointer

Modifier and Type	Method	Description
static Optional<String>	JwtUtil.getValue(JwtClaimsSet claimsSet, JsonPointer ptr)	Return a value from it's well-known location on the OAuth2 authorization JWT.

Uses of JsonPointer in org.forgerock.util.query

Methods in org.forgerock.util.query that return types with arguments of type JsonPointer

Modifier and Type	Method	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.

Methods in org.forgerock.util.query with parameters of type JsonPointer

Modifier and Type	Method	Description
Boolean	JsonValueFilterVisitor.visitComplexFilter(JsonValue p, JsonPointer field, QueryFilter<JsonPointer> subFilter)
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)

Method parameters in org.forgerock.util.query with type arguments of type JsonPointer

Modifier and Type	Method	Description
Boolean	JsonValueFilterVisitor.visitAndFilter(JsonValue p, List<QueryFilter<JsonPointer>> subFilters)
Boolean	JsonValueFilterVisitor.visitComplexFilter(JsonValue p, JsonPointer field, QueryFilter<JsonPointer> subFilter)
Boolean	JsonValueFilterVisitor.visitNotFilter(JsonValue p, QueryFilter<JsonPointer> subFilter)
Boolean	JsonValueFilterVisitor.visitOrFilter(JsonValue p, List<QueryFilter<JsonPointer>> subFilters)