Uses of Interface
org.forgerock.util.promise.Promise

Packages that use Promise

Package	Description
org.forgerock.am.cts
org.forgerock.am.cts.queue
org.forgerock.am.cts.reaper
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	Core Filter implementations.
org.forgerock.http.filter.cors	Support for CORS.
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.protocol	Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.routing	Provides routing functionality for HTTP requests.
org.forgerock.http.session	Provides interfaces for managing and interacting with HTTP Sessions.
org.forgerock.http.spi	HTTP service provider API.
org.forgerock.jaspi.modules.openid	This package contains classes which form the Open ID Connect JASPIc AuthN module.
org.forgerock.jaspi.modules.session.jwt	This package contains classes for the Jwt Session JASPI Authentication Module.
org.forgerock.json	Provides an API for the traversal and manipulation of JSON object model structures in Java.
org.forgerock.json.jose.jwe	Classes and interfaces for JWT encryption and JWEs.
org.forgerock.json.jose.jwk	Classes and interfaces for creating and manipulating JWKs.
org.forgerock.json.jose.jwk.store	This package contains classes to manage a JWKs URI.
org.forgerock.json.jose.jws	Classes and interfaces for JWT signing and JWS'.
org.forgerock.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.macaroons	Implementation of Macaroons: Cookies with contextual caveats for decentralized authorization in the cloud. See Macaroon for more details.
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.linkedin	Forgerock LinkedIn 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.oauth.resolvers	This package contains classes to generate Open ID Resolvers, which can validate a supplied JWS against an Open ID Connect provider.
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.secrets	The AM supporting classes for centrally configuring secrets.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.gcp.sm	Classes for integrating Google Secret Manager into the ForgeRock Secrets API.
org.forgerock.secrets.gcpkms	A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.
org.forgerock.secrets.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.
org.forgerock.secrets.keystore	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.
org.forgerock.secrets.propertyresolver	Provides a SecretStore implementation that loads secrets from a Common Configuration PropertyResolver and then decodes it with a SecretPropertyFormat.
org.forgerock.secrets.vault	Secrets backend that reads secrets from a remote Hashicorp Vault server.
org.forgerock.selfservice.core	This package contains the core implementation for the anonymous process service.
org.forgerock.util	Provides common interfaces and classes.
org.forgerock.util.promise	An implementation of the Promise API in Java.

Uses of Promise in org.forgerock.am.cts

Methods in org.forgerock.am.cts that return Promise

Modifier and Type	Method	Description
default Promise<Collection<PartialToken>,CoreTokenException>	CTSPersistentStore.attributeQueryAsync(TokenFilter tokenFilter)	Performs a partial Token query against the store synchronously.
Promise<Collection<PartialToken>,CoreTokenException>	CTSPersistentStore.attributeQueryAsync(TokenFilter tokenFilter, Options options)	Performs a partial Token query against the store synchronously.
default Promise<Token,CoreTokenException>	CTSPersistentStore.createAsync(Token token)	Creates a Token in the persistent store asynchronously.
Promise<Token,CoreTokenException>	CTSPersistentStore.createAsync(Token token, Options options)	Creates a Token in the persistent store asynchronously.
default Promise<PartialToken,CoreTokenException>	CTSPersistentStore.deleteAsync(String tokenId)	Delete the Token from the store asynchronously based on its id.
Promise<PartialToken,CoreTokenException>	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.
Promise<Collection<PartialToken>,CoreTokenException>	CTSPersistentStore.deleteOnQueryAsync(TokenFilter tokenFilter, Options options)	Performs an asynchronous query against the persistent store using the provided TokenFilter and then deletes the matching tokens from the store.
default Promise<PartialToken,CoreTokenException>	CTSPersistentStore.patchAsync(String tokenId, TokenType tokenType, TokenModifications modifications)	Asynchronously patches a token which already exists in the persistent store with modifications.
Promise<PartialToken,CoreTokenException>	CTSPersistentStore.patchAsync(String tokenId, TokenType tokenType, TokenModifications modifications, Options options)	Asynchronously patches a token which already exists in the persistent store with modifications.
default Promise<Token,CoreTokenException>	CTSPersistentStore.updateAsync(Token readState, Token updatedState)	Updates an existing Token in the store asynchronously.
Promise<Token,CoreTokenException>	CTSPersistentStore.updateAsync(Token readState, Token updatedState, Options options)	Updates an existing Token in the store asynchronously.
default Promise<Token,CoreTokenException>	CTSPersistentStore.upsertAsync(Token token)	Updates an existing Token in the store asynchronously.
Promise<Token,CoreTokenException>	CTSPersistentStore.upsertAsync(Token token, Options options)	Updates an existing Token in the store asynchronously.

Uses of Promise in org.forgerock.am.cts.queue

Methods in org.forgerock.am.cts.queue that return Promise

Modifier and Type	Method	Description
Promise<Token,CoreTokenException>	TaskDispatcher.create(Token token, Options options)	The CTS Token to create in the persistent store.
Promise<PartialToken,CoreTokenException>	TaskDispatcher.delete(String tokenId, Options options)	The Token ID, for a specific revision of the token, to delete from the persistent store.
Promise<Collection<PartialToken>,CoreTokenException>	TaskDispatcher.partialQuery(TokenFilter tokenFilter, Options options)	Perform a query against the persistent store and signal the results to the provided ResultHandler.
Promise<PartialToken,CoreTokenException>	TaskDispatcher.patch(String tokenId, TokenModifications modifications, Options options)	Patches a token in the persistent store.
Promise<Collection<Token>,CoreTokenException>	TaskDispatcher.query(TokenFilter tokenFilter, Options options)	Perform a query against the persistent store and signal the results to the provided ResultHandler.
Promise<Token,CoreTokenException>	TaskDispatcher.read(String tokenId, Options options)	The CTS Token to read from the persistent store.
Promise<Token,CoreTokenException>	TaskDispatcher.update(Token readState, Token updatedState, Options options)	The CTS Token to update in the persistent store.
Promise<Token,CoreTokenException>	TaskDispatcher.upsert(Token token, Options options)	The CTS Token to create or update in the persistent store.

Uses of Promise in org.forgerock.am.cts.reaper

Methods in org.forgerock.am.cts.reaper that return Promise

Modifier and Type	Method	Description
Promise<PartialToken,CoreTokenException>	TokenDeletionStrategy.delete(String tokenId, TokenType tokenType, long expiryTime)	Delete the token from the CTS persistence store.

Uses of Promise in org.forgerock.am.iot

Methods in org.forgerock.am.iot that return Promise

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 Promise in org.forgerock.authz.filter.crest.api

Methods in org.forgerock.authz.filter.crest.api that return Promise

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 Promise in org.forgerock.caf.authentication.api

Methods in org.forgerock.caf.authentication.api that return Promise

Modifier and Type	Method	Description
Promise<Void,AuthenticationException>	AsyncServerAuthContext.cleanSubject(MessageContext context, Subject clientSubject)	Removes any method specific principals and credentials from the client subject.
Promise<Void,AuthenticationException>	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

Methods in org.forgerock.caf.authentication.framework that return Promise

Modifier and Type	Method	Description
Promise<Void,AuthenticationException>	FallbackAuthContext.cleanSubject(MessageContext context, Subject clientSubject)	Calls each AsyncServerAuthContext 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.
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.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	FallbackAuthContext.secureResponse(MessageContext context, Subject serviceSubject)	Secures the response message using the same AsyncServerAuthModule 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 each AsyncServerAuthModule in order until an auth module returns an AuthStatus value other than SEND_FAILURE, or returns an AuthenticationException or the end of the module list is reached.

Uses of Promise in org.forgerock.http

Methods in org.forgerock.http that return Promise

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)	Returns a Promise representing the asynchronous Response of the given request.
Promise<Response,NeverThrowsException>	Client.send(Request request)	Sends an HTTP request and returns a Promise representing the pending HTTP response.
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(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.

Uses of Promise in org.forgerock.http.filter

Methods in org.forgerock.http.filter that return Promise

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 the Handler.
Promise<Response,NeverThrowsException>	TransactionIdInboundFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	TransactionIdOutboundFilter.filter(Context context, Request request, Handler next)

Uses of Promise in org.forgerock.http.filter.cors

Methods in org.forgerock.http.filter.cors that return Promise

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	CorsFilter.filter(Context context, Request request, Handler next)

Uses of Promise in org.forgerock.http.handler

Methods in org.forgerock.http.handler that return Promise

Modifier and Type	Method	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.

Uses of Promise in org.forgerock.http.oauth2

Methods in org.forgerock.http.oauth2 that return Promise

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. Use AccessTokenResolver.resolve(Context, Supplier, String) instead.
default Promise<AccessTokenInfo,AccessTokenException>	AccessTokenResolver.resolve(Context context, Supplier<Request,IOException> request, String token)	Resolves a given access token against an authorization server.

Uses of Promise in org.forgerock.http.oauth2.resolver

Methods in org.forgerock.http.oauth2.resolver that return Promise

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)

Constructor parameters in org.forgerock.http.oauth2.resolver with type arguments of type Promise

Constructor	Description
CachingAccessTokenResolver(Clock clock, AccessTokenResolver resolver, PerItemEvictionStrategyCache<String,Promise<AccessTokenInfo,AccessTokenException>> cache)	Builds a CachingAccessTokenResolver delegating to the given AccessTokenResolver using the given (pre-configured) cache.

Uses of Promise in org.forgerock.http.protocol

Methods in org.forgerock.http.protocol that return Promise

Modifier and Type	Method	Description
Promise<byte[],IOException>	Entity.getBytesAsync()	Returns a promise of the decoded entity content as a byte array.
Promise<Form,IOException>	Entity.getFormAsync()	Returns a promise of a copy of the "application/x-www-form-urlencoded" entity decoded as a form.
Promise<Object,IOException>	Entity.getJsonAsync()	Returns a promise of the content of this entity decoded as a JSON object.
Promise<InputStream,NeverThrowsException>	Entity.getRawContentInputStreamAsync()	Returns a promise of an input stream representing the raw content of this entity.
Promise<String,IOException>	Entity.getStringAsync()	Returns a promise of the content of this entity decoded as a string.
static Promise<Response,NeverThrowsException>	Response.newResponsePromise(Response response)	Returns a Promise representing the Response for an asynchronous Request which has already completed.

Uses of Promise in org.forgerock.http.routing

Methods in org.forgerock.http.routing that return Promise

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	ResourceApiVersionRoutingFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	Router.handle(Context context, Request request)

Uses of Promise in org.forgerock.http.session

Methods in org.forgerock.http.session that return Promise

Modifier and Type	Method	Description
Promise<Session,NeverThrowsException>	AsyncSessionManager.loadAsync(Request request)	Loads a new Session for the given Request.
Promise<Void,IOException>	AsyncSessionManager.saveAsync(Session session, Response response)	Saves the session into the provided response.

Uses of Promise in org.forgerock.http.spi

Methods in org.forgerock.http.spi that return Promise

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	HttpClient.sendAsync(Request request)	Returns a Promise representing the asynchronous Response of the given request.

Uses of Promise in org.forgerock.jaspi.modules.openid

Methods in org.forgerock.jaspi.modules.openid that return Promise

Modifier and Type	Method	Description
Promise<Void,AuthenticationException>	OpenIdConnectModule.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

Methods in org.forgerock.jaspi.modules.session.jwt that return Promise

Modifier and Type	Method	Description
Promise<Void,AuthenticationException>	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

Methods in org.forgerock.json that return Promise

Modifier and Type	Method	Description
<V,E extends Exception> Promise<V,E>	JsonValue.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

Methods in org.forgerock.json.jose.jwe that return Promise

Modifier and Type	Method	Description
Promise<? extends EncryptedJwt,JweDecryptionCheckedException>	EncryptedJwt.decrypt(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose)	Attempts to decrypt the JWT using any available keys for the given Purpose from the given SecretsProvider.
Promise<SignedThenEncryptedJwt,JweDecryptionCheckedException>	SignedThenEncryptedJwt.decrypt(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose)
Promise<SignedThenEncryptedJwt,JweDecryptionCheckedException>	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 supplied SecretsProvider.
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 given SecretsProvider that satisfy the supplied Purpose.

Uses of Promise in org.forgerock.json.jose.jwk

Methods in org.forgerock.json.jose.jwk that return Promise

Modifier and Type	Method	Description
Promise<JsonValue,FailedToLoadJWKException>	JWKSetParser.gatherHttpContentsAsync(URL url)	Uses the Client to gather HTTP information.
Promise<JWKSet,FailedToLoadJWKException>	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

Methods in org.forgerock.json.jose.jwk.store that return Promise

Modifier and Type	Method	Description
Promise<JwksStore,FailedToLoadJWKException>	JwksStoreService.configureJwksStoreAsync(String uid, Duration cacheTimeout, Duration cacheMissCacheTime, URL jwkUrl, Clock clock)	Configure a JWKs store.
Promise<JWK,FailedToLoadJWKException>	JwksStore.findJwkAsync(String kid)	Search asynchronously for a JWK that matches the kid.
Promise<JWK,FailedToLoadJWKException>	JwksStore.findJwkAsync(Algorithm algorithm, String keyUse)	Search asynchronously for a JWK that matches the algorithm and the key usage.
Promise<JWKSet,FailedToLoadJWKException>	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.
Promise<Void,FailedToLoadJWKException>	JwksStore.reloadJwksAsync()	Communicates with the configured server, attempting to download the latest JWKs for use.
Promise<Void,FailedToLoadJWKException>	JwksStore.setJwkUrlAsync(URL jwkUrl)	Update the JWKs URI.

Uses of Promise in org.forgerock.json.jose.jws

Methods in org.forgerock.json.jose.jws that return Promise

Modifier and Type	Method	Description
Promise<? extends EncryptedJwt,JweDecryptionCheckedException>	EncryptedThenSignedJwt.decrypt(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> decryptionPurpose)	Decrypts the inner encrypted JWE so that the payload can be accessed.
Promise<SigningHandler,NoSuchSecretException>	SigningManager.newSigningHandler(Purpose<SigningKey> purpose)	Constructs a new SigningHandler configured for signing with the provided secret purpose.
Promise<SigningHandler,NoSuchSecretException>	SigningManager.newSigningHandler(SecretReference<SigningKey> secretReference)	Constructs a new SigningHandler configured for signing with the provided secret reference.
Promise<SigningHandler,NeverThrowsException>	SigningManager.newVerificationHandler(Purpose<VerificationKey> purpose, String keyId)	Constructs a new SigningHandler configured for verifying with the provided secret purpose.

Uses of Promise in org.forgerock.json.resource

Methods in org.forgerock.json.resource that return Promise

Modifier and Type	Method	Description
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 provided action against the resource collection.
Promise<ActionResponse,ResourceException>	MemoryBackend.actionCollection(Context context, ActionRequest request)	Performs the provided action against the resource collection.
default Promise<ActionResponse,ResourceException>	CollectionResourceProvider.actionInstance(Context context, String resourceId, ActionRequest request)	Performs the provided action against a resource within the collection.
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>	SingletonResourceProvider.actionInstance(Context context, ActionRequest request)	Performs the provided action against the single resource instance.
Promise<ActionResponse,ResourceException>	ActionResponse.asPromise()	Return this response as a result Promise.
Promise<QueryResponse,ResourceException>	QueryResponse.asPromise()	Return this response as a result Promise.
<V> Promise<V,ResourceException>	ResourceException.asPromise()	Return this ResourceException as a Promise.
Promise<ResourceResponse,ResourceException>	ResourceResponse.asPromise()	Return this response as a result Promise.
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.
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)
Promise<Connection,ResourceException>	ConnectionFactory.getConnectionAsync()	Asynchronously obtains a connection to the JSON resource provider associated with this connection factory.
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)
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 a Promise that will be completed when the resource has been added.
Promise<ResourceResponse,ResourceException>	Router.handleCreate(Context context, CreateRequest request)
Promise<ResourceResponse,ResourceException>	FilterChain.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>	Router.handleDelete(Context context, DeleteRequest 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 a Promise that will be completed when the resource has been updated.
Promise<ResourceResponse,ResourceException>	Router.handlePatch(Context context, PatchRequest request)
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 a Promise that will be completed when the search has completed.
Promise<QueryResponse,ResourceException>	Router.handleQuery(Context context, QueryRequest request, QueryResourceHandler handler)
Promise<ResourceResponse,ResourceException>	FilterChain.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>	Router.handleRead(Context context, ReadRequest request)
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 a Promise that will be completed when the resource has been updated.
Promise<ResourceResponse,ResourceException>	Router.handleUpdate(Context context, UpdateRequest request)
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.
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>	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.
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.
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.
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.

Uses of Promise in org.forgerock.macaroons

Methods in org.forgerock.macaroons that return Promise

Modifier and Type	Method	Description
Promise<MacaroonVerifierResult,RejectedMacaroonException>	MacaroonVerifier.verify(Macaroon macaroon)	Verifies the given macaroon using any valid verification key and testing to see that all caveats are satisfied.

Uses of Promise in org.forgerock.monitoring

Methods in org.forgerock.monitoring that return Promise

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 Promise in org.forgerock.oauth

Methods in org.forgerock.oauth that return Promise

Modifier and Type	Method	Description
<V> Promise<V,OAuthException>	OAuthException.asPromise()	Return this OAuthException as a Promise.
Promise<URI,OAuthException>	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.
Promise<UserInfo,OAuthException>	OAuthClient.getUserInfo(DataStore dataStore)	Return the authenticated user's info from the external authentication server.
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.
Promise<JsonValue,OAuthException>	OAuthClient.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)	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 the OAuthClient.getAuthRedirect(DataStore, String, URI) call.
Promise<Void,OAuthException>	OAuthClient.refresh(DataStore dataStore)	Refreshes a token if it has expired.

Uses of Promise in org.forgerock.oauth.clients.apple

Methods in org.forgerock.oauth.clients.apple that return Promise

Modifier and Type	Method	Description
Promise<UserInfo,OAuthException>	AppleClient.getUserInfo(DataStore dataStore)
Promise<JsonValue,OAuthException>	AppleClient.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> requestParameters)
Promise<JsonValue,OAuthException>	AppleClient.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)

Uses of Promise in org.forgerock.oauth.clients.facebook

Methods in org.forgerock.oauth.clients.facebook that return Promise

Modifier and Type	Method	Description
protected Promise<JsonValue,OAuthException>	FacebookClient.getAppAccessToken(Context context)	Retrieves the app access token from IDP.
Promise<JsonValue,OAuthException>	FacebookClient.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)

Uses of Promise in org.forgerock.oauth.clients.linkedin

Methods in org.forgerock.oauth.clients.linkedin that return Promise

Modifier and Type	Method	Description
Promise<UserInfo,OAuthException>	LinkedInClient.getUserInfo(DataStore dataStore)

Uses of Promise in org.forgerock.oauth.clients.oauth2

Methods in org.forgerock.oauth.clients.oauth2 that return Promise

Modifier and Type	Method	Description
protected Promise<JsonValue,OAuthException>	OAuth2Client.createPostResponse(DataStore dataStore, JsonValue storedData)	Creates the post response.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForIntrospectEndpoint(String accessToken)	Creates a Request for the introspect endpoint of an identity provider.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenEndpoint(String code)	Deprecated. Use OAuth2Client.createAuthRedirectUri(String, String) and specify a PKCE verifier.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenEndpoint(String code, String pkceVerifier)	Creates a Request for the token endpoint of an identity provider.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenRefresh(JsonValue storedData)	Creates a Request 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 a JsonValue.
Promise<URI,OAuthException>	OAuth2Client.getAuthRedirect(DataStore dataStore, String data, URI landingPage)
Promise<? extends OAuth2SessionInfo,OAuthException>	OAuth2Client.getSessionInfo(DataStore dataStore)
Promise<UserInfo,OAuthException>	OAuth2Client.getUserInfo(DataStore dataStore)
Promise<JsonValue,OAuthException>	OAuth2Client.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
Promise<JsonValue,OAuthException>	OAuth2Client.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)
Promise<Void,OAuthException>	OAuth2Client.refresh(DataStore dataStore)

Uses of Promise in org.forgerock.oauth.clients.oidc

Methods in org.forgerock.oauth.clients.oidc that return Promise

Modifier and Type	Method	Description
Promise<URI,OAuthException>	OpenIDConnectClient.getAuthRedirect(DataStore dataStore, String data, URI landingPage)
Promise<? extends OAuth2SessionInfo,OAuthException>	OpenIDConnectClient.getSessionInfo(DataStore dataStore)
Promise<UserInfo,OAuthException>	OpenIDConnectClient.getUserInfo(DataStore dataStore)
Promise<JsonValue,OAuthException>	OpenIDConnectClient.handleNativePostAuth(Context context, DataStore dataStore, Map<String,List<String>> parameters)
Promise<JsonValue,OAuthException>	OpenIDConnectClient.handlePostAuth(DataStore dataStore, Map<String,List<String>> requestParameters)

Uses of Promise in org.forgerock.oauth.resolvers

Methods in org.forgerock.oauth.resolvers that return Promise

Modifier and Type	Method	Description
Promise<JWKOpenIdResolverImpl,FailedToLoadJWKException>	WellKnownOpenIdConfigurationFactory.buildAsync(String configuredIssuer, URL configUrl)	Returns a JWKOpenIdResolverImpl representing the contents of the supplied URL.

Uses of Promise in org.forgerock.openam.rest.resource

Methods in org.forgerock.openam.rest.resource that return Promise

Modifier and Type	Method	Description
Promise<ActionResponse,ResourceException>	RestrictedTokenContextFilter.filterAction(Context context, ActionRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>	RestrictedTokenContextFilter.filterCreate(Context context, CreateRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>	RestrictedTokenContextFilter.filterDelete(Context context, DeleteRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>	RestrictedTokenContextFilter.filterPatch(Context context, PatchRequest request, RequestHandler next)
Promise<QueryResponse,ResourceException>	RestrictedTokenContextFilter.filterQuery(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next)
Promise<ResourceResponse,ResourceException>	RestrictedTokenContextFilter.filterRead(Context context, ReadRequest request, RequestHandler next)
Promise<ResourceResponse,ResourceException>	RestrictedTokenContextFilter.filterUpdate(Context context, UpdateRequest request, RequestHandler next)

Uses of Promise in org.forgerock.openam.secrets

Methods in org.forgerock.openam.secrets that return Promise

Modifier and Type	Method	Description
<S extends Secret> Promise<S,NoSuchSecretException>	SecretsProviderFacade.getActiveSecret(DefaultingPurpose<S> defaultingPurpose, String instanceId)	Get the active secret for a DefaultingPurpose.
<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 a DefaultingPurpose.
<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 a DefaultingPurpose.
<S extends Secret> Promise<Stream<S>,NeverThrowsException>	SecretsProviderFacade.getValidSecrets(Purpose<S> purpose)

Uses of Promise in org.forgerock.opendj.ldap

Subinterfaces of Promise in org.forgerock.opendj.ldap

Modifier and Type	Interface	Description
interface	LdapPromise<S>	A handle which can be used to retrieve the Result of an asynchronous Request.

Methods in org.forgerock.opendj.ldap that return Promise

Modifier and Type	Method	Description
Promise<Connection,LdapException>	ConnectionFactory.getConnectionAsync()	Asynchronously obtains a connection to the Directory Server associated with this connection factory.
Promise<Connection,LdapException>	LdapConnectionFactory.getConnectionAsync()
static <V,E extends Exception> Promise<V,E>	Utils.toPromise(io.reactivex.rxjava3.core.Maybe<V> maybe, io.reactivex.rxjava3.functions.Function<Throwable,E> exceptionConverter)	Transforms a Maybe into a Promise.
static <V,E extends Exception> Promise<V,E>	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.

Method parameters in org.forgerock.opendj.ldap with type arguments of type Promise

Modifier and Type	Method	Description
static <V,E extends Exception> io.reactivex.rxjava3.core.Maybe<V>	Utils.toMaybe(Callable<Promise<V,E>> callable)	Transforms a Promise into a Maybe.
static <V,E extends Exception> io.reactivex.rxjava3.core.Single<V>	Utils.toSingle(Callable<Promise<V,E>> callable)	Transforms a Promise into a Single.

Uses of Promise in org.forgerock.secrets

Methods in org.forgerock.secrets that return Promise

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	SecretDecoder.decodeToPromise(byte[] data)	Decodes the raw data retrieved from a backend into a SecretBuilder for further processing.
default <S extends T> Promise<S,NoSuchSecretException>	SecretStore.getActive(Purpose<S> purpose)	Returns the active secret for the given purpose.
<S extends T> Promise<S,NoSuchSecretException>	ThreadPoolSecretStore.getActive(Purpose<S> purpose)
<S extends Secret> Promise<S,NoSuchSecretException>	SecretsProvider.getActiveSecret(Purpose<S> purpose)	Gets the currently active secret for the given purpose.
Promise<T,NoSuchSecretException>	SecretReference.getAsync()	Gets the current active secret object asynchronously, refreshing it if necessary.
default <S extends T> Promise<S,NoSuchSecretException>	SecretStore.getNamed(Purpose<S> purpose, String name)	Returns the named secret from this store.
<S extends T> Promise<S,NoSuchSecretException>	ThreadPoolSecretStore.getNamed(Purpose<S> purpose, String name)
<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 given purpose 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>	SecretStore.getValid(Purpose<S> purpose)	Returns all valid secrets for the given purpose from this store.
<S extends T> Promise<Stream<S>,NeverThrowsException>	ThreadPoolSecretStore.getValid(Purpose<S> purpose)
<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.gcp.sm

Methods in org.forgerock.secrets.gcp.sm that return Promise

Modifier and Type	Method	Description
<S extends Secret> Promise<S,NoSuchSecretException>	GoogleSecretManagerSecretStore.getActive(Purpose<S> purpose)
<S extends Secret> Promise<S,NoSuchSecretException>	GoogleSecretManagerSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends Secret> Promise<Stream<S>,NeverThrowsException>	GoogleSecretManagerSecretStore.getValid(Purpose<S> purpose)

Uses of Promise in org.forgerock.secrets.gcpkms

Methods in org.forgerock.secrets.gcpkms that return Promise

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	GoogleKmsEncryptedPropertyFormat.decodeToPromise(String propertyValue)
<S extends CryptoKey> Promise<S,NoSuchSecretException>	GoogleKmsSecretStore.getActive(Purpose<S> purpose)
<S extends CryptoKey> Promise<S,NoSuchSecretException>	GoogleKmsSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends CryptoKey> Promise<Stream<S>,NeverThrowsException>	GoogleKmsSecretStore.getValid(Purpose<S> purpose)

Uses of Promise in org.forgerock.secrets.jwkset

Methods in org.forgerock.secrets.jwkset that return Promise

Modifier and Type	Method	Description
<S extends CryptoKey> Promise<S,NoSuchSecretException>	JwkSetSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends CryptoKey> Promise<Stream<S>,NeverThrowsException>	JwkSetSecretStore.getValid(Purpose<S> purpose)

Uses of Promise in org.forgerock.secrets.keystore

Methods in org.forgerock.secrets.keystore that return Promise

Modifier and Type	Method	Description
<S extends CryptoKey> Promise<S,NoSuchSecretException>	KeyStoreSecretStore.getActive(Purpose<S> purpose)
<S extends CryptoKey> Promise<S,NoSuchSecretException>	KeyStoreSecretStore.getNamed(Purpose<S> purpose, String id)
<S extends CryptoKey> Promise<Stream<S>,NeverThrowsException>	KeyStoreSecretStore.getValid(Purpose<S> purpose)

Uses of Promise in org.forgerock.secrets.propertyresolver

Methods in org.forgerock.secrets.propertyresolver that return Promise

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	PemPropertyFormat.decodeToPromise(String propertyValue)
default Promise<SecretBuilder,NoSuchSecretException>	SecretPropertyFormat.decodeToPromise(byte[] data)	Decodes the data as a UTF-8 string and then calls SecretPropertyFormat.decodeToPromise(String) to decode the string value.
default Promise<SecretBuilder,NoSuchSecretException>	SecretPropertyFormat.decodeToPromise(String propertyValue)	Decodes the input property value, setting relevant properties on a SecretBuilder object.
<S extends Secret> Promise<S,NoSuchSecretException>	PropertyResolverSecretStore.getActive(Purpose<S> purpose)
<S extends Secret> Promise<S,NoSuchSecretException>	PropertyResolverSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends Secret> Promise<Stream<S>,NeverThrowsException>	PropertyResolverSecretStore.getValid(Purpose<S> purpose)	Returns a stream of the active secret for the given purpose.

Uses of Promise in org.forgerock.secrets.vault

Methods in org.forgerock.secrets.vault that return Promise

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	VaultKeyValueSecretStore.SecretFieldDecoder.apply(SecretBuilder secretBuilder, JsonValue jsonValue)	Decodes a JSON value into one or more fields on a SecretBuilder.

Uses of Promise in org.forgerock.selfservice.core

Methods in org.forgerock.selfservice.core that return Promise

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)

Uses of Promise in org.forgerock.util

Methods in org.forgerock.util that return Promise

Modifier and Type	Method	Description
Promise<VOUT,E>	AsyncFunction.apply(VIN value)	Asynchronously applies this function to the input parameter value and returns a Promise for the result.
Promise<VOUT,E>	CloseSilentlyAsyncFunction.apply(VIN value)	Invokes the delegate async function's AsyncFunction.apply(Object) with the input parameter value, closes it when the delegated promise completes.

Uses of Promise in org.forgerock.util.promise

Classes in org.forgerock.util.promise that implement Promise

Modifier and Type	Class	Description
class	PromiseImpl<V,E extends Exception>	An implementation of Promise which can be used as is, or as the basis for more complex asynchronous behavior.

Methods in org.forgerock.util.promise that return Promise

Modifier and Type	Method	Description
static Promise<Void,NeverThrowsException>	Promises.allDone(Collection<Promise<?,?>> promises)	Returns a Promise 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 a Promise which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions), returning back the context parameter.
static Promise<Promises.Results,Exception>	Promises.join(List<Promise<?,? extends Exception>> promises)	Returns a Promise 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>	Promises.join(Promise<?,? extends Exception>... promises)	Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
static <V,E extends Exception> Promise<V,E>	Promises.newExceptionPromise(E exception)	Returns a Promise representing an asynchronous task which has already failed with the provided exception.
static <V,E extends Exception> Promise<V,E>	Promises.newPromise(Supplier<V,E> supplier)	Execute a task and return the result as a Promise.
static <V,E extends Exception> Promise<V,E>	Promises.newResultPromise(V result)	Returns a Promise representing an asynchronous task which has already succeeded with the provided result.
static <V,E extends Exception> Promise<V,E>	Promises.newRuntimeExceptionPromise(RuntimeException exception)	Returns a Promise representing an asynchronous task which has already failed with the provided runtime exception.
static <E extends Exception> Promise<Void,E>	Promises.newVoidResultPromise()	Returns a Promise representing an asynchronous task which has already succeeded without result.
<VOUT> Promise<VOUT,E>	Promise.then(Function<? super V,VOUT,E> onResult)	Submits the provided function for execution once this Promise has completed with a result, and returns a new Promise representing the outcome of the function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	Promise.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException)	Submits the provided functions for execution once this Promise has completed (with a result or an exception), and returns a new Promise representing the outcome of the invoked function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	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 this Promise has completed (with a result or an exception or a RuntimeException), and returns a new Promise representing the outcome of the invoked function.
<VOUT> Promise<VOUT,E>	PromiseImpl.then(Function<? super V,VOUT,E> onResult)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException)
Promise<V,E>	Promise.thenAlways(Runnable onResultOrException)	Submits the provided runnable for execution once this Promise has completed, and regardless of whether it has a result or an exception.
Promise<V,E>	PromiseImpl.thenAlways(Runnable always)
<VOUT> Promise<VOUT,E>	Promise.thenAsync(AsyncFunction<? super V,VOUT,E> onResult)	Submits the provided asynchronous function for execution once this Promise has completed with a result, and returns a new Promise representing the outcome of the function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	Promise.thenAsync(AsyncFunction<? super V,VOUT,EOUT> onResult, AsyncFunction<? super E,VOUT,EOUT> onException)	Submits the provided asynchronous functions for execution once this Promise has completed, and returns a new Promise representing the outcome of the invoked function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	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 this Promise has completed, and returns a new Promise representing the outcome of the invoked function.
<VOUT> Promise<VOUT,E>	PromiseImpl.thenAsync(AsyncFunction<? super V,VOUT,E> onResult)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.thenAsync(AsyncFunction<? super V,VOUT,EOUT> onResult, AsyncFunction<? super E,VOUT,EOUT> onException)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.thenAsync(AsyncFunction<? super V,VOUT,EOUT> onResult, AsyncFunction<? super E,VOUT,EOUT> onException, AsyncFunction<? super RuntimeException,VOUT,EOUT> onRuntimeException)
<EOUT extends Exception> Promise<V,EOUT>	Promise.thenCatch(Function<? super E,V,EOUT> onException)	Submits the provided function for execution once this Promise has not completed with a result (has completed with an exception), and returns a new Promise representing the outcome of the function.
<EOUT extends Exception> Promise<V,EOUT>	PromiseImpl.thenCatch(Function<? super E,V,EOUT> onException)
<EOUT extends Exception> Promise<V,EOUT>	Promise.thenCatchAsync(AsyncFunction<? super E,V,EOUT> onException)	Submits the provided asynchronous function for execution once this Promise has completed with an exception, and returns a new Promise representing the outcome of the function.
<EOUT extends Exception> Promise<V,EOUT>	PromiseImpl.thenCatchAsync(AsyncFunction<? super E,V,EOUT> onException)
Promise<V,E>	Promise.thenCatchRuntimeException(Function<? super RuntimeException,V,E> onRuntimeException)	Submits the provided function for execution once this Promise has not completed with a result nor with an exception but with a RuntimeException, and returns a new Promise representing the outcome of the function.
Promise<V,E>	PromiseImpl.thenCatchRuntimeException(Function<? super RuntimeException,V,E> onRuntimeException)
Promise<V,E>	Promise.thenCatchRuntimeExceptionAsync(AsyncFunction<? super RuntimeException,V,E> onRuntimeException)	Submits the provided asynchronous function for execution once this Promise has completed with a RuntimeException, and returns a new Promise representing the outcome of the function.
Promise<V,E>	PromiseImpl.thenCatchRuntimeExceptionAsync(AsyncFunction<? super RuntimeException,V,E> onRuntimeException)
default Promise<Void,E>	Promise.thenDiscardResult()	Discards the promise result if this Promise has completed with a result.
Promise<V,E>	Promise.thenFinally(Runnable onResultOrException)	Submits the provided runnable for execution once this Promise has completed, and regardless of whether of its outcome.
Promise<V,E>	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 this Promise.
<T extends ResultHandler<? super V> & ExceptionHandler<? super E> & RuntimeExceptionHandler> Promise<V,E>	PromiseImpl.thenOnCompletion(T handler)
Promise<V,E>	Promise.thenOnException(ExceptionHandler<? super E> onException)	Registers the provided completion handler for notification if this Promise cannot be completed due to an exception.
Promise<V,E>	PromiseImpl.thenOnException(ExceptionHandler<? super E> onException)
Promise<V,E>	Promise.thenOnResult(ResultHandler<? super V> onResult)	Registers the provided completion handler for notification once this Promise has completed with a result.
Promise<V,E>	PromiseImpl.thenOnResult(ResultHandler<? super V> onResult)
Promise<V,E>	Promise.thenOnResultOrException(Runnable onResultOrException)	Submits the provided runnable for execution once this Promise has completed, and regardless of whether it has a result or an exception.
Promise<V,E>	Promise.thenOnResultOrException(ResultHandler<? super V> onResult, ExceptionHandler<? super E> onException)	Registers the provided completion handlers for notification once this Promise has completed (with a result or an exception).
Promise<V,E>	PromiseImpl.thenOnResultOrException(Runnable onResultOrException)
Promise<V,E>	PromiseImpl.thenOnResultOrException(ResultHandler<? super V> onResult, ExceptionHandler<? super E> onException)
Promise<V,E>	Promise.thenOnRuntimeException(RuntimeExceptionHandler onRuntimeException)	Registers the provided completion handler for notification if this Promise cannot be completed due to an runtime exception.
Promise<V,E>	PromiseImpl.thenOnRuntimeException(RuntimeExceptionHandler onRuntimeException)
static <V,E extends Exception> Promise<List<V>,E>	Promises.when(List<Promise<V,E>> promises)	Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
static <V,E extends Exception> Promise<List<V>,E>	Promises.when(Promise<V,E>... promises)	Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.

Methods in org.forgerock.util.promise that return types with arguments of type Promise

Modifier and Type	Method	Description
static <V,E extends Exception> Optional<Promise<V,E>>	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.

Methods in org.forgerock.util.promise with parameters of type Promise

Modifier and Type	Method	Description
static Promise<Promises.Results,Exception>	Promises.join(Promise<?,? extends Exception>... promises)	Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
static <V,E extends Exception> Promise<List<V>,E>	Promises.when(Promise<V,E>... promises)	Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.

Method parameters in org.forgerock.util.promise with type arguments of type Promise

Modifier and Type	Method	Description
static Promise<Void,NeverThrowsException>	Promises.allDone(Collection<Promise<?,?>> promises)	Returns a Promise 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 a Promise which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions), returning back the context parameter.
static <V,E extends Exception> Optional<Promise<V,E>>	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>	Promises.join(List<Promise<?,? extends Exception>> promises)	Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
static <V,E extends Exception> Promise<List<V>,E>	Promises.when(List<Promise<V,E>> promises)	Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.