Uses of Interface
org.forgerock.services.context.Context
-
Packages that use Context Package Description org.forgerock.am.iot This package contains all classes pertaining to AM's IoT functionality.org.forgerock.authz.filter.crest.api This package defines the authorization API interfaces for use in a CREST environment.org.forgerock.caf.authentication.api This package defines the core interfaces and classes to provide an asynchronous and improved JASPI-like message authentication API.org.forgerock.caf.authentication.framework This package defines the authentication framework classes for the authentication of messages via authentication contexts and modules.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.json.resource Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.org.forgerock.monitoring Common utility classes for monitoring.org.forgerock.oauth Commons OAuth Framework API.org.forgerock.oauth.clients.apple Forgerock Apple Client implementation.org.forgerock.oauth.clients.facebook Forgerock Facebook Client Implementation.org.forgerock.oauth.clients.oauth2 OAuth 2.0 ForgeRock Client Implementation.org.forgerock.oauth.clients.oidc OpenID Connect ForgeRock Client Implementation.org.forgerock.openam.rest.resource This package contains classes for the handling of REST request to CREST Resource endpoints with the concept of realms in OpenAM built in.org.forgerock.openam.selfservice.config Contains classes for handling self service console configuration.org.forgerock.secrets.gcpkms A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.org.forgerock.selfservice.core This package contains the core implementation for the anonymous process service.org.forgerock.selfservice.stages.email This package contains a common email stage implementation.org.forgerock.selfservice.stages.kba This package contains a common user kba stage implementation.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.am.iot
Methods in org.forgerock.am.iot with parameters of type Context Modifier and Type Method Description Promise<ActionResponse,ResourceException>
ThingsResource. actionInstance(Context context, String id, ActionRequest request)
Promise<ActionResponse,ResourceException>
ThingsAccessAuditFilter. filterAction(Context context, ActionRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>
ThingsResource. readInstance(Context context, String id, ReadRequest request)
-
Uses of Context in org.forgerock.authz.filter.crest.api
Methods in org.forgerock.authz.filter.crest.api with parameters of type Context Modifier and Type Method Description Promise<AuthorizationResult,ResourceException>
CrestAuthorizationModule. authorizeAction(Context context, ActionRequest request)
Authorizes a received REST action request.Promise<AuthorizationResult,ResourceException>
CrestAuthorizationModule. authorizeCreate(Context context, CreateRequest request)
Authorizes a received REST create request.Promise<AuthorizationResult,ResourceException>
CrestAuthorizationModule. authorizeDelete(Context context, DeleteRequest request)
Authorizes a received REST delete request.Promise<AuthorizationResult,ResourceException>
CrestAuthorizationModule. authorizePatch(Context context, PatchRequest request)
Authorizes a received REST patch request.Promise<AuthorizationResult,ResourceException>
CrestAuthorizationModule. authorizeQuery(Context context, QueryRequest request)
Authorizes a received REST query request.Promise<AuthorizationResult,ResourceException>
CrestAuthorizationModule. authorizeRead(Context context, ReadRequest request)
Authorizes a received REST read request.Promise<AuthorizationResult,ResourceException>
CrestAuthorizationModule. authorizeUpdate(Context context, UpdateRequest request)
Authorizes a received REST update request. -
Uses of Context in org.forgerock.caf.authentication.api
Subinterfaces of Context in org.forgerock.caf.authentication.api Modifier and Type Interface Description interface
MessageContext
The authentication framework uses thisMessageContext
to pass messages and message processing state to authentication contexts for processing by authentication modules.interface
MessageInfoContext
The authentication framework uses thisMessageContextInfo
to pass messages and message processing state to authentication modules for processing of messages. -
Uses of Context in org.forgerock.caf.authentication.framework
Classes in org.forgerock.caf.authentication.framework that implement Context Modifier and Type Class Description class
MessageContextImpl
An implementation ofMessageContext
that holds contextual information and state for a given request and response message exchange.Methods in org.forgerock.caf.authentication.framework with parameters of type Context Modifier and Type Method Description Promise<Response,NeverThrowsException>
AuthenticationFilter. filter(Context context, Request request, Handler next)
Authenticates incoming request messages and if successful calls the downstream filter or handler and then secures the returned response. -
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.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.ApiDescription
AbstractConnectionWrapper. handleApiRequest(Context context, Request request)
ApiDescription
DescribedSyncRequestHandlerAdapter. handleApiRequest(Context context, Request request)
ApiDescription
FilterChain. handleApiRequest(Context context, Request request)
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.monitoring
Methods in org.forgerock.monitoring with parameters of type Context Modifier and Type Method Description Promise<QueryResponse,ResourceException>
DropwizardMetricsCollectionResourceProvider. queryCollection(Context context, QueryRequest request, QueryResourceHandler handler)
Promise<ResourceResponse,ResourceException>
DropwizardMetricsCollectionResourceProvider. readInstance(Context context, String resourceId, ReadRequest request)
-
Uses of Context in org.forgerock.oauth
Methods in org.forgerock.oauth with parameters of type Context Modifier and Type Method Description Promise<JsonValue,OAuthException>
OAuthClient. handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
Handle the data produced by the Auth Server as a result of a successful authentication and return the final redirect to the mobile device. -
Uses of Context in org.forgerock.oauth.clients.apple
Methods in org.forgerock.oauth.clients.apple with parameters of type Context Modifier and Type Method Description Promise<JsonValue,OAuthException>
AppleClient. handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> requestParameters)
-
Uses of Context in org.forgerock.oauth.clients.facebook
Methods in org.forgerock.oauth.clients.facebook with parameters of type Context Modifier and Type Method Description protected Promise<JsonValue,OAuthException>
FacebookClient. getAppAccessToken(Context context)
Retrieves the app access token from IDP.protected AsyncFunction<JsonValue,JsonValue,OAuthException>
FacebookClient. getInputTokenInfo(Context context, String inputToken)
Retrieves the access token information as aJsonValue
.Promise<JsonValue,OAuthException>
FacebookClient. handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
-
Uses of Context in org.forgerock.oauth.clients.oauth2
Methods in org.forgerock.oauth.clients.oauth2 with parameters of type Context Modifier and Type Method Description protected Promise<JsonValue,OAuthException>
OAuth2Client. getAccessTokenInfo(Context context, String accessToken)
Retrieves the access token information as aJsonValue
.Promise<JsonValue,OAuthException>
OAuth2Client. handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
-
Uses of Context in org.forgerock.oauth.clients.oidc
Methods in org.forgerock.oauth.clients.oidc with parameters of type Context Modifier and Type Method Description Promise<JsonValue,OAuthException>
OpenIDConnectClient. handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
-
Uses of Context in org.forgerock.openam.rest.resource
-
Uses of Context in org.forgerock.openam.selfservice.config
Methods in org.forgerock.openam.selfservice.config with parameters of type Context Modifier and Type Method Description ProcessInstanceConfig
ServiceConfigProvider. getServiceConfig(C config, Context context, String realm)
Provides the self service config for the appropriate flow. -
Uses of Context in org.forgerock.secrets.gcpkms
Constructor parameters in org.forgerock.secrets.gcpkms with type arguments of type Context Constructor Description ChfHttpTransport(Handler httpHandler, Supplier<Context> context)
Initialises the transport with the given CHF client handler and context supplier. -
Uses of Context in org.forgerock.selfservice.core
Classes in org.forgerock.selfservice.core that implement Context Modifier and Type Class Description class
SelfServiceContext
A Context that indicates the request came from Self-Service.Methods in org.forgerock.selfservice.core that return Context Modifier and Type Method Description Context
ProcessContext. getRequestContext()
Gets the request context.Methods in org.forgerock.selfservice.core with parameters of type Context Modifier and Type Method Description Promise<ActionResponse,ResourceException>
AnonymousProcessService. handleAction(Context context, ActionRequest request)
Promise<ResourceResponse,ResourceException>
AnonymousProcessService. handleRead(Context context, ReadRequest request)
Promise<ResourceResponse,ResourceException>
UserUpdateService. patchInstance(Context context, String resourceId, PatchRequest request)
Constructors in org.forgerock.selfservice.core with parameters of type Context Constructor Description SelfServiceContext(Context parent)
Constructs a new SelfServiceContext. -
Uses of Context in org.forgerock.selfservice.stages.email
Methods in org.forgerock.selfservice.stages.email with parameters of type Context Modifier and Type Method Description void
EmailVerificationWhitelist. add(Context context, String token)
Add the token to the whitelist.boolean
EmailVerificationWhitelist. validateAndRemove(Context context, String token)
Check to see if the token is valid (still in whitelist) and remove it. -
Uses of Context in org.forgerock.selfservice.stages.kba
Methods in org.forgerock.selfservice.stages.kba with parameters of type Context Modifier and Type Method Description void
SecurityAnswerLockoutManager. handleSecurityAnswerMatchFailure(Context context, JsonValue user, String identityServiceUrl)
Handle the security answer match failure.void
SecurityAnswerLockoutManager. validateUserLockout(Context context, JsonValue user)
Verifies whether user should be allowed to attempt security answer verification. -
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)
-