Modifier and Type | Class and Description |
---|---|
class |
AuditingContext
A Context used when auditing over the router.
|
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.
|
Constructor and Description |
---|
AuditingContext(Context parent)
Construct a new audit context with the provided parent.
|
Modifier and Type | Method and Description |
---|---|
T |
AccessAuditEventBuilder.clientFromContext(Context context)
Sets client ip, port and host from
ClientContext , if the provided
Context contains a ClientContext . |
T |
AccessAuditEventBuilder.forContext(Context context)
Sets common fields from services contexts.
|
T |
AccessAuditEventBuilder.forHttpRequest(Context context,
Request request)
Sets common fields from CREST contexts and request.
|
T |
AccessAuditEventBuilder.httpFromContext(Context context)
Sets HTTP method, path, queryString and headers from
HttpContext , if the provided
Context contains a HttpContext . |
T |
AccessAuditEventBuilder.serverFromContext(Context context)
Sets the server fields for the event, if the provided
Context contains a ClientContext .. |
T |
AuditEventBuilder.transactionIdFromContext(Context context)
Sets transactionId from ID of
TransactionIdContext , if the provided
Context contains a TransactionIdContext . |
Modifier and Type | Method and Description |
---|---|
Context |
AuditEventTopicState.getContext()
Returns the context that triggered the event.
|
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.
|
Constructor and Description |
---|
AuditEventTopicState(Context context,
String topic,
JsonValue event)
Creates a (topic,event) pair.
|
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 |
---|---|
Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
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 |
---|---|
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 |
---|---|
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 |
---|---|
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 |
---|---|
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 |
---|---|
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 | Interface and Description |
---|---|
interface |
MessageContext
The authentication framework uses this
MessageContext to pass messages and message
processing state to authentication contexts for processing by authentication modules. |
interface |
MessageInfoContext
The authentication framework uses this
MessageContextInfo to pass messages and
message processing state to authentication modules for processing of messages. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
AuthenticationFilter.filter(Context context,
Request request,
Handler next)
Authenticates incoming request messages and if successful calls the downstream filter or
handler and then secures the returned response.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ProtectedResource.handle(Context context,
Request request)
Sets a header, "RESOURCE_CALLED:true" on the response to signify that it has been called and write a JSON
string to the response containing the principal and context from the request attributes.
|
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 |
---|---|
Promise<Response,NeverThrowsException> |
Filter.filter(Context context,
Request request,
Handler next)
Filters the request and/or response of an exchange.
|
Promise<Response,NeverThrowsException> |
Handler.handle(Context context,
Request request)
|
Promise<Response,NeverThrowsException> |
Client.send(Context context,
Request request)
Sends an HTTP request and returns a
Promise representing the
pending HTTP response. |
Constructor and Description |
---|
Client(Handler handler,
Context defaultContext)
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
DescribedOauth2Endpoint.handle(Context context,
Request request) |
io.swagger.models.Swagger |
DescribedOauth2Endpoint.handleApiRequest(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
TransactionIdOutboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TransactionIdInboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
OptionsFilter.filter(Context context,
Request request,
Handler next)
Handles all OPTION requests to CREST resources, all other request methods are handled by the
Handler . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
HttpClientHandler.handle(Context context,
Request request)
Sends an HTTP request to a remote server and returns a
Promise
representing the asynchronous response. |
Modifier and Type | Class and Description |
---|---|
class |
OAuth2Context
An
OAuth2Context could be used to store and retrieve an AccessTokenInfo . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceServerFilter.filter(Context context,
Request request,
Handler next) |
Set<String> |
ResourceAccess.getRequiredScopes(Context context,
Request request)
Returns the scopes required to access the resource.
|
Promise<AccessTokenInfo,AccessTokenException> |
AccessTokenResolver.resolve(Context context,
String token)
Resolves a given access token against an authorization server.
|
Constructor and Description |
---|
OAuth2Context(Context parent,
AccessTokenInfo accessToken)
Creates a new OAuth2 context with the provided
AccessTokenInfo . |
Modifier and Type | Method and Description |
---|---|
Promise<AccessTokenInfo,AccessTokenException> |
OpenAmAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
CachingAccessTokenResolver.resolve(Context context,
String token) |
Modifier and Type | Class and Description |
---|---|
class |
ApiVersionRouterContext
A
Context which is created when a request is and has been routed
based on resource API version. |
class |
UriRouterContext
A
Context which is created when a request has been routed. |
Modifier and Type | Method and Description |
---|---|
protected ApiVersionRouterContext |
ResourceApiVersionRoutingFilter.createApiVersionRouterContext(Context context)
Creates a
ApiVersionRouterContext using the default version
behaviour and whether to issue warnings from the
behaviourManager instance. |
Promise<Response,NeverThrowsException> |
ResourceApiVersionRoutingFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
Router.handle(Context context,
Request request) |
static UriRouterContext.Builder |
UriRouterContext.uriRouterContext(Context parent)
Return a builder for a new
UriRouterContext . |
Constructor and Description |
---|
ApiVersionRouterContext(Context parent,
DefaultVersionBehaviour defaultVersionBehaviour,
boolean warningEnabled)
Creates a new resource API version routing context having the provided
parent, default versioning behaviour and whether warnings will be
issued.
|
UriRouterContext(Context parent,
String matchedUri,
String remainingUri,
Map<String,String> uriTemplateVariables)
Creates a new routing context having the provided parent, URI template
variables, and an ID automatically generated using
UUID.randomUUID() . |
UriRouterContext(Context parent,
String matchedUri,
String remainingUri,
Map<String,String> uriTemplateVariables,
URI originalUri)
Creates a new routing context having the provided parent, URI template
variables, and an ID automatically generated using
UUID.randomUUID() . |
Modifier and Type | Method and Description |
---|---|
static ClientContext |
HttpFrameworkServlet.createClientContext(Context parent,
javax.servlet.http.HttpServletRequest req) |
UriRouterContext |
HttpFrameworkServlet.createRouterContext(Context parent,
javax.servlet.http.HttpServletRequest req,
Request request) |
Modifier and Type | Class and Description |
---|---|
class |
SessionContext
A
SessionContext is a mechanism for maintaining state between components when processing a successive
requests from the same logical client or end-user. |
Constructor and Description |
---|
SessionContext(Context parent,
Session session)
Constructs a new
SessionContext . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
OpenApiRequestFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
String |
WDSSO.process(Map<String,String> options,
Context context,
Request request)
Process the login attempt.
|
Modifier and Type | Class and Description |
---|---|
class |
AdviceContext
A
Context containing information which should be returned to the user in some
appropriate form to the user. |
Modifier and Type | Method and Description |
---|---|
protected Context |
AbstractConnectionWrapper.transform(Context context)
Optional Context-transformation function if the implementer has
requirements to override the
Context provided in the
Connection 's method invocations. |
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) |
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. |
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) |
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. |
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) |
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.
|
ActionResponse |
SynchronousRequestHandler.handleAction(Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
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.
|
ApiDescription |
Router.handleApiRequest(Context context,
Request request) |
ApiDescription |
FilterChain.handleApiRequest(Context context,
Request request) |
ApiDescription |
DescribedSyncRequestHandlerAdapter.handleApiRequest(Context context,
Request request) |
ApiDescription |
AbstractConnectionWrapper.handleApiRequest(Context context,
Request request) |
ResourceResponse |
SynchronousRequestHandler.handleCreate(Context context,
CreateRequest request)
Adds a new JSON resource.
|
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. |
ResourceResponse |
SynchronousRequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
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. |
ResourceResponse |
SynchronousRequestHandler.handlePatch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
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. |
QueryResponse |
SynchronousRequestHandler.handleQuery(Context context,
QueryRequest request,
Collection<ResourceResponse> resources)
Searches for all JSON resources matching a user specified set of
criteria.
|
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. |
ResourceResponse |
SynchronousRequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource.
|
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. |
ResourceResponse |
SynchronousRequestHandler.handleUpdate(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
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. |
boolean |
FilterCondition.matches(Context context,
Request request)
Returns
true if the conditional filter should be invoked, or
false if processing should continue directly to the next filter
in the filter chain. |
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) |
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. |
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) |
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. |
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) |
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. |
protected Context |
AbstractConnectionWrapper.transform(Context context)
Optional Context-transformation function if the implementer has
requirements to override the
Context provided in the
Connection 's method invocations. |
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) |
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. |
Constructor and Description |
---|
AdviceContext(Context parent,
Collection<String> restrictedAdviceNames)
Creates a new AdviceContext with the provided parent.
|
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 | Class and Description |
---|---|
class |
HttpContext
A
Context containing information relating to the originating HTTP request. |
Modifier and Type | Method and Description |
---|---|
Context |
HttpContextFactory.createContext(Context parent,
Request request)
Returns the context which should be used for the provided HTTP request.
|
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 Handler |
CrestHttp.newHttpHandler(ConnectionFactory connectionFactory,
Context parentContext)
Deprecated.
Use
CrestHttp.newHttpHandler(CrestApplication) instead. |
static Handler |
CrestHttp.newHttpHandler(CrestApplication application,
Context context)
Creates a new JSON resource HTTP handler with the provided CREST request handler.
|
Modifier and Type | Class and Description |
---|---|
class |
ScriptContext
A context to wrap the calling context when entering a script.
|
Modifier and Type | Method and Description |
---|---|
Script |
ScriptEntry.getScript(Context context)
Get a new Non-ThreadSafe Script instance.
|
Bindings |
ScriptEntry.getScriptBindings(Context context,
Bindings request)
Get a JSR223 Script Engine aware binding.
|
Constructor and Description |
---|
ScriptContext(Context parent,
String name,
String type,
String revision) |
Modifier and Type | Method and Description |
---|---|
Bindings |
ScriptEngine.compileBindings(Context context,
Bindings request,
Bindings... value)
Visits a function instance.
|
Object |
ScriptEngine.compileObject(Context context,
Object value)
Visits a function instance.
|
Object |
AbstractScriptEngine.compileObject(Context context,
Object value)
{@inheritDoc
|
Object |
CompiledScript.eval(Context context,
Bindings request,
Bindings... scopes)
Evaluated the script stored in this
CompiledScript object. |
static Object |
Utils.evaluateScript(Context context,
org.apache.commons.lang3.tuple.Pair<JsonPointer,ScriptEntry> scriptPair)
Executes the given script with the appropriate context information.
|
Bindings |
CompiledScript.prepareBindings(Context context,
Bindings request,
Bindings... scopes) |
Modifier and Type | Method and Description |
---|---|
Bindings |
GroovyScriptEngineImpl.compileBindings(Context context,
Bindings request,
Bindings... value) |
Object |
GroovyScript.eval(Context context,
Bindings request,
Bindings... scopes) |
Bindings |
GroovyScript.prepareBindings(Context context,
Bindings request,
Bindings... scopes) |
Modifier and Type | Method and Description |
---|---|
Bindings |
RhinoScriptEngine.compileBindings(Context context,
Bindings request,
Bindings... value) |
Object |
RhinoScript.eval(Context ctx,
Bindings request,
Bindings... scopes) |
OperationParameter |
RhinoScriptEngine.getOperationParameter(Context context) |
Bindings |
RhinoScript.prepareBindings(Context context,
Bindings request,
Bindings... scopes) |
Modifier and Type | Field and Description |
---|---|
protected Context |
OperationParameter.context |
Modifier and Type | Method and Description |
---|---|
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 |
---|---|
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.
|
Constructor and Description |
---|
OperationParameter(Context context) |
Modifier and Type | Class and Description |
---|---|
class |
SelfServiceContext
A Context that indicates the request came from Self-Service.
|
Modifier and Type | Method and Description |
---|---|
Context |
ProcessContext.getRequestContext()
Gets the request context.
|
Constructor and Description |
---|
SelfServiceContext(Context parent)
Constructs a new SelfServiceContext.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractContext
A base implementation of the
Context interface. |
class |
AttributesContext
An
AttributesContext is a mechanism for transferring transient state between components when processing a
single request. |
class |
ClientContext
Client context gives easy access to client-related information that are available into the request.
|
class |
RequestAuditContext
A context for audit information for an incoming request.
|
class |
RootContext
A
Context which has an a globally unique ID but no parent. |
class |
SecurityContext
A
Context containing information about the client performing the
request which may be used when performing authorization decisions. |
class |
TransactionIdContext
This context aims to hold the
TransactionId . |
Modifier and Type | Method and Description |
---|---|
<T extends Context> |
Context.asContext(Class<T> clazz)
Returns the first context in the chain whose type is a sub-type of the
provided
Context class. |
<T extends Context> |
AbstractContext.asContext(Class<T> clazz) |
Modifier and Type | Method and Description |
---|---|
Context |
Context.getContext(String contextName)
Returns the first context in the chain whose context name matches the
provided name.
|
Context |
AbstractContext.getContext(String contextName) |
Context |
Context.getParent()
Returns the parent of this context.
|
Context |
AbstractContext.getParent() |
Modifier and Type | Method and Description |
---|---|
static ClientContext.Builder |
ClientContext.buildExternalClientContext(Context parent)
Creates a
ClientContext.Builder for creating an external ClientContext instance. |
static ClientContext |
ClientContext.newInternalClientContext(Context parent)
Creates an internal
ClientContext instance. |
Modifier and Type | Method and Description |
---|---|
boolean |
Context.containsContext(Class<? extends Context> clazz)
Returns
true if there is a context in the chain whose type is a
sub-type of the provided Context class. |
boolean |
AbstractContext.containsContext(Class<? extends Context> clazz) |
Constructor and Description |
---|
AbstractContext(Context parent,
String name)
Constructs a new
AbstractContext with a null id . |
AbstractContext(String id,
String name,
Context parent)
Constructs a new
AbstractContext . |
AttributesContext(Context parent)
Constructs a new
AttributesContext . |
RequestAuditContext(Context parent)
Constructs a new context using the specified parent and the current time as the request received time.
|
RequestAuditContext(Context parent,
TimeService time)
Constructs a new context using the specified parent and the current time as the request received time.
|
SecurityContext(Context parent,
String authenticationId,
Map<String,Object> authorization)
Creates a new security context having the provided parent and an ID
automatically generated using
UUID.randomUUID() . |
SecurityContext(String id,
Context parent,
String authenticationId,
Map<String,Object> authorization)
Creates a new security context having the provided ID, and parent.
|
TransactionIdContext(Context parent,
TransactionId transactionId)
Constructs a new TransactionIdContext.
|
Modifier and Type | Method and Description |
---|---|
D |
Describable.handleApiRequest(Context context,
R request)
Handle a request for the API Descriptor.
|
Modifier and Type | Method and Description |
---|---|
Context |
RouteMatch.decorateContext(Context context)
Decorates the given context with any routing information for the route.
|
Modifier and Type | Method and Description |
---|---|
protected Pair<Context,H> |
AbstractRouter.getBestRoute(Context context,
R request)
Finds the best route that matches the given request based on the route
matchers of the registered routes.
|
Modifier and Type | Method and Description |
---|---|
Context |
RouteMatch.decorateContext(Context context)
Decorates the given context with any routing information for the route.
|
abstract RouteMatch |
RouteMatcher.evaluate(Context context,
R request)
Evaluates the request and determines whether it matches the route.
|
RouteMatch |
DelegatingRouteMatcher.evaluate(Context context,
R request) |
protected Pair<Context,H> |
AbstractRouter.getBestRoute(Context context,
R request)
Finds the best route that matches the given request based on the route
matchers of the registered routes.
|
D |
AbstractRouter.handleApiRequest(Context context,
R request) |
Copyright © 2025 Open Identity Platform Community. All rights reserved.