Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
AuditServiceProxy.handleAction(Context context,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AuditService.handleAction(Context context,
ActionRequest request)
Audit service may support actions on the service itself or on handlers.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleCreate(Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleCreate(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(Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleDelete(Context context,
DeleteRequest request)
Audit service does not support changing audit entries.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handlePatch(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handlePatch(Context context,
PatchRequest request)
Audit service does not support changing audit entries.
|
Promise<QueryResponse,ResourceException> |
AuditServiceProxy.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AuditService.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler)
Performs the query on the specified object and returns the associated results.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleRead(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleRead(Context context,
ReadRequest request)
Gets an object from the audit logs by identifier.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleUpdate(Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleUpdate(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(Context context,
String topic,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AuditEventHandler.handleAction(Context context,
String topic,
ActionRequest request)
Performs an action.
|
Promise<ResourceResponse,ResourceException> |
NoOpAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
Promise<ResourceResponse,ResourceException> |
AuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event)
Publishes an event to the provided topic.
|
Promise<QueryResponse,ResourceException> |
NoOpAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Query some events from the provided topic.
|
Promise<ResourceResponse,ResourceException> |
NoOpAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
Promise<ResourceResponse,ResourceException> |
AuditEventHandler.readEvent(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(Context context,
String topic,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
CsvAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event)
Create a csv audit log entry.
|
Promise<QueryResponse,ResourceException> |
CsvAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Perform a query on the csv audit log.
|
Promise<ResourceResponse,ResourceException> |
CsvAuditEventHandler.readEvent(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,
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(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(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Queries the Elasticsearch
Search API for
audit events.
|
Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.readEvent(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(Context context,
String topic,
JsonValue event)
Publishes an event to the provided topic.
|
Promise<QueryResponse,ResourceException> |
JdbcAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler)
Query some events from the provided topic.
|
Promise<ResourceResponse,ResourceException> |
JdbcAuditEventHandler.readEvent(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(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(Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler)
Returns NotSupportedException as query is not implemented for JMS.
|
Promise<ResourceResponse,ResourceException> |
JmsAuditEventHandler.readEvent(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 |
---|---|
void |
JsonAuditEventHandler.shutdown() |
void |
JsonAuditEventHandler.startup() |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
SplunkAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
SplunkAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
SplunkAuditEventHandler.readEvent(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(Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
SyslogAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler) |
Promise<ResourceResponse,ResourceException> |
SyslogAuditEventHandler.readEvent(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 | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
SimpleResource.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
Promise<ActionResponse,ResourceException> |
SimpleResource.actionInstance(Context context,
String resourceId,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
Promise<AuthorizationResult,ResourceException> |
NotPatchAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysDenyAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
NotQueryAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
NotUpdateAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
NotDeleteAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
NotCreateAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysAllowAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
NotReadAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
NotActionAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
NotPatchAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysDenyAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
NotQueryAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
NotUpdateAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
NotDeleteAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
NotCreateAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysAllowAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
NotReadAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
NotActionAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
NotPatchAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysDenyAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
NotQueryAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
NotUpdateAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
NotDeleteAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
NotCreateAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysAllowAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
NotReadAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
NotActionAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
NotPatchAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysDenyAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
NotQueryAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
NotUpdateAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
NotDeleteAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
NotCreateAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysAllowAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
NotReadAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
NotActionAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
NotPatchAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysDenyAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
NotQueryAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
NotUpdateAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
NotDeleteAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
NotCreateAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysAllowAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
NotReadAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
NotActionAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
NotPatchAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysDenyAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
NotQueryAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
NotUpdateAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
NotDeleteAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
NotCreateAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysAllowAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
NotReadAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
NotActionAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
NotPatchAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysDenyAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
NotQueryAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
NotUpdateAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
NotDeleteAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
NotCreateAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
AlwaysAllowAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
NotReadAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<AuthorizationResult,ResourceException> |
NotActionAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Promise<ResourceResponse,ResourceException> |
SimpleResource.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
Promise<ResourceResponse,ResourceException> |
SimpleResource.deleteInstance(Context context,
String resourceId,
DeleteRequest request)
Removes a resource instance from the collection. |
Promise<ResourceResponse,ResourceException> |
SimpleResource.patchInstance(Context context,
String resourceId,
PatchRequest request)
Patches an existing resource within the collection. |
Promise<QueryResponse,ResourceException> |
SimpleResource.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
Promise<ResourceResponse,ResourceException> |
SimpleResource.readInstance(Context context,
String resourceId,
ReadRequest request)
Reads an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
SimpleResource.updateInstance(Context context,
String resourceId,
UpdateRequest request)
Updates an existing resource within the collection. |
Modifier and Type | Method and Description |
---|---|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Modifier and Type | Method and Description |
---|---|
Promise<AuthorizationResult,ResourceException> |
OAuth2CrestAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request using the OAuth2 Access Token present in the request header.
|
Promise<AuthorizationResult,ResourceException> |
OAuth2CrestAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request using the OAuth2 Access Token present in the request header.
|
Promise<AuthorizationResult,ResourceException> |
OAuth2CrestAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request using the OAuth2 Access Token present in the request header.
|
Promise<AuthorizationResult,ResourceException> |
OAuth2CrestAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request using the OAuth2 Access Token present in the request header.
|
Promise<AuthorizationResult,ResourceException> |
OAuth2CrestAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request using the OAuth2 Access Token present in the request header.
|
Promise<AuthorizationResult,ResourceException> |
OAuth2CrestAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request using the OAuth2 Access Token present in the request header.
|
Promise<AuthorizationResult,ResourceException> |
OAuth2CrestAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request using the OAuth2 Access Token present in the request header.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
ConfigurationResource.actionInstance(Context context,
ActionRequest request)
Unsupported operation.
|
Promise<ActionResponse,ResourceException> |
AuditResource.actionInstance(Context context,
ActionRequest request)
Only the "readAndClear" action is supported, which will read the audit records and then subsequently clear them.
|
Promise<ResourceResponse,ResourceException> |
ConfigurationResource.patchInstance(Context context,
PatchRequest request)
Unsupported operation.
|
Promise<ResourceResponse,ResourceException> |
AuditResource.patchInstance(Context context,
PatchRequest request)
Unsupported operation.
|
Promise<ResourceResponse,ResourceException> |
ConfigurationResource.readInstance(Context context,
ReadRequest request)
Will perform a read of the runtime's module configuration.
|
Promise<ResourceResponse,ResourceException> |
AuditResource.readInstance(Context context,
ReadRequest request)
Will perform a read of the audit records.
|
Promise<ResourceResponse,ResourceException> |
ConfigurationResource.updateInstance(Context context,
UpdateRequest request)
Will perform an update of the runtime's module configuration.
|
Promise<ResourceResponse,ResourceException> |
AuditResource.updateInstance(Context context,
UpdateRequest request)
Unsupported operation.
|
Modifier and Type | Method and Description |
---|---|
List<AsyncServerAuthModule> |
GuiceModule.getAuthModules(ConfigurationResource configurationResource,
com.google.inject.Injector injector)
Provider for the JASPI runtime's auth modules.
|
AsyncServerAuthModule |
GuiceModule.getSessionAuthModule(ConfigurationResource configurationResource,
com.google.inject.Injector injector)
Provider for the JASPI runtime's "Session" auth module.
|
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 |
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. that re-trying
alone without addressing the cause is not expected to succeed.
|
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 |
---|---|
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) |
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.
|
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.
|
ResourceException |
ResourceException.setDetail(JsonValue detail)
Sets the additional detail which can be evaluated by applications.
|
ResourceException |
ResourceException.setReason(String reason)
Sets/overrides the short reason phrase of the exception.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
Connection.actionAsync(Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
AbstractConnectionWrapper.actionAsync(Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
Promise<ActionResponse,ResourceException> |
SingletonResourceProvider.actionInstance(Context context,
ActionRequest request)
Performs the provided
action against the single resource instance. |
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionInstance(Context context,
String id,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionInstance(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(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.createAsync(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.deleteInstance(Context context,
String id,
DeleteRequest request)
Removes a resource instance from the collection. |
Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.deleteInstance(Context context,
String resourceId,
DeleteRequest request)
Removes a resource instance from the collection. |
Promise<ActionResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterAction(Context context,
ActionRequest request,
RequestHandler next) |
Promise<ActionResponse,ResourceException> |
Filter.filterAction(Context context,
ActionRequest request,
RequestHandler next)
Filters an action request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterCreate(Context context,
CreateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterCreate(Context context,
CreateRequest request,
RequestHandler next)
Filters a create request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next)
Filters a delete request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterPatch(Context context,
PatchRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterPatch(Context context,
PatchRequest request,
RequestHandler next)
Filters a patch request.
|
Promise<QueryResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterQuery(Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next) |
Promise<QueryResponse,ResourceException> |
Filter.filterQuery(Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next)
Filters a query request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterRead(Context context,
ReadRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterRead(Context context,
ReadRequest request,
RequestHandler next)
Filters a read request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterUpdate(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(Context context,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
RequestHandler.handleAction(Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
Promise<ActionResponse,ResourceException> |
FilterChain.handleAction(Context context,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AbstractRequestHandler.handleAction(Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
Promise<ResourceResponse,ResourceException> |
Router.handleCreate(Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
RequestHandler.handleCreate(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(Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleCreate(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> |
Router.handleDelete(Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
RequestHandler.handleDelete(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(Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource, returning a
Promise that will be
completed when the resource has been deleted. |
Promise<ResourceResponse,ResourceException> |
Router.handlePatch(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
RequestHandler.handlePatch(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(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handlePatch(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<QueryResponse,ResourceException> |
Router.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
RequestHandler.handleQuery(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(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AbstractRequestHandler.handleQuery(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<ResourceResponse,ResourceException> |
Router.handleRead(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
RequestHandler.handleRead(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(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource, returning a
Promise that will be
completed when the resource has been read. |
Promise<ResourceResponse,ResourceException> |
Router.handleUpdate(Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
RequestHandler.handleUpdate(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(Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
AbstractRequestHandler.handleUpdate(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> |
Connection.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.patchInstance(Context context,
PatchRequest request)
Patches the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.patchInstance(Context context,
String id,
PatchRequest request)
Patches an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.patchInstance(Context context,
String resourceId,
PatchRequest request)
Patches an existing resource within the collection. |
Promise<QueryResponse,ResourceException> |
Connection.queryAsync(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(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(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
Promise<QueryResponse,ResourceException> |
CollectionResourceProvider.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
Promise<ResourceResponse,ResourceException> |
Connection.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.readInstance(Context context,
ReadRequest request)
Reads the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.readInstance(Context context,
String id,
ReadRequest request)
Reads an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.readInstance(Context context,
String resourceId,
ReadRequest request)
Reads an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.updateInstance(Context context,
String id,
UpdateRequest request)
Updates an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.updateInstance(Context context,
String resourceId,
UpdateRequest request)
Updates an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.updateInstance(Context context,
UpdateRequest request)
Updates the single resource instance. |
Modifier and Type | Method and Description |
---|---|
ActionResponse |
Connection.action(Context context,
ActionRequest request)
Performs an action against a specific resource, or set of resources.
|
ActionResponse |
AbstractConnectionWrapper.action(Context context,
ActionRequest request)
Performs an action against a specific resource, or set of resources.
|
ActionResponse |
AbstractAsynchronousConnection.action(Context context,
ActionRequest request) |
ResourceResponse |
Connection.create(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.create(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.create(Context context,
CreateRequest request) |
ResourceResponse |
Connection.delete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.delete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.delete(Context context,
DeleteRequest request) |
Connection |
ConnectionFactory.getConnection()
Returns a connection to the JSON resource provider associated with this
connection factory.
|
ActionResponse |
SynchronousRequestHandler.handleAction(Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
ResourceResponse |
SynchronousRequestHandler.handleCreate(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handlePatch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
QueryResponse |
SynchronousRequestHandler.handleQuery(Context context,
QueryRequest request,
Collection<ResourceResponse> resources)
Searches for all JSON resources matching a user specified set of
criteria.
|
ResourceResponse |
SynchronousRequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
SynchronousRequestHandler.handleUpdate(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
Connection.patch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractConnectionWrapper.patch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractAsynchronousConnection.patch(Context context,
PatchRequest request) |
QueryResponse |
Connection.query(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(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(Context context,
QueryRequest request,
Collection<? super ResourceResponse> results) |
QueryResponse |
Connection.query(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(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(Context context,
QueryRequest request,
QueryResourceHandler handler) |
ResourceResponse |
Connection.read(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.read(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.read(Context context,
ReadRequest request) |
ResourceResponse |
Connection.update(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractConnectionWrapper.update(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractAsynchronousConnection.update(Context context,
UpdateRequest request) |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
DeviceCollectionProviderV1.create(Context context,
CreateRequest request)
Performs a create operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
UserCollectionProviderV1.create(Context context,
CreateRequest request)
Performs a create operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
DeviceCollectionProviderV1.delete(Context context,
String id,
DeleteRequest request)
Performs a delete operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
UserCollectionProviderV1.delete(Context context,
String id,
DeleteRequest request)
Performs a delete operation on the resource.
|
Promise<ActionResponse,ResourceException> |
DeviceCollectionProviderV1.markStolen(Context context,
String id,
ActionRequest request)
Performs a mark as stolen action operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
DeviceCollectionProviderV1.patch(Context context,
String id,
PatchRequest request)
Performs a patch operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
UserCollectionProviderV1.patch(Context context,
String id,
PatchRequest request)
Performs a patch operation on the resource.
|
Promise<QueryResponse,ResourceException> |
DeviceCollectionProviderV1.query(Context context,
QueryRequest request,
QueryResourceHandler handler)
Performs a query operation on the resource.
|
Promise<QueryResponse,ResourceException> |
UserCollectionProviderV1.query(Context context,
QueryRequest request,
QueryResourceHandler handler)
Performs a query operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
DeviceCollectionProviderV1.read(Context context,
String id,
ReadRequest request)
Performs a read operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
UserCollectionProviderV1.read(Context context,
String id,
ReadRequest request)
Performs a read operation on the resource.
|
Promise<ActionResponse,ResourceException> |
UserCollectionProviderV1.resetPasswd(Context context,
String id,
ActionRequest request)
Performs a mark as stolen action operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
DeviceCollectionProviderV1.update(Context context,
String id,
UpdateRequest request)
Performs an update operation on the resource.
|
Promise<ResourceResponse,ResourceException> |
UserCollectionProviderV1.update(Context context,
String id,
UpdateRequest request)
Performs an update operation on the resource.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
DeviceCollectionProviderV2.rollOutDevice(Context context,
String id,
ActionRequest request)
Performs a roll out device action operation on the resource.
|
Modifier and Type | Method and Description |
---|---|
static void |
VersionedResourcesDemo.main(String... args)
Main application.
|
static void |
SimpleRealmDemo.main(String... args)
Main application.
|
static void |
DynamicRealmDemo.main(String... args)
Main application.
|
static void |
AsyncReadModifyWriteDemo.main(String[] args)
Main method.
|
static void |
ReadModifyWriteDemo.main(String[] args)
Main method.
|
Modifier and Type | Method and Description |
---|---|
SecurityContext |
SecurityContextFactory.createContext(Context parent)
Deprecated.
Creates a new
SecurityContext using the attributes contained in
the provided HTTP request. |
SecurityContext |
SecurityContextFactory.createContext(Context context,
Request request)
Deprecated.
Creates a new
SecurityContext using the attributes contained in
the provided HTTP request. |
Context |
HttpContextFactory.createContext(Context parent,
Request request)
Returns the context which should be used for the provided HTTP request.
|
static RequestType |
HttpUtils.determineRequestType(Request request)
Determines which CREST operation (CRUDPAQ) of the incoming request.
|
Modifier and Type | Method and Description |
---|---|
static ResourceException |
Utils.adapt(Throwable t)
Adapts a
Throwable to a ResourceException . |
Modifier and Type | Method and Description |
---|---|
static Object |
Utils.evaluateScript(Context context,
org.apache.commons.lang3.tuple.Pair<JsonPointer,ScriptEntry> scriptPair)
Executes the given script with the appropriate context information.
|
Modifier and Type | Method and Description |
---|---|
ResourceException |
ScriptThrownException.toResourceException(int defaultCode,
String defaultMsg)
Converts the script exception to an appropriate json resource exception.
|
Modifier and Type | Method and Description |
---|---|
R |
Function.call(Parameter scope,
Function<?> callback,
Object... arguments)
Computes a result, or throws an exception if unable to do so.
|
Context |
Parameter.getContext(Context savedContext)
Returns the Context assigned with the current
Request
from the saved context data. |
Context |
OperationParameter.getContext(Context savedContext)
Returns the internal context.
|
Modifier and Type | Method and Description |
---|---|
StageResponse |
ProgressStage.advance(ProcessContext context,
C config)
Advance the progress stage.
|
JsonValue |
ProgressStage.gatherInitialRequirements(ProcessContext context,
C config)
Response for defining any initial requirements the stage may have.
|
Modifier and Type | Method and Description |
---|---|
String |
SnapshotTokenHandler.generate(JsonValue state)
Generates a new snapshot token using the state.
|
void |
SnapshotTokenCallback.snapshotTokenPreview(ProcessContext context,
String snapshotToken)
Preview of the snapshot token just prior to requirements being sent to the client.
|
void |
SnapshotTokenHandler.validate(String snapshotToken)
Validates the passed snapshot token.
|
JsonValue |
SnapshotTokenHandler.validateAndExtractState(String snapshotToken)
Validates and parses the token, extracting any encapsulated state.
|
Modifier and Type | Method and Description |
---|---|
StageResponse |
MathProblemStage.advance(ProcessContext context,
MathProblemStageConfig config) |
JsonValue |
MathProblemStage.gatherInitialRequirements(ProcessContext context,
MathProblemStageConfig config) |
Modifier and Type | Method and Description |
---|---|
StageResponse |
CaptchaStage.advance(ProcessContext context,
CaptchaStageConfig config) |
JsonValue |
CaptchaStage.gatherInitialRequirements(ProcessContext context,
CaptchaStageConfig config) |
Modifier and Type | Method and Description |
---|---|
StageResponse |
VerifyEmailAccountStage.advance(ProcessContext context,
VerifyEmailAccountConfig config) |
Modifier and Type | Method and Description |
---|---|
StageResponse |
SecurityAnswerDefinitionStage.advance(ProcessContext context,
SecurityAnswerDefinitionConfig config) |
StageResponse |
SecurityAnswerVerificationStage.advance(ProcessContext context,
SecurityAnswerVerificationConfig config) |
JsonValue |
SecurityAnswerDefinitionStage.gatherInitialRequirements(ProcessContext context,
SecurityAnswerDefinitionConfig config) |
JsonValue |
SecurityAnswerVerificationStage.gatherInitialRequirements(ProcessContext context,
SecurityAnswerVerificationConfig config) |
Modifier and Type | Method and Description |
---|---|
StageResponse |
UserRegistrationStage.advance(ProcessContext context,
UserRegistrationConfig config) |
JsonValue |
UserRegistrationStage.gatherInitialRequirements(ProcessContext context,
UserRegistrationConfig config) |
Modifier and Type | Method and Description |
---|---|
StageResponse |
ResetStage.advance(ProcessContext context,
ResetStageConfig config) |
JsonValue |
ResetStage.gatherInitialRequirements(ProcessContext context,
ResetStageConfig config) |
Modifier and Type | Method and Description |
---|---|
StageResponse |
TermsAndConditionsStage.advance(ProcessContext context,
TermsAndConditionsConfig config) |
Modifier and Type | Method and Description |
---|---|
String |
JwtTokenHandler.generate(JsonValue state) |
void |
JwtTokenHandler.validate(String snapshotToken) |
JsonValue |
JwtTokenHandler.validateAndExtractState(String snapshotToken) |
Modifier and Type | Method and Description |
---|---|
StageResponse |
EmailUsernameStage.advance(ProcessContext context,
EmailUsernameConfig config) |
StageResponse |
RetrieveUsernameStage.advance(ProcessContext context,
RetrieveUsernameConfig config) |
StageResponse |
UserDetailsStage.advance(ProcessContext context,
UserDetailsConfig config) |
StageResponse |
UserQueryStage.advance(ProcessContext context,
UserQueryConfig config) |
JsonValue |
EmailUsernameStage.gatherInitialRequirements(ProcessContext context,
EmailUsernameConfig config) |
JsonValue |
RetrieveUsernameStage.gatherInitialRequirements(ProcessContext context,
RetrieveUsernameConfig config) |
JsonValue |
UserDetailsStage.gatherInitialRequirements(ProcessContext context,
UserDetailsConfig config) |
JsonValue |
UserQueryStage.gatherInitialRequirements(ProcessContext context,
UserQueryConfig config) |
Copyright © 2025 Open Identity Platform Community. All rights reserved.