Uses of Interface
org.forgerock.util.promise.Promise
Package
Description
This package contains all classes pertaining to AM's IoT functionality.
This package defines the authorization API interfaces for use in a CREST environment.
This package defines the core interfaces and classes to provide an asynchronous and improved
JASPI-like message authentication API.
This package defines the authentication framework classes for the authentication of messages
via authentication contexts and modules.
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
.Models and manages elements of the Hypertext Transfer Protocol.
Provides routing functionality for HTTP requests.
Provides interfaces for managing and interacting with HTTP Sessions.
HTTP service provider API.
This package contains classes which form the Open ID Connect JASPIc AuthN module.
This package contains classes for the Jwt Session JASPI Authentication Module.
Provides an API for the traversal and manipulation of JSON object model structures in Java.
Classes and interfaces for JWT encryption and JWEs.
Classes and interfaces for creating and manipulating JWKs.
This package contains classes to manage a JWKs URI.
Classes and interfaces for JWT signing and JWS'.
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
Implementation of
Macaroons: Cookies with contextual caveats for decentralized
authorization in the cloud. See
Macaroon
for more details.Common utility classes for monitoring.
Commons OAuth Framework API.
Forgerock Apple Client implementation.
Forgerock Facebook Client Implementation.
Forgerock LinkedIn Client Implementation.
OAuth 2.0 ForgeRock Client Implementation.
OpenID Connect ForgeRock Client Implementation.
This package contains classes to generate Open ID Resolvers, which can
validate a supplied JWS against an Open ID Connect provider.
This package contains classes for the handling of REST request to CREST Resource endpoints with the concept of realms
in OpenAM built in.
The AM supporting classes for centrally configuring secrets.
Classes and interfaces for core types including connections, entries, and
attributes.
Provides a unified API for accessing secrets of various kinds.
Contains secret credential related API objects.
Classes for integrating Google Secret Manager
into the ForgeRock Secrets API.
A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.
Secret store backend for retrieving keys from a local or remote JWK Set.
Implementations of
SecretStore
for accessing keys stored in Java KeyStores, such as
PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.A Secrets API backend that can obtain OAuth 2 access tokens from a token endpoint, along with a collection of
grant type handlers.
Provides a
SecretStore
implementation that loads secrets from a Common Configuration
PropertyResolver
and then decodes it with a
SecretPropertyFormat
.Secrets backend that reads secrets from a remote Hashicorp Vault server.
This package contains the core implementation for the anonymous process service.
Provides common interfaces and classes.
An implementation of the
Promise
API in Java.-
Uses of Promise in org.forgerock.am.cts
Modifier and TypeMethodDescriptiondefault Promise<PartialToken,
CoreTokenException> CTSPersistentStore.deleteAsync
(String tokenId) Delete the Token from the store asynchronously based on its id.CTSPersistentStore.deleteAsync
(String tokenId, Options options) Delete the Token from the store asynchronously based on its id.default Promise<PartialToken,
CoreTokenException> CTSPersistentStore.deleteAsync
(Token token) Deletes the Token from the store asynchronously. -
Uses of Promise in org.forgerock.am.cts.api
Modifier and TypeMethodDescriptionTokenStorageAdapter.deleteAsync
(String tokenId, Options options) Performs a delete against the Token ID provided. -
Uses of Promise in org.forgerock.am.cts.reaper
Modifier and TypeMethodDescriptionDelete the token from the CTS persistence store. -
Uses of Promise in org.forgerock.am.iot
Modifier and TypeMethodDescriptionThingsResource.actionInstance
(Context context, String id, ActionRequest request) ThingsAccessAuditFilter.filterAction
(Context context, ActionRequest request, RequestHandler next) ThingsResource.readInstance
(Context context, String id, ReadRequest request) -
Uses of Promise in org.forgerock.authz.filter.crest.api
Modifier and TypeMethodDescriptionCrestAuthorizationModule.authorizeAction
(Context context, ActionRequest request) Authorizes a received REST action request.CrestAuthorizationModule.authorizeCreate
(Context context, CreateRequest request) Authorizes a received REST create request.CrestAuthorizationModule.authorizeDelete
(Context context, DeleteRequest request) Authorizes a received REST delete request.CrestAuthorizationModule.authorizePatch
(Context context, PatchRequest request) Authorizes a received REST patch request.CrestAuthorizationModule.authorizeQuery
(Context context, QueryRequest request) Authorizes a received REST query request.CrestAuthorizationModule.authorizeRead
(Context context, ReadRequest request) Authorizes a received REST read request.CrestAuthorizationModule.authorizeUpdate
(Context context, UpdateRequest request) Authorizes a received REST update request. -
Uses of Promise in org.forgerock.caf.authentication.api
Modifier and TypeMethodDescriptionAsyncServerAuthContext.cleanSubject
(MessageContext context, Subject clientSubject) Removes any method specific principals and credentials from the client subject.AsyncServerAuthModule.cleanSubject
(MessageInfoContext messageInfo, Subject clientSubject) Removes any method specific principals and credentials from the client subject.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> AsyncServerAuthContext.secureResponse
(MessageContext context, Subject serviceSubject) Secures the outgoing response message.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> AsyncServerAuthModule.secureResponse
(MessageInfoContext messageInfo, Subject serviceSubject) Secures the outgoing response message.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> AsyncServerAuthContext.validateRequest
(MessageContext context, Subject clientSubject, Subject serviceSubject) Validates the incoming request message.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> AsyncServerAuthModule.validateRequest
(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Validates the incoming request message. -
Uses of Promise in org.forgerock.caf.authentication.framework
Modifier and TypeMethodDescriptionFallbackAuthContext.cleanSubject
(MessageContext context, Subject clientSubject) Calls eachAsyncServerAuthContext
in parallel to clean the client subject and only return a successful promise if all complete successfully otherwise returns the first exception in a failed promise.Authenticates incoming request messages and if successful calls the downstream filter or handler and then secures the returned response.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> FallbackAuthContext.secureResponse
(MessageContext context, Subject serviceSubject) Secures the response message using the sameAsyncServerAuthModule
that authenticated the incoming request message.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> FallbackAuthContext.validateRequest
(MessageContext context, Subject clientSubject, Subject serviceSubject) Authenticates the incoming request message by calling eachAsyncServerAuthModule
in order until an auth module returns anAuthStatus
value other thanSEND_FAILURE
, or returns anAuthenticationException
or the end of the module list is reached. -
Uses of Promise 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.Sends an HTTP request and returns aPromise
representing the pending HTTP response.Client.sendWithoutClose
(Request request) 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 Promise in org.forgerock.http.filter
Modifier and TypeMethodDescriptionHandles all OPTION requests to CREST resources, all other request methods are handled by theHandler
. -
Uses of Promise in org.forgerock.http.filter.cors
-
Uses of Promise in org.forgerock.http.handler
-
Uses of Promise in org.forgerock.http.oauth2
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. -
Uses of Promise 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) ModifierConstructorDescriptionCachingAccessTokenResolver
(Clock clock, AccessTokenResolver resolver, PerItemEvictionStrategyCache<String, Promise<AccessTokenInfo, AccessTokenException>> cache) Builds aCachingAccessTokenResolver
delegating to the givenAccessTokenResolver
using the given (pre-configured) cache. -
Uses of Promise in org.forgerock.http.protocol
Modifier and TypeMethodDescriptionPromise<byte[],
IOException> Entity.getBytesAsync()
Returns a promise of the decoded entity content as a byte array.Entity.getFormAsync()
Returns a promise of a copy of the "application/x-www-form-urlencoded" entity decoded as a form.Entity.getJsonAsync()
Returns a promise of the content of this entity decoded as a JSON object.Entity.getRawContentInputStreamAsync()
Returns a promise of an input stream representing the raw content of this entity.Entity.getStringAsync()
Returns a promise of the content of this entity decoded as a string.static Promise<Response,
NeverThrowsException> Response.newResponsePromise
(Response response) Returns aPromise
representing theResponse
for an asynchronousRequest
which has already completed. -
Uses of Promise in org.forgerock.http.routing
-
Uses of Promise in org.forgerock.http.session
Modifier and TypeMethodDescriptionLoads a new Session for the givenRequest
.Saves the session into the provided response. -
Uses of Promise in org.forgerock.http.spi
-
Uses of Promise in org.forgerock.jaspi.modules.openid
Modifier and TypeMethodDescriptionOpenIdConnectModule.cleanSubject
(MessageInfoContext messageInfo, Subject subject) Nothing to clean.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> OpenIdConnectModule.secureResponse
(MessageInfoContext messageInfo, Subject subject) Sends SEND_SUCCESS automatically.Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> OpenIdConnectModule.validateRequest
(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Attempts to retrieve the value of the specified OpenID Connect header from the messageInfo, then converts this to a Jwt and attempts to decrypt. -
Uses of Promise in org.forgerock.jaspi.modules.session.jwt
Modifier and TypeMethodDescriptionAuthenticatedEncryptionCryptographyHandler.buildJwtAsync
(JwtBuilderFactory jwtBuilderFactory, JwtClaimsSet claimsSet) default Promise<String,
NoSuchSecretException> JwtCryptographyHandler.buildJwtAsync
(JwtBuilderFactory jwtBuilderFactory, JwtClaimsSet claimsSet) Builds a JWT with the given claims set.JwtSessionModule.cleanSubject
(MessageInfoContext messageInfo, Subject clientSubject) Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> JwtSessionModule.secureResponse
(MessageInfoContext messageInfo, Subject serviceSubject) Promise<javax.security.auth.message.AuthStatus,
AuthenticationException> JwtSessionModule.validateRequest
(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) -
Uses of Promise in org.forgerock.json
Modifier and TypeMethodDescriptionJsonValue.asAsync
(AsyncFunction<JsonValue, V, E> transformFunction) Returns the JSON value as a promised object whose type (and value) is specified by a transformation function. -
Uses of Promise in org.forgerock.json.jose.jwe
Modifier and TypeMethodDescriptionPromise<? extends EncryptedJwt,
JweDecryptionCheckedException> EncryptedJwt.decrypt
(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose) Attempts to decrypt the JWT using any available keys for the givenPurpose
from the givenSecretsProvider
.Promise<? extends EncryptedJwt,
JweDecryptionCheckedException> EncryptedJwt.decrypt
(ValidSecretsReference<? extends CryptoKey, NeverThrowsException> secretsReference) Attempts to decrypt the JWT using any available keys from the givenValidSecretsReference
.SignedThenEncryptedJwt.decrypt
(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose) SignedThenEncryptedJwt.decrypt
(ValidSecretsReference<? extends CryptoKey, NeverThrowsException> validSecretsReference) SignedThenEncryptedJwt.decryptAndVerify
(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> decryptionPurpose, Purpose<VerificationKey> verificationPurpose) Decrypts the outer JWT and then verifies the signature on the inner JWT using secrets from the suppliedSecretsProvider
.SignedThenEncryptedJwt.decryptAndVerify
(ValidSecretsReference<? extends CryptoKey, NeverThrowsException> decryptionSecretsReference, ValidSecretsReference<VerificationKey, NeverThrowsException> verificationSecretsReference) Decrypts the outer JWT and then verifies the signature on the inner JWT using supplied valid secrets.Promise<byte[],
JweDecryptionCheckedException> EncryptedJwt.decryptRawPayload
(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose) Attempts to decrypt the raw payload of the JWT using any keys from the givenSecretsProvider
that satisfy the suppliedPurpose
.Promise<byte[],
JweDecryptionCheckedException> EncryptedJwt.decryptRawPayload
(ValidSecretsReference<? extends CryptoKey, NeverThrowsException> secretsReference) Attempts to decrypt the raw payload of the JWT using any keys from the given theSecret
s contained in the givenValidSecretsReference
. -
Uses of Promise in org.forgerock.json.jose.jwk
Modifier and TypeMethodDescriptionJWKSetParser.gatherHttpContentsAsync
(URL url) Uses the Client to gather HTTP information.JWKSetParser.jwkSetAsync
(URL url) Provides a JWK set as indicated by the JWKSet's URL. -
Uses of Promise in org.forgerock.json.jose.jwk.store
Modifier and TypeMethodDescriptionJwksStoreService.configureJwksStoreAsync
(String uid, Duration cacheTimeout, Duration cacheMissCacheTime, URL jwkUrl, Clock clock) Configure a JWKs store.JwksStore.findJwkAsync
(String kid) Search asynchronously for a JWK that matches the kid.JwksStore.findJwkAsync
(Predicate<JWK> predicate) Return the JWK matching the keyID with the algorithm and keyUse.JwksStore.findJwkAsync
(Algorithm algorithm, String keyUse) Search asynchronously for a JWK that matches the algorithm and the key usage.JwksStore.getLatestJwkSet()
Returns the latest non expired successfully loaded JWK Set.static Promise<JwksStore,
FailedToLoadJWKException> JwksStore.newJwksStore
(Duration cacheTimeout, Duration cacheMissCacheTime, URL jwkUrl, JWKSetParser jwkSetParser, Clock clock) Create a new JWKs store asynchronously.JwksStore.reloadJwksAsync()
Communicates with the configured server, attempting to download the latest JWKs for use.JwksStore.setJwkUrlAsync
(URL jwkUrl) Update the JWKs URI. -
Uses of Promise in org.forgerock.json.jose.jws
Modifier and TypeMethodDescriptionPromise<? extends EncryptedJwt,
JweDecryptionCheckedException> EncryptedThenSignedJwt.decrypt
(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> decryptionPurpose) Decrypts the inner encrypted JWE so that the payload can be accessed.Promise<? extends EncryptedJwt,
JweDecryptionCheckedException> EncryptedThenSignedJwt.decrypt
(ValidSecretsReference<? extends CryptoKey, NeverThrowsException> secretsReference) Decrypts the inner encrypted JWE so that the payload can be accessed.SigningManager.newSigningHandler
(Purpose<SigningKey> purpose) Constructs a new SigningHandler configured for signing with the provided secret purpose.SigningManager.newSigningHandler
(SecretReference<SigningKey> secretReference) Constructs a new SigningHandler configured for signing with the provided secret reference.SigningManager.newVerificationHandler
(Purpose<VerificationKey> purpose, String keyId) Constructs a new SigningHandler configured for verifying with the provided secret purpose.SigningManager.newVerificationHandler
(ValidSecretsReference<VerificationKey, NeverThrowsException> validSecrets) Constructs a new SigningHandler configured for verifying with the provided valid secrets reference. -
Uses of Promise in org.forgerock.json.resource
Modifier and TypeMethodDescriptionAbstractConnectionWrapper.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.ActionResponse.asPromise()
Return this response as a result Promise.QueryResponse.asPromise()
Return this response as a result Promise.<V> Promise<V,
ResourceException> ResourceException.asPromise()
Return this ResourceException as a Promise.ResourceResponse.asPromise()
Return this response as a result Promise.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.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) ConnectionFactory.getConnectionAsync()
Asynchronously obtains a connection to the JSON resource provider associated with this connection factory.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) 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) 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) 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) 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) 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) 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) 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.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.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.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. -
Uses of Promise in org.forgerock.macaroons
Modifier and TypeMethodDescriptionVerifies the given macaroon using any valid verification key and testing to see that all caveats are satisfied. -
Uses of Promise in org.forgerock.monitoring
Modifier and TypeMethodDescriptionDropwizardMetricsCollectionResourceProvider.queryCollection
(Context context, QueryRequest request, QueryResourceHandler handler) DropwizardMetricsCollectionResourceProvider.readInstance
(Context context, String resourceId, ReadRequest request) -
Uses of Promise in org.forgerock.oauth
Modifier and TypeMethodDescription<V> Promise<V,
OAuthException> OAuthException.asPromise()
Return this OAuthException as a Promise.OAuthClient.getAuthRedirect
(DataStore dataStore, String data, URI landingPage) Return the URI that the user agent should be redirected to, to authenticate and authorize access.Promise<? extends SessionInfo,
OAuthException> OAuthClient.getSessionInfo
(DataStore dataStore) Validate whether an Auth Server session is still active and valid.OAuthClient.getUserInfo
(DataStore dataStore) Return the authenticated user's info from the external authentication server.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.Handle the data produced by the Auth Server as a result of a successful authentication and return the final redirect to the landing page specified in theOAuthClient.getAuthRedirect(DataStore, String, URI)
call.Refreshes a token if it has expired. -
Uses of Promise in org.forgerock.oauth.clients.apple
Modifier and TypeMethodDescriptionAppleClient.getUserInfo
(DataStore dataStore) AppleClient.handleNativePostAuth
(Context context, DataStore dataStore, Map<String, List<String>> requestParameters) -
Uses of Promise in org.forgerock.oauth.clients.facebook
Modifier and TypeMethodDescriptionprotected Promise<JsonValue,
OAuthException> FacebookClient.getAppAccessToken
(Context context) Retrieves the app access token from IDP.FacebookClient.handleNativePostAuth
(Context context, DataStore dataStore, Map<String, List<String>> parameters) -
Uses of Promise in org.forgerock.oauth.clients.linkedin
-
Uses of Promise in org.forgerock.oauth.clients.oauth2
Modifier and TypeMethodDescriptionprotected Promise<JsonValue,
OAuthException> OAuth2Client.createPostResponse
(DataStore dataStore, JsonValue storedData) Creates the post response.protected Promise<Request,
OAuthException> OAuth2Client.createRequestForIntrospectEndpoint
(String accessToken) Creates aRequest
for the introspect endpoint of an identity provider.protected Promise<Request,
OAuthException> OAuth2Client.createRequestForTokenEndpoint
(String code) Deprecated.UseOAuth2Client.createAuthRedirectUri(String, String)
and specify a PKCE verifier.protected Promise<Request,
OAuthException> OAuth2Client.createRequestForTokenEndpoint
(String code, String pkceVerifier) Creates aRequest
for the token endpoint of an identity provider.protected Promise<Request,
OAuthException> OAuth2Client.createRequestForTokenRefresh
(JsonValue storedData) Creates aRequest
for the token refresh endpoint of an identity provider.protected Promise<JsonValue,
OAuthException> OAuth2Client.getAccessTokenInfo
(Context context, String accessToken) Retrieves the access token information as aJsonValue
.OAuth2Client.getAuthRedirect
(DataStore dataStore, String data, URI landingPage) Promise<? extends OAuth2SessionInfo,
OAuthException> OAuth2Client.getSessionInfo
(DataStore dataStore) OAuth2Client.getUserInfo
(DataStore dataStore) OAuth2Client.handleNativePostAuth
(Context context, DataStore dataStore, Map<String, List<String>> parameters) -
Uses of Promise in org.forgerock.oauth.clients.oidc
Modifier and TypeMethodDescriptionOpenIDConnectClient.getAuthRedirect
(DataStore dataStore, String data, URI landingPage) Promise<? extends OAuth2SessionInfo,
OAuthException> OpenIDConnectClient.getSessionInfo
(DataStore dataStore) OpenIDConnectClient.getUserInfo
(DataStore dataStore) OpenIDConnectClient.handleNativePostAuth
(Context context, DataStore dataStore, Map<String, List<String>> parameters) -
Uses of Promise in org.forgerock.oauth.resolvers
Modifier and TypeMethodDescriptionWellKnownOpenIdConfigurationFactory.buildAsync
(String configuredIssuer, URL configUrl) Returns a JWKOpenIdResolverImpl representing the contents of the supplied URL.WellKnownOpenIdConfigurationFactory.buildAsync
(BiPredicate<String, String> issuerComparator, String configuredIssuer, URL configUrl) Returns a JWKOpenIdResolverImpl representing the contents of the supplied URL. -
Uses of Promise in org.forgerock.openam.rest.resource
Modifier and TypeMethodDescriptionRestrictedTokenContextFilter.filterAction
(Context context, ActionRequest request, RequestHandler next) RestrictedTokenContextFilter.filterCreate
(Context context, CreateRequest request, RequestHandler next) RestrictedTokenContextFilter.filterDelete
(Context context, DeleteRequest request, RequestHandler next) RestrictedTokenContextFilter.filterPatch
(Context context, PatchRequest request, RequestHandler next) RestrictedTokenContextFilter.filterQuery
(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next) RestrictedTokenContextFilter.filterRead
(Context context, ReadRequest request, RequestHandler next) RestrictedTokenContextFilter.filterUpdate
(Context context, UpdateRequest request, RequestHandler next) -
Uses of Promise in org.forgerock.openam.secrets
Modifier and TypeMethodDescription<S extends Secret>
Promise<S,NoSuchSecretException> SecretsProviderFacade.getActiveSecret
(DefaultingPurpose<S> defaultingPurpose, String instanceId) Get the active secret for aDefaultingPurpose
.<S extends Secret>
Promise<S,NoSuchSecretException> SecretsProviderFacade.getActiveSecret
(Purpose<S> purpose) <S extends Secret>
Promise<S,NoSuchSecretException> SecretsProviderFacade.getNamedSecret
(DefaultingPurpose<S> defaultingPurpose, String instanceId, String keyId) Get the named secret for aDefaultingPurpose
.<S extends Secret>
Promise<S,NoSuchSecretException> SecretsProviderFacade.getNamedSecret
(Purpose<S> purpose, String id) <S extends Secret>
Promise<Stream<S>,NeverThrowsException> SecretsProviderFacade.getValidSecrets
(DefaultingPurpose<S> defaultingPurpose, String instanceId) Get a stream of the valid secrets for aDefaultingPurpose
.<S extends Secret>
Promise<Stream<S>,NeverThrowsException> SecretsProviderFacade.getValidSecrets
(Purpose<S> purpose) -
Uses of Promise in org.forgerock.opendj.ldap
Modifier and TypeInterfaceDescriptioninterface
LdapPromise<S>
A handle which can be used to retrieve the Result of an asynchronous Request.Modifier and TypeMethodDescriptionConnectionFactory.getConnectionAsync()
Asynchronously obtains a connection to the Directory Server associated with this connection factory.LdapConnectionFactory.getConnectionAsync()
Utils.toPromise
(io.reactivex.rxjava3.core.Maybe<V> maybe, io.reactivex.rxjava3.functions.Function<Throwable, E> exceptionConverter) Transforms a Maybe into a Promise.Utils.toPromise
(io.reactivex.rxjava3.core.Single<V> single, io.reactivex.rxjava3.functions.Function<Throwable, E> exceptionConverter) Transforms a Single into a Promise.static <V> Promise<V,
NeverThrowsException> Utils.toPromiseNoError
(io.reactivex.rxjava3.core.Single<V> single) Transforms a Single into a Promise which do not throws exceptions. -
Uses of Promise in org.forgerock.secrets
Modifier and TypeMethodDescriptionSecretDecoder.decodeToPromise
(byte[] data) Decodes the raw data retrieved from a backend into aSecretBuilder
for further processing.default <S extends T>
Promise<S,NoSuchSecretException> Returns the active secret for the given purpose.<S extends T>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<S,NoSuchSecretException> SecretsProvider.getActiveSecret
(Purpose<S> purpose) Gets the currently active secret for the given purpose.SecretReference.getAsync()
Gets the current active secret object asynchronously, refreshing it if necessary.ValidSecretsReference.getAsync()
Gets the secrets asynchronously, refreshing them if necessary.default <S extends T>
Promise<S,NoSuchSecretException> Returns the named secret from this store.<S extends T>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<Stream<S>,NeverThrowsException> SecretsProvider.getNamedOrValidSecrets
(Purpose<S> purpose, String id) If the given id is not null, then this returns the single named secret that corresponds to that stable id (or a stream of valid secrets for the givenpurpose
if no such secret exists), otherwise it returns all valid secrets for the given purpose.<S extends Secret>
Promise<S,NoSuchSecretException> SecretsProvider.getNamedSecret
(Purpose<S> purpose, String id) Gets the secret for the given purpose with the given stable secret id.<S extends T>
Promise<Stream<S>,NeverThrowsException> Returns all valid secrets for the given purpose from this store.<S extends T>
Promise<Stream<S>,NeverThrowsException> <S extends Secret>
Promise<Stream<S>,NeverThrowsException> SecretsProvider.getValidSecrets
(Purpose<S> purpose) Returns all secrets for the given purpose which have not yet expired. -
Uses of Promise in org.forgerock.secrets.credentials
Modifier and TypeMethodDescriptionCredentialPair.getAsync()
Gets thePrincipalAndSecret
asynchronously. -
Uses of Promise in org.forgerock.secrets.gcp.sm
Modifier and TypeMethodDescription<S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<Stream<S>,NeverThrowsException> -
Uses of Promise in org.forgerock.secrets.gcpkms
Modifier and TypeMethodDescriptionGoogleKmsEncryptedPropertyFormat.decodeToPromise
(String propertyValue) <S extends CryptoKey>
Promise<S,NoSuchSecretException> <S extends CryptoKey>
Promise<S,NoSuchSecretException> <S extends CryptoKey>
Promise<Stream<S>,NeverThrowsException> -
Uses of Promise in org.forgerock.secrets.jwkset
-
Uses of Promise in org.forgerock.secrets.keystore
Modifier and TypeMethodDescription<S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<Stream<S>,NeverThrowsException> -
Uses of Promise in org.forgerock.secrets.oauth2
Modifier and TypeMethodDescription<S extends GenericSecret>
Promise<S,NoSuchSecretException> <S extends GenericSecret>
Promise<S,NoSuchSecretException> <S extends GenericSecret>
Promise<Stream<S>,NeverThrowsException> protected Promise<Form,
NoSuchSecretException> protected Promise<Form,
NoSuchSecretException> Handles the request by adding appropriate parameters to the OAuth 2.0 token endpoint request.protected Promise<Form,
NoSuchSecretException> protected Promise<Form,
NoSuchSecretException> protected Promise<Form,
NoSuchSecretException> -
Uses of Promise in org.forgerock.secrets.propertyresolver
Modifier and TypeMethodDescriptionPemPropertyFormat.decodeToPromise
(String propertyValue) default Promise<SecretBuilder,
NoSuchSecretException> SecretPropertyFormat.decodeToPromise
(byte[] data) Decodes the data as a UTF-8 string and then callsSecretPropertyFormat.decodeToPromise(String)
to decode the string value.default Promise<SecretBuilder,
NoSuchSecretException> SecretPropertyFormat.decodeToPromise
(String propertyValue) Decodes the input property value, setting relevant properties on aSecretBuilder
object.<S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<S,NoSuchSecretException> <S extends Secret>
Promise<Stream<S>,NeverThrowsException> <S extends Secret>
Promise<Stream<S>,NeverThrowsException> Returns a stream of the active secret for the given purpose. -
Uses of Promise in org.forgerock.secrets.vault
Modifier and TypeMethodDescriptionVaultKeyValueSecretStore.SecretFieldDecoder.apply
(SecretBuilder secretBuilder, JsonValue jsonValue) Decodes a JSON value into one or more fields on aSecretBuilder
. -
Uses of Promise in org.forgerock.selfservice.core
Modifier and TypeMethodDescriptionAnonymousProcessService.handleAction
(Context context, ActionRequest request) AnonymousProcessService.handleRead
(Context context, ReadRequest request) UserUpdateService.patchInstance
(Context context, String resourceId, PatchRequest request) -
Uses of Promise in org.forgerock.util
Modifier and TypeMethodDescriptionAsynchronously applies this function to the input parametervalue
and returns aPromise
for the result.Invokes the delegate async function'sAsyncFunction.apply(Object)
with the input parametervalue
, closes it when the delegated promise completes. -
Uses of Promise in org.forgerock.util.promise
Modifier and TypeClassDescriptionclass
PromiseImpl<V,
E extends Exception> An implementation ofPromise
which can be used as is, or as the basis for more complex asynchronous behavior.Modifier and TypeMethodDescriptionstatic Promise<Void,
NeverThrowsException> Promises.allDone
(Collection<Promise<?, ?>> promises) Returns aPromise
which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions).static <V> Promise<V,
NeverThrowsException> Promises.allDone
(Collection<Promise<?, ?>> promises, V context) Returns aPromise
which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions), returning back thecontext
parameter.Promises.executeAsync
(Executor executor, Supplier<T, E> supplier) Execute the provided supplier through the executor and returns immediately aPromise
that will be completed once the supplier has been executed.static Promise<Promises.Results,
Exception> Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.static Promise<Promises.Results,
Exception> Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.Promises.newExceptionPromise
(E exception) Returns aPromise
representing an asynchronous task which has already failed with the provided exception.Promises.newPromise
(Supplier<V, E> supplier) Execute a task and return the result as aPromise
.Promises.newResultPromise
(V result) Returns aPromise
representing an asynchronous task which has already succeeded with the provided result.Promises.newRuntimeExceptionPromise
(RuntimeException exception) Returns aPromise
representing an asynchronous task which has already failed with the provided runtime exception.Promises.newVoidResultPromise()
Returns aPromise
representing an asynchronous task which has already succeeded without result.Submits the provided function for execution once thisPromise
has completed with a result, and returns a newPromise
representing the outcome of the function.Submits the provided functions for execution once thisPromise
has completed (with a result or an exception), and returns a newPromise
representing the outcome of the invoked function.Promise.then
(Function<? super V, VOUT, EOUT> onResult, Function<? super E, VOUT, EOUT> onException, Function<? super RuntimeException, VOUT, EOUT> onRuntimeException) Submits the provided functions for execution once thisPromise
has completed (with a result or an exception or aRuntimeException
), and returns a newPromise
representing the outcome of the invoked function.PromiseImpl.then
(Function<? super V, VOUT, EOUT> onResult, Function<? super E, VOUT, EOUT> onException, Function<? super RuntimeException, VOUT, EOUT> onRuntimeException) Promise.thenAlways
(Runnable onResultOrException) Submits the provided runnable for execution once thisPromise
has completed, and regardless of whether it has a result or an exception.PromiseImpl.thenAlways
(Runnable always) Promise.thenAsync
(AsyncFunction<? super V, VOUT, E> onResult) Submits the provided asynchronous function for execution once thisPromise
has completed with a result, and returns a newPromise
representing the outcome of the function.Promise.thenAsync
(AsyncFunction<? super V, VOUT, EOUT> onResult, AsyncFunction<? super E, VOUT, EOUT> onException) Submits the provided asynchronous functions for execution once thisPromise
has completed, and returns a newPromise
representing the outcome of the invoked function.Promise.thenAsync
(AsyncFunction<? super V, VOUT, EOUT> onResult, AsyncFunction<? super E, VOUT, EOUT> onException, AsyncFunction<? super RuntimeException, VOUT, EOUT> onRuntimeException) Submits the provided asynchronous functions for execution once thisPromise
has completed, and returns a newPromise
representing the outcome of the invoked function.PromiseImpl.thenAsync
(AsyncFunction<? super V, VOUT, E> onResult) PromiseImpl.thenAsync
(AsyncFunction<? super V, VOUT, EOUT> onResult, AsyncFunction<? super E, VOUT, EOUT> onException) PromiseImpl.thenAsync
(AsyncFunction<? super V, VOUT, EOUT> onResult, AsyncFunction<? super E, VOUT, EOUT> onException, AsyncFunction<? super RuntimeException, VOUT, EOUT> onRuntimeException) Submits the provided function for execution once thisPromise
has not completed with a result (has completed with an exception), and returns a newPromise
representing the outcome of the function.Promise.thenCatchAsync
(AsyncFunction<? super E, V, EOUT> onException) Submits the provided asynchronous function for execution once thisPromise
has completed with an exception, and returns a newPromise
representing the outcome of the function.PromiseImpl.thenCatchAsync
(AsyncFunction<? super E, V, EOUT> onException) Promise.thenCatchRuntimeException
(Function<? super RuntimeException, V, E> onRuntimeException) Submits the provided function for execution once thisPromise
has not completed with a result nor with an exception but with aRuntimeException
, and returns a newPromise
representing the outcome of the function.PromiseImpl.thenCatchRuntimeException
(Function<? super RuntimeException, V, E> onRuntimeException) Promise.thenCatchRuntimeExceptionAsync
(AsyncFunction<? super RuntimeException, V, E> onRuntimeException) Submits the provided asynchronous function for execution once thisPromise
has completed with aRuntimeException
, and returns a newPromise
representing the outcome of the function.PromiseImpl.thenCatchRuntimeExceptionAsync
(AsyncFunction<? super RuntimeException, V, E> onRuntimeException) Promise.thenDiscardResult()
Discards the promise result if thisPromise
has completed with a result.Promise.thenFinally
(Runnable onResultOrException) Submits the provided runnable for execution once thisPromise
has completed, and regardless of whether of its outcome.PromiseImpl.thenFinally
(Runnable onFinally) <T extends ResultHandler<? super V> & ExceptionHandler<? super E> & RuntimeExceptionHandler>
Promise<V,E> Promise.thenOnCompletion
(T handler) Registers the provided completion handler for notification for all completion cases of thisPromise
.final <T extends ResultHandler<? super V> & ExceptionHandler<? super E> & RuntimeExceptionHandler>
Promise<V,E> PromiseImpl.thenOnCompletion
(T handler) Promise.thenOnException
(ExceptionHandler<? super E> onException) Registers the provided completion handler for notification if thisPromise
cannot be completed due to an exception.PromiseImpl.thenOnException
(ExceptionHandler<? super E> onException) Promise.thenOnResult
(ResultHandler<? super V> onResult) Registers the provided completion handler for notification once thisPromise
has completed with a result.PromiseImpl.thenOnResult
(ResultHandler<? super V> onResult) Promise.thenOnResultOrException
(Runnable onResultOrException) Submits the provided runnable for execution once thisPromise
has completed, and regardless of whether it has a result or an exception.Promise.thenOnResultOrException
(ResultHandler<? super V> onResult, ExceptionHandler<? super E> onException) Registers the provided completion handlers for notification once thisPromise
has completed (with a result or an exception).PromiseImpl.thenOnResultOrException
(Runnable onResultOrException) PromiseImpl.thenOnResultOrException
(ResultHandler<? super V> onResult, ExceptionHandler<? super E> onException) Promise.thenOnRuntimeException
(RuntimeExceptionHandler onRuntimeException) Registers the provided completion handler for notification if thisPromise
cannot be completed due to an runtime exception.PromiseImpl.thenOnRuntimeException
(RuntimeExceptionHandler onRuntimeException) Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.Modifier and TypeMethodDescriptionPromises.anyResultFrom
(Stream<Promise<V, E>> promises) Takes a stream of promises that may not yet be resolved and returns a resolved value from them, or if none resolve to a result, the failure from the last.Modifier and TypeMethodDescriptionstatic Promise<Promises.Results,
Exception> Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.Modifier and TypeMethodDescriptionstatic Promise<Void,
NeverThrowsException> Promises.allDone
(Collection<Promise<?, ?>> promises) Returns aPromise
which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions).static <V> Promise<V,
NeverThrowsException> Promises.allDone
(Collection<Promise<?, ?>> promises, V context) Returns aPromise
which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions), returning back thecontext
parameter.Promises.anyResultFrom
(Stream<Promise<V, E>> promises) Takes a stream of promises that may not yet be resolved and returns a resolved value from them, or if none resolve to a result, the failure from the last.static Promise<Promises.Results,
Exception> Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.Returns aPromise
which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
AccessTokenResolver.resolve(Context, Supplier, String)
instead.