Uses of Interface
org.forgerock.services.context.Context
-
Packages that use Context 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 defaultAuditEventHandlers
.org.forgerock.audit.handlers.csv This package contains the default AuditEventHandler implementations.org.forgerock.audit.handlers.elasticsearch This package contains the ElasticsearchAuditEventHandler
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-fileAuditEventHandler
implementation.org.forgerock.audit.handlers.json.stdout This package contains the JSON-stdoutAuditEventHandler
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 CoreFilter
implementations.org.forgerock.http.filter.cors Support for CORS.org.forgerock.http.handler CoreHandler
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 anAccessTokenInfo
.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.openig.audit Service Provider interface for registering audit events.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.allow Filters the HTTP request using a declarative configuration model based on a chain of predicates to validate.org.forgerock.openig.filter.circuitbreaker This package contains the components used to implement circuit breaking.org.forgerock.openig.filter.finance Support for financial APIs (Open Banking, PSD2, Berlin Group, ...).org.forgerock.openig.filter.jwt This package contains the components used to implement some JWT related filter.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.oauth2.cnf JWT confirmation key support for access tokens.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.assertion Handles identity assertion processing.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.openam.session AM Session idle timeout tracking.org.forgerock.openig.script Scripting support.org.forgerock.openig.sql Provides SQL and JDBC 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 theContext
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. -
-
Uses of Context in org.forgerock.audit
Classes in org.forgerock.audit that implement Context Modifier and Type Class Description class
AuditingContext
A Context used when auditing over the router.Methods in org.forgerock.audit with parameters of type Context Modifier and Type Method Description Promise<ActionResponse,ResourceException>
AuditService. handleAction(Context context, ActionRequest request)
Audit service may support actions on the service itself or on handlers.Promise<ActionResponse,ResourceException>
AuditServiceProxy. handleAction(Context context, ActionRequest request)
Promise<ResourceResponse,ResourceException>
AuditService. handleCreate(Context context, CreateRequest request)
Propagates the audit event to theAuditEventHandler
objects that have been registered for the audit event topic.Promise<ResourceResponse,ResourceException>
AuditServiceProxy. handleCreate(Context context, CreateRequest request)
Promise<ResourceResponse,ResourceException>
AuditService. handleDelete(Context context, DeleteRequest request)
Audit service does not support changing audit entries.Promise<ResourceResponse,ResourceException>
AuditServiceProxy. handleDelete(Context context, DeleteRequest request)
Promise<ResourceResponse,ResourceException>
AuditService. handlePatch(Context context, PatchRequest request)
Audit service does not support changing audit entries.Promise<ResourceResponse,ResourceException>
AuditServiceProxy. handlePatch(Context context, PatchRequest request)
Promise<QueryResponse,ResourceException>
AuditService. handleQuery(Context context, QueryRequest request, QueryResourceHandler handler)
Performs the query on the specified object and returns the associated results.Promise<QueryResponse,ResourceException>
AuditServiceProxy. handleQuery(Context context, QueryRequest request, QueryResourceHandler handler)
Promise<ResourceResponse,ResourceException>
AuditService. handleRead(Context context, ReadRequest request)
Gets an object from the audit logs by identifier.Promise<ResourceResponse,ResourceException>
AuditServiceProxy. handleRead(Context context, ReadRequest request)
Promise<ResourceResponse,ResourceException>
AuditService. handleUpdate(Context context, UpdateRequest request)
Audit service does not support changing audit entries.Promise<ResourceResponse,ResourceException>
AuditServiceProxy. handleUpdate(Context context, UpdateRequest request)
Constructors in org.forgerock.audit with parameters of type Context Constructor Description AuditingContext(Context parent)
Construct a new audit context with the provided parent. -
Uses of Context in org.forgerock.audit.events
Methods in org.forgerock.audit.events with parameters of type Context Modifier and Type Method Description T
AccessAuditEventBuilder. clientFromContext(Context context)
Sets client ip, port and host fromClientContext
, if the providedContext
contains aClientContext
.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 fromHttpContext
, if the providedContext
contains aHttpContext
.T
AccessAuditEventBuilder. serverFromContext(Context context)
Sets the server fields for the event, if the providedContext
contains aClientContext
..T
AuditEventBuilder. transactionIdFromContext(Context context)
Sets transactionId from ID ofTransactionIdContext
, if the providedContext
contains aTransactionIdContext
. -
Uses of Context in org.forgerock.audit.events.handlers
Methods in org.forgerock.audit.events.handlers that return Context Modifier and Type Method Description Context
AuditEventTopicState. getContext()
Returns the context that triggered the event.Methods in org.forgerock.audit.events.handlers with parameters of type Context Modifier and Type Method Description Promise<ActionResponse,ResourceException>
AuditEventHandler. handleAction(Context context, String topic, ActionRequest request)
Performs an action.Promise<ActionResponse,ResourceException>
AuditEventHandlerBase. handleAction(Context context, String topic, ActionRequest request)
Promise<ResourceResponse,ResourceException>
AuditEventHandler. publishEvent(Context context, String topic, JsonValue event)
Publishes an event to the provided topic.Promise<ResourceResponse,ResourceException>
NoOpAuditEventHandler. publishEvent(Context context, String topic, JsonValue event)
Promise<QueryResponse,ResourceException>
AuditEventHandler. queryEvents(Context context, String topic, QueryRequest query, QueryResourceHandler handler)
Query some events from the provided topic.Promise<QueryResponse,ResourceException>
NoOpAuditEventHandler. queryEvents(Context context, String topic, QueryRequest query, QueryResourceHandler handler)
Promise<ResourceResponse,ResourceException>
AuditEventHandler. readEvent(Context context, String topic, String resourceId)
Reads an event with the provided resource id from the provided topic.Promise<ResourceResponse,ResourceException>
NoOpAuditEventHandler. readEvent(Context context, String topic, String resourceId)
Constructors in org.forgerock.audit.events.handlers with parameters of type Context Constructor Description AuditEventTopicState(Context context, String topic, JsonValue event)
Creates a (topic,event) pair. -
Uses of Context in org.forgerock.audit.handlers.csv
Methods in org.forgerock.audit.handlers.csv with parameters of type Context Modifier and Type Method 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. -
Uses of Context in org.forgerock.audit.handlers.elasticsearch
Methods in org.forgerock.audit.handlers.elasticsearch with parameters of type Context Modifier and Type Method 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)
-
Uses of Context in org.forgerock.audit.handlers.jdbc
Methods in org.forgerock.audit.handlers.jdbc with parameters of type Context Modifier and Type Method 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)
-
Uses of Context in org.forgerock.audit.handlers.jms
Methods in org.forgerock.audit.handlers.jms with parameters of type Context Modifier and Type Method Description Promise<ResourceResponse,ResourceException>
JmsAuditEventHandler. publishEvent(Context context, String topic, JsonValue event)
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. -
Uses of Context in org.forgerock.audit.handlers.json
Methods in org.forgerock.audit.handlers.json with parameters of type Context Modifier and Type Method 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)
-
Uses of Context in org.forgerock.audit.handlers.json.stdout
Methods in org.forgerock.audit.handlers.json.stdout with parameters of type Context Modifier and Type Method Description Promise<ResourceResponse,ResourceException>
JsonStdoutAuditEventHandler. publishEvent(Context context, String topic, JsonValue event)
Promise<QueryResponse,ResourceException>
JsonStdoutAuditEventHandler. queryEvents(Context context, String topic, QueryRequest query, QueryResourceHandler handler)
Promise<ResourceResponse,ResourceException>
JsonStdoutAuditEventHandler. readEvent(Context context, String topic, String resourceId)
-
Uses of Context in org.forgerock.audit.handlers.splunk
Methods in org.forgerock.audit.handlers.splunk with parameters of type Context Modifier and Type Method 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)
-
Uses of Context in org.forgerock.audit.handlers.syslog
Methods in org.forgerock.audit.handlers.syslog with parameters of type Context Modifier and Type Method 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)
-
Uses of Context in org.forgerock.http
Methods in org.forgerock.http with parameters of type Context Modifier and Type Method 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 aPromise
representing the pending HTTP response.Promise<Response,NeverThrowsException>
Client. sendWithoutClose(Context context, Request request)
Sends an HTTP request and returns aPromise
representing the pending HTTP response.Constructors in org.forgerock.http with parameters of type Context Constructor Description Client(Handler handler, Context defaultContext)
-
Uses of Context in org.forgerock.http.filter
Methods in org.forgerock.http.filter with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
CsrfFilter. 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 theHandler
.Promise<Response,NeverThrowsException>
TransactionIdInboundFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
TransactionIdOutboundFilter. filter(Context context, Request request, Handler next)
Method parameters in org.forgerock.http.filter with type arguments of type Context Modifier and Type Method Description static Filter
Filters. conditionalFilter(Filter delegate, BiPredicate<Context,Request> condition)
Create a Filter decorator that only delegates to the decorated filter if the supplied predicate returns true. -
Uses of Context in org.forgerock.http.filter.cors
Methods in org.forgerock.http.filter.cors with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
CorsFilter. filter(Context context, Request request, Handler next)
Optional<CorsPolicy>
CorsPolicyProvider. findApplicable(Context context, String origin)
Returns an optional CORS policy applicable in thiscontext
, for the givenorigin
. -
Uses of Context in org.forgerock.http.handler
Methods in org.forgerock.http.handler with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
HttpClientHandler. handle(Context context, Request request)
Sends an HTTP request to a remote server and returns aPromise
representing the asynchronous response. -
Uses of Context in org.forgerock.http.oauth2
Classes in org.forgerock.http.oauth2 that implement Context Modifier and Type Class Description class
OAuth2Context
AnOAuth2Context
could be used to store and retrieve anAccessTokenInfo
.Methods in org.forgerock.http.oauth2 with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
ClientSecretBasicAuthenticationFilter. filter(Context context, Request request, Handler next)
Deprecated.Promise<Response,NeverThrowsException>
ClientSecretPostAuthenticationFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
PrivateKeyJwtClientAuthenticationFilter. filter(Context context, Request request, Handler next)
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.default Promise<AccessTokenInfo,AccessTokenException>
AccessTokenResolver. resolve(Context context, String token)
Deprecated, for removal: This API element is subject to removal in a future version.default Promise<AccessTokenInfo,AccessTokenException>
AccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
Resolves a given access token against an authorization server.Constructors in org.forgerock.http.oauth2 with parameters of type Context Constructor Description OAuth2Context(Context parent, AccessTokenInfo accessToken)
Creates a new OAuth2 context with the providedAccessTokenInfo
. -
Uses of Context in org.forgerock.http.oauth2.resolver
Methods in org.forgerock.http.oauth2.resolver with parameters of type Context Modifier and Type Method Description Promise<AccessTokenInfo,AccessTokenException>
CachingAccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
Promise<AccessTokenInfo,AccessTokenException>
OpenAmAccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
Deprecated.Promise<AccessTokenInfo,AccessTokenException>
TokenIntrospectionAccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
-
Uses of Context in org.forgerock.http.routing
Classes in org.forgerock.http.routing that implement Context Modifier and Type Class Description class
ApiVersionRouterContext
AContext
which is created when a request is and has been routed based on resource API version.class
UriRouterContext
AContext
which is created when a request has been routed.Methods in org.forgerock.http.routing with parameters of type Context Modifier and Type Method Description protected ApiVersionRouterContext
ResourceApiVersionRoutingFilter. createApiVersionRouterContext(Context context)
Creates aApiVersionRouterContext
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 newUriRouterContext
.Constructors in org.forgerock.http.routing with parameters of type Context Constructor 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 usingUUID.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 usingUUID.randomUUID()
. -
Uses of Context in org.forgerock.http.session
Classes in org.forgerock.http.session that implement Context Modifier and Type Class Description class
SessionContext
ASessionContext
is a mechanism for maintaining state between components when processing a successive requests from the same logical client or end-user.Constructors in org.forgerock.http.session with parameters of type Context Constructor Description SessionContext(Context parent, Session session)
Constructs a newSessionContext
. -
Uses of Context in org.forgerock.http.swagger
Methods in org.forgerock.http.swagger with parameters of type Context Modifier and Type Method 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. -
Uses of Context in org.forgerock.json.resource
Classes in org.forgerock.json.resource that implement Context Modifier and Type Class Description class
AdviceContext
AContext
containing information which should be returned to the user in some appropriate form to the user.Methods in org.forgerock.json.resource that return Context Modifier and Type Method Description protected Context
AbstractConnectionWrapper. transform(Context context)
Optional Context-transformation function if the implementer has requirements to override theContext
provided in theConnection
's method invocations.Methods in org.forgerock.json.resource with parameters of type Context Modifier and Type Method Description ActionResponse
AbstractAsynchronousConnection. action(Context context, ActionRequest request)
ActionResponse
AbstractConnectionWrapper. action(Context context, ActionRequest request)
Performs an action against a specific resource, or set of resources.ActionResponse
Connection. action(Context context, ActionRequest request)
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>
Connection. actionAsync(Context context, ActionRequest request)
Asynchronously performs an action against a specific resource, or set of resources.default Promise<ActionResponse,ResourceException>
CollectionResourceProvider. actionCollection(Context context, ActionRequest request)
Performs the providedaction
against the resource collection.Promise<ActionResponse,ResourceException>
MemoryBackend. actionCollection(Context context, ActionRequest request)
Performs the providedaction
against the resource collection.default Promise<ActionResponse,ResourceException>
CollectionResourceProvider. actionInstance(Context context, String resourceId, ActionRequest request)
Performs the providedaction
against a resource within the collection.Promise<ActionResponse,ResourceException>
MemoryBackend. actionInstance(Context context, String id, ActionRequest request)
Performs the providedaction
against a resource within the collection.default Promise<ActionResponse,ResourceException>
SingletonResourceProvider. actionInstance(Context context, ActionRequest request)
Performs the providedaction
against the single resource instance.ResourceResponse
AbstractAsynchronousConnection. create(Context context, CreateRequest request)
ResourceResponse
AbstractConnectionWrapper. create(Context context, CreateRequest request)
Adds a new JSON resource.ResourceResponse
Connection. create(Context context, CreateRequest request)
Adds a new JSON resource.Promise<ResourceResponse,ResourceException>
AbstractConnectionWrapper. createAsync(Context context, CreateRequest request)
Asynchronously adds a new JSON resource.Promise<ResourceResponse,ResourceException>
Connection. createAsync(Context context, CreateRequest request)
Asynchronously adds a new JSON resource.default Promise<ResourceResponse,ResourceException>
CollectionResourceProvider. createInstance(Context context, CreateRequest request)
Adds
a new resource instance to the collection.Promise<ResourceResponse,ResourceException>
MemoryBackend. createInstance(Context context, CreateRequest request)
Adds
a new resource instance to the collection.ResourceResponse
AbstractAsynchronousConnection. delete(Context context, DeleteRequest request)
ResourceResponse
AbstractConnectionWrapper. delete(Context context, DeleteRequest request)
Deletes a JSON resource.ResourceResponse
Connection. delete(Context context, DeleteRequest request)
Deletes a JSON resource.Promise<ResourceResponse,ResourceException>
AbstractConnectionWrapper. deleteAsync(Context context, DeleteRequest request)
Asynchronously deletes a JSON resource.Promise<ResourceResponse,ResourceException>
Connection. deleteAsync(Context context, DeleteRequest request)
Asynchronously deletes a JSON resource.default Promise<ResourceResponse,ResourceException>
CollectionResourceProvider. deleteInstance(Context context, String resourceId, DeleteRequest request)
Removes
a resource instance from the collection.Promise<ResourceResponse,ResourceException>
MemoryBackend. deleteInstance(Context context, String id, DeleteRequest request)
Removes
a resource instance from the collection.Promise<ActionResponse,ResourceException>
Filter. filterAction(Context context, ActionRequest request, RequestHandler next)
Filters an action request.Promise<ActionResponse,ResourceException>
ResourceApiVersionRoutingFilter. filterAction(Context context, ActionRequest request, RequestHandler next)
Promise<ActionResponse,ResourceException>
ResourceApiVersionSpecificationFilter. filterAction(Context context, ActionRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
Filter. filterCreate(Context context, CreateRequest request, RequestHandler next)
Filters a create request.Promise<ResourceResponse,ResourceException>
ResourceApiVersionRoutingFilter. filterCreate(Context context, CreateRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
ResourceApiVersionSpecificationFilter. filterCreate(Context context, CreateRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
Filter. filterDelete(Context context, DeleteRequest request, RequestHandler next)
Filters a delete request.Promise<ResourceResponse,ResourceException>
ResourceApiVersionRoutingFilter. filterDelete(Context context, DeleteRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
ResourceApiVersionSpecificationFilter. filterDelete(Context context, DeleteRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
Filter. filterPatch(Context context, PatchRequest request, RequestHandler next)
Filters a patch request.Promise<ResourceResponse,ResourceException>
ResourceApiVersionRoutingFilter. filterPatch(Context context, PatchRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
ResourceApiVersionSpecificationFilter. filterPatch(Context context, PatchRequest request, RequestHandler next)
Promise<QueryResponse,ResourceException>
Filter. filterQuery(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next)
Filters a query request.Promise<QueryResponse,ResourceException>
ResourceApiVersionRoutingFilter. filterQuery(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next)
Promise<QueryResponse,ResourceException>
ResourceApiVersionSpecificationFilter. filterQuery(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next)
Promise<ResourceResponse,ResourceException>
Filter. filterRead(Context context, ReadRequest request, RequestHandler next)
Filters a read request.Promise<ResourceResponse,ResourceException>
ResourceApiVersionRoutingFilter. filterRead(Context context, ReadRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
ResourceApiVersionSpecificationFilter. filterRead(Context context, ReadRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
Filter. filterUpdate(Context context, UpdateRequest request, RequestHandler next)
Filters an update request.Promise<ResourceResponse,ResourceException>
ResourceApiVersionRoutingFilter. filterUpdate(Context context, UpdateRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
ResourceApiVersionSpecificationFilter. filterUpdate(Context context, UpdateRequest request, RequestHandler next)
boolean
ResourceApiVersionSpecificationFilter.NoApiVersionHandler. handle(Context context, ResourcePath resourcePath)
Handler called when a request has no resource API version.Promise<ActionResponse,ResourceException>
FilterChain. 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>
Router. handleAction(Context context, ActionRequest request)
ActionResponse
SynchronousRequestHandler. handleAction(Context context, ActionRequest request)
Handles performing an action on a resource, and optionally returns an associated result.org.forgerock.api.models.ApiDescription
AbstractConnectionWrapper. handleApiRequest(Context context, Request request)
org.forgerock.api.models.ApiDescription
DescribedSyncRequestHandlerAdapter. handleApiRequest(Context context, Request request)
org.forgerock.api.models.ApiDescription
FilterChain. handleApiRequest(Context context, Request request)
org.forgerock.api.models.ApiDescription
Router. handleApiRequest(Context context, Request request)
Promise<ResourceResponse,ResourceException>
FilterChain. handleCreate(Context context, CreateRequest request)
default Promise<ResourceResponse,ResourceException>
RequestHandler. handleCreate(Context context, CreateRequest request)
Adds a new JSON resource, returning aPromise
that will be completed when the resource has been added.Promise<ResourceResponse,ResourceException>
Router. handleCreate(Context context, CreateRequest request)
ResourceResponse
SynchronousRequestHandler. handleCreate(Context context, CreateRequest request)
Adds a new JSON resource.Promise<ResourceResponse,ResourceException>
FilterChain. handleDelete(Context context, DeleteRequest request)
default Promise<ResourceResponse,ResourceException>
RequestHandler. handleDelete(Context context, DeleteRequest request)
Deletes a JSON resource, returning aPromise
that will be completed when the resource has been deleted.Promise<ResourceResponse,ResourceException>
Router. handleDelete(Context context, DeleteRequest request)
ResourceResponse
SynchronousRequestHandler. handleDelete(Context context, DeleteRequest request)
Deletes a JSON resource.void
ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification. handleNoApiVersionSupplied(Context context, ResourcePath resourcePath)
Support handling when no resource API version is supplied on the request.void
ResourceApiVersionSpecificationFilter.VersionSpecification. handleNoApiVersionSupplied(Context context, ResourcePath resourcePath)
Support custom handling when no resource API version is supplied on the request.Promise<ResourceResponse,ResourceException>
FilterChain. 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 aPromise
that will be completed when the resource has been updated.Promise<ResourceResponse,ResourceException>
Router. handlePatch(Context context, PatchRequest request)
ResourceResponse
SynchronousRequestHandler. handlePatch(Context context, PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing content.Promise<QueryResponse,ResourceException>
FilterChain. 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 aPromise
that will be completed when the search has completed.Promise<QueryResponse,ResourceException>
Router. handleQuery(Context context, QueryRequest request, QueryResourceHandler handler)
QueryResponse
SynchronousRequestHandler. handleQuery(Context context, QueryRequest request, Collection<ResourceResponse> resources)
Searches for all JSON resources matching a user specified set of criteria.Promise<ResourceResponse,ResourceException>
FilterChain. handleRead(Context context, ReadRequest request)
default Promise<ResourceResponse,ResourceException>
RequestHandler. handleRead(Context context, ReadRequest request)
Reads a JSON resource, returning aPromise
that will be completed when the resource has been read.Promise<ResourceResponse,ResourceException>
Router. handleRead(Context context, ReadRequest request)
ResourceResponse
SynchronousRequestHandler. handleRead(Context context, ReadRequest request)
Reads a JSON resource.Promise<ResourceResponse,ResourceException>
FilterChain. 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 aPromise
that will be completed when the resource has been updated.Promise<ResourceResponse,ResourceException>
Router. handleUpdate(Context context, UpdateRequest request)
ResourceResponse
SynchronousRequestHandler. handleUpdate(Context context, UpdateRequest request)
Updates a JSON resource by replacing its existing content with new content.boolean
FilterCondition. matches(Context context, Request request)
Returnstrue
if the conditional filter should be invoked, orfalse
if processing should continue directly to the next filter in the filter chain.ResourceResponse
AbstractAsynchronousConnection. patch(Context context, PatchRequest request)
ResourceResponse
AbstractConnectionWrapper. patch(Context context, PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing content.ResourceResponse
Connection. patch(Context context, PatchRequest request)
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>
Connection. patchAsync(Context context, PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to its existing content.default Promise<ResourceResponse,ResourceException>
CollectionResourceProvider. patchInstance(Context context, String resourceId, PatchRequest request)
Patches
an existing resource within the collection.Promise<ResourceResponse,ResourceException>
MemoryBackend. patchInstance(Context context, String id, PatchRequest request)
Patches
an existing resource within the collection.default Promise<ResourceResponse,ResourceException>
SingletonResourceProvider. patchInstance(Context context, PatchRequest request)
Patches
the single resource instance.QueryResponse
AbstractAsynchronousConnection. query(Context context, QueryRequest request, Collection<? super ResourceResponse> results)
QueryResponse
AbstractAsynchronousConnection. query(Context context, QueryRequest request, QueryResourceHandler handler)
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
AbstractConnectionWrapper. query(Context context, QueryRequest request, QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of criteria, and returns aPromise
that will be completed with the results of the search.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
Connection. query(Context context, QueryRequest request, QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of criteria, and returns aPromise
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 aPromise
that will be completed with the results of the search.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 aPromise
that will be completed with the results of the search.default Promise<QueryResponse,ResourceException>
CollectionResourceProvider. queryCollection(Context context, QueryRequest request, QueryResourceHandler handler)
Searches
the collection for all resources which match the query request criteria.Promise<QueryResponse,ResourceException>
MemoryBackend. queryCollection(Context context, QueryRequest request, QueryResourceHandler handler)
Searches
the collection for all resources which match the query request criteria.ResourceResponse
AbstractAsynchronousConnection. read(Context context, ReadRequest request)
ResourceResponse
AbstractConnectionWrapper. read(Context context, ReadRequest request)
Reads a JSON resource.ResourceResponse
Connection. read(Context context, ReadRequest request)
Reads a JSON resource.Promise<ResourceResponse,ResourceException>
AbstractConnectionWrapper. readAsync(Context context, ReadRequest request)
Asynchronously reads a JSON resource.Promise<ResourceResponse,ResourceException>
Connection. readAsync(Context context, ReadRequest request)
Asynchronously reads a JSON resource.default Promise<ResourceResponse,ResourceException>
CollectionResourceProvider. readInstance(Context context, String resourceId, ReadRequest request)
Reads
an existing resource within the collection.Promise<ResourceResponse,ResourceException>
MemoryBackend. readInstance(Context context, String id, ReadRequest request)
Reads
an existing resource within the collection.default Promise<ResourceResponse,ResourceException>
SingletonResourceProvider. readInstance(Context context, ReadRequest request)
Reads
the single resource instance.protected Context
AbstractConnectionWrapper. transform(Context context)
Optional Context-transformation function if the implementer has requirements to override theContext
provided in theConnection
's method invocations.ResourceResponse
AbstractAsynchronousConnection. update(Context context, UpdateRequest request)
ResourceResponse
AbstractConnectionWrapper. update(Context context, UpdateRequest request)
Updates a JSON resource by replacing its existing content with new content.ResourceResponse
Connection. update(Context context, UpdateRequest request)
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>
Connection. updateAsync(Context context, UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content with new content.default Promise<ResourceResponse,ResourceException>
CollectionResourceProvider. updateInstance(Context context, String resourceId, UpdateRequest request)
Updates
an existing resource within the collection.Promise<ResourceResponse,ResourceException>
MemoryBackend. updateInstance(Context context, String id, UpdateRequest request)
Updates
an existing resource within the collection.default Promise<ResourceResponse,ResourceException>
SingletonResourceProvider. updateInstance(Context context, UpdateRequest request)
Updates
the single resource instance.Constructors in org.forgerock.json.resource with parameters of type Context Constructor Description AdviceContext(Context parent, Collection<String> restrictedAdviceNames)
Creates a new AdviceContext with the provided parent. -
Uses of Context in org.forgerock.json.resource.http
Classes in org.forgerock.json.resource.http that implement Context Modifier and Type Class Description class
HttpContext
AContext
containing information relating to the originating HTTP request.Methods in org.forgerock.json.resource.http that return Context Modifier and Type Method Description Context
HttpContextFactory. createContext(Context parent, Request request)
Returns the context which should be used for the provided HTTP request.Methods in org.forgerock.json.resource.http with parameters of type Context Modifier and Type Method Description Context
HttpContextFactory. createContext(Context parent, Request request)
Returns the context which should be used for the provided HTTP request.SecurityContext
SecurityContextFactory. createContext(Context parent)
Deprecated.Creates a newSecurityContext
using the attributes contained in the provided HTTP request.SecurityContext
SecurityContextFactory. createContext(Context context, Request request)
Deprecated.Creates a newSecurityContext
using the attributes contained in the provided HTTP request.static Handler
CrestHttp. newHttpHandler(ConnectionFactory connectionFactory, Context parentContext)
Deprecated.UseCrestHttp.newHttpHandler(CrestApplication)
instead.static Handler
CrestHttp. newHttpHandler(CrestApplication application, Context context)
Deprecated.Since 25.0.0.static Handler
CrestHttp. newHttpHandler(CrestApplication application, Context context, Factory<Buffer> bufferFactory)
Creates a new JSON resource HTTP handler with the provided CREST request handler. -
Uses of Context in org.forgerock.openig.audit
Methods in org.forgerock.openig.audit with parameters of type Context Modifier and Type Method Description Promise<ActionResponse,ResourceException>
NoOpAuditService. handleAction(Context context, ActionRequest actionRequest)
Promise<ResourceResponse,ResourceException>
NoOpAuditService. handleCreate(Context context, CreateRequest createRequest)
Promise<ResourceResponse,ResourceException>
NoOpAuditService. handleDelete(Context context, DeleteRequest deleteRequest)
Promise<ResourceResponse,ResourceException>
NoOpAuditService. handlePatch(Context context, PatchRequest patchRequest)
Promise<QueryResponse,ResourceException>
NoOpAuditService. handleQuery(Context context, QueryRequest queryRequest, QueryResourceHandler queryResourceHandler)
Promise<ResourceResponse,ResourceException>
NoOpAuditService. handleRead(Context context, ReadRequest readRequest)
Promise<ResourceResponse,ResourceException>
NoOpAuditService. handleUpdate(Context context, UpdateRequest updateRequest)
-
Uses of Context in org.forgerock.openig.el
Methods in org.forgerock.openig.el that return types with arguments of type Context Modifier and Type Method Description static Map<String,Context>
Bindings. flatten(Context leaf)
Flatten the currentleaf
Context
into a Map keyed by context name.Methods in org.forgerock.openig.el with parameters of type Context Modifier and Type Method Description static Bindings
Bindings. bindings(Context context)
Returns aBindings
initialized with the givencontext
andrequest
.static Bindings
Bindings. bindings(Context context, Request request)
Returns aBindings
initialized with the givencontext
andrequest
.static Bindings
Bindings. bindings(Context context, Request request, Response response)
Returns aBindings
initialized with the givencontext
,request
andresponse
.static Map<String,Context>
Bindings. flatten(Context leaf)
Flatten the currentleaf
Context
into a Map keyed by context name. -
Uses of Context in org.forgerock.openig.filter
Classes in org.forgerock.openig.filter that implement Context Modifier and Type Class Description class
AuthRedirectContext
Used by theFragmentFilter
and theDataPreservationFilter
to know if a filter has attempted an impending IG redirection.class
JwtBuilderContext
Used by theJwtBuilderFilter
to make the JWT available in the context.Constructors in org.forgerock.openig.filter with parameters of type Context Constructor Description AuthRedirectContext(Context parent)
Create an AuthRedirectContext instance. -
Uses of Context in org.forgerock.openig.filter.allow
Methods in org.forgerock.openig.filter.allow with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
AllowOnlyFilter. filter(Context context, Request request, Handler next)
-
Uses of Context in org.forgerock.openig.filter.circuitbreaker
Methods in org.forgerock.openig.filter.circuitbreaker with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
CircuitBreakerFilter. filter(Context context, Request request, Handler next)
-
Uses of Context in org.forgerock.openig.filter.finance
Methods in org.forgerock.openig.filter.finance with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
FapiInteractionIdFilter. filter(Context context, Request request, Handler next)
-
Uses of Context in org.forgerock.openig.filter.jwt
Classes in org.forgerock.openig.filter.jwt that implement Context Modifier and Type Class Description class
JwtValidationContext
AJwtValidationContext
used to store the JWT and claims.class
JwtValidationErrorContext
AJwtValidationErrorContext
used to store the JWT and the list of violations for this JWT.Methods in org.forgerock.openig.filter.jwt with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
JwtValidationFilter. filter(Context context, Request request, Handler next)
-
Uses of Context in org.forgerock.openig.filter.oauth2
Classes in org.forgerock.openig.filter.oauth2 that implement Context Modifier and Type Class Description class
OAuth2FailureContext
Context
implementation to hold OAuth2 error details, should a failure occur during OAuth2 scenarios.class
OAuth2TokenExchangeContext
Context
supporting OAuth2 token exchange scenarios, this manages the resulting exchange token.Methods in org.forgerock.openig.filter.oauth2 with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
OAuth2TokenExchangeFilter. filter(Context context, Request request, Handler next)
Promise<Set<String>,ResponseException>
ScriptableResourceAccess. getRequiredScopes(Context context, Request request)
static OAuth2FailureContext
OAuth2FailureContext. oauth2FailureContext(Context parent, OAuth2ErrorException exception)
Create a newOAuth2FailureContext
.Promise<AccessTokenInfo,AccessTokenException>
CaffeineCacheAccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
Promise<AccessTokenInfo,AccessTokenException>
ScriptableAccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
Promise<AccessTokenInfo,AccessTokenException>
StatelessAccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
-
Uses of Context in org.forgerock.openig.filter.oauth2.client
Classes in org.forgerock.openig.filter.oauth2.client that implement Context Modifier and Type Class Description class
OAuth2SessionContext
This context helps to manage theOAuth2Session
when used withOAuth2ClientFilter
.Methods in org.forgerock.openig.filter.oauth2.client with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
ClientRegistrationFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
DiscoveryFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
GrantSwapJwtAssertionOAuth2ClientFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
OAuth2ClientFilter. 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<ClientRegistration,RegistrationException>
ClientRegistrationStrategy. performClientRegistration(Context context, Issuer issuer)
Perform client registration for the suppliedIssuer
.Promise<JsonValue,OAuth2ErrorException>
ClientRegistration. refreshAccessToken(Context context, String refreshToken)
Refreshes the actual access token, making a refresh request to the token end-point. -
Uses of Context in org.forgerock.openig.filter.oauth2.cnf
Methods in org.forgerock.openig.filter.oauth2.cnf with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
CertificateThumbprintFilter. filter(Context context, Request request, Handler next)
Promise<AccessTokenInfo,AccessTokenException>
ConfirmationKeyVerifierAccessTokenResolver. resolve(Context context, Supplier<Request,IOException> request, String token)
Promise<Result,NeverThrowsException>
ClientContextCertificateThumbprintVerifier. verify(Context context, AccessTokenInfo tokenInfo, JsonValue cnfKey)
Promise<Result,NeverThrowsException>
ConfirmationKeyVerifier. verify(Context context, AccessTokenInfo tokenInfo, JsonValue cnfKey)
Verifies the given confirmation key value.Promise<Result,NeverThrowsException>
Sha256AttributeCertificateThumbprintVerifier. verify(Context context, AccessTokenInfo tokenInfo, JsonValue cnfKey)
-
Uses of Context in org.forgerock.openig.filter.throttling
Methods in org.forgerock.openig.filter.throttling with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
ThrottlingFilter. filter(Context context, Request request, Handler next)
Promise<ThrottlingRate,Exception>
DefaultRateThrottlingPolicy. lookup(Context context, Request request)
Promise<ThrottlingRate,Exception>
FixedRateThrottlingPolicy. lookup(Context context, Request request)
Promise<ThrottlingRate,Exception>
MappedThrottlingPolicy. lookup(Context context, Request request)
Promise<ThrottlingRate,Exception>
ScriptableThrottlingPolicy. lookup(Context context, Request request)
Promise<ThrottlingRate,Exception>
ThrottlingPolicy. lookup(Context context, Request request)
Returns theThrottlingRate
that should be used for the provided request. -
Uses of Context in org.forgerock.openig.handler
Methods in org.forgerock.openig.handler with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
DesKeyGenHandler. handle(Context context, Request request)
Deprecated.Promise<Response,NeverThrowsException>
DispatchHandler. handle(Context context, Request request)
Promise<Response,NeverThrowsException>
JwkSetHandler. handle(Context context, Request request)
Promise<Response,NeverThrowsException>
ScriptableHandler. handle(Context context, Request request)
Promise<Response,NeverThrowsException>
SequenceHandler. handle(Context context, Request request)
Promise<Response,NeverThrowsException>
StaticResponseHandler. handle(Context context, Request request)
Promise<Response,NeverThrowsException>
WelcomeHandler. handle(Context context, Request request)
-
Uses of Context in org.forgerock.openig.handler.assertion
Methods in org.forgerock.openig.handler.assertion with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
IdentityAssertionHandlerTechPreview. handle(Context context, Request request)
Promise<IdentityAssertionClaims,IdentityAssertionException>
IdentityAssertionPluginTechPreview. process(Context context, Request request, Map<String,Object> incomingClaims)
Preform some processing and return a set of claims to be returned in the Assertion JWT.Promise<IdentityAssertionClaims,IdentityAssertionException>
ScriptableIdentityAssertionPluginTechPreview. process(Context context, Request request, Map<String,Object> incomingClaims)
-
Uses of Context in org.forgerock.openig.handler.resources
Methods in org.forgerock.openig.handler.resources with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
ResourceHandler. handle(Context context, Request request)
-
Uses of Context in org.forgerock.openig.handler.router
Classes in org.forgerock.openig.handler.router that implement Context Modifier and Type Class Description class
RoutingContext
Context
implementation to maintain a record of the route that accepted the request.Methods in org.forgerock.openig.handler.router with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
NullResponseFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
RouterHandler. handle(Context context, Request request)
Constructors in org.forgerock.openig.handler.router with parameters of type Context Constructor Description RoutingContext(Context parent, String routeId, String routeName)
Create a new instance of aRoutingContext
. -
Uses of Context in org.forgerock.openig.handler.saml
Classes in org.forgerock.openig.handler.saml that implement Context Modifier and Type Class Description class
SamlFailureContext
Context
implementation to hold error details, should an error occur during SAML processing.Methods in org.forgerock.openig.handler.saml with parameters of type Context Modifier and Type Method Description protected Promise<Response,NeverThrowsException>
AbstractSamlFederationHeaplet. defaultFailureHandler(Context context, Request request)
The default failure handler to use should none be provided in the configuration.URI
SamlConfig. requestUri(Context context, URI requestUri)
Return the request URI. -
Uses of Context in org.forgerock.openig.http
Methods in org.forgerock.openig.http that return Context Modifier and Type Method Description Context
ContextAndRequest. getContext()
Returns the context.Methods in org.forgerock.openig.http with parameters of type Context Modifier and Type Method 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)
Constructors in org.forgerock.openig.http with parameters of type Context Constructor Description ContextAndRequest(Context context, Request request)
Constructs a new ContextAndRequest. -
Uses of Context in org.forgerock.openig.ldap
Methods in org.forgerock.openig.ldap with parameters of type Context Modifier and Type Method 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. -
Uses of Context in org.forgerock.openig.openam
Classes in org.forgerock.openig.openam that implement Context Modifier and Type Class Description class
CapturedUserPasswordContext
ACapturedUserPasswordContext
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
APolicyDecisionContext
convey policy decision information to downstream filters and handlers.class
SessionInfoContext
Context
to store Access Management session info and properties.class
SsoTokenContext
TheSsoTokenContext
provides access to the token and user information related to this session.class
StsContext
AStsContext
convey the token transformation results to downstream filters and handlers.class
UserProfileContext
Used by theUserProfileFilter
to make the user's profile attributes available in the context.Methods in org.forgerock.openig.openam with parameters of type Context Modifier and Type Method Description protected Optional<Response>
AbstractConditionAdviceFilter. customAdvicesResponse(Context context, Request request, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices)
Provide extenders a change to provide a custom advices response.protected abstract Promise<Response,NeverThrowsException>
AbstractConditionAdviceFilter. doRedirect(Context context, Request request, Handler next, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices, URI originalUri)
Handle redirect to theinstance
to verify the required advices.protected Promise<Response,NeverThrowsException>
CdSsoConditionAdviceFilter. doRedirect(Context context, Request request, Handler next, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices, URI originalUri)
Promise<Response,NeverThrowsException>
AbstractConditionAdviceFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
CapturedUserPasswordFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
CrossDomainSingleSignOnFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
PolicyEnforcementFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
SessionInfoFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
SingleSignOnFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
TokenTransformationFilter. filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>
UserProfileFilter. filter(Context context, Request request, Handler next)
String
RequestResourceUriProvider. resourceUri(Context context, Request request)
String
ResourceUriProvider. resourceUri(Context context, Request request)
Returns the resource URI as aString
to be used when making policy requests.String
ScriptableResourceUriProvider. resourceUri(Context context, Request request)
Constructors in org.forgerock.openig.openam with parameters of type Context Constructor Description CdSsoContext(Context parent, String token, JwtClaimsSet claimsSet, String redirectEndpoint, org.forgerock.openig.http.protocol.CookieBuilder cookieBuilder)
CreateCdSsoContext
for supplied JWT. -
Uses of Context in org.forgerock.openig.openam.session
Methods in org.forgerock.openig.openam.session with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
AmSessionIdleTimeoutFilter. filter(Context context, Request request, Handler next)
-
Uses of Context in org.forgerock.openig.script
Methods in org.forgerock.openig.script with parameters of type Context Modifier and Type Method Description protected V
AbstractScriptableHeapObject. runScript(Bindings bindings, Context context, Class<V> clazz)
Synchronously runs the compiled script using the provided bindings.protected Promise<V,ScriptException>
AbstractScriptableHeapObject. runScriptAsync(Bindings bindings, Context context, Class<V> clazz)
Asynchronously runs the compiled script using the provided bindings. -
Uses of Context in org.forgerock.openig.sql
Methods in org.forgerock.openig.sql with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
SqlAttributesFilter. filter(Context context, Request request, Handler next)
-
Uses of Context in org.forgerock.openig.tools
Classes in org.forgerock.openig.tools that implement Context Modifier and Type Class Description class
InternalSsoTokenContext
AnInternalSsoTokenContext
used to store an SSO token.Constructors in org.forgerock.openig.tools with parameters of type Context Constructor Description InternalSsoTokenContext(Context parent, String token)
Creates a newInternalSsoTokenContext
context with the provided token. -
Uses of Context in org.forgerock.openig.tools.authentication
Methods in org.forgerock.openig.tools.authentication with parameters of type Context Modifier and Type Method Description Promise<SsoToken,AuthenticationException>
AuthenticationService. authenticate(Context context, String username, SecretReference<GenericSecret> passwordRef)
Authenticates a subject (identified with the givenusername
andpasswordRef
credentials), returning asynchronously an SSO token (if the authentication succeeded) or anAuthenticationException
on failures (I/O, invalid credentials, ...).Promise<SsoToken,AuthenticationException>
AuthenticatorAuthenticationService. authenticate(Context context, String username, SecretReference<GenericSecret> passwordRef)
-
Uses of Context in org.forgerock.openig.tools.authentication.chf
Methods in org.forgerock.openig.tools.authentication.chf with parameters of type Context Modifier and Type Method Description 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 parameters in org.forgerock.openig.tools.authentication.chf with type arguments of type Context Constructor Description AsyncRefreshableSupplier(AsyncFunction<Context,V,E> compute)
Creates a provider ensuring "only-once" invocation of the given compute function. -
Uses of Context in org.forgerock.openig.tools.session
Methods in org.forgerock.openig.tools.session with parameters of type Context Modifier and Type Method Description Promise<Optional<SessionInfo>,SessionException>
CacheSessionService. getSessionInfo(Context context, String ssoToken)
Promise<Optional<SessionInfo>,SessionException>
CrestSessionService. getSessionInfo(Context context, String ssoToken)
Promise<Optional<SessionInfo>,SessionException>
SessionService. getSessionInfo(Context context, String ssoToken)
Returns a promise that will be completed with an optionalSessionInfo
or with anSessionException
in case of errors.Promise<Void,SessionException>
CacheSessionService. logout(Context context, String ssoToken)
Promise<Void,SessionException>
CrestSessionService. logout(Context context, String ssoToken)
Promise<Void,SessionException>
SessionService. logout(Context context, String ssoToken)
Returns a promise that will be completed with aVoid
or with anSessionException
in case of errors. -
Uses of Context in org.forgerock.openig.tools.userprofile
Methods in org.forgerock.openig.tools.userprofile with parameters of type Context Modifier and Type Method Description Promise<UserProfile,UserProfileException>
CacheUserProfileService. getUserProfile(Context context, String username)
Promise<UserProfile,UserProfileException>
CrestUserProfileService. getUserProfile(Context context, String username)
Promise<UserProfile,UserProfileException>
UserProfileService. getUserProfile(Context context, String username)
Returns a promise that will be completed with anUserProfile
or with anUserProfileException
in case of errors. -
Uses of Context in org.forgerock.openig.ui.record
-
Uses of Context in org.forgerock.openig.uma
Methods in org.forgerock.openig.uma with parameters of type Context Modifier and Type Method 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 givenresourcePath
.Promise<Response,NeverThrowsException>
UmaResourceServerFilter. filter(Context context, Request request, Handler next)
-
Uses of Context in org.forgerock.openig.websocket
Classes in org.forgerock.openig.websocket that implement Context Modifier and Type Class Description class
WebSocketHandshakeContext
Context
signaling that the associated request is a WebSocket Handshake.Methods in org.forgerock.openig.websocket with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
WebSocketHandshakeDetectorFilter. filter(Context context, Request request, Handler next)
Constructors in org.forgerock.openig.websocket with parameters of type Context Constructor Description WebSocketHandshakeContext(Context parent)
Create an instance of this context. -
Uses of Context in org.forgerock.services.context
Classes in org.forgerock.services.context that implement Context Modifier and Type Class Description class
AbstractContext
A base implementation of theContext
interface.class
AttributesContext
AnAttributesContext
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
AContext
which has an a globally unique ID but no parent.class
SecurityContext
AContext
containing information about the client performing the request which may be used when performing authorization decisions.class
TransactionIdContext
This context aims to hold theTransactionId
.Methods in org.forgerock.services.context with type parameters of type Context Modifier and Type Method Description <T extends Context>
Optional<T>AbstractContext. as(Class<T> clazz)
default <T extends Context>
Optional<T>Context. as(Class<T> clazz)
Returns an @{link Optional} which contains the first context in the chain whose type is a sub-type of the providedContext
class if one exists, or an empty optional if none is present.<T extends Context>
TAbstractContext. asContext(Class<T> clazz)
<T extends Context>
TContext. asContext(Class<T> clazz)
Returns the first context in the chain whose type is a sub-type of the providedContext
class.Methods in org.forgerock.services.context that return Context Modifier and Type Method Description Context
AbstractContext. getContext(String contextName)
Context
Context. getContext(String contextName)
Returns the first context in the chain whose context name matches the provided name.Context
AbstractContext. getParent()
Context
Context. getParent()
Returns the parent of this context.Methods in org.forgerock.services.context that return types with arguments of type Context Modifier and Type Method Description Optional<Context>
AbstractContext. get(String contextName)
default Optional<Context>
Context. get(String contextName)
Methods in org.forgerock.services.context with parameters of type Context Modifier and Type Method Description static ClientContext.Builder
ClientContext. buildExternalClientContext(Context parent)
Creates aClientContext.Builder
for creating an externalClientContext
instance.static ClientContext
ClientContext. newInternalClientContext(Context parent)
Creates an internalClientContext
instance.Method parameters in org.forgerock.services.context with type arguments of type Context Modifier and Type Method Description boolean
AbstractContext. containsContext(Class<? extends Context> clazz)
boolean
Context. containsContext(Class<? extends Context> clazz)
Returnstrue
if there is a context in the chain whose type is a sub-type of the providedContext
class.Constructors in org.forgerock.services.context with parameters of type Context Constructor Description AbstractContext(String id, String name, Context parent)
Constructs a newAbstractContext
.AbstractContext(Context parent, String name)
Constructs a newAbstractContext
with anull
id
.AttributesContext(Context parent)
Constructs a newAttributesContext
.RequestAuditContext(Context parent)
Deprecated.Prefer usingRequestAuditContext(Context, Instant)
not to rely on the system clock.RequestAuditContext(Context parent, Clock clock)
Deprecated.Prefer usingRequestAuditContext(Context, Instant)
.RequestAuditContext(Context parent, Instant requestReceivedTime)
Constructs a new context using the specified parent and the current time as the request received time.SecurityContext(String id, Context parent, String authenticationId, Map<String,Object> authorization)
Creates a new security context having the provided ID, and parent.SecurityContext(Context parent, String authenticationId, Map<String,Object> authorization)
Creates a new security context having the provided parent and an ID automatically generated usingUUID.randomUUID()
.TransactionIdContext(Context parent, TransactionId transactionId)
Constructs a new TransactionIdContext. -
Uses of Context in org.forgerock.services.descriptor
Methods in org.forgerock.services.descriptor with parameters of type Context Modifier and Type Method Description D
Describable. handleApiRequest(Context context, R request)
Handle a request for the API Descriptor. -
Uses of Context in org.forgerock.services.routing
Methods in org.forgerock.services.routing that return Context Modifier and Type Method Description Context
RouteMatch. decorateContext(Context context)
Decorates the given context with any routing information for the route.Methods in org.forgerock.services.routing that return types with arguments of type Context Modifier and Type Method 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.Methods in org.forgerock.services.routing with parameters of type Context Modifier and Type Method Description Context
RouteMatch. decorateContext(Context context)
Decorates the given context with any routing information for the route.RouteMatch
DelegatingRouteMatcher. evaluate(Context context, R request)
abstract RouteMatch
RouteMatcher. evaluate(Context context, R request)
Evaluates the request and determines whether it matches the route.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)
-