Uses of Interface
org.forgerock.services.context.Context
Package
Description
Package contains the AuditService.
Package contains audit events.
This package contains the default
AuditEventHandlers
.This package contains the default AuditEventHandler implementations.
This package contains the Elasticsearch
AuditEventHandler
implementation.This package contains a JDBC AuditEventHandler implementation.
This package contains a JMS AuditEventHandler implementation.
This package contains the JSON-file
AuditEventHandler
implementation.This package contains the JSON-stdout
AuditEventHandler
implementation.This package contains the audit handler implementation for Splunk.
This package contains a Syslog AuditEventHandler implementation.
Models and manages elements of the Hypertext Transfer Protocol.
Core
Filter
implementations.Support for CORS.
Core
Handler
implementations.This package provides APIs for OAuth 2.0 services implementations.
This package defines OpenAM specific logic needed to retrieve an
AccessTokenInfo
.Provides routing functionality for HTTP requests.
Provides interfaces for managing and interacting with HTTP Sessions.
Classes to support OpenAPI API Descriptions using Swagger.
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
JSON resource Commons HTTP Framework integration.
Handles Identity Assertion processing.
Identity Assertion handler.
Identity Assertion plugins.
Kerberos Identity Assertion plugin.
Service Provider interface for registering audit events.
Integrates with the Java Enterprise Edition Unified Expression Language API.
Filters the requests and/or responses of HTTP.
Filters the HTTP request using a declarative configuration model based on a chain of predicates to validate.
This package contains the components used to implement circuit breaking.
Support for financial APIs (Open Banking, PSD2, Berlin Group, ...).
This package contains the components used to implement some JWT related filter.
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
OAuth 2.0 Client filter implementation.
JWT confirmation key support for access tokens.
This package contains the components used to implement a throttling rate support.
Handles HTTP requests by generating responses.
Handles the tech preview identity assertion processing.
Contains components and APIs used to serve static resources.
Provides automated router capability that loads its configurations files (called routes) from a given directory.
Identity Gateway SAML support.
Integrates with the ForgeRock HTTP Framework.
Integration classes specifically for ForgeRock Access Management.
AM Session idle timeout tracking.
This package contains the components used to integrate with PingOne Protect, to support risk evaluation and routing.
Contains every classes related to Ping's sideband API.
Scripting support.
Provides SQL and JDBC support.
Common tools used in policy service.
AM authentication service.
HTTP-based authentication service.
This package contains classes to call AM to retrieve user's session info.
This package contains classes to call AM to retrieve user's profile info.
Defines a storage service to be used by the UI to persist its component model.
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
Miscellaneous utility classes.
This package contains the
Context
interface and various common protocol
independent implementations.Classes that allow services to be described.
This package provides a simple framework for implementing routers.
-
Uses of Context in org.forgerock.audit
Modifier and TypeClassDescriptionclass
A Context used when auditing over the router.Modifier and TypeMethodDescriptionAuditService.handleAction
(Context context, ActionRequest request) Audit service may support actions on the service itself or on handlers.AuditServiceProxy.handleAction
(Context context, ActionRequest request) AuditService.handleCreate
(Context context, CreateRequest request) Propagates the audit event to theAuditEventHandler
objects that have been registered for the audit event topic.AuditServiceProxy.handleCreate
(Context context, CreateRequest request) AuditService.handleDelete
(Context context, DeleteRequest request) Audit service does not support changing audit entries.AuditServiceProxy.handleDelete
(Context context, DeleteRequest request) AuditService.handlePatch
(Context context, PatchRequest request) Audit service does not support changing audit entries.AuditServiceProxy.handlePatch
(Context context, PatchRequest request) AuditService.handleQuery
(Context context, QueryRequest request, QueryResourceHandler handler) Performs the query on the specified object and returns the associated results.AuditServiceProxy.handleQuery
(Context context, QueryRequest request, QueryResourceHandler handler) AuditService.handleRead
(Context context, ReadRequest request) Gets an object from the audit logs by identifier.AuditServiceProxy.handleRead
(Context context, ReadRequest request) AuditService.handleUpdate
(Context context, UpdateRequest request) Audit service does not support changing audit entries.AuditServiceProxy.handleUpdate
(Context context, UpdateRequest request) ModifierConstructorDescriptionAuditingContext
(Context parent) Construct a new audit context with the provided parent. -
Uses of Context in org.forgerock.audit.events
Modifier and TypeMethodDescriptionfinal T
AccessAuditEventBuilder.clientFromContext
(Context context) Sets client ip, port and host fromClientContext
, if the providedContext
contains aClientContext
.final T
AccessAuditEventBuilder.forContext
(Context context) Sets common fields from services contexts.final T
AccessAuditEventBuilder.forHttpRequest
(Context context, Request request) Sets common fields from CREST contexts and request.final T
AccessAuditEventBuilder.httpFromContext
(Context context) Sets HTTP method, path, queryString and headers fromHttpContext
, if the providedContext
contains aHttpContext
.final T
AccessAuditEventBuilder.serverFromContext
(Context context) Sets the server fields for the event, if the providedContext
contains aClientContext
..final T
AuditEventBuilder.transactionIdFromContext
(Context context) Sets transactionId from ID ofTransactionIdContext
, if the providedContext
contains aTransactionIdContext
. -
Uses of Context in org.forgerock.audit.events.handlers
Modifier and TypeMethodDescriptionAuditEventTopicState.getContext()
Returns the context that triggered the event.Modifier and TypeMethodDescriptionAuditEventHandler.handleAction
(Context context, String topic, ActionRequest request) Performs an action.AuditEventHandlerBase.handleAction
(Context context, String topic, ActionRequest request) AuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) Publishes an event to the provided topic.NoOpAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) AuditEventHandler.queryEvents
(Context context, String topic, QueryRequest query, QueryResourceHandler handler) Query some events from the provided topic.NoOpAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest query, QueryResourceHandler handler) Reads an event with the provided resource id from the provided topic.ModifierConstructorDescriptionAuditEventTopicState
(Context context, String topic, JsonValue event) Creates a (topic,event) pair. -
Uses of Context in org.forgerock.audit.handlers.csv
Modifier and TypeMethodDescriptionCsvAuditEventHandler.handleAction
(Context context, String topic, ActionRequest request) CsvAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) Create a csv audit log entry.CsvAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest query, QueryResourceHandler handler) Perform a query on the csv audit log.Read from the csv audit log. -
Uses of Context in org.forgerock.audit.handlers.elasticsearch
Modifier and TypeMethodDescriptionElasticsearchAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) ElasticsearchAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest query, QueryResourceHandler handler) Queries the Elasticsearch Search API for audit events. -
Uses of Context in org.forgerock.audit.handlers.jdbc
Modifier and TypeMethodDescriptionJdbcAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) Publishes an event to the provided topic.JdbcAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest queryRequest, QueryResourceHandler queryResourceHandler) Query some events from the provided topic. -
Uses of Context in org.forgerock.audit.handlers.jms
Modifier and TypeMethodDescriptionJmsAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) JmsAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest queryRequest, QueryResourceHandler queryResourceHandler) Returns NotSupportedException as query is not implemented for JMS.Returns NotSupportedException as read is not implemented for JMS. -
Uses of Context in org.forgerock.audit.handlers.json
Modifier and TypeMethodDescriptionJsonAuditEventHandler.handleAction
(Context context, String topic, ActionRequest request) JsonAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) JsonAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest query, QueryResourceHandler handler) -
Uses of Context in org.forgerock.audit.handlers.json.stdout
Modifier and TypeMethodDescriptionJsonStdoutAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) JsonStdoutAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest query, QueryResourceHandler handler) -
Uses of Context in org.forgerock.audit.handlers.splunk
Modifier and TypeMethodDescriptionSplunkAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) SplunkAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest query, QueryResourceHandler handler) -
Uses of Context in org.forgerock.audit.handlers.syslog
Modifier and TypeMethodDescriptionSyslogAuditEventHandler.publishEvent
(Context context, String topic, JsonValue event) SyslogAuditEventHandler.queryEvents
(Context context, String topic, QueryRequest queryRequest, QueryResourceHandler queryResourceHandler) -
Uses of Context in org.forgerock.http
Modifier and TypeMethodDescriptionFilters the request and/or response of an exchange.Sends an HTTP request and returns aPromise
representing the pending HTTP response.Client.sendWithoutClose
(Context context, Request request) Sends an HTTP request and returns aPromise
representing the pending HTTP response. -
Uses of Context in org.forgerock.http.filter
Modifier and TypeMethodDescriptionstatic BiPredicate<Context,
Request> Filters.matchRequestUriPath
(String regex) Returns aBiPredicate
which will only match requests whose URI path matches the provided regular expression.static BiPredicate<Context,
Request> Filters.matchRequestUriPath
(Pattern regex) Returns aBiPredicate
which will only match requests whose URI path matches the provided regular expression.Modifier and TypeMethodDescriptionHandles all OPTION requests to CREST resources, all other request methods are handled by theHandler
.Modifier and TypeMethodDescriptionstatic 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
Modifier and TypeMethodDescriptionCorsPolicyProvider.findApplicable
(Context context, String origin) Returns an optional CORS policy applicable in thiscontext
, for the givenorigin
. -
Uses of Context in org.forgerock.http.handler
-
Uses of Context in org.forgerock.http.oauth2
Modifier and TypeClassDescriptionclass
AnOAuth2Context
could be used to store and retrieve anAccessTokenInfo
.Modifier and TypeMethodDescriptionDeprecated.ResourceAccess.getRequiredScopes
(Context context, Request request) Returns the scopes required to access the resource.default Promise<AccessTokenInfo,
AccessTokenException> Deprecated, for removal: This API element is subject to removal in a future version.default Promise<AccessTokenInfo,
AccessTokenException> Resolves a given access token against an authorization server.ModifierConstructorDescriptionOAuth2Context
(Context parent, AccessTokenInfo accessToken) Creates a new OAuth2 context with the providedAccessTokenInfo
. -
Uses of Context in org.forgerock.http.oauth2.resolver
Modifier and TypeMethodDescriptionCachingAccessTokenResolver.resolve
(Context context, Supplier<Request, IOException> request, String token) OpenAmAccessTokenResolver.resolve
(Context context, Supplier<Request, IOException> request, String token) Deprecated.TokenIntrospectionAccessTokenResolver.resolve
(Context context, Supplier<Request, IOException> request, String token) -
Uses of Context in org.forgerock.http.routing
Modifier and TypeClassDescriptionclass
AContext
which is created when a request is and has been routed based on resource API version.final class
AContext
which is created when a request has been routed.Modifier and TypeMethodDescriptionprotected ApiVersionRouterContext
ResourceApiVersionRoutingFilter.createApiVersionRouterContext
(Context context) Creates aApiVersionRouterContext
using the default version behaviour and whether to issue warnings from the behaviourManager instance.static UriRouterContext.Builder
UriRouterContext.uriRouterContext
(Context parent) Return a builder for a newUriRouterContext
.ModifierConstructorDescriptionApiVersionRouterContext
(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
Modifier and TypeClassDescriptionfinal class
ASessionContext
is a mechanism for maintaining state between components when processing a successive requests from the same logical client or end-user.ModifierConstructorDescriptionSessionContext
(Context parent, Session session) Constructs a newSessionContext
. -
Uses of Context in org.forgerock.http.swagger
Modifier and TypeMethodDescriptionprotected 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
Modifier and TypeClassDescriptionclass
AContext
containing information which should be returned to the user in some appropriate form to the user.Modifier and TypeMethodDescriptionprotected Context
Optional Context-transformation function if the implementer has requirements to override theContext
provided in theConnection
's method invocations.Modifier and TypeMethodDescriptionAbstractAsynchronousConnection.action
(Context context, ActionRequest request) AbstractConnectionWrapper.action
(Context context, ActionRequest request) Performs an action against a specific resource, or set of resources.Connection.action
(Context context, ActionRequest request) Performs an action against a specific resource, or set of resources.AbstractConnectionWrapper.actionAsync
(Context context, ActionRequest request) Asynchronously performs an action against a specific resource, or set of resources.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.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.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.AbstractAsynchronousConnection.create
(Context context, CreateRequest request) AbstractConnectionWrapper.create
(Context context, CreateRequest request) Adds a new JSON resource.Connection.create
(Context context, CreateRequest request) Adds a new JSON resource.AbstractConnectionWrapper.createAsync
(Context context, CreateRequest request) Asynchronously adds a new JSON resource.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.MemoryBackend.createInstance
(Context context, CreateRequest request) Adds
a new resource instance to the collection.AbstractAsynchronousConnection.delete
(Context context, DeleteRequest request) AbstractConnectionWrapper.delete
(Context context, DeleteRequest request) Deletes a JSON resource.Connection.delete
(Context context, DeleteRequest request) Deletes a JSON resource.AbstractConnectionWrapper.deleteAsync
(Context context, DeleteRequest request) Asynchronously deletes a JSON resource.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.MemoryBackend.deleteInstance
(Context context, String id, DeleteRequest request) Removes
a resource instance from the collection.Filter.filterAction
(Context context, ActionRequest request, RequestHandler next) Filters an action request.ResourceApiVersionRoutingFilter.filterAction
(Context context, ActionRequest request, RequestHandler next) ResourceApiVersionSpecificationFilter.filterAction
(Context context, ActionRequest request, RequestHandler next) Filter.filterCreate
(Context context, CreateRequest request, RequestHandler next) Filters a create request.ResourceApiVersionRoutingFilter.filterCreate
(Context context, CreateRequest request, RequestHandler next) ResourceApiVersionSpecificationFilter.filterCreate
(Context context, CreateRequest request, RequestHandler next) Filter.filterDelete
(Context context, DeleteRequest request, RequestHandler next) Filters a delete request.ResourceApiVersionRoutingFilter.filterDelete
(Context context, DeleteRequest request, RequestHandler next) ResourceApiVersionSpecificationFilter.filterDelete
(Context context, DeleteRequest request, RequestHandler next) Filter.filterPatch
(Context context, PatchRequest request, RequestHandler next) Filters a patch request.ResourceApiVersionRoutingFilter.filterPatch
(Context context, PatchRequest request, RequestHandler next) ResourceApiVersionSpecificationFilter.filterPatch
(Context context, PatchRequest request, RequestHandler next) Filter.filterQuery
(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next) Filters a query request.ResourceApiVersionRoutingFilter.filterQuery
(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next) ResourceApiVersionSpecificationFilter.filterQuery
(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next) Filter.filterRead
(Context context, ReadRequest request, RequestHandler next) Filters a read request.ResourceApiVersionRoutingFilter.filterRead
(Context context, ReadRequest request, RequestHandler next) ResourceApiVersionSpecificationFilter.filterRead
(Context context, ReadRequest request, RequestHandler next) Filter.filterUpdate
(Context context, UpdateRequest request, RequestHandler next) Filters an update request.ResourceApiVersionRoutingFilter.filterUpdate
(Context context, UpdateRequest request, RequestHandler next) 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.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.Router.handleAction
(Context context, ActionRequest request) 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) 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.Router.handleCreate
(Context context, CreateRequest request) SynchronousRequestHandler.handleCreate
(Context context, CreateRequest request) Adds a new JSON resource.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.Router.handleDelete
(Context context, DeleteRequest request) 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.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.Router.handlePatch
(Context context, PatchRequest request) SynchronousRequestHandler.handlePatch
(Context context, PatchRequest request) Updates a JSON resource by applying a set of changes to its existing content.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.Router.handleQuery
(Context context, QueryRequest request, QueryResourceHandler handler) SynchronousRequestHandler.handleQuery
(Context context, QueryRequest request, Collection<ResourceResponse> resources) Searches for all JSON resources matching a user specified set of criteria.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.Router.handleRead
(Context context, ReadRequest request) SynchronousRequestHandler.handleRead
(Context context, ReadRequest request) Reads a JSON resource.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.Router.handleUpdate
(Context context, UpdateRequest request) SynchronousRequestHandler.handleUpdate
(Context context, UpdateRequest request) Updates a JSON resource by replacing its existing content with new content.boolean
Returnstrue
if the conditional filter should be invoked, orfalse
if processing should continue directly to the next filter in the filter chain.AbstractAsynchronousConnection.patch
(Context context, PatchRequest request) AbstractConnectionWrapper.patch
(Context context, PatchRequest request) Updates a JSON resource by applying a set of changes to its existing content.Connection.patch
(Context context, PatchRequest request) Updates a JSON resource by applying a set of changes to its existing content.AbstractConnectionWrapper.patchAsync
(Context context, PatchRequest request) Asynchronously updates a JSON resource by applying a set of changes to its existing content.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.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.AbstractAsynchronousConnection.query
(Context context, QueryRequest request, Collection<? super ResourceResponse> results) AbstractAsynchronousConnection.query
(Context context, QueryRequest request, QueryResourceHandler handler) 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.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.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.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.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.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.MemoryBackend.queryCollection
(Context context, QueryRequest request, QueryResourceHandler handler) Searches
the collection for all resources which match the query request criteria.AbstractAsynchronousConnection.read
(Context context, ReadRequest request) AbstractConnectionWrapper.read
(Context context, ReadRequest request) Reads a JSON resource.Connection.read
(Context context, ReadRequest request) Reads a JSON resource.AbstractConnectionWrapper.readAsync
(Context context, ReadRequest request) Asynchronously reads a JSON resource.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.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
Optional Context-transformation function if the implementer has requirements to override theContext
provided in theConnection
's method invocations.AbstractAsynchronousConnection.update
(Context context, UpdateRequest request) AbstractConnectionWrapper.update
(Context context, UpdateRequest request) Updates a JSON resource by replacing its existing content with new content.Connection.update
(Context context, UpdateRequest request) Updates a JSON resource by replacing its existing content with new content.AbstractConnectionWrapper.updateAsync
(Context context, UpdateRequest request) Asynchronously updates a JSON resource by replacing its existing content with new content.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.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.ModifierConstructorDescriptionAdviceContext
(Context parent, Collection<String> restrictedAdviceNames) Creates a new AdviceContext with the provided parent. -
Uses of Context in org.forgerock.json.resource.http
Modifier and TypeClassDescriptionfinal class
AContext
containing information relating to the originating HTTP request.Modifier and TypeMethodDescriptionHttpContextFactory.createContext
(Context parent, Request request) Returns the context which should be used for the provided HTTP request.Modifier and TypeMethodDescriptionHttpContextFactory.createContext
(Context parent, Request request) Returns the context which should be used for the provided HTTP request.SecurityContextFactory.createContext
(Context parent) Deprecated.Creates a newSecurityContext
using the attributes contained in the provided HTTP request.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.assertion
Modifier and TypeClassDescriptionclass
AnIdentityRequestJwtContext
is used to store the key details of the Identity Request JWT.ModifierConstructorDescriptionIdentityRequestJwtContext
(Context parent, EncryptedJwt identityRequestJwt) Creates a newIdentityRequestJwtContext
context based on a validated Identity Request JWT. -
Uses of Context in org.forgerock.openig.assertion.handler
-
Uses of Context in org.forgerock.openig.assertion.plugin
Modifier and TypeMethodDescriptionPreform some processing and return a set of claims to be returned in the Identity Assertion JWT. -
Uses of Context in org.forgerock.openig.assertion.plugin.kerberos
Modifier and TypeMethodDescription -
Uses of Context in org.forgerock.openig.audit
Modifier and TypeMethodDescriptionNoOpAuditService.handleAction
(Context context, ActionRequest actionRequest) NoOpAuditService.handleCreate
(Context context, CreateRequest createRequest) NoOpAuditService.handleDelete
(Context context, DeleteRequest deleteRequest) NoOpAuditService.handlePatch
(Context context, PatchRequest patchRequest) NoOpAuditService.handleQuery
(Context context, QueryRequest queryRequest, QueryResourceHandler queryResourceHandler) NoOpAuditService.handleRead
(Context context, ReadRequest readRequest) NoOpAuditService.handleUpdate
(Context context, UpdateRequest updateRequest) -
Uses of Context in org.forgerock.openig.el
Modifier and TypeMethodDescriptionFlatten the currentleaf
Context
into a Map keyed by context name.Modifier and TypeMethodDescriptionstatic Bindings
Returns aBindings
initialized with the givencontext
andrequest
.static Bindings
Returns aBindings
initialized with the givencontext
andrequest
.static Bindings
Returns aBindings
initialized with the givencontext
,request
andresponse
.Flatten the currentleaf
Context
into a Map keyed by context name. -
Uses of Context in org.forgerock.openig.filter
Modifier and TypeClassDescriptionclass
Used by theFragmentFilter
and theDataPreservationFilter
to know if a filter has attempted an impending IG redirection.class
Context holding values extracted from theFileAttributesFilter
.class
Used by theJwtBuilderFilter
to make the JWT available in the context.Modifier and TypeMethodDescriptionModifierConstructorDescriptionAuthRedirectContext
(Context parent) Create an AuthRedirectContext instance. -
Uses of Context in org.forgerock.openig.filter.allow
-
Uses of Context in org.forgerock.openig.filter.circuitbreaker
-
Uses of Context in org.forgerock.openig.filter.finance
-
Uses of Context in org.forgerock.openig.filter.jwt
Modifier and TypeClassDescriptionclass
AJwtValidationContext
used to store the JWT and claims.class
AJwtValidationErrorContext
used to store the JWT and the list of violations for this JWT. -
Uses of Context in org.forgerock.openig.filter.oauth2
Modifier and TypeClassDescriptionfinal class
Context
implementation to hold OAuth2 error details, should a failure occur during OAuth2 scenarios.class
Context
supporting OAuth2 token exchange scenarios, this manages the resulting exchange token.Modifier and TypeMethodDescriptionScriptableResourceAccess.getRequiredScopes
(Context context, Request request) static OAuth2FailureContext
OAuth2FailureContext.oauth2FailureContext
(Context parent, OAuth2ErrorException exception) Create a newOAuth2FailureContext
.CaffeineCacheAccessTokenResolver.resolve
(Context context, Supplier<Request, IOException> request, String token) ScriptableAccessTokenResolver.resolve
(Context context, Supplier<Request, IOException> request, String token) StatelessAccessTokenResolver.resolve
(Context context, Supplier<Request, IOException> request, String token) -
Uses of Context in org.forgerock.openig.filter.oauth2.client
Modifier and TypeClassDescriptionclass
This context helps to manage theOAuth2Session
when used withOAuth2ClientFilter
.Modifier and TypeMethodDescriptionClientRegistrationStrategy.performClientRegistration
(Context context, Issuer issuer) Perform client registration for the suppliedIssuer
. -
Uses of Context in org.forgerock.openig.filter.oauth2.cnf
Modifier and TypeMethodDescriptionConfirmationKeyVerifierAccessTokenResolver.resolve
(Context context, Supplier<Request, IOException> request, String token) ClientContextCertificateThumbprintVerifier.verify
(Context context, AccessTokenInfo tokenInfo, JsonValue cnfKey) ConfirmationKeyVerifier.verify
(Context context, AccessTokenInfo tokenInfo, JsonValue cnfKey) Verifies the given confirmation key value.Sha256AttributeCertificateThumbprintVerifier.verify
(Context context, AccessTokenInfo tokenInfo, JsonValue cnfKey) -
Uses of Context in org.forgerock.openig.filter.throttling
Modifier and TypeMethodDescriptionReturns theThrottlingRate
that should be used for the provided request. -
Uses of Context in org.forgerock.openig.handler
Modifier and TypeMethodDescription -
Uses of Context in org.forgerock.openig.handler.assertion
Modifier and TypeMethodDescriptionIdentityAssertionPluginTechPreview.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.ScriptableIdentityAssertionPluginTechPreview.process
(Context context, Request request, Map<String, Object> incomingClaims) -
Uses of Context in org.forgerock.openig.handler.resources
-
Uses of Context in org.forgerock.openig.handler.router
Modifier and TypeClassDescriptionclass
Context
implementation to maintain a record of the route that accepted the request.Modifier and TypeMethodDescriptionModifierConstructorDescriptionRoutingContext
(Context parent, String routeId, String routeName) Create a new instance of aRoutingContext
. -
Uses of Context in org.forgerock.openig.handler.saml
Modifier and TypeClassDescriptionclass
Context
implementation to hold error details, should an error occur during SAML processing.Modifier and TypeMethodDescriptionprotected Promise<Response,
NeverThrowsException> AbstractSamlFederationHeaplet.defaultFailureHandler
(Context context, Request request) The default failure handler to use should none be provided in the configuration.SamlConfig.requestUri
(Context context, URI requestUri) Return the request URI. -
Uses of Context in org.forgerock.openig.http
Modifier and TypeMethodDescriptionContextAndRequest.context()
Returns the value of thecontext
record component.Modifier and TypeMethodDescriptionServerInfoSingletonProvider.actionInstance
(Context context, ActionRequest request) ServerInfoSingletonProvider.patchInstance
(Context context, PatchRequest request) ServerInfoSingletonProvider.readInstance
(Context context, ReadRequest request) ServerInfoSingletonProvider.updateInstance
(Context context, UpdateRequest request) ModifierConstructorDescriptionContextAndRequest
(Context context, Request request) Creates an instance of aContextAndRequest
record class. -
Uses of Context in org.forgerock.openig.openam
Modifier and TypeClassDescriptionclass
ACapturedUserPasswordContext
to store the user's decrypted password.class
Context
implementation to maintain cross-domain SSO properties.class
Context
implementation to hold error details, should an error occur during cross-domain SSO authentication.class
APolicyDecisionContext
convey policy decision information to downstream filters and handlers.class
Context
to store Access Management session info and properties.class
TheSsoTokenContext
provides access to the token and user information related to this session.class
AStsContext
convey the token transformation results to downstream filters and handlers.class
Used by theUserProfileFilter
to make the user's profile attributes available in the context.Modifier and TypeMethodDescriptionAbstractConditionAdviceFilter.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) RequestResourceUriProvider.resourceUri
(Context context, Request request) ResourceUriProvider.resourceUri
(Context context, Request request) Returns the resource URI as aString
to be used when making policy requests.ScriptableResourceUriProvider.resourceUri
(Context context, Request request) ModifierConstructorDescriptionCdSsoContext
(Context parent, String token, JwtClaimsSet claimsSet, String redirectEndpoint, org.forgerock.openig.http.protocol.CookieBuilder cookieBuilder, Duration authnStateLifetime) CreateCdSsoContext
for supplied JWT. -
Uses of Context in org.forgerock.openig.openam.session
-
Uses of Context in org.forgerock.openig.ping.protect
Modifier and TypeMethodDescription -
Uses of Context in org.forgerock.openig.ping.sideband
-
Uses of Context in org.forgerock.openig.script
Modifier and TypeMethodDescriptionprotected final V
Synchronously runs the compiled script using the provided bindings.protected final 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
-
Uses of Context in org.forgerock.openig.tools
Modifier and TypeClassDescriptionclass
AnInternalSsoTokenContext
used to store an SSO token.Modifier and TypeMethodDescriptionCachePolicyDecisionFilter.filterAction
(Context context, ActionRequest actionRequest, RequestHandler next) ExecutorFilter.filterAction
(Context context, ActionRequest request, RequestHandler next) NotSupportedFilter.filterAction
(Context context, ActionRequest actionRequest, RequestHandler requestHandler) ExecutorFilter.filterCreate
(Context context, CreateRequest request, RequestHandler next) NotSupportedFilter.filterCreate
(Context context, CreateRequest createRequest, RequestHandler requestHandler) ExecutorFilter.filterDelete
(Context context, DeleteRequest request, RequestHandler next) NotSupportedFilter.filterDelete
(Context context, DeleteRequest deleteRequest, RequestHandler requestHandler) ExecutorFilter.filterPatch
(Context context, PatchRequest request, RequestHandler next) NotSupportedFilter.filterPatch
(Context context, PatchRequest patchRequest, RequestHandler requestHandler) ExecutorFilter.filterQuery
(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next) NotSupportedFilter.filterQuery
(Context context, QueryRequest queryRequest, QueryResourceHandler queryResourceHandler, RequestHandler requestHandler) ExecutorFilter.filterRead
(Context context, ReadRequest request, RequestHandler next) NotSupportedFilter.filterRead
(Context context, ReadRequest readRequest, RequestHandler requestHandler) ExecutorFilter.filterUpdate
(Context context, UpdateRequest request, RequestHandler next) NotSupportedFilter.filterUpdate
(Context context, UpdateRequest updateRequest, RequestHandler requestHandler) ModifierConstructorDescriptionInternalSsoTokenContext
(Context parent, String token) Creates a newInternalSsoTokenContext
context with the provided token. -
Uses of Context in org.forgerock.openig.tools.authentication
Modifier and TypeMethodDescriptionAuthenticationService.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, ...).AuthenticatorAuthenticationService.authenticate
(Context context, String username, SecretReference<GenericSecret> passwordRef) -
Uses of Context in org.forgerock.openig.tools.authentication.chf
Modifier and TypeMethodDescriptionComputes (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.Refresh (and returns) the value, in a thread-safe manner.ModifierConstructorDescriptionAsyncRefreshableSupplier
(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
Modifier and TypeMethodDescriptionCacheSessionService.getSessionInfo
(Context context, String ssoToken) CrestSessionService.getSessionInfo
(Context context, String ssoToken) SessionService.getSessionInfo
(Context context, String ssoToken) Returns a promise that will be completed with an optionalSessionInfo
or with anSessionException
in case of errors.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
Modifier and TypeMethodDescriptionCacheUserProfileService.getUserProfile
(Context context, String username) CrestUserProfileService.getUserProfile
(Context context, String username) 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
Modifier and TypeMethodDescriptionRecordProvider.actionCollection
(Context context, ActionRequest request) RecordProvider.actionInstance
(Context context, String resourceId, ActionRequest request) RecordProvider.createInstance
(Context context, CreateRequest request) RecordProvider.deleteInstance
(Context context, String resourceId, DeleteRequest request) RecordProvider.patchInstance
(Context context, String resourceId, PatchRequest request) RecordProvider.queryCollection
(Context context, QueryRequest request, QueryResourceHandler resourceHandler) RecordProvider.readInstance
(Context context, String resourceId, ReadRequest request) RecordProvider.updateInstance
(Context context, String resourceId, UpdateRequest request) -
Uses of Context in org.forgerock.openig.uma
Modifier and TypeMethodDescriptionUmaSharingService.createShare
(Context context, String resourcePath, String pat) Creates a Share that will be used to protect the givenresourcePath
. -
Uses of Context in org.forgerock.openig.util
Modifier and TypeClassDescriptionfinal class
Context
implementation to hold error information regarding failures.ModifierConstructorDescriptionFailureContext
(Context parent, Exception exception) Create a newFailureContext
. -
Uses of Context in org.forgerock.services.context
Modifier and TypeClassDescriptionclass
A base implementation of theContext
interface.final class
AnAttributesContext
is a mechanism for transferring transient state between components when processing a single request.final class
Client context gives easy access to client-related information that are available into the request.class
A context for audit information for an incoming request.final class
AContext
which has an a globally unique ID but no parent.final class
AContext
containing information about the client performing the request which may be used when performing authorization decisions.class
This context aims to hold theTransactionId
.Modifier and TypeMethodDescriptionReturns 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.final <T extends Context>
T<T extends Context>
TReturns the first context in the chain whose type is a sub-type of the providedContext
class.Modifier and TypeMethodDescriptionfinal Context
AbstractContext.getContext
(String contextName) Context.getContext
(String contextName) Returns the first context in the chain whose context name matches the provided name.final Context
AbstractContext.getParent()
Context.getParent()
Returns the parent of this context.Modifier and TypeMethodDescriptionModifier and TypeMethodDescriptionstatic ClientContext.Builder
ClientContext.buildExternalClientContext
(Context parent) Creates aClientContext.Builder
for creating an externalClientContext
instance.static ClientContext
ClientContext.newInternalClientContext
(Context parent) Creates an internalClientContext
instance.Modifier and TypeMethodDescriptionfinal 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.ModifierConstructorDescriptionprotected
AbstractContext
(String id, String name, Context parent) Constructs a newAbstractContext
.protected
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.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
Modifier and TypeMethodDescriptionDescribable.handleApiRequest
(Context context, R request) Handle a request for the API Descriptor. -
Uses of Context in org.forgerock.services.routing
Modifier and TypeMethodDescriptionRouteMatch.decorateContext
(Context context) Decorates the given context with any routing information for the route.Modifier and TypeMethodDescriptionAbstractRouter.getBestApiRoute
(Context context, R request) Get the best route for an API request.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 TypeMethodDescriptionRouteMatch.decorateContext
(Context context) Decorates the given context with any routing information for the route.abstract RouteMatch
Evaluates the request and determines whether it matches the route.AbstractRouter.getBestApiRoute
(Context context, R request) Get the best route for an API request.AbstractRouter.getBestRoute
(Context context, R request) Finds the best route that matches the given request based on the route matchers of the registered routes.AbstractRouter.handleApiRequest
(Context context, R request)
AccessTokenResolver.resolve(Context, Supplier, String)
instead.