Package | Description |
---|---|
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 |
Core
Filter implementations. |
org.forgerock.http.handler |
Core
Handler implementations. |
org.forgerock.http.oauth2 |
This package provides APIs for OAuth 2.0 services implementations.
|
org.forgerock.http.oauth2.resolver |
This package defines OpenAM specific logic needed to retrieve an
AccessTokenInfo . |
org.forgerock.http.routing |
Provides routing functionality for HTTP requests.
|
org.forgerock.http.session |
Provides interfaces for managing and interacting with HTTP Sessions.
|
org.forgerock.json.resource |
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
|
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.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 the
Context interface and various common protocol
independent implementations. |
org.forgerock.services.descriptor |
Classes that allow services to be described.
|
org.forgerock.services.routing |
This package provides a simple framework for implementing routers.
|
Modifier and Type | Method and Description |
---|---|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeAction(Context context,
ActionRequest request)
Authorizes a received REST action request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeCreate(Context context,
CreateRequest request)
Authorizes a received REST create request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeDelete(Context context,
DeleteRequest request)
Authorizes a received REST delete request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizePatch(Context context,
PatchRequest request)
Authorizes a received REST patch request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeQuery(Context context,
QueryRequest request)
Authorizes a received REST query request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeRead(Context context,
ReadRequest request)
Authorizes a received REST read request.
|
Promise<AuthorizationResult,ResourceException> |
CrestAuthorizationModule.authorizeUpdate(Context context,
UpdateRequest request)
Authorizes a received REST update request.
|
Modifier and Type | Interface and Description |
---|---|
interface |
MessageContext
The authentication framework uses this
MessageContext to pass messages and message
processing state to authentication contexts for processing by authentication modules. |
interface |
MessageInfoContext
The authentication framework uses this
MessageContextInfo to pass messages and
message processing state to authentication modules for processing of messages. |
Modifier and Type | Class and Description |
---|---|
class |
MessageContextImpl
An implementation of
MessageContext that holds contextual information and state for a
given request and response message exchange. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
AuthenticationFilter.filter(Context context,
Request request,
Handler next)
Authenticates incoming request messages and if successful calls the downstream filter or
handler and then secures the returned response.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
Filter.filter(Context context,
Request request,
Handler next)
Filters the request and/or response of an exchange.
|
Promise<Response,NeverThrowsException> |
Handler.handle(Context context,
Request request)
|
Promise<Response,NeverThrowsException> |
Client.send(Context context,
Request request)
Sends an HTTP request and returns a
Promise representing the
pending HTTP response. |
Promise<Response,NeverThrowsException> |
Client.sendWithoutClose(Context context,
Request request)
Sends an HTTP request and returns a
Promise representing the
pending HTTP response. |
Constructor and Description |
---|
Client(Handler handler,
Context defaultContext)
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
TransactionIdOutboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TransactionIdInboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
OptionsFilter.filter(Context context,
Request request,
Handler next)
Handles all OPTION requests to CREST resources, all other request methods are handled by the
Handler . |
Promise<Response,NeverThrowsException> |
CsrfFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
HttpClientHandler.handle(Context context,
Request request)
Sends an HTTP request to a remote server and returns a
Promise
representing the asynchronous response. |
Modifier and Type | Class and Description |
---|---|
class |
OAuth2Context
An
OAuth2Context could be used to store and retrieve an AccessTokenInfo . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceServerFilter.filter(Context context,
Request request,
Handler next) |
Promise<Set<String>,ResponseException> |
ResourceAccess.getRequiredScopes(Context context,
Request request)
Returns the scopes required to access the resource.
|
Promise<AccessTokenInfo,AccessTokenException> |
AccessTokenResolver.resolve(Context context,
String token)
Resolves a given access token against an authorization server.
|
Constructor and Description |
---|
OAuth2Context(Context parent,
AccessTokenInfo accessToken)
Creates a new OAuth2 context with the provided
AccessTokenInfo . |
Modifier and Type | Method and Description |
---|---|
Promise<AccessTokenInfo,AccessTokenException> |
TokenIntrospectionAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
OpenAmAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
CachingAccessTokenResolver.resolve(Context context,
String token) |
Modifier and Type | Class and Description |
---|---|
class |
ApiVersionRouterContext
A
Context which is created when a request is and has been routed
based on resource API version. |
class |
UriRouterContext
A
Context which is created when a request has been routed. |
Modifier and Type | Method and Description |
---|---|
protected ApiVersionRouterContext |
ResourceApiVersionRoutingFilter.createApiVersionRouterContext(Context context)
Creates a
ApiVersionRouterContext using the default version
behaviour and whether to issue warnings from the
behaviourManager instance. |
Promise<Response,NeverThrowsException> |
ResourceApiVersionRoutingFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
Router.handle(Context context,
Request request) |
static UriRouterContext.Builder |
UriRouterContext.uriRouterContext(Context parent)
Return a builder for a new
UriRouterContext . |
Constructor and Description |
---|
ApiVersionRouterContext(Context parent,
DefaultVersionBehaviour defaultVersionBehaviour,
boolean warningEnabled)
Creates a new resource API version routing context having the provided
parent, default versioning behaviour and whether warnings will be
issued.
|
UriRouterContext(Context parent,
String matchedUri,
String remainingUri,
Map<String,String> uriTemplateVariables)
Creates a new routing context having the provided parent, URI template
variables, and an ID automatically generated using
UUID.randomUUID() . |
UriRouterContext(Context parent,
String matchedUri,
String remainingUri,
Map<String,String> uriTemplateVariables,
URI originalUri)
Creates a new routing context having the provided parent, URI template
variables, and an ID automatically generated using
UUID.randomUUID() . |
Modifier and Type | Class and Description |
---|---|
class |
SessionContext
A
SessionContext is a mechanism for maintaining state between components when processing a successive
requests from the same logical client or end-user. |
Constructor and Description |
---|
SessionContext(Context parent,
Session session)
Constructs a new
SessionContext . |
Modifier and Type | Class and Description |
---|---|
class |
AdviceContext
A
Context containing information which should be returned to the user in some
appropriate form to the user. |
Modifier and Type | Method and Description |
---|---|
protected Context |
AbstractConnectionWrapper.transform(Context context)
Optional Context-transformation function if the implementer has
requirements to override the
Context provided in the
Connection 's method invocations. |
Modifier and Type | Method and Description |
---|---|
ActionResponse |
Connection.action(Context context,
ActionRequest request)
Performs an action against a specific resource, or set of resources.
|
ActionResponse |
AbstractConnectionWrapper.action(Context context,
ActionRequest request)
Performs an action against a specific resource, or set of resources.
|
ActionResponse |
AbstractAsynchronousConnection.action(Context context,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
Connection.actionAsync(Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
AbstractConnectionWrapper.actionAsync(Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
default Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
default Promise<ActionResponse,ResourceException> |
SingletonResourceProvider.actionInstance(Context context,
ActionRequest request)
Performs the provided
action against the single resource instance. |
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionInstance(Context context,
String id,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
default Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionInstance(Context context,
String resourceId,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
ResourceResponse |
Connection.create(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.create(Context context,
CreateRequest request)
Adds a new JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.create(Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.createAsync(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.createAsync(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
ResourceResponse |
Connection.delete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.delete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.delete(Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.deleteInstance(Context context,
String id,
DeleteRequest request)
Removes a resource instance from the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.deleteInstance(Context context,
String resourceId,
DeleteRequest request)
Removes a resource instance from the collection. |
Promise<ActionResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterAction(Context context,
ActionRequest request,
RequestHandler next) |
Promise<ActionResponse,ResourceException> |
Filter.filterAction(Context context,
ActionRequest request,
RequestHandler next)
Filters an action request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterCreate(Context context,
CreateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterCreate(Context context,
CreateRequest request,
RequestHandler next)
Filters a create request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next)
Filters a delete request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterPatch(Context context,
PatchRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterPatch(Context context,
PatchRequest request,
RequestHandler next)
Filters a patch request.
|
Promise<QueryResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterQuery(Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next) |
Promise<QueryResponse,ResourceException> |
Filter.filterQuery(Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next)
Filters a query request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterRead(Context context,
ReadRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterRead(Context context,
ReadRequest request,
RequestHandler next)
Filters a read request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next)
Filters an update request.
|
ActionResponse |
SynchronousRequestHandler.handleAction(Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
Promise<ActionResponse,ResourceException> |
Router.handleAction(Context context,
ActionRequest request) |
default Promise<ActionResponse,ResourceException> |
RequestHandler.handleAction(Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
Promise<ActionResponse,ResourceException> |
FilterChain.handleAction(Context context,
ActionRequest request) |
ApiDescription |
Router.handleApiRequest(Context context,
Request request) |
ApiDescription |
FilterChain.handleApiRequest(Context context,
Request request) |
ApiDescription |
DescribedSyncRequestHandlerAdapter.handleApiRequest(Context context,
Request request) |
ApiDescription |
AbstractConnectionWrapper.handleApiRequest(Context context,
Request request) |
ResourceResponse |
SynchronousRequestHandler.handleCreate(Context context,
CreateRequest request)
Adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
Router.handleCreate(Context context,
CreateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleCreate(Context context,
CreateRequest request)
Adds a new JSON resource, returning a
Promise that will be
completed when the resource has been added. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleCreate(Context context,
CreateRequest request) |
ResourceResponse |
SynchronousRequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
Router.handleDelete(Context context,
DeleteRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource, returning a
Promise that will be
completed when the resource has been deleted. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleDelete(Context context,
DeleteRequest request) |
ResourceResponse |
SynchronousRequestHandler.handlePatch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
Promise<ResourceResponse,ResourceException> |
Router.handlePatch(Context context,
PatchRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handlePatch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handlePatch(Context context,
PatchRequest request) |
QueryResponse |
SynchronousRequestHandler.handleQuery(Context context,
QueryRequest request,
Collection<ResourceResponse> resources)
Searches for all JSON resources matching a user specified set of
criteria.
|
Promise<QueryResponse,ResourceException> |
Router.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler) |
default Promise<QueryResponse,ResourceException> |
RequestHandler.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, returning a
Promise that will be completed when the
search has completed. |
Promise<QueryResponse,ResourceException> |
FilterChain.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler) |
ResourceResponse |
SynchronousRequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
Router.handleRead(Context context,
ReadRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource, returning a
Promise that will be
completed when the resource has been read. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleRead(Context context,
ReadRequest request) |
ResourceResponse |
SynchronousRequestHandler.handleUpdate(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
Promise<ResourceResponse,ResourceException> |
Router.handleUpdate(Context context,
UpdateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleUpdate(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleUpdate(Context context,
UpdateRequest request) |
boolean |
FilterCondition.matches(Context context,
Request request)
Returns
true if the conditional filter should be invoked, or
false if processing should continue directly to the next filter
in the filter chain. |
ResourceResponse |
Connection.patch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractConnectionWrapper.patch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content.
|
ResourceResponse |
AbstractAsynchronousConnection.patch(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.patchInstance(Context context,
PatchRequest request)
Patches the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.patchInstance(Context context,
String id,
PatchRequest request)
Patches an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.patchInstance(Context context,
String resourceId,
PatchRequest request)
Patches an existing resource within the collection. |
QueryResponse |
Connection.query(Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
AbstractConnectionWrapper.query(Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
AbstractAsynchronousConnection.query(Context context,
QueryRequest request,
Collection<? super ResourceResponse> results) |
QueryResponse |
Connection.query(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, and returns a
Promise that will be completed with the
results of the search. |
QueryResponse |
AbstractConnectionWrapper.query(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, and returns a
Promise that will be completed with the
results of the search. |
QueryResponse |
AbstractAsynchronousConnection.query(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
Connection.queryAsync(Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
Promise<QueryResponse,ResourceException> |
AbstractConnectionWrapper.queryAsync(Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
Promise<QueryResponse,ResourceException> |
MemoryBackend.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
default Promise<QueryResponse,ResourceException> |
CollectionResourceProvider.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
ResourceResponse |
Connection.read(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractConnectionWrapper.read(Context context,
ReadRequest request)
Reads a JSON resource.
|
ResourceResponse |
AbstractAsynchronousConnection.read(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.readInstance(Context context,
ReadRequest request)
Reads the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.readInstance(Context context,
String id,
ReadRequest request)
Reads an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.readInstance(Context context,
String resourceId,
ReadRequest request)
Reads an existing resource within the collection. |
protected Context |
AbstractConnectionWrapper.transform(Context context)
Optional Context-transformation function if the implementer has
requirements to override the
Context provided in the
Connection 's method invocations. |
ResourceResponse |
Connection.update(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractConnectionWrapper.update(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content.
|
ResourceResponse |
AbstractAsynchronousConnection.update(Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.updateInstance(Context context,
String id,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.updateInstance(Context context,
String resourceId,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.updateInstance(Context context,
UpdateRequest request)
Updates the single resource instance. |
Constructor and Description |
---|
AdviceContext(Context parent,
Collection<String> restrictedAdviceNames)
Creates a new AdviceContext with the provided parent.
|
Modifier and Type | Method and Description |
---|---|
ProcessInstanceConfig |
ServiceConfigProvider.getServiceConfig(C config,
Context context,
String realm)
Provides the self service config for the appropriate flow.
|
Modifier and Type | Class and Description |
---|---|
class |
SelfServiceContext
A Context that indicates the request came from Self-Service.
|
Modifier and Type | Method and Description |
---|---|
Context |
ProcessContext.getRequestContext()
Gets the request context.
|
Modifier and Type | Method and 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) |
Constructor and Description |
---|
SelfServiceContext(Context parent)
Constructs a new SelfServiceContext.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Method and 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.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractContext
A base implementation of the
Context interface. |
class |
AttributesContext
An
AttributesContext is a mechanism for transferring transient state between components when processing a
single request. |
class |
ClientContext
Client context gives easy access to client-related information that are available into the request.
|
class |
RequestAuditContext
A context for audit information for an incoming request.
|
class |
RootContext
A
Context which has an a globally unique ID but no parent. |
class |
SecurityContext
A
Context containing information about the client performing the
request which may be used when performing authorization decisions. |
class |
TransactionIdContext
This context aims to hold the
TransactionId . |
Modifier and Type | Method and Description |
---|---|
<T extends Context> |
Context.asContext(Class<T> clazz)
Returns the first context in the chain whose type is a sub-type of the
provided
Context class. |
<T extends Context> |
AbstractContext.asContext(Class<T> clazz) |
Modifier and Type | Method and Description |
---|---|
Context |
Context.getContext(String contextName)
Returns the first context in the chain whose context name matches the
provided name.
|
Context |
AbstractContext.getContext(String contextName) |
Context |
Context.getParent()
Returns the parent of this context.
|
Context |
AbstractContext.getParent() |
Modifier and Type | Method and Description |
---|---|
static ClientContext.Builder |
ClientContext.buildExternalClientContext(Context parent)
Creates a
ClientContext.Builder for creating an external ClientContext instance. |
static ClientContext |
ClientContext.newInternalClientContext(Context parent)
Creates an internal
ClientContext instance. |
Modifier and Type | Method and Description |
---|---|
boolean |
Context.containsContext(Class<? extends Context> clazz)
Returns
true if there is a context in the chain whose type is a
sub-type of the provided Context class. |
boolean |
AbstractContext.containsContext(Class<? extends Context> clazz) |
Constructor and Description |
---|
AbstractContext(Context parent,
String name)
Constructs a new
AbstractContext with a null id . |
AbstractContext(String id,
String name,
Context parent)
Constructs a new
AbstractContext . |
AttributesContext(Context parent)
Constructs a new
AttributesContext . |
RequestAuditContext(Context parent)
Constructs a new context using the specified parent and the current time as the request received time.
|
RequestAuditContext(Context parent,
Clock clock)
Constructs a new context using the specified parent and the current time as the request received time.
|
SecurityContext(Context parent,
String authenticationId,
Map<String,Object> authorization)
Creates a new security context having the provided parent and an ID
automatically generated using
UUID.randomUUID() . |
SecurityContext(String id,
Context parent,
String authenticationId,
Map<String,Object> authorization)
Creates a new security context having the provided ID, and parent.
|
TransactionIdContext(Context parent,
TransactionId transactionId)
Constructs a new TransactionIdContext.
|
Modifier and Type | Method and Description |
---|---|
D |
Describable.handleApiRequest(Context context,
R request)
Handle a request for the API Descriptor.
|
Modifier and Type | Method and Description |
---|---|
Context |
RouteMatch.decorateContext(Context context)
Decorates the given context with any routing information for the route.
|
Modifier and Type | Method and Description |
---|---|
protected Pair<Context,H> |
AbstractRouter.getBestApiRoute(Context context,
R request)
Get the best route for an API request.
|
protected Pair<Context,H> |
AbstractRouter.getBestRoute(Context context,
R request)
Finds the best route that matches the given request based on the route
matchers of the registered routes.
|
Modifier and Type | Method and Description |
---|---|
Context |
RouteMatch.decorateContext(Context context)
Decorates the given context with any routing information for the route.
|
abstract RouteMatch |
RouteMatcher.evaluate(Context context,
R request)
Evaluates the request and determines whether it matches the route.
|
RouteMatch |
DelegatingRouteMatcher.evaluate(Context context,
R request) |
protected Pair<Context,H> |
AbstractRouter.getBestApiRoute(Context context,
R request)
Get the best route for an API request.
|
protected Pair<Context,H> |
AbstractRouter.getBestRoute(Context context,
R request)
Finds the best route that matches the given request based on the route
matchers of the registered routes.
|
D |
AbstractRouter.handleApiRequest(Context context,
R request) |
Copyright © 2010-2018, ForgeRock All Rights Reserved.