Package | Description |
---|---|
org.forgerock.audit |
Package contains the AuditService.
|
org.forgerock.audit.events |
Package contains audit events.
|
org.forgerock.audit.events.handlers |
This package contains the default
AuditEventHandlers . |
org.forgerock.audit.filter |
Contains the classes for filtering audit events.
|
org.forgerock.audit.handlers.csv |
This package contains the default AuditEventHandler implementations.
|
org.forgerock.audit.handlers.elasticsearch |
This package contains the Elasticsearch
AuditEventHandler implementation. |
org.forgerock.audit.handlers.jdbc |
This package contains a JDBC AuditEventHandler implementation.
|
org.forgerock.audit.handlers.syslog |
This package contains a Syslog AuditEventHandler implementation.
|
org.forgerock.audit.json |
This package contains utilities to build and configure audit service and handlers from JSON configuration.
|
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.resource.http |
JSON resource Commons HTTP Framework integration.
|
org.forgerock.opendj.rest2ldap |
APIs for implementing REST to LDAP gateways.
|
Constructor and Description |
---|
AuditingContext(JsonValue savedContext,
ClassLoader classLoader)
Restore a serialized audit context.
|
Modifier and Type | Field and Description |
---|---|
protected JsonValue |
AuditEventBuilder.jsonValue
Represents the event as a JSON value.
|
Modifier and Type | Method and Description |
---|---|
static JsonValue |
AuditEventHelper.getAuditEventProperties(JsonValue auditEvent)
Gets the Audit Event schema properties.
|
static JsonValue |
AuditEventHelper.getAuditEventSchema(JsonValue auditEvent)
Gets the Audit Event schema.
|
JsonValue |
EventTopicsMetaData.getSchema(String topic)
Returns the JSON schema for the requested topic if this object has meta-data for that topic.
|
JsonValue |
AuditEvent.getValue()
Returns the Json value of this event.
|
Modifier and Type | Method and Description |
---|---|
static JsonValue |
AuditEventHelper.getAuditEventProperties(JsonValue auditEvent)
Gets the Audit Event schema properties.
|
static JsonValue |
AuditEventHelper.getAuditEventSchema(JsonValue auditEvent)
Gets the Audit Event schema.
|
static List<String> |
AuditEventHelper.getConfiguredAuditEventHandlers(JsonValue auditEvent)
Gets the AuditEventHandlers that the audit event is configure to log to.
|
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.
|
T |
AccessAuditEventBuilder.request(String protocol,
String operation,
JsonValue detail)
Sets the provided request details for the event.
|
T |
AccessAuditEventBuilder.responseWithDetail(AccessAuditEventBuilder.ResponseStatus status,
String statusCode,
long elapsedTime,
TimeUnit elapsedTimeUnits,
JsonValue detail)
Sets the provided response for the event, with an additional detail.
|
EventTopicsMetaDataBuilder |
EventTopicsMetaDataBuilder.withAdditionalTopicSchemas(JsonValue additionalTopicSchemas)
Specifies schemas for additional topics.
|
EventTopicsMetaDataBuilder |
EventTopicsMetaDataBuilder.withCoreTopicSchemaExtensions(JsonValue coreTopicSchemaExtensions)
Specifies additional fields that should be added to the schemas for core event topics.
|
Constructor and Description |
---|
EventTopicsMetaData(Map<String,JsonValue> eventTopicsMetaData)
Create a new EventTopicsMetaData.
|
Modifier and Type | Method and Description |
---|---|
JsonValue |
AuditEventTopicState.getEvent()
Returns the event content.
|
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
NoOpAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event) |
Promise<ResourceResponse,ResourceException> |
AuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event)
Publishes an event to the provided topic.
|
Constructor and Description |
---|
AuditEventTopicState(org.forgerock.services.context.Context context,
String topic,
JsonValue event)
Creates a (topic,event) pair.
|
Modifier and Type | Method and Description |
---|---|
void |
FilterChainBuilder.FilterChain.doFilter(String auditTopic,
JsonValue auditEvent)
Runs the filters in the filter chain.
|
void |
Filter.doFilter(String auditTopic,
JsonValue auditEvent)
Runs a filter on the given audit event.
|
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
CsvAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event)
Create a csv audit log entry.
|
Modifier and Type | Method and Description |
---|---|
void |
ElasticsearchAuditEventHandler.addToBatch(String topic,
JsonValue event,
StringBuilder payload)
Adds an audit event to an Elasticsearch Bulk API payload.
|
Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event) |
protected Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.publishSingleEvent(String topic,
JsonValue event)
Publishes a single event to the provided topic.
|
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
JdbcAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event)
Publishes an event to the provided topic.
|
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
SyslogAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event) |
Modifier and Type | Method and Description |
---|---|
static JsonValue |
AuditJsonConfig.getAuditEventHandlerConfigurationSchema(String className,
ClassLoader classLoader)
Gets the configuration schema for an audit event handler as json schema.
|
static JsonValue |
AuditJsonConfig.getJson(InputStream input)
Returns a JSON value from the provided input stream.
|
Modifier and Type | Method and Description |
---|---|
static <C extends EventHandlerConfiguration> |
AuditJsonConfig.parseAuditEventHandlerConfiguration(Class<C> clazz,
JsonValue jsonConfig)
Returns the audit event handler configuration from the provided JSON string.
|
static AuditServiceConfiguration |
AuditJsonConfig.parseAuditServiceConfiguration(JsonValue json)
Returns the audit service configuration from the provided JSON value.
|
static void |
AuditJsonConfig.registerHandlerToService(JsonValue jsonConfig,
AuditServiceBuilder auditServiceBuilder)
Configures and registers the audit event handler corresponding to the provided JSON configuration
to the provided audit service.
|
static void |
AuditJsonConfig.registerHandlerToService(JsonValue jsonConfig,
AuditServiceBuilder auditServiceBuilder,
ClassLoader classLoader)
Configures and registers the audit event handler corresponding to the provided JSON configuration
to the provided audit service, using a specific class loader.
|
Modifier and Type | Field and Description |
---|---|
static QueryFilterVisitor<Boolean,JsonValue,JsonPointer> |
JsonValueUtils.JSONVALUE_FILTER_VISITOR
A generic JsonValue Query Filter Visitor.
|
Modifier and Type | Method and Description |
---|---|
static JsonValue |
JsonValueUtils.expand(Map<String,Object> object)
Expands a Json Object Map, where the keys of the map are the
JsonPointer s
and the values are the value the JsonPointer resolves to. |
Modifier and Type | Method and Description |
---|---|
static String |
JsonValueUtils.extractValueAsString(JsonValue json,
String fieldName)
Extracts String representation of field identified by
fieldName from json object. |
static Map<String,Object> |
JsonValueUtils.flatten(JsonValue jsonValue)
Flattens a
JsonValue to a Map, where the keys of the Map are JsonPointer s
and the values are the value the JsonPointer s resolve to. |
static Set<String> |
JsonSchemaUtils.generateJsonPointers(JsonValue schema)
Generates the Set of
JsonPointer s in a given JsonSchema. |
Modifier and Type | Class and Description |
---|---|
class |
JsonValueKeyAccessChecker
Subclass of
JsonValue that checks all keys are accessed. |
Modifier and Type | Method and Description |
---|---|
JsonValue |
JsonValueKeyAccessChecker.add(int index,
Object object)
Adds the specified value to the list.
|
JsonValue |
JsonValue.add(int index,
Object object)
Adds the specified value to the list.
|
JsonValue |
JsonValueKeyAccessChecker.add(JsonPointer pointer,
Object object)
Adds the value identified by the specified pointer, relative to this
value as root.
|
JsonValue |
JsonValue.add(JsonPointer pointer,
Object object)
Adds the value identified by the specified pointer, relative to this
value as root.
|
JsonValue |
JsonValueKeyAccessChecker.add(Object object)
Adds the specified value to a set or to the end of the list.
|
JsonValue |
JsonValue.add(Object object)
Adds the specified value to a set or to the end of the list.
|
JsonValue |
JsonValueKeyAccessChecker.add(String key,
Object object)
Adds the specified value.
|
JsonValue |
JsonValue.add(String key,
Object object)
Adds the specified value.
|
JsonValue |
JsonValueKeyAccessChecker.addPermissive(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.
|
JsonValue |
JsonValueKeyAccessChecker.clone()
Returns a shallow copy of this JSON value.
|
JsonValue |
JsonValue.clone()
Returns a shallow copy of this JSON value.
|
JsonValue |
JsonValueKeyAccessChecker.copy()
Returns a deep copy of this JSON value.
|
JsonValue |
JsonValue.copy()
Returns a deep copy of this JSON value.
|
JsonValue |
JsonValueKeyAccessChecker.defaultTo(Object object)
Defaults the JSON value to the specified value if it is currently
null . |
JsonValue |
JsonValue.defaultTo(Object object)
Defaults the JSON value to the specified value if it is currently
null . |
JsonValue |
JsonValueKeyAccessChecker.expect(Class<?> type)
Called to enforce that the JSON value is of a particular type.
|
JsonValue |
JsonValue.expect(Class<?> type)
Called to enforce that the JSON value is of a particular type.
|
JsonValue |
JsonValueKeyAccessChecker.get(int index)
Returns the specified child value.
|
JsonValue |
JsonValue.get(int index)
Returns the specified child value.
|
JsonValue |
JsonValueKeyAccessChecker.get(JsonPointer pointer)
Returns the specified child value with a pointer, relative to this value
as root.
|
JsonValue |
JsonValue.get(JsonPointer pointer)
Returns the specified child value with a pointer, relative to this value
as root.
|
JsonValue |
JsonValueKeyAccessChecker.get(String key)
Returns the specified item value.
|
JsonValue |
JsonValue.get(String key)
Returns the specified item value.
|
JsonValue |
JsonValueException.getJsonValue()
Returns the JSON value for which the exception was thrown.
|
static JsonValue |
JsonValue.json(Object object)
Returns a JSON value whose content is the provided object.
|
JsonValue |
JsonValueKeyAccessChecker.put(int index,
Object object)
Sets the value of the specified child list element.
|
JsonValue |
JsonValue.put(int index,
Object object)
Sets the value of the specified child list element.
|
JsonValue |
JsonValueKeyAccessChecker.put(JsonPointer pointer,
Object object)
Sets the value identified by the specified 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 |
JsonValueKeyAccessChecker.put(String key,
Object object)
Sets the value of the specified member.
|
JsonValue |
JsonValue.put(String key,
Object object)
Sets the value of the specified member.
|
JsonValue |
JsonValueKeyAccessChecker.putPermissive(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.
|
JsonValue |
JsonValueKeyAccessChecker.recordKeyAccesses()
Returns a subclass of JsonValue that records which keys are accessed in this
JsonValue and its children. |
JsonValue |
JsonValue.recordKeyAccesses()
Returns a subclass of JsonValue that records which keys are accessed in this
JsonValue and its children. |
JsonValue |
JsonValueKeyAccessChecker.required()
Throws a
JsonValueException if the JSON value is null . |
JsonValue |
JsonValue.required()
Throws a
JsonValueException if the JSON value is null . |
Modifier and Type | Method and Description |
---|---|
static Function<JsonValue,Charset,JsonValueException> |
JsonValueFunctions.charset()
Returns the JSON string value as a character set used for byte
encoding/decoding.
|
static Function<JsonValue,Duration,JsonValueException> |
JsonValueFunctions.duration()
Returns the JSON string value as a
Duration . |
static <T extends Enum<T>> |
JsonValueFunctions.enumConstant(Class<T> type)
Returns the JSON string value as an enum constant of the specified enum
type.
|
static Function<JsonValue,File,JsonValueException> |
JsonValueFunctions.file()
Returns the JSON string value as a
File object. |
Iterator<JsonValue> |
JsonValueKeyAccessChecker.iterator()
Returns an iterator over the child values that this JSON value contains.
|
Iterator<JsonValue> |
JsonValue.iterator()
Returns an iterator over the child values that this JSON value contains.
|
static <V,E extends Exception> |
JsonValueFunctions.listOf(Function<JsonValue,V,E> transformFunction)
Returns the JSON value as a
List containing objects whose type
(and value) is specified by a transformation function. |
static Function<JsonValue,Pattern,JsonValueException> |
JsonValueFunctions.pattern()
Returns the JSON string value as a regular expression pattern.
|
static Function<JsonValue,JsonPointer,JsonValueException> |
JsonValueFunctions.pointer()
Returns the JSON string value as a JSON pointer.
|
static <V,E extends Exception> |
JsonValueFunctions.setOf(Function<JsonValue,V,E> transformFunction)
Returns the JSON value as a
Set containing objects whose type
(and value) is specified by a transformation function. |
static Function<JsonValue,URI,JsonValueException> |
JsonValueFunctions.uri()
Returns the JSON string value as a uniform resource identifier.
|
static Function<JsonValue,URL,JsonValueException> |
JsonValueFunctions.url()
Returns the JSON string value as a uniform resource locator.
|
static Function<JsonValue,UUID,JsonValueException> |
JsonValueFunctions.uuid()
Returns the JSON string value as a universally unique identifier (UUID).
|
Modifier and Type | Method and Description |
---|---|
void |
JsonTransformer.transform(JsonValue value)
Performs the transformation of the specified JSON value.
|
Modifier and Type | Method and Description |
---|---|
<V,E extends Exception> |
JsonValue.as(Function<JsonValue,V,E> transformFunction)
Returns the JSON value as an object whose type
(and value) is specified by a transformation function.
|
<V,E extends Exception> |
JsonValue.asList(Function<JsonValue,V,E> transformFunction)
Deprecated.
Use the method
as(Function) with the appropriate function. (Replace the following call
jv.asList(transformFunction) with jv.map(JsonValueFunctions.list(transformFunction)) ). |
<V,E extends Exception> |
JsonValue.asSet(Function<JsonValue,V,E> transformFunction)
Deprecated.
Use the method
as(Function) with the appropriate function. (Replace the following call
jv.asSet(transformFunction) with jv.map(JsonValueFunctions.set(transformFunction)) ). |
static <V,E extends Exception> |
JsonValueFunctions.listOf(Function<JsonValue,V,E> transformFunction)
Returns the JSON value as a
List containing objects whose type
(and value) is specified by a transformation function. |
static <V,E extends Exception> |
JsonValueFunctions.setOf(Function<JsonValue,V,E> transformFunction)
Returns the JSON value as a
Set containing objects whose type
(and value) is specified by a transformation function. |
Constructor and Description |
---|
JsonValueException(JsonValue value)
Constructs a new exception with the specified JSON value and
null
as its detail message. |
JsonValueException(JsonValue value,
String message)
Constructs a new exception with the specified JSON value and detail
message.
|
JsonValueException(JsonValue value,
String message,
Throwable cause)
Constructs a new exception with the specified JSON value, detail message
and cause.
|
JsonValueException(JsonValue value,
Throwable cause)
Constructs a new exception with the specified JSON value and cause.
|
JsonValueKeyAccessChecker(JsonValue delegate)
Constructs a
JsonValueKeyAccessChecker . |
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.
|
JsonValue |
UpdateRequest.getContent()
Returns the content of the JSON resource to be replaced.
|
JsonValue |
ResourceResponse.getContent()
Returns the JSON content of this resource.
|
JsonValue |
CreateRequest.getContent()
Returns the content of the JSON resource to be created.
|
JsonValue |
ActionRequest.getContent()
Returns the content of this action request.
|
JsonValue |
ResourceException.getDetail()
Returns the additional detail which can be evaluated by applications.
|
JsonValue |
ActionResponse.getJsonContent()
Gets the
JsonValue content contained in the Response . |
JsonValue |
PatchOperation.getValue()
Returns the value for the patch operation.
|
JsonValue |
UpdateRequest.toJsonValue() |
JsonValue |
ResourceException.toJsonValue()
Returns the exception in a JSON object structure, suitable for inclusion
in the entity of an HTTP error response.
|
JsonValue |
Request.toJsonValue()
Return a JsonValue representation of this request.
|
JsonValue |
ReadRequest.toJsonValue() |
JsonValue |
QueryRequest.toJsonValue() |
JsonValue |
PatchRequest.toJsonValue() |
JsonValue |
PatchOperation.toJsonValue()
Returns a JSON value representation of this patch operation.
|
JsonValue |
DeleteRequest.toJsonValue() |
JsonValue |
CreateRequest.toJsonValue() |
JsonValue |
ActionRequest.toJsonValue() |
Modifier and Type | Method and Description |
---|---|
PatchRequest |
PatchRequest.addPatchOperation(String operation,
String field,
JsonValue value)
Adds a single patch operation which should be performed against the targeted resource.
|
static JsonValue |
Resources.filterResource(JsonValue resource,
Collection<JsonPointer> fields)
Returns a JSON object containing only the specified fields from the
provided JSON value.
|
static ActionResponse |
Responses.newActionResponse(JsonValue json)
Returns a new
JsonValue response with the provided JSON content. |
static CreateRequest |
Requests.newCreateRequest(ResourcePath resourceContainer,
JsonValue content)
Returns a new create request with the provided resource path, and JSON
content.
|
static CreateRequest |
Requests.newCreateRequest(ResourcePath resourceContainer,
String newResourceId,
JsonValue content)
Returns a new create request with the provided resource path, new
resource ID, and JSON content.
|
static CreateRequest |
Requests.newCreateRequest(String resourceContainer,
JsonValue content)
Returns a new create request with the provided resource path, and JSON
content.
|
static CreateRequest |
Requests.newCreateRequest(String resourceContainer,
String newResourceId,
JsonValue content)
Returns a new create request with the provided resource path, new
resource ID, and JSON content.
|
static ResourceResponse |
Responses.newResourceResponse(String id,
String revision,
JsonValue content)
Returns a new
Resource response with the provided Resource as
content. |
static UpdateRequest |
Requests.newUpdateRequest(ResourcePath resourcePath,
JsonValue newContent)
Returns a new update request with the provided resource path and new JSON
content.
|
static UpdateRequest |
Requests.newUpdateRequest(ResourcePath resourceContainer,
String resourceId,
JsonValue newContent)
Returns a new update request with the provided resource container path,
resource ID, and new JSON content.
|
static UpdateRequest |
Requests.newUpdateRequest(String resourcePath,
JsonValue newContent)
Returns a new update request with the provided resource path and new JSON
content.
|
static UpdateRequest |
Requests.newUpdateRequest(String resourceContainer,
String resourceId,
JsonValue newContent)
Returns a new update request with the provided resource container path,
resource ID, and new JSON content.
|
UpdateRequest |
UpdateRequest.setContent(JsonValue content)
Sets the content of the JSON resource to be replaced.
|
CreateRequest |
CreateRequest.setContent(JsonValue content)
Sets the content of the JSON resource to be created.
|
ActionRequest |
ActionRequest.setContent(JsonValue content)
Sets the content of this action request.
|
ResourceException |
ResourceException.setDetail(JsonValue detail)
Sets the additional detail which can be evaluated by applications.
|
static PatchOperation |
PatchOperation.valueOf(JsonValue json)
Parses the provided JSON content as a patch operation.
|
static List<PatchOperation> |
PatchOperation.valueOfList(JsonValue json)
Parses the provided JSON content as a list of patch operations.
|
Constructor and Description |
---|
AdviceContext(JsonValue savedContext,
ClassLoader classLoader)
Restore from JSON representation.
|
Constructor and Description |
---|
HttpContext(JsonValue savedContext,
ClassLoader classLoader)
Restore from JSON representation.
|
Modifier and Type | Method and Description |
---|---|
static ConnectionFactory |
Rest2LdapJsonConfigurator.configureConnectionFactory(JsonValue configuration,
String name,
TrustManager trustManager,
X509KeyManager keyManager)
Creates a new connection factory using the named configuration in the provided JSON list of factory
configurations.
|
static ConnectionFactory |
Rest2LdapJsonConfigurator.configureConnectionFactory(JsonValue configuration,
String name,
TrustManager trustManager,
X509KeyManager keyManager,
ClassLoader providerClassLoader)
Creates a new connection factory using the named configuration in the provided JSON list of factory
configurations.
|
static X509KeyManager |
Rest2LdapJsonConfigurator.configureKeyManager(JsonValue configuration)
Configures a
X509KeyManager using the provided JSON configuration. |
static Options |
Rest2LdapJsonConfigurator.configureOptions(JsonValue config)
Parses Rest2Ldap configuration options.
|
static List<Resource> |
Rest2LdapJsonConfigurator.configureResources(JsonValue config)
Parses a list of Rest2Ldap resource definitions.
|
static TrustManager |
Rest2LdapJsonConfigurator.configureTrustManager(JsonValue configuration)
Configures a
TrustManager using the provided JSON configuration. |
Copyright 2010-2017 ForgeRock AS.