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.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.jms |
This package contains a JMS AuditEventHandler implementation.
|
org.forgerock.audit.handlers.json |
This package contains the JSON-file
AuditEventHandler implementation. |
org.forgerock.audit.handlers.splunk |
This package contains the audit handler implementation for Splunk.
|
org.forgerock.audit.handlers.syslog |
This package contains a Syslog AuditEventHandler implementation.
|
org.forgerock.audit.util |
This package contains utility classes used in the audit service.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
AuditServiceProxy.handleAction(org.forgerock.services.context.Context context,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AuditService.handleAction(org.forgerock.services.context.Context context,
ActionRequest request)
Audit service may support actions on the service itself or on handlers.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request)
Propagates the audit event to the
AuditEventHandler objects that have been registered
for the audit event topic. |
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request)
Audit service does not support changing audit entries.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request)
Audit service does not support changing audit entries.
|
Promise<QueryResponse,ResourceException> |
AuditServiceProxy.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AuditService.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Performs the query on the specified object and returns the associated results.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleRead(org.forgerock.services.context.Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleRead(org.forgerock.services.context.Context context,
ReadRequest request)
Gets an object from the audit logs by identifier.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request)
Audit service does not support changing audit entries.
|
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 String |
AuditEventHelper.getPropertyType(JsonValue auditEvent,
JsonPointer property)
Gets a AuditEvent property type.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
AuditEventHandlerBase.handleAction(org.forgerock.services.context.Context context,
String topic,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AuditEventHandler.handleAction(org.forgerock.services.context.Context context,
String topic,
ActionRequest request)
Performs an action.
|
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.
|
Promise<QueryResponse,ResourceException> |
NoOpAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Query some events from the provided topic.
|
Promise<ResourceResponse,ResourceException> |
NoOpAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId) |
Promise<ResourceResponse,ResourceException> |
AuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId)
Reads an event with the provided resource id from the provided topic.
|
Modifier and Type | Method and Description |
---|---|
void |
NoOpAuditEventHandler.shutdown() |
void |
AuditEventHandler.shutdown()
Instruct this object to flush any buffers and close any open file handles or network connections.
|
void |
NoOpAuditEventHandler.startup() |
void |
AuditEventHandler.startup()
Instruct this object that it is safe to initialize file handles and network connections.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
CsvAuditEventHandler.handleAction(org.forgerock.services.context.Context context,
String topic,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
CsvAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event)
Create a csv audit log entry.
|
Promise<QueryResponse,ResourceException> |
CsvAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Perform a query on the csv audit log.
|
Promise<ResourceResponse,ResourceException> |
CsvAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId)
Read from the csv audit log.
|
Modifier and Type | Method and Description |
---|---|
void |
CsvAuditEventHandler.shutdown()
Instruct this object to flush any buffers and close any open file handles or network connections.
|
void |
CsvAuditEventHandler.startup()
Instruct this object that it is safe to initialize file handles and network connections.
|
Modifier and Type | Method and Description |
---|---|
protected static ResourceException |
ElasticsearchAuditEventHandler.resourceException(String indexName,
String topic,
String resourceId,
org.forgerock.http.protocol.Response response)
Gets an
Exception Promise containing an Elasticsearch HTTP response status and payload. |
Modifier and Type | Method and Description |
---|---|
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.
|
Promise<QueryResponse,ResourceException> |
ElasticsearchAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Queries the Elasticsearch
Search API for
audit events.
|
Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
void |
ElasticsearchAuditEventHandler.shutdown() |
void |
ElasticsearchAuditEventHandler.startup() |
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.
|
Promise<QueryResponse,ResourceException> |
JdbcAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler)
Query some events from the provided topic.
|
Promise<ResourceResponse,ResourceException> |
JdbcAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
void |
JdbcAuditEventHandler.shutdown()
Instruct this object to flush any buffers and close any open file handles or network connections.
|
void |
JdbcAuditEventHandler.startup()
Instruct this object that it is safe to initialize file handles and network connections.
|
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
JmsAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String auditTopic,
JsonValue auditEvent)
Converts the audit event into a JMS TextMessage and then publishes the message on the configured jmsTopic.
|
Promise<QueryResponse,ResourceException> |
JmsAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler)
Returns NotSupportedException as query is not implemented for JMS.
|
Promise<ResourceResponse,ResourceException> |
JmsAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId)
Returns NotSupportedException as read is not implemented for JMS.
|
Modifier and Type | Method and Description |
---|---|
void |
Publisher.publish(T message)
implement this to deliver the audit event representation to the service.
|
void |
Publisher.shutdown()
Cleanup services that were initialized with
Publisher.startup() . |
void |
JmsAuditEventHandler.shutdown()
Closes the JMS connection.
|
void |
BatchPublisher.shutdown()
This shutdowns the worker threads, and then calls
BatchPublisher.shutdownPublisher() . |
protected abstract void |
BatchPublisher.shutdownPublisher()
This is invoked by
BatchPublisher.shutdown() . |
void |
Publisher.startup()
Initialize services that are reused by individual publish calls.
|
void |
JmsAuditEventHandler.startup()
Creates the JMS Topic and ConnectionFactory from the context configuration settings and opens the JMS connection.
|
void |
BatchPublisher.startup()
This first initializes the worker threads that monitor the queue of items to publish, and then calls
BatchPublisher.startupPublisher() . |
protected abstract void |
BatchPublisher.startupPublisher()
This is invoked by
BatchPublisher.startup() . |
Constructor and Description |
---|
JmsAuditEventHandler(JmsContextManager jmsContextManager,
JmsAuditEventHandlerConfiguration configuration,
EventTopicsMetaData eventTopicsMetaData)
Creates a new AuditEventHandler instance that publishes JMS messages on a JMS Topic for each Audit event.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
JsonAuditEventHandler.handleAction(org.forgerock.services.context.Context context,
String topic,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
JsonAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
JsonAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
JsonAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
void |
JsonAuditEventHandler.shutdown() |
void |
JsonAuditEventHandler.startup() |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
SplunkAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
SplunkAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
SplunkAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
void |
SplunkAuditEventHandler.shutdown() |
void |
SplunkAuditEventHandler.startup() |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
SyslogAuditEventHandler.publishEvent(org.forgerock.services.context.Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
SyslogAuditEventHandler.queryEvents(org.forgerock.services.context.Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler) |
Promise<ResourceResponse,ResourceException> |
SyslogAuditEventHandler.readEvent(org.forgerock.services.context.Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
static ResourceException |
ResourceExceptionsUtil.adapt(Throwable t)
Adapts a
Throwable to a ResourceException . |
static ResourceException |
ResourceExceptionsUtil.notSupported(Request request)
Creates a NotSupportedException.
|
static ResourceException |
ResourceExceptionsUtil.notSupportedOnCollection(Request request)
Creates a NotSupportedException.
|
static ResourceException |
ResourceExceptionsUtil.notSupportedOnInstance(Request request)
Creates a NotSupportedException.
|
Modifier and Type | Class and Description |
---|---|
class |
BadRequestException
An exception that is thrown during a operation on a resource when the
requested operation is malformed.
|
class |
ConflictException
An exception that is thrown during a operation on a resource when such an
operation would result in a conflict.
|
class |
CreateNotSupportedException
A specific exception for when Create is not supported, but Upsert might be being attempted so distinguish from
other
BadRequestException s. |
class |
ForbiddenException
An exception that is thrown when access to a resource is forbidden during an
operation on an resource.
|
class |
InternalServerErrorException
An exception that is thrown during an operation on a resource when the server
encountered an unexpected condition which prevented it from fulfilling the
request.
|
class |
NotFoundException
An exception that is thrown when a specified resource cannot be found.
|
class |
NotSupportedException
An exception that is thrown during an operation on a resource when the
resource does not implement/support the feature to fulfill the request.
|
class |
PermanentException
An exception that indicates that a failure is permanent, i.e.
|
class |
PreconditionFailedException
An exception that is thrown to indicate that a resource's current version
does not match the version provided.
|
class |
PreconditionRequiredException
An exception that is thrown to indicate that a resource requires a version,
but no version was supplied in the request.
|
class |
RetryableException
An exception that indicates that a failure may be temporary, and that
retrying the same request may be able to succeed in the future.
|
class |
ServiceUnavailableException
An exception that is thrown during an operation on a resource when the server
is temporarily unable to handle the request.
|
class |
UncategorizedException
An exception that indicates that a failure is not directly known to the
system, and hence requires out-of-band knowledge or enhancements to determine
if a failure should be categorized as temporary or permanent.
|
Modifier and Type | Method and Description |
---|---|
<E extends ResourceException> |
ResourceException.includeCauseInJsonValue()
Returns this ResourceException with the includeCause flag set to true
so that toJsonValue() method will include the cause if there is
one supplied.
|
<E extends ResourceException> |
ResourceException.setDetail(JsonValue detail)
Sets the additional detail which can be evaluated by applications.
|
<E extends ResourceException> |
ResourceException.setReason(String reason)
Sets/overrides the short reason phrase of the exception.
|
Modifier and Type | Method and Description |
---|---|
static ResourceException |
ResourceException.getException(int code)
Deprecated.
in favor of
newResourceException(int) |
static ResourceException |
ResourceException.getException(int code,
String message)
Deprecated.
in favor of
newResourceException(int, String) |
static ResourceException |
ResourceException.getException(int code,
String message,
Throwable cause)
Deprecated.
in favor of
newResourceException(int, String, Throwable) |
static ResourceException |
ResourceException.newResourceException(int code)
Returns an exception with the specified HTTP error code, but no detail
message or cause, and a default reason phrase.
|
static ResourceException |
ResourceException.newResourceException(int code,
String message)
Returns an exception with the specified HTTP error code and detail
message, but no cause, and a default reason phrase.
|
static ResourceException |
ResourceException.newResourceException(int code,
String message,
Throwable cause)
Returns an exception with the specified HTTP error code, detail message,
and cause, and a default reason phrase.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
Connection.actionAsync(org.forgerock.services.context.Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
AbstractConnectionWrapper.actionAsync(org.forgerock.services.context.Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionCollection(org.forgerock.services.context.Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
default Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionCollection(org.forgerock.services.context.Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
default Promise<ActionResponse,ResourceException> |
SingletonResourceProvider.actionInstance(org.forgerock.services.context.Context context,
ActionRequest request)
Performs the provided
action against the single resource instance. |
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionInstance(org.forgerock.services.context.Context context,
String id,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
default Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionInstance(org.forgerock.services.context.Context context,
String resourceId,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
Promise<ResourceResponse,ResourceException> |
ResourceResponse.asPromise()
Return this response as a result Promise.
|
Promise<QueryResponse,ResourceException> |
QueryResponse.asPromise()
Return this response as a result Promise.
|
Promise<ActionResponse,ResourceException> |
ActionResponse.asPromise()
Return this response as a result Promise.
|
<V> Promise<V,ResourceException> |
ResourceException.asPromise()
Return this ResourceException as a Promise.
|
Promise<ResourceResponse,ResourceException> |
Connection.createAsync(org.forgerock.services.context.Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.createAsync(org.forgerock.services.context.Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.createInstance(org.forgerock.services.context.Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.createInstance(org.forgerock.services.context.Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.deleteAsync(org.forgerock.services.context.Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.deleteAsync(org.forgerock.services.context.Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.deleteInstance(org.forgerock.services.context.Context context,
String id,
DeleteRequest request)
Removes a resource instance from the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.deleteInstance(org.forgerock.services.context.Context context,
String resourceId,
DeleteRequest request)
Removes a resource instance from the collection. |
Promise<ActionResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterAction(org.forgerock.services.context.Context context,
ActionRequest request,
RequestHandler next) |
Promise<ActionResponse,ResourceException> |
Filter.filterAction(org.forgerock.services.context.Context context,
ActionRequest request,
RequestHandler next)
Filters an action request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterCreate(org.forgerock.services.context.Context context,
CreateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterCreate(org.forgerock.services.context.Context context,
CreateRequest request,
RequestHandler next)
Filters a create request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterDelete(org.forgerock.services.context.Context context,
DeleteRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterDelete(org.forgerock.services.context.Context context,
DeleteRequest request,
RequestHandler next)
Filters a delete request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterPatch(org.forgerock.services.context.Context context,
PatchRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterPatch(org.forgerock.services.context.Context context,
PatchRequest request,
RequestHandler next)
Filters a patch request.
|
Promise<QueryResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next) |
Promise<QueryResponse,ResourceException> |
Filter.filterQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next)
Filters a query request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterRead(org.forgerock.services.context.Context context,
ReadRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterRead(org.forgerock.services.context.Context context,
ReadRequest request,
RequestHandler next)
Filters a read request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterUpdate(org.forgerock.services.context.Context context,
UpdateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterUpdate(org.forgerock.services.context.Context context,
UpdateRequest request,
RequestHandler next)
Filters an update request.
|
Promise<Connection,ResourceException> |
ConnectionFactory.getConnectionAsync()
Asynchronously obtains a connection to the JSON resource provider
associated with this connection factory.
|
Promise<ActionResponse,ResourceException> |
Router.handleAction(org.forgerock.services.context.Context context,
ActionRequest request) |
default Promise<ActionResponse,ResourceException> |
RequestHandler.handleAction(org.forgerock.services.context.Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
Promise<ActionResponse,ResourceException> |
FilterChain.handleAction(org.forgerock.services.context.Context context,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request)
Adds a new JSON resource, returning a
Promise that will be
completed when the resource has been added. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request)
Deletes a JSON resource, returning a
Promise that will be
completed when the resource has been deleted. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request) |
Promise<QueryResponse,ResourceException> |
Router.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
default Promise<QueryResponse,ResourceException> |
RequestHandler.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, returning a
Promise that will be completed when the
search has completed. |
Promise<QueryResponse,ResourceException> |
FilterChain.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
Router.handleRead(org.forgerock.services.context.Context context,
ReadRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleRead(org.forgerock.services.context.Context context,
ReadRequest request)
Reads a JSON resource, returning a
Promise that will be
completed when the resource has been read. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleRead(org.forgerock.services.context.Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.patchAsync(org.forgerock.services.context.Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.patchAsync(org.forgerock.services.context.Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.patchInstance(org.forgerock.services.context.Context context,
PatchRequest request)
Patches the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.patchInstance(org.forgerock.services.context.Context context,
String id,
PatchRequest request)
Patches an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.patchInstance(org.forgerock.services.context.Context context,
String resourceId,
PatchRequest request)
Patches an existing resource within the collection. |
Promise<QueryResponse,ResourceException> |
Connection.queryAsync(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
Promise<QueryResponse,ResourceException> |
AbstractConnectionWrapper.queryAsync(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
Promise<QueryResponse,ResourceException> |
MemoryBackend.queryCollection(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
default Promise<QueryResponse,ResourceException> |
CollectionResourceProvider.queryCollection(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
Promise<ResourceResponse,ResourceException> |
Connection.readAsync(org.forgerock.services.context.Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.readAsync(org.forgerock.services.context.Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.readInstance(org.forgerock.services.context.Context context,
ReadRequest request)
Reads the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.readInstance(org.forgerock.services.context.Context context,
String id,
ReadRequest request)
Reads an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.readInstance(org.forgerock.services.context.Context context,
String resourceId,
ReadRequest request)
Reads an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.updateAsync(org.forgerock.services.context.Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.updateAsync(org.forgerock.services.context.Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.updateInstance(org.forgerock.services.context.Context context,
String id,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.updateInstance(org.forgerock.services.context.Context context,
String resourceId,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.updateInstance(org.forgerock.services.context.Context context,
UpdateRequest request)
Updates the single resource instance. |
Modifier and Type | Method and Description |
---|---|
ActionResponse |
Connection.action(org.forgerock.services.context.Context context,
ActionRequest request)
Performs an action against a specific resource, or set of resources.
|
ActionResponse |
AbstractConnectionWrapper.action(org.forgerock.services.context.Context context,
ActionRequest request)
Performs an action against a specific resource, or set of resources.
|
ActionResponse |
AbstractAsynchronousConnection.action(org.forgerock.services.context.Context context,
ActionRequest request) |
ResourceResponse |
Connection.create(org.forgerock.services.context.Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.create(org.forgerock.services.context.Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.create(org.forgerock.services.context.Context context,
CreateRequest request) |
ResourceResponse |
Connection.delete(org.forgerock.services.context.Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.delete(org.forgerock.services.context.Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.delete(org.forgerock.services.context.Context context,
DeleteRequest request) |
Connection |
ConnectionFactory.getConnection()
Returns a connection to the JSON resource provider associated with this
connection factory.
|
ActionResponse |
SynchronousRequestHandler.handleAction(org.forgerock.services.context.Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
ResourceResponse |
SynchronousRequestHandler.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
QueryResponse |
SynchronousRequestHandler.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<ResourceResponse> resources)
Searches for all JSON resources matching a user specified set of
criteria.
|
ResourceResponse |
SynchronousRequestHandler.handleRead(org.forgerock.services.context.Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
Connection.patch(org.forgerock.services.context.Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractConnectionWrapper.patch(org.forgerock.services.context.Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractAsynchronousConnection.patch(org.forgerock.services.context.Context context,
PatchRequest request) |
QueryResponse |
Connection.query(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
AbstractConnectionWrapper.query(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
AbstractAsynchronousConnection.query(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<? super ResourceResponse> results) |
QueryResponse |
Connection.query(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, and returns a
Promise that will be completed with the
results of the search. |
QueryResponse |
AbstractConnectionWrapper.query(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, and returns a
Promise that will be completed with the
results of the search. |
QueryResponse |
AbstractAsynchronousConnection.query(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
ResourceResponse |
Connection.read(org.forgerock.services.context.Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.read(org.forgerock.services.context.Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.read(org.forgerock.services.context.Context context,
ReadRequest request) |
ResourceResponse |
Connection.update(org.forgerock.services.context.Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractConnectionWrapper.update(org.forgerock.services.context.Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractAsynchronousConnection.update(org.forgerock.services.context.Context context,
UpdateRequest request) |
Modifier and Type | Method and Description |
---|---|
org.forgerock.services.context.SecurityContext |
SecurityContextFactory.createContext(org.forgerock.services.context.Context parent)
Deprecated.
Creates a new
SecurityContext using the attributes contained in
the provided HTTP request. |
org.forgerock.services.context.SecurityContext |
SecurityContextFactory.createContext(org.forgerock.services.context.Context context,
org.forgerock.http.protocol.Request request)
Deprecated.
Creates a new
SecurityContext using the attributes contained in
the provided HTTP request. |
org.forgerock.services.context.Context |
HttpContextFactory.createContext(org.forgerock.services.context.Context parent,
org.forgerock.http.protocol.Request request)
Returns the context which should be used for the provided HTTP request.
|
static RequestType |
HttpUtils.determineRequestType(org.forgerock.http.protocol.Request request)
Determines which CREST operation (CRUDPAQ) of the incoming request.
|
Modifier and Type | Method and Description |
---|---|
static ResourceException |
Rest2Ldap.asResourceException(Throwable t)
Adapts a
Throwable to a ResourceException . |
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
DescribableRequestHandler.handleAction(org.forgerock.services.context.Context context,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AbstractRequestHandler.handleAction(org.forgerock.services.context.Context context,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
DescribableRequestHandler.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleCreate(org.forgerock.services.context.Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
DescribableRequestHandler.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleDelete(org.forgerock.services.context.Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
DescribableRequestHandler.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handlePatch(org.forgerock.services.context.Context context,
PatchRequest request) |
Promise<QueryResponse,ResourceException> |
DescribableRequestHandler.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AbstractRequestHandler.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
DescribableRequestHandler.handleRead(org.forgerock.services.context.Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleRead(org.forgerock.services.context.Context context,
ReadRequest request) |
protected <V> Promise<V,ResourceException> |
AbstractRequestHandler.handleRequest(org.forgerock.services.context.Context context,
Request request)
Implement this method in order to provide a default behavior when processing requests.
|
Promise<ResourceResponse,ResourceException> |
DescribableRequestHandler.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleUpdate(org.forgerock.services.context.Context context,
UpdateRequest request) |
Copyright 2010-2020 ForgeRock AS.