Package | Description |
---|---|
org.forgerock.audit |
Package contains the AuditService.
|
org.forgerock.audit.events.handlers |
This package contains the default
AuditEventHandlers . |
org.forgerock.audit.events.handlers.buffering |
This package contains the batch publisher and its various implementations.
|
org.forgerock.audit.handlers.csv |
This package contains the default AuditEventHandler implementations.
|
org.forgerock.audit.handlers.elasticsearch |
This package contains the Elasticsearch
AuditEventHandler implementation. |
org.forgerock.audit.handlers.jdbc |
This package contains a JDBC AuditEventHandler implementation.
|
org.forgerock.audit.handlers.jms |
This package contains a JMS AuditEventHandler implementation.
|
org.forgerock.audit.handlers.json |
This package contains the JSON-file
AuditEventHandler implementation. |
org.forgerock.audit.handlers.splunk |
This package contains the audit handler implementation for Splunk.
|
org.forgerock.audit.handlers.syslog |
This package contains a Syslog AuditEventHandler implementation.
|
org.forgerock.http |
Models and manages elements of the Hypertext Transfer Protocol.
|
org.forgerock.http.apache.async |
Provides
HttpClientHandler client integration with
Apache HttpComponents Http Async Client. |
org.forgerock.http.filter |
Core
Filter implementations. |
org.forgerock.http.filter.throttling |
This package contains the components used to implement a throttling rate support.
|
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.spi |
HTTP service provider API.
|
org.forgerock.http.swagger |
Classes to support OpenAPI API Descriptions using Swagger.
|
org.forgerock.json.jose.jwk.store |
This package contains classes to manage a JWKs URI.
|
org.forgerock.json.resource |
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
|
org.forgerock.monitoring |
Common utility classes for monitoring.
|
org.forgerock.monitoring.http |
Common utility classes for monitoring.
|
org.forgerock.opendj.ldap |
Classes and interfaces for core types including connections, entries, and
attributes.
|
org.forgerock.opendj.ldap.spi |
Interfaces and classes for service providers.
|
org.forgerock.openig.doc |
Files for the Sample Application used in the product documentation.
|
org.forgerock.openig.el |
Integrates with the Java Enterprise Edition Unified Expression Language API.
|
org.forgerock.openig.filter |
Filters the requests and/or responses of HTTP.
|
org.forgerock.openig.filter.oauth2 |
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
|
org.forgerock.openig.filter.oauth2.client |
OAuth 2.0 Client filter implementation.
|
org.forgerock.openig.filter.throttling |
This package contains the components used to implement a throttling rate support.
|
org.forgerock.openig.handler |
Handles HTTP requests by generating responses.
|
org.forgerock.openig.handler.resources |
Contains components and APIs used to serve static resources.
|
org.forgerock.openig.handler.router |
Provides automated router capability that loads its configurations files (called routes) from a given directory.
|
org.forgerock.openig.handler.saml |
Identity Gateway SAML support.
|
org.forgerock.openig.http |
Integrates with the ForgeRock HTTP Framework.
|
org.forgerock.openig.openam |
Integration classes specifically for ForgeRock Access Management.
|
org.forgerock.openig.script |
Scripting support.
|
org.forgerock.openig.secrets |
Provides the Common Secrets API for accessing secrets of various kinds.
|
org.forgerock.openig.tools |
Common tools used in policy service.
|
org.forgerock.openig.tools.authentication |
AM authentication service.
|
org.forgerock.openig.tools.authentication.chf |
HTTP-based authentication service.
|
org.forgerock.openig.tools.notifications |
AM notifications service.
|
org.forgerock.openig.tools.notifications.ws |
Web socket notifications service implementation.
|
org.forgerock.openig.tools.session |
This package contains classes to call AM to retrieve user's session info.
|
org.forgerock.openig.tools.userprofile |
This package contains classes to call AM to retrieve user's profile info.
|
org.forgerock.openig.ui.record |
Defines a storage service to be used by the UI to persist its component model.
|
org.forgerock.openig.uma |
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
|
org.forgerock.openig.websocket |
WebSocket proxy support.
|
org.forgerock.secrets |
Provides a unified API for accessing secrets of various kinds.
|
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.util |
Provides common interfaces and classes.
|
org.forgerock.util.promise |
An implementation of the
Promise API in Java. |
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
AuditServiceProxy.handleAction(Context context,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AuditService.handleAction(Context context,
ActionRequest request)
Audit service may support actions on the service itself or on handlers.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleCreate(Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleCreate(Context context,
CreateRequest request)
Propagates the audit event to the
AuditEventHandler objects that have been registered
for the audit event topic. |
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleDelete(Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleDelete(Context context,
DeleteRequest request)
Audit service does not support changing audit entries.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handlePatch(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handlePatch(Context context,
PatchRequest request)
Audit service does not support changing audit entries.
|
Promise<QueryResponse,ResourceException> |
AuditServiceProxy.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AuditService.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler)
Performs the query on the specified object and returns the associated results.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleRead(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleRead(Context context,
ReadRequest request)
Gets an object from the audit logs by identifier.
|
Promise<ResourceResponse,ResourceException> |
AuditServiceProxy.handleUpdate(Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
AuditService.handleUpdate(Context context,
UpdateRequest request)
Audit service does not support changing audit entries.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
AuditEventHandlerBase.handleAction(Context context,
String topic,
ActionRequest request) |
Promise<ActionResponse,ResourceException> |
AuditEventHandler.handleAction(Context context,
String topic,
ActionRequest request)
Performs an action.
|
Promise<ResourceResponse,ResourceException> |
NoOpAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
Promise<ResourceResponse,ResourceException> |
AuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event)
Publishes an event to the provided topic.
|
Promise<QueryResponse,ResourceException> |
NoOpAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<QueryResponse,ResourceException> |
AuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Query some events from the provided topic.
|
Promise<ResourceResponse,ResourceException> |
NoOpAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
Promise<ResourceResponse,ResourceException> |
AuditEventHandler.readEvent(Context context,
String topic,
String resourceId)
Reads an event with the provided resource id from the provided topic.
|
Modifier and Type | Method and Description |
---|---|
Promise<Void,BatchException> |
BatchConsumer.publishBatch(String payload)
Publishes the batch payload.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
CsvAuditEventHandler.handleAction(Context context,
String topic,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
CsvAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event)
Create a csv audit log entry.
|
Promise<QueryResponse,ResourceException> |
CsvAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Perform a query on the csv audit log.
|
Promise<ResourceResponse,ResourceException> |
CsvAuditEventHandler.readEvent(Context context,
String topic,
String resourceId)
Read from the csv audit log.
|
Modifier and Type | Method and Description |
---|---|
Promise<Void,BatchException> |
ElasticsearchAuditEventHandler.publishBatch(String payload)
Publishes a Bulk API
payload to Elasticsearch.
|
Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
protected Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.publishSingleEvent(String topic,
JsonValue event)
Publishes a single event to the provided topic.
|
Promise<QueryResponse,ResourceException> |
ElasticsearchAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler)
Queries the Elasticsearch
Search API for
audit events.
|
Promise<ResourceResponse,ResourceException> |
ElasticsearchAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
JdbcAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event)
Publishes an event to the provided topic.
|
Promise<QueryResponse,ResourceException> |
JdbcAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler)
Query some events from the provided topic.
|
Promise<ResourceResponse,ResourceException> |
JdbcAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
JmsAuditEventHandler.publishEvent(Context context,
String auditTopic,
JsonValue auditEvent)
Converts the audit event into a JMS TextMessage and then publishes the message on the configured jmsTopic.
|
Promise<QueryResponse,ResourceException> |
JmsAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler)
Returns NotSupportedException as query is not implemented for JMS.
|
Promise<ResourceResponse,ResourceException> |
JmsAuditEventHandler.readEvent(Context context,
String topic,
String resourceId)
Returns NotSupportedException as read is not implemented for JMS.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
JsonAuditEventHandler.handleAction(Context context,
String topic,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
JsonAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
JsonAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
JsonAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
Promise<Void,BatchException> |
SplunkAuditEventHandler.publishBatch(String payload) |
Promise<ResourceResponse,ResourceException> |
SplunkAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
SplunkAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest query,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
SplunkAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
Promise<ResourceResponse,ResourceException> |
SyslogAuditEventHandler.publishEvent(Context context,
String topic,
JsonValue event) |
Promise<QueryResponse,ResourceException> |
SyslogAuditEventHandler.queryEvents(Context context,
String topic,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler) |
Promise<ResourceResponse,ResourceException> |
SyslogAuditEventHandler.readEvent(Context context,
String topic,
String resourceId) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
Filter.filter(Context context,
Request request,
Handler next)
Filters the request and/or response of an exchange.
|
Promise<Response,NeverThrowsException> |
Handler.handle(Context context,
Request request)
|
Promise<Response,NeverThrowsException> |
Client.send(Context context,
Request request)
Sends an HTTP request and returns a
Promise representing the
pending HTTP response. |
Promise<Response,NeverThrowsException> |
Client.send(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. |
Promise<Response,NeverThrowsException> |
Client.sendWithoutClose(Request request)
Sends an HTTP request and returns a
Promise representing the
pending HTTP response. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
AsyncStreamingHttpClient.sendAsync(Request request) |
Promise<Response,NeverThrowsException> |
AsyncResponseHttpClient.sendAsync(Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ConditionalFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TransactionIdOutboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TransactionIdInboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
OptionsFilter.filter(Context context,
Request request,
Handler next)
Handles all OPTION requests to CREST resources, all other request methods are handled by the
Handler . |
Promise<Response,NeverThrowsException> |
CsrfFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ThrottlingFilter.filter(Context context,
Request request,
Handler next) |
Promise<ThrottlingRate,Exception> |
ThrottlingPolicy.lookup(Context context,
Request request)
Returns the
ThrottlingRate that should be used for the provided request. |
Promise<ThrottlingRate,Exception> |
MappedThrottlingPolicy.lookup(Context context,
Request request) |
Promise<ThrottlingRate,Exception> |
FixedRateThrottlingPolicy.lookup(Context context,
Request request) |
Promise<ThrottlingRate,Exception> |
DefaultRateThrottlingPolicy.lookup(Context context,
Request request) |
Promise<Long,NeverThrowsException> |
TokenBucketThrottlingStrategy.throttle(String partitionKey,
ThrottlingRate throttlingRate) |
Promise<Long,NeverThrowsException> |
ThrottlingStrategy.throttle(String partitionKey,
ThrottlingRate throttlingRate)
Based on the given partitionKey and throttlingRate, return if the call is accepted or not.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
HttpClientHandler.handle(Context context,
Request request)
Sends an HTTP request to a remote server and returns a
Promise
representing the asynchronous response. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceServerFilter.filter(Context context,
Request request,
Handler next) |
Promise<Set<String>,ResponseException> |
ResourceAccess.getRequiredScopes(Context context,
Request request)
Returns the scopes required to access the resource.
|
Promise<AccessTokenInfo,AccessTokenException> |
AccessTokenResolver.resolve(Context context,
String token)
Resolves a given access token against an authorization server.
|
Modifier and Type | Method and Description |
---|---|
Promise<AccessTokenInfo,AccessTokenException> |
TokenIntrospectionAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
OpenAmAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
CachingAccessTokenResolver.resolve(Context context,
String token) |
Constructor and 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. |
Modifier and Type | Method and Description |
---|---|
static Promise<Response,NeverThrowsException> |
Response.newResponsePromise(Response response)
Returns a
Promise representing the Response for an
asynchronous Request which has already completed. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceApiVersionRoutingFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
Router.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
HttpClient.sendAsync(Request request)
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
OpenApiRequestFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
Promise<JWKSet,FailedToLoadJWKException> |
JwksStore.getLatestJwkSet()
Returns the latest non expired successfully loaded JWK Set.
|
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
Connection.actionAsync(Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
AbstractConnectionWrapper.actionAsync(Context context,
ActionRequest request)
Asynchronously performs an action against a specific resource, or set of
resources.
|
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
default Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionCollection(Context context,
ActionRequest request)
Performs the provided
action
against the resource collection. |
default Promise<ActionResponse,ResourceException> |
SingletonResourceProvider.actionInstance(Context context,
ActionRequest request)
Performs the provided
action against the single resource instance. |
Promise<ActionResponse,ResourceException> |
MemoryBackend.actionInstance(Context context,
String id,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
default Promise<ActionResponse,ResourceException> |
CollectionResourceProvider.actionInstance(Context context,
String resourceId,
ActionRequest request)
Performs the provided
action against a resource within the collection. |
Promise<ResourceResponse,ResourceException> |
ResourceResponse.asPromise()
Return this response as a result Promise.
|
Promise<QueryResponse,ResourceException> |
QueryResponse.asPromise()
Return this response as a result Promise.
|
Promise<ActionResponse,ResourceException> |
ActionResponse.asPromise()
Return this response as a result Promise.
|
<V> Promise<V,ResourceException> |
ResourceException.asPromise()
Return this ResourceException as a Promise.
|
Promise<ResourceResponse,ResourceException> |
Connection.createAsync(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.createAsync(Context context,
CreateRequest request)
Asynchronously adds a new JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.createInstance(Context context,
CreateRequest request)
Adds a new resource instance to the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.deleteAsync(Context context,
DeleteRequest request)
Asynchronously deletes a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.deleteInstance(Context context,
String id,
DeleteRequest request)
Removes a resource instance from the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.deleteInstance(Context context,
String resourceId,
DeleteRequest request)
Removes a resource instance from the collection. |
Promise<ActionResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterAction(Context context,
ActionRequest request,
RequestHandler next) |
Promise<ActionResponse,ResourceException> |
Filter.filterAction(Context context,
ActionRequest request,
RequestHandler next)
Filters an action request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterCreate(Context context,
CreateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterCreate(Context context,
CreateRequest request,
RequestHandler next)
Filters a create request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterDelete(Context context,
DeleteRequest request,
RequestHandler next)
Filters a delete request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterPatch(Context context,
PatchRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterPatch(Context context,
PatchRequest request,
RequestHandler next)
Filters a patch request.
|
Promise<QueryResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterQuery(Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next) |
Promise<QueryResponse,ResourceException> |
Filter.filterQuery(Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next)
Filters a query request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterRead(Context context,
ReadRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterRead(Context context,
ReadRequest request,
RequestHandler next)
Filters a read request.
|
Promise<ResourceResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next) |
Promise<ResourceResponse,ResourceException> |
Filter.filterUpdate(Context context,
UpdateRequest request,
RequestHandler next)
Filters an update request.
|
Promise<Connection,ResourceException> |
ConnectionFactory.getConnectionAsync()
Asynchronously obtains a connection to the JSON resource provider
associated with this connection factory.
|
Promise<ActionResponse,ResourceException> |
Router.handleAction(Context context,
ActionRequest request) |
default Promise<ActionResponse,ResourceException> |
RequestHandler.handleAction(Context context,
ActionRequest request)
Handles performing an action on a resource, and optionally returns an
associated result.
|
Promise<ActionResponse,ResourceException> |
FilterChain.handleAction(Context context,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleCreate(Context context,
CreateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleCreate(Context context,
CreateRequest request)
Adds a new JSON resource, returning a
Promise that will be
completed when the resource has been added. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleCreate(Context context,
CreateRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleDelete(Context context,
DeleteRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleDelete(Context context,
DeleteRequest request)
Deletes a JSON resource, returning a
Promise that will be
completed when the resource has been deleted. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleDelete(Context context,
DeleteRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handlePatch(Context context,
PatchRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handlePatch(Context context,
PatchRequest request)
Updates a JSON resource by applying a set of changes to its existing
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handlePatch(Context context,
PatchRequest request) |
Promise<QueryResponse,ResourceException> |
Router.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler) |
default Promise<QueryResponse,ResourceException> |
RequestHandler.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, returning a
Promise that will be completed when the
search has completed. |
Promise<QueryResponse,ResourceException> |
FilterChain.handleQuery(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
Router.handleRead(Context context,
ReadRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleRead(Context context,
ReadRequest request)
Reads a JSON resource, returning a
Promise that will be
completed when the resource has been read. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleRead(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
Router.handleUpdate(Context context,
UpdateRequest request) |
default Promise<ResourceResponse,ResourceException> |
RequestHandler.handleUpdate(Context context,
UpdateRequest request)
Updates a JSON resource by replacing its existing content with new
content, returning a
Promise that will be completed when the
resource has been updated. |
Promise<ResourceResponse,ResourceException> |
FilterChain.handleUpdate(Context context,
UpdateRequest request) |
Promise<ResourceResponse,ResourceException> |
Connection.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.patchAsync(Context context,
PatchRequest request)
Asynchronously updates a JSON resource by applying a set of changes to
its existing content.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.patchInstance(Context context,
PatchRequest request)
Patches the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.patchInstance(Context context,
String id,
PatchRequest request)
Patches an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.patchInstance(Context context,
String resourceId,
PatchRequest request)
Patches an existing resource within the collection. |
Promise<QueryResponse,ResourceException> |
Connection.queryAsync(Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
Promise<QueryResponse,ResourceException> |
AbstractConnectionWrapper.queryAsync(Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
Promise<QueryResponse,ResourceException> |
MemoryBackend.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
default Promise<QueryResponse,ResourceException> |
CollectionResourceProvider.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
Promise<ResourceResponse,ResourceException> |
Connection.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.readAsync(Context context,
ReadRequest request)
Asynchronously reads a JSON resource.
|
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.readInstance(Context context,
ReadRequest request)
Reads the single resource instance. |
Promise<ResourceResponse,ResourceException> |
MemoryBackend.readInstance(Context context,
String id,
ReadRequest request)
Reads an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.readInstance(Context context,
String resourceId,
ReadRequest request)
Reads an existing resource within the collection. |
Promise<ResourceResponse,ResourceException> |
Connection.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
AbstractConnectionWrapper.updateAsync(Context context,
UpdateRequest request)
Asynchronously updates a JSON resource by replacing its existing content
with new content.
|
Promise<ResourceResponse,ResourceException> |
MemoryBackend.updateInstance(Context context,
String id,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
CollectionResourceProvider.updateInstance(Context context,
String resourceId,
UpdateRequest request)
Updates an existing resource within the collection. |
default Promise<ResourceResponse,ResourceException> |
SingletonResourceProvider.updateInstance(Context context,
UpdateRequest request)
Updates the single resource instance. |
Modifier and Type | Method and Description |
---|---|
Promise<QueryResponse,ResourceException> |
DropwizardMetricsCollectionResourceProvider.queryCollection(Context context,
QueryRequest request,
QueryResourceHandler handler) |
Promise<ResourceResponse,ResourceException> |
DropwizardMetricsCollectionResourceProvider.readInstance(Context context,
String resourceId,
ReadRequest request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
PrometheusHandler.handle(Context context,
Request request) |
Modifier and Type | Interface and Description |
---|---|
interface |
LdapPromise<S>
A handle which can be used to retrieve the Result of an asynchronous Request.
|
Modifier and Type | Method and Description |
---|---|
Promise<Connection,LdapException> |
LdapConnectionFactory.getConnectionAsync() |
Promise<Connection,LdapException> |
ConnectionFactory.getConnectionAsync()
Asynchronously obtains a connection to the Directory Server associated
with this connection factory.
|
Modifier and Type | Class and Description |
---|---|
class |
LdapPromiseImpl<S>
This class provides an implementation of the
LdapPromise . |
Modifier and Type | Method and Description |
---|---|
static <R> LdapPromise<R> |
LdapPromises.asLdapPromise(Promise<R,LdapException> wrappedPromise)
Converts a
Promise to a LdapPromise with a request ID of -1. |
static <R> LdapPromise<R> |
LdapPromises.asLdapPromise(Promise<R,LdapException> wrappedPromise,
int requestId)
Converts a
Promise to a LdapPromise with the provided request ID. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
SampleFilter.filter(Context context,
Request request,
Handler next)
Set a header in the incoming request and in the outgoing response.
|
Modifier and Type | Method and Description |
---|---|
Promise<V,Exception> |
ExpressionRequestAsyncFunction.apply(ContextAndRequest contextAndRequest) |
Modifier and Type | Method and Description |
---|---|
Promise<Result,NeverThrowsException> |
Result.asPromise()
Returns a new completed promise wrapping this result.
|
Promise<Set<String>,ResponseException> |
ScriptableResourceAccess.getRequiredScopes(Context context,
Request request) |
Promise<AccessTokenInfo,AccessTokenException> |
StatelessAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
ScriptableAccessTokenResolver.resolve(Context context,
String token) |
Promise<AccessTokenInfo,AccessTokenException> |
ConfirmationKeyVerifierAccessTokenResolver.resolve(Context context,
String token) |
Promise<Result,NeverThrowsException> |
ConfirmationKeyVerifier.verify(Context context,
AccessTokenInfo tokenInfo,
JsonValue cnfKey)
Verifies the given confirmation key value.
|
Promise<Result,NeverThrowsException> |
CertificateThumbprintConfirmationKeyVerifier.verify(Context context,
AccessTokenInfo tokenInfo,
JsonValue cnfKey) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
OAuth2ClientFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
DiscoveryFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
ClientRegistrationFilter.filter(Context context,
Request request,
Handler next) |
Promise<Issuer,DiscoveryException> |
IssuerRepository.findByName(String issuerName)
Find a registered
Issuer whose name matches issuerName. |
Promise<Issuer,DiscoveryException> |
IssuerRepository.findBySupportedDomainNames(String givenDomainName)
Find a registered
Issuer that supports the given {code domainName}. |
Promise<Issuer,DiscoveryException> |
IssuerRepository.findOrCreateFromWellKnownUri(String issuerName,
URI wellKnownUri)
Try to find an already registered Issuer named issuerName.
|
Promise<Issuer,DiscoveryException> |
IssuerRepository.findOrCreateFromWellKnownUri(String issuerName,
URI wellKnownUri,
List<Pattern> supportedDomains,
Handler handler)
Tries to find an already registered Issuer named issuerName.
|
Promise<JsonValue,OAuth2ErrorException> |
ClientRegistration.getAccessToken(Context context,
String code,
String callbackUri)
Exchanges the authorization code for an access token and optional ID
token, and then update the session state.
|
Promise<JsonValue,OAuth2ErrorException> |
ClientRegistration.getUserInfo(Context context,
org.forgerock.openig.filter.oauth2.client.OAuth2Session session)
Returns a Promise completed either with the json value of the user info obtained from the authorization
server if the response from the authorization server has a status code of 200, or with an exception, meaning the
access token may have expired.
|
Promise<JsonValue,OAuth2ErrorException> |
ClientRegistration.refreshAccessToken(Context context,
org.forgerock.openig.filter.oauth2.client.OAuth2Session session)
Refreshes the actual access token, making a refresh request to the token
end-point.
|
Promise<Issuer,DiscoveryException> |
IssuerRepository.register(String issuerName,
JsonValue config,
List<Pattern> supportedDomains)
Register an
Issuer into the repository. |
Constructor and Description |
---|
OAuth2ClientFilter(org.forgerock.openig.filter.oauth2.client.ClientRegistrationRepository registrations,
PerItemEvictionStrategyCache<String,Promise<Map<String,Object>,OAuth2ErrorException>> userInfoCache,
org.forgerock.openig.filter.oauth2.client.UriValidationService validationService,
Clock clock,
Handler discoveryAndDynamicRegistrationChain,
Expression<String> clientEndpoint)
Constructs an
OAuth2ClientFilter . |
Modifier and Type | Method and Description |
---|---|
Promise<ThrottlingRate,Exception> |
ScriptableThrottlingPolicy.lookup(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
WelcomeHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
StaticResponseHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
SequenceHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ScriptableHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ReverseProxyHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
DispatchHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
DesKeyGenHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ClientHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
RouterHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
SamlFederationHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<ActionResponse,ResourceException> |
ServerInfoSingletonProvider.actionInstance(Context context,
ActionRequest request) |
Promise<ResourceResponse,ResourceException> |
ServerInfoSingletonProvider.patchInstance(Context context,
PatchRequest request) |
Promise<ResourceResponse,ResourceException> |
ServerInfoSingletonProvider.readInstance(Context context,
ReadRequest request) |
Promise<ResourceResponse,ResourceException> |
ServerInfoSingletonProvider.updateInstance(Context context,
UpdateRequest request) |
Modifier and Type | Method and Description |
---|---|
protected Promise<Response,NeverThrowsException> |
CdSsoConditionAdviceFilter.doRedirect(Context context,
Request request,
Handler next,
List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices) |
protected abstract Promise<Response,NeverThrowsException> |
AbstractConditionAdviceFilter.doRedirect(Context context,
Request request,
Handler next,
List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices)
Handle redirect to the
instance to verify the required advices. |
Promise<Response,NeverThrowsException> |
UserProfileFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TokenTransformationFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SingleSignOnFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SessionInfoFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
PolicyEnforcementFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
DeprecatedUserProfileFilter.filter(Context context,
Request request,
Handler next)
Deprecated.
|
Promise<Response,NeverThrowsException> |
CrossDomainSingleSignOnFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
CapturedUserPasswordFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
AbstractConditionAdviceFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
protected Promise<V,ScriptException> |
AbstractScriptableHeapObject.runScript(Bindings bindings,
Context context,
Class<V> clazz)
Runs the compiled script using the provided bindings.
|
Modifier and Type | Method and Description |
---|---|
<S extends Secret> |
SecretsServiceProvider.getActiveSecret(Purpose<S> purpose) |
<S extends Secret> |
SecretsService.getActiveSecret(Purpose<S> purpose)
Gets the currently active secret for the given purpose.
|
<S extends Secret> |
DefaultSecretsService.getActiveSecret(Purpose<S> purpose) |
<S extends Secret> |
SecretsServiceProvider.getNamedOrValidSecrets(Purpose<S> purpose,
String id) |
<S extends Secret> |
SecretsServiceProvider.getNamedSecret(Purpose<S> purpose,
String id) |
<S extends Secret> |
SecretsService.getNamedSecret(Purpose<S> purpose,
String id)
Gets the secret for the given purpose with the given stable secret id.
|
<S extends Secret> |
DefaultSecretsService.getNamedSecret(Purpose<S> purpose,
String id) |
<S extends Secret> |
SecretsServiceProvider.getValidSecrets(Purpose<S> purpose) |
<S extends Secret> |
SecretsService.getValidSecrets(Purpose<S> purpose)
Returns all secrets for the given purpose which have not yet expired.
|
<S extends Secret> |
DefaultSecretsService.getValidSecrets(Purpose<S> purpose) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
InsertSsoTokenHeaderFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
HeadlessAuthenticationFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
ApiVersionProtocolHeaderFilter.filter(Context context,
Request request,
Handler next) |
Promise<ActionResponse,ResourceException> |
NotSupportedFilter.filterAction(Context context,
ActionRequest actionRequest,
RequestHandler requestHandler) |
Promise<ResourceResponse,ResourceException> |
NotSupportedFilter.filterCreate(Context context,
CreateRequest createRequest,
RequestHandler requestHandler) |
Promise<ResourceResponse,ResourceException> |
NotSupportedFilter.filterDelete(Context context,
DeleteRequest deleteRequest,
RequestHandler requestHandler) |
Promise<ResourceResponse,ResourceException> |
NotSupportedFilter.filterPatch(Context context,
PatchRequest patchRequest,
RequestHandler requestHandler) |
Promise<QueryResponse,ResourceException> |
NotSupportedFilter.filterQuery(Context context,
QueryRequest queryRequest,
QueryResourceHandler queryResourceHandler,
RequestHandler requestHandler) |
Promise<ResourceResponse,ResourceException> |
NotSupportedFilter.filterRead(Context context,
ReadRequest readRequest,
RequestHandler requestHandler) |
Promise<ResourceResponse,ResourceException> |
NotSupportedFilter.filterUpdate(Context context,
UpdateRequest updateRequest,
RequestHandler requestHandler) |
static <T,E extends Exception> |
FutureUtils.futureToPromise(CompletionStage<T> completionStage,
Class<E> exceptionType)
Converts a
CompletionStage to a Promise . |
Promise<ActionResponse,ResourceException> |
CachePolicyDecisionRequestHandler.handleAction(Context context,
ActionRequest actionRequest) |
static <K,V,E extends Exception> |
CaffeineUtils.invalidateEagerly(com.github.benmanes.caffeine.cache.AsyncLoadingCache<K,V> cache,
Promise<V,E> promise,
K key)
Preemptively invalidates the cache entry on failure.
|
Modifier and Type | Method and Description |
---|---|
static <K,V,E extends Exception> |
CaffeineUtils.invalidateEagerly(com.github.benmanes.caffeine.cache.AsyncLoadingCache<K,V> cache,
Promise<V,E> promise,
K key)
Preemptively invalidates the cache entry on failure.
|
static <T,E extends Exception> |
FutureUtils.promiseToFuture(Promise<T,E> promise)
Converts a
Promise to a CompletableFuture . |
Modifier and Type | Method and Description |
---|---|
Promise<SsoToken,AuthenticationException> |
AuthenticationService.authenticate(Context context,
String username,
char[] password)
Authenticates a subject (identified with the given
username and password credentials),
returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException
on failures (I/O, invalid credentials, ...). |
Modifier and Type | Method and Description |
---|---|
Promise<SsoToken,AuthenticationException> |
DefaultAuthenticationService.authenticate(Context context,
String username,
char[] password) |
Promise<V,E> |
AsyncRefreshableSupplier.get(Context context)
Computes (or re-computes) the value in a thread-safe manner, making sure that only 1 thread
will compute the value, the other being blocked, waiting for the result to be computed.
|
Promise<V,E> |
AsyncRefreshableSupplier.refresh(Context context)
Refresh (and returns) the value, in a thread-safe manner.
|
Modifier and Type | Method and Description |
---|---|
Promise<NotificationService.Registration,NeverThrowsException> |
NotificationService.addConnectionEventListener(Consumer<ConnectionEvent> listener)
Registers asynchronously a listener that will be notified on connection/disconnection events.
|
Promise<Subscription,SubscriptionException> |
NotificationService.subscribe(String topic,
NotificationListener listener)
Subscribes (asynchronously) to a given topic, providing a listener
that will be invoked at notification reception time.
|
Promise<SubscriptionAck,IOException> |
Subscription.unsubscribe()
Un-subscribes from the topic asynchronously.
|
Modifier and Type | Method and Description |
---|---|
Promise<NotificationService.Registration,NeverThrowsException> |
TyrusNotificationService.addConnectionEventListener(Consumer<ConnectionEvent> listener) |
Promise<Subscription,SubscriptionException> |
TyrusNotificationService.subscribe(String topic,
NotificationListener listener) |
Modifier and Type | Method and Description |
---|---|
Promise<Optional<SessionInfo>,SessionException> |
SessionService.getSessionInfo(Context context,
String ssoToken)
Returns a promise that will be completed with an optional
SessionInfo or with an SessionException
in case of errors. |
Promise<Optional<SessionInfo>,SessionException> |
CrestSessionService.getSessionInfo(Context context,
String ssoToken) |
Promise<Optional<SessionInfo>,SessionException> |
CacheSessionService.getSessionInfo(Context context,
String ssoToken) |
Promise<Void,SessionException> |
SessionService.logout(Context context,
String ssoToken)
Returns a promise that will be completed with a
Void or with an SessionException in case
of errors. |
Promise<Void,SessionException> |
CrestSessionService.logout(Context context,
String ssoToken) |
Promise<Void,SessionException> |
CacheSessionService.logout(Context context,
String ssoToken) |
Modifier and Type | Method and Description |
---|---|
Promise<UserProfile,UserProfileException> |
UserProfileService.getUserProfile(Context context,
String username)
Returns a promise that will be completed with an
UserProfile or with an UserProfileException
in case of errors. |
Promise<UserProfile,UserProfileException> |
CrestUserProfileService.getUserProfile(Context context,
String username) |
Promise<UserProfile,UserProfileException> |
CacheUserProfileService.getUserProfile(Context context,
String username) |
Modifier and Type | Method and Description |
---|---|
Promise<org.forgerock.openig.uma.Share,UmaException> |
UmaSharingService.createShare(Context context,
String resourcePath,
String pat)
Creates a Share that will be used to protect the given
resourcePath . |
Promise<Response,NeverThrowsException> |
UmaResourceServerFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
WebSocketProxyFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
<S extends T> |
ThreadPoolSecretStore.getActive(Purpose<S> purpose) |
<S extends T> |
SecretStore.getActive(Purpose<S> purpose)
Returns the active secret for the given purpose.
|
<S extends Secret> |
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.
|
<S extends T> |
ThreadPoolSecretStore.getNamed(Purpose<S> purpose,
String name) |
<S extends T> |
SecretStore.getNamed(Purpose<S> purpose,
String name)
Returns the named secret from this store.
|
<S extends Secret> |
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> |
SecretsProvider.getNamedSecret(Purpose<S> purpose,
String id)
Gets the secret for the given purpose with the given stable secret id.
|
<S extends T> |
ThreadPoolSecretStore.getValid(Purpose<S> purpose) |
<S extends T> |
SecretStore.getValid(Purpose<S> purpose)
Returns all valid secrets for the given purpose from this store.
|
<S extends Secret> |
SecretsProvider.getValidSecrets(Purpose<S> purpose)
Returns all secrets for the given purpose which have not yet expired.
|
Modifier and Type | Method and Description |
---|---|
<S extends CryptoKey> |
KeyStoreSecretStore.getActive(Purpose<S> purpose) |
<S extends CryptoKey> |
KeyStoreSecretStore.getNamed(Purpose<S> purpose,
String id) |
<S extends CryptoKey> |
KeyStoreSecretStore.getValid(Purpose<S> purpose) |
Modifier and Type | Method and Description |
---|---|
default Promise<SecretBuilder,NoSuchSecretException> |
SecretPropertyFormat.decodeToPromise(String propertyValue)
Decodes the input property value, setting relevant properties on a
SecretBuilder object. |
<S extends Secret> |
PropertyResolverSecretStore.getActive(Purpose<S> purpose) |
<S extends Secret> |
PropertyResolverSecretStore.getNamed(Purpose<S> purpose,
String name) |
<S extends Secret> |
PropertyResolverSecretStore.getValid(Purpose<S> purpose) |
Modifier and Type | Method and Description |
---|---|
Promise<? extends VOUT,? extends E> |
AsyncFunction.apply(VIN value)
Asynchronously applies this function to the input parameter
value
and returns a Promise for the result. |
Modifier and Type | Class and 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. |
Modifier and Type | Method and 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> |
Promises.newExceptionPromise(E exception)
Returns a
Promise representing an asynchronous task which has
already failed with the provided exception. |
static <V,E extends Exception> |
Promises.newResultPromise(V result)
Returns a
Promise representing an asynchronous task which has
already succeeded with the provided result. |
static <V,E extends Exception> |
Promises.newRuntimeExceptionPromise(RuntimeException exception)
Returns a
Promise representing an asynchronous task which has
already failed with the provided runtime exception. |
<VOUT> Promise<VOUT,E> |
PromiseImpl.then(Function<? super V,VOUT,E> onResult) |
<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> |
PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult,
Function<? super E,VOUT,EOUT> onException) |
<VOUT,EOUT extends Exception> |
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> |
PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult,
Function<? super E,VOUT,EOUT> onException,
Function<? super RuntimeException,VOUT,EOUT> onRuntimeException) |
<VOUT,EOUT extends Exception> |
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. |
Promise<V,E> |
PromiseImpl.thenAlways(Runnable always) |
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. |
<VOUT> Promise<VOUT,E> |
PromiseImpl.thenAsync(AsyncFunction<? super V,VOUT,E> onResult) |
<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> |
PromiseImpl.thenAsync(AsyncFunction<? super V,VOUT,EOUT> onResult,
AsyncFunction<? super E,VOUT,EOUT> onException) |
<VOUT,EOUT extends Exception> |
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> |
PromiseImpl.thenAsync(AsyncFunction<? super V,VOUT,EOUT> onResult,
AsyncFunction<? super E,VOUT,EOUT> onException,
AsyncFunction<? super RuntimeException,VOUT,EOUT> onRuntimeException) |
<VOUT,EOUT extends Exception> |
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. |
<EOUT extends Exception> |
PromiseImpl.thenCatch(Function<? super E,V,EOUT> onException) |
<EOUT extends Exception> |
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> |
PromiseImpl.thenCatchAsync(AsyncFunction<? super E,V,EOUT> onException) |
<EOUT extends Exception> |
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. |
Promise<V,E> |
PromiseImpl.thenCatchRuntimeException(Function<? super RuntimeException,V,E> onRuntimeException) |
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.thenCatchRuntimeExceptionAsync(AsyncFunction<? 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.thenFinally(Runnable onFinally) |
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.thenOnException(ExceptionHandler<? super E> onException) |
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.thenOnResult(ResultHandler<? super V> onResult) |
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.thenOnResultOrException(ResultHandler<? super V> onResult,
ExceptionHandler<? super E> onException) |
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> |
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> |
PromiseImpl.thenOnRuntimeException(RuntimeExceptionHandler onRuntimeException) |
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. |
static <V,E extends Exception> |
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> |
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. |
Modifier and Type | Method and Description |
---|---|
static <V,E extends Exception> |
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.
|
Modifier and Type | Method and Description |
---|---|
static <V,E extends Exception> |
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. |
Modifier and Type | Method and 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> |
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 <V,E extends Exception> |
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. |
Copyright 2011-2017 ForgeRock AS.