Package | Description |
---|---|
org.forgerock.audit |
Package contains the AuditService.
|
org.forgerock.audit.events |
Package contains audit events.
|
org.forgerock.audit.events.handlers |
This package contains the default
AuditEventHandlers . |
org.forgerock.audit.handlers.csv |
This package contains the default AuditEventHandler implementations.
|
org.forgerock.audit.handlers.elasticsearch |
This package contains the Elasticsearch
AuditEventHandler implementation. |
org.forgerock.audit.handlers.jdbc |
This package contains a JDBC AuditEventHandler implementation.
|
org.forgerock.audit.handlers.jms |
This package contains a JMS AuditEventHandler implementation.
|
org.forgerock.audit.handlers.json |
This package contains the JSON-file
AuditEventHandler implementation. |
org.forgerock.audit.handlers.splunk |
This package contains the audit handler implementation for Splunk.
|
org.forgerock.audit.handlers.syslog |
This package contains a Syslog AuditEventHandler implementation.
|
org.forgerock.http |
Models and manages elements of the Hypertext Transfer Protocol.
|
org.forgerock.http.filter |
Core
Filter implementations. |
org.forgerock.http.filter.throttling |
This package contains the components used to implement a throttling rate support.
|
org.forgerock.http.handler |
Core
Handler implementations. |
org.forgerock.http.oauth2 |
This package provides APIs for OAuth 2.0 services implementations.
|
org.forgerock.http.oauth2.resolver |
This package defines OpenAM specific logic needed to retrieve an
AccessTokenInfo . |
org.forgerock.http.routing |
Provides routing functionality for HTTP requests.
|
org.forgerock.http.session |
Provides interfaces for managing and interacting with HTTP Sessions.
|
org.forgerock.http.swagger |
Classes to support OpenAPI API Descriptions using Swagger.
|
org.forgerock.json.resource |
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
|
org.forgerock.json.resource.http |
JSON resource Commons HTTP Framework integration.
|
org.forgerock.monitoring |
Common utility classes for monitoring.
|
org.forgerock.monitoring.http |
Common utility classes for monitoring.
|
org.forgerock.openig.doc |
Files for the Sample Application used in the product documentation.
|
org.forgerock.openig.el |
Integrates with the Java Enterprise Edition Unified Expression Language API.
|
org.forgerock.openig.filter |
Filters the requests and/or responses of HTTP.
|
org.forgerock.openig.filter.oauth2 |
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
|
org.forgerock.openig.filter.oauth2.client |
OAuth 2.0 Client filter implementation.
|
org.forgerock.openig.filter.throttling |
This package contains the components used to implement a throttling rate support.
|
org.forgerock.openig.handler |
Handles HTTP requests by generating responses.
|
org.forgerock.openig.handler.resources |
Contains components and APIs used to serve static resources.
|
org.forgerock.openig.handler.router |
Provides automated router capability that loads its configurations files (called routes) from a given directory.
|
org.forgerock.openig.handler.saml |
Identity Gateway SAML support.
|
org.forgerock.openig.http |
Integrates with the ForgeRock HTTP Framework.
|
org.forgerock.openig.ldap |
Facilitates access to the OpenDJ LDAP SDK from within scripts.
|
org.forgerock.openig.openam |
Integration classes specifically for ForgeRock Access Management.
|
org.forgerock.openig.script |
Scripting support.
|
org.forgerock.openig.tools |
Common tools used in policy service.
|
org.forgerock.openig.tools.authentication |
AM authentication service.
|
org.forgerock.openig.tools.authentication.chf |
HTTP-based authentication service.
|
org.forgerock.openig.tools.session |
This package contains classes to call AM to retrieve user's session info.
|
org.forgerock.openig.tools.userprofile |
This package contains classes to call AM to retrieve user's profile info.
|
org.forgerock.openig.ui.record |
Defines a storage service to be used by the UI to persist its component model.
|
org.forgerock.openig.uma |
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
|
org.forgerock.openig.websocket |
WebSocket proxy support.
|
org.forgerock.services.context |
This package contains the
Context interface and various common protocol
independent implementations. |
org.forgerock.services.descriptor |
Classes that allow services to be described.
|
org.forgerock.services.routing |
This package provides a simple framework for implementing routers.
|
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<ActionResponse,ResourceException> |
JsonAuditEventHandler.handleAction(Context context,
String topic,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
JsonAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
JsonAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
JsonAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
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 |
---|---|
Context |
ContextAndRequest.getContext()
Returns the context.
|
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. |
Promise<Response,NeverThrowsException> |
Client.sendWithoutClose(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)
|
ContextAndRequest(Context context,
Request request)
Constructs a new ContextAndRequest.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ConditionalFilter.filter(Context context,
Request request,
Handler next) |
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 . |
Promise<Response,NeverThrowsException> |
CsrfFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ThrottlingFilter.filter(Context context,
Request request,
Handler next) |
Promise<ThrottlingRate,Exception> |
ThrottlingPolicy.lookup(Context context,
Request request)
Returns the
ThrottlingRate that should be used for the provided request. |
Promise<ThrottlingRate,Exception> |
MappedThrottlingPolicy.lookup(Context context,
Request request) |
Promise<ThrottlingRate,Exception> |
FixedRateThrottlingPolicy.lookup(Context context,
Request request) |
Promise<ThrottlingRate,Exception> |
DefaultRateThrottlingPolicy.lookup(Context context,
Request request) |
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) |
Promise<Set<String>,ResponseException> |
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> |
TokenIntrospectionAccessTokenResolver.resolve(Context context,
String token) |
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 | 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) |
protected io.swagger.models.Swagger |
OpenApiRequestFilter.setUriDetailsIfNotPresent(Request request,
Context context,
io.swagger.models.Swagger descriptor)
Deduce and set the base URI of the request for the OpenAPI descriptor from the request context.
|
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. |
default Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
default 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. |
default 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. |
default 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. |
default 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) |
default 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) |
org.forgerock.api.models.ApiDescription |
Router.handleApiRequest(Context context,
Request request) |
org.forgerock.api.models.ApiDescription |
FilterChain.handleApiRequest(Context context,
Request request) |
org.forgerock.api.models.ApiDescription |
DescribedSyncRequestHandlerAdapter.handleApiRequest(Context context,
Request request) |
org.forgerock.api.models.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) |
default 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) |
ResourceResponse |
SynchronousRequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
Router.handleDelete(Context context,
DeleteRequest request) |
default 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) |
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) |
default 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) |
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) |
default 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) |
ResourceResponse |
SynchronousRequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
Router.handleRead(Context context,
ReadRequest request) |
default 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) |
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) |
default 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) |
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.
|
default 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. |
default 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. |
default 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.
|
default 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. |
default 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. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.updateInstance(Context context,
String resourceId,
UpdateRequest request)
Updates an existing resource within the collection. |
default 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 | 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 | Method and Description |
---|---|
Promise<QueryResponse,ResourceException> |
DropwizardMetricsCollectionResourceProvider.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
DropwizardMetricsCollectionResourceProvider.readInstance(Context context,
String resourceId,
ReadRequest request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
PrometheusHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
SampleFilter.filter(Context context,
Request request,
Handler next)
Set a header in the incoming request and in the outgoing response.
|
Modifier and Type | Method and Description |
---|---|
static Map<String,Context> |
Bindings.flatten(Context leaf)
Flatten the current
leaf Context into a Map keyed by context name. |
Modifier and Type | Method and Description |
---|---|
static Bindings |
Bindings.bindings(Context context)
|
static Bindings |
Bindings.bindings(Context context,
Request request)
|
static Bindings |
Bindings.bindings(Context context,
Request request,
Response response)
|
static Map<String,Context> |
Bindings.flatten(Context leaf)
Flatten the current
leaf Context into a Map keyed by context name. |
Modifier and Type | Class and Description |
---|---|
class |
JwtBuilderContext
Used by the
JwtBuilderFilter to make the JWT available in the context. |
Modifier and Type | Method and Description |
---|---|
Promise<Set<String>,ResponseException> |
ScriptableResourceAccess.getRequiredScopes(Context context,
Request request) |
Promise<AccessTokenInfo,AccessTokenException> |
StatelessAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
ScriptableAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
ConfirmationKeyVerifierAccessTokenResolver.resolve(Context context,
String token) |
Promise<Result,NeverThrowsException> |
ConfirmationKeyVerifier.verify(Context context,
AccessTokenInfo tokenInfo,
JsonValue cnfKey)
Verifies the given confirmation key value.
|
Promise<Result,NeverThrowsException> |
CertificateThumbprintConfirmationKeyVerifier.verify(Context context,
AccessTokenInfo tokenInfo,
JsonValue cnfKey) |
Modifier and Type | Class and Description |
---|---|
class |
OAuth2SessionContext
This context helps to manage the
OAuth2Session when used with OAuth2ClientFilter . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
OAuth2ClientFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
DiscoveryFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
ClientRegistrationFilter.filter(Context context,
Request request,
Handler next) |
Promise<JsonValue,OAuth2ErrorException> |
ClientRegistration.getAccessToken(Context context,
String code,
String callbackUri)
Exchanges the authorization code for an access token and optional ID
token, and then update the session state.
|
Promise<JsonValue,OAuth2ErrorException> |
ClientRegistration.getUserInfo(Context context,
org.forgerock.openig.filter.oauth2.client.OAuth2Session session)
Returns a Promise completed either with the json value of the user info obtained from the authorization
server if the response from the authorization server has a status code of 200, or with an exception, meaning the
access token may have expired.
|
Promise<JsonValue,OAuth2ErrorException> |
ClientRegistration.refreshAccessToken(Context context,
org.forgerock.openig.filter.oauth2.client.OAuth2Session session)
Refreshes the actual access token, making a refresh request to the token
end-point.
|
Modifier and Type | Method and Description |
---|---|
Promise<ThrottlingRate,Exception> |
ScriptableThrottlingPolicy.lookup(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
WelcomeHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
StaticResponseHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
SequenceHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ScriptableHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ReverseProxyHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
DispatchHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
DesKeyGenHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ClientHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
RouterHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
SamlFederationHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
ServerInfoSingletonProvider.actionInstance(Context context,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
ServerInfoSingletonProvider.patchInstance(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
ServerInfoSingletonProvider.readInstance(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
ServerInfoSingletonProvider.updateInstance(Context context,
UpdateRequest request) |
Modifier and Type | Method and Description |
---|---|
static Options |
LdapClient.defaultOptions(Context context)
Setup the default options to create a LdapClient and adds the transactionId if any in the context's chain.
|
Modifier and Type | Class and Description |
---|---|
class |
CapturedUserPasswordContext
A
CapturedUserPasswordContext to store the user's decrypted password. |
class |
CdSsoContext
Context implementation to maintain cross-domain SSO properties. |
class |
CdSsoFailureContext
Context implementation to hold error details, should an error occur during cross-domain SSO authentication. |
class |
PolicyDecisionContext
A
PolicyDecisionContext convey policy decision information to downstream filters and handlers. |
class |
SessionInfoContext
Context to store Access Management session info and properties. |
class |
SsoTokenContext
An
SsoTokenContext could be used to store and retrieve an token. |
class |
StsContext
A
StsContext convey the token transformation results to downstream filters and handlers. |
class |
UserProfileContext
Used by the
UserProfileFilter to make the user's profile attributes available in the context. |
Modifier and Type | Method and Description |
---|---|
protected Promise<Response,NeverThrowsException> |
CdSsoConditionAdviceFilter.doRedirect(Context context,
Request request,
Handler next,
List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices) |
protected abstract Promise<Response,NeverThrowsException> |
AbstractConditionAdviceFilter.doRedirect(Context context,
Request request,
Handler next,
List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices)
Handle redirect to the
instance to verify the required advices. |
Promise<Response,NeverThrowsException> |
UserProfileFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TokenTransformationFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SingleSignOnFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SessionInfoFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
PolicyEnforcementFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
DeprecatedUserProfileFilter.filter(Context context,
Request request,
Handler next)
Deprecated.
|
Promise<Response,NeverThrowsException> |
CrossDomainSingleSignOnFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
CapturedUserPasswordFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
AbstractConditionAdviceFilter.filter(Context context,
Request request,
Handler next) |
static SsoTokenContext |
SsoTokenContext.fromSessionInfo(Context parent,
SessionInfo sessionInfo,
String loginEndpoint)
Create a
SsoTokenContext from a SessionInfo and SSO token. |
String |
ScriptableResourceUriProvider.resourceUri(Context context,
Request request) |
String |
ResourceUriProvider.resourceUri(Context context,
Request request)
Returns the resource URI as a
String to be used when making policy requests. |
String |
RequestResourceUriProvider.resourceUri(Context context,
Request request) |
Constructor and Description |
---|
CdSsoContext(Context parent,
String token,
JwtClaimsSet claimsSet,
String redirectEndpoint,
CookieBuilder cookieBuilder)
Create
CdSsoContext for supplied JWT. |
SsoTokenContext(Context parent,
JsonValue info,
String token,
String loginEndpoint)
Creates a new
SsoTokenContext context with the provided token
and additional validation information such as 'realm', 'uid' and 'authModule'. |
Modifier and Type | Method and Description |
---|---|
protected Promise<V,ScriptException> |
AbstractScriptableHeapObject.runScript(Bindings bindings,
Context context,
Class<V> clazz)
Runs the compiled script using the provided bindings.
|
Modifier and Type | Class and Description |
---|---|
class |
InternalSsoTokenContext
An
InternalSsoTokenContext used to store an SSO token. |
Constructor and Description |
---|
InternalSsoTokenContext(Context parent,
String token)
Creates a new
InternalSsoTokenContext context with the provided token. |
Modifier and Type | Method and Description |
---|---|
Promise<SsoToken,AuthenticationException> |
AuthenticationService.authenticate(Context context,
String username,
char[] password)
Authenticates a subject (identified with the given
username and password credentials),
returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException
on failures (I/O, invalid credentials, ...). |
Modifier and Type | Method and Description |
---|---|
Promise<SsoToken,AuthenticationException> |
DefaultAuthenticationService.authenticate(Context context,
String username,
char[] password) |
Promise<V,E> |
AsyncRefreshableSupplier.get(Context context)
Computes (or re-computes) the value in a thread-safe manner, making sure that only 1 thread
will compute the value, the other being blocked, waiting for the result to be computed.
|
Promise<V,E> |
AsyncRefreshableSupplier.refresh(Context context)
Refresh (and returns) the value, in a thread-safe manner.
|
Constructor and Description |
---|
AsyncRefreshableSupplier(AsyncFunction<Context,V,E> compute)
Creates a provider ensuring "only-once" invocation of the given compute function.
|
Modifier and Type | Method and Description |
---|---|
Promise<Optional<SessionInfo>,SessionException> |
SessionService.getSessionInfo(Context context,
String ssoToken)
Returns a promise that will be completed with an optional
SessionInfo or with an SessionException
in case of errors. |
Promise<Optional<SessionInfo>,SessionException> |
CrestSessionService.getSessionInfo(Context context,
String ssoToken) |
Promise<Optional<SessionInfo>,SessionException> |
CacheSessionService.getSessionInfo(Context context,
String ssoToken) |
Promise<Void,SessionException> |
SessionService.logout(Context context,
String ssoToken)
Returns a promise that will be completed with a
Void or with an SessionException in case
of errors. |
Promise<Void,SessionException> |
CrestSessionService.logout(Context context,
String ssoToken) |
Promise<Void,SessionException> |
CacheSessionService.logout(Context context,
String ssoToken) |
Modifier and Type | Method and Description |
---|---|
Promise<UserProfile,UserProfileException> |
UserProfileService.getUserProfile(Context context,
String username)
Returns a promise that will be completed with an
UserProfile or with an UserProfileException
in case of errors. |
Promise<UserProfile,UserProfileException> |
CrestUserProfileService.getUserProfile(Context context,
String username) |
Promise<UserProfile,UserProfileException> |
CacheUserProfileService.getUserProfile(Context context,
String username) |
Modifier and Type | Method and Description |
---|---|
Promise<org.forgerock.openig.uma.Share,UmaException> |
UmaSharingService.createShare(Context context,
String resourcePath,
String pat)
Creates a Share that will be used to protect the given
resourcePath . |
Promise<Response,NeverThrowsException> |
UmaResourceServerFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
WebSocketProxyFilter.filter(Context context,
Request request,
Handler next) |
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,
Clock clock)
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.getBestApiRoute(Context context,
R request)
Get the best route for an API 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.
|
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.getBestApiRoute(Context context,
R request)
Get the best route for an API 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 2011-2017 ForgeRock AS.