Index

A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

A128CBC_HS256 - Enum constant in enum class org.forgerock.json.jose.jwe.EncryptionMethod
AES encryption in CBC mode with PKCS5 Padding and a 128 bit length, AES encryption for CEK, HMAC using SHA-256 hash algorithm for authentication tag.
A128GCM - Enum constant in enum class org.forgerock.json.jose.jwe.EncryptionMethod
AES encryption in Galois Counter Mode (GCM) with a 128 bit key length.
A128KW - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
AES-128 KeyWrap.
A192CBC_HS384 - Enum constant in enum class org.forgerock.json.jose.jwe.EncryptionMethod
AES encryption in CBC mode with PKCS5 Padding and a 192 bit length, AES encryption for CEK, HMAC using SHA-384 hash algorithm for the authentication tag.
A192GCM - Enum constant in enum class org.forgerock.json.jose.jwe.EncryptionMethod
AES encryption in Galois Counter Mode (GCM) with a 192 bit key length.
A192KW - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
AES-192 KeyWrap.
A256CBC_HS512 - Enum constant in enum class org.forgerock.json.jose.jwe.EncryptionMethod
AES encryption in CBC mode with PKCS5 Padding and a 256 bit length, AES encryption for CEK, HMAC using SHA-256 hash algorithm for authentication tag.
A256GCM - Enum constant in enum class org.forgerock.json.jose.jwe.EncryptionMethod
AES encryption in Galois Counter Mode (GCM) with a 256 bit key length.
A256KW - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
AES-256 KeyWrap.
AbstractAsynchronousConnection - Class in org.forgerock.json.resource
An abstract connection whose synchronous methods are implemented in terms of asynchronous methods.
AbstractAsynchronousConnection() - Constructor for class org.forgerock.json.resource.AbstractAsynchronousConnection
Creates a new abstract asynchronous connection.
AbstractAuditEvents - Class in org.forgerock.openig.audit
Abstract AuditEvents base class providing audit events lookup support.
AbstractAuditEvents() - Constructor for class org.forgerock.openig.audit.AbstractAuditEvents
 
AbstractConditionAdviceFilter - Class in org.forgerock.openig.openam
Abstract Filter base class providing policy condition advice support.
AbstractConnectionWrapper<C extends Connection> - Class in org.forgerock.json.resource
An abstract base class from which connection wrappers may be easily implemented.
AbstractConnectionWrapper(C) - Constructor for class org.forgerock.json.resource.AbstractConnectionWrapper
Creates a new connection wrapper.
AbstractContext - Class in org.forgerock.services.context
A base implementation of the Context interface.
AbstractContext(String, String, Context) - Constructor for class org.forgerock.services.context.AbstractContext
Constructs a new AbstractContext.
AbstractContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.AbstractContext
Creates a new context from the JSON representation of a previously persisted context.
AbstractContext(Context, String) - Constructor for class org.forgerock.services.context.AbstractContext
Constructs a new AbstractContext with a null id.
AbstractDecorator - Class in org.forgerock.openig.decoration.helper
This class provides a logger for decorators, according to the pattern: <decoratorClassname>.<decoratorName>.<decoratedObjectName>.
AbstractDecorator(String) - Constructor for class org.forgerock.openig.decoration.helper.AbstractDecorator
Provides the decorator name.
AbstractEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Deprecated.
Use ContentEncryptionHandler instead.
AbstractEncryptionHandler() - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler
Deprecated.
 
AbstractHandlerAndFilterDecorator - Class in org.forgerock.openig.decoration.helper
Deprecated.
in 7.1, use AbstractDecorator as a replacement along with the class service/factory.
AbstractHandlerAndFilterDecorator(String) - Constructor for class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Deprecated.
Forces to give the name of the decorator.
AbstractJwtBuilder - Class in org.forgerock.json.jose.builders
A base implementation for all JwtBuilders that provides the basis of the JWT builder methods.
AbstractJwtBuilder() - Constructor for class org.forgerock.json.jose.builders.AbstractJwtBuilder
 
AbstractRequestHandler - Class in org.forgerock.json.resource
Deprecated.
RequestHandler now has default methods which implement the not-supported behavior. This class is here for transition from pre-JDK8 impelementations.
AbstractRequestHandler() - Constructor for class org.forgerock.json.resource.AbstractRequestHandler
Deprecated.
Creates a new abstract request handler.
AbstractRouter<T extends AbstractRouter<T,R,H,D>,R,H,D> - Class in org.forgerock.services.routing
An abstract base class for implementing routers.
AbstractRouter() - Constructor for class org.forgerock.services.routing.AbstractRouter
Creates a new abstract router with no routes defined.
AbstractRouter(AbstractRouter<T, R, H, D>) - Constructor for class org.forgerock.services.routing.AbstractRouter
Creates a new router containing the same routes and default route as the provided router.
AbstractSamlFederationHeaplet - Class in org.forgerock.openig.handler.saml
The base class for both the filter and handler heaplet implementations.
AbstractSamlFederationHeaplet() - Constructor for class org.forgerock.openig.handler.saml.AbstractSamlFederationHeaplet
 
AbstractScriptableHeaplet() - Constructor for class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
AbstractScriptableHeapObject<V> - Class in org.forgerock.openig.script
A scriptable heap object acts as a simple wrapper around the scripting engine.
AbstractScriptableHeapObject(Script, Heap, String) - Constructor for class org.forgerock.openig.script.AbstractScriptableHeapObject
Creates a new scriptable heap object using the provided compiled script.
AbstractScriptableHeapObject.AbstractScriptableHeaplet<V> - Class in org.forgerock.openig.script
Creates and initializes a scriptable heap object in a heap environment.
AbstractScriptableTypeProvider - Class in org.forgerock.openig.script
Base TypeDefinitionProvider for any scriptable components.
AbstractScriptableTypeProvider() - Constructor for class org.forgerock.openig.script.AbstractScriptableTypeProvider
 
AbstractSetCookieHeader - Class in org.forgerock.http.header
An abstract SetCookieHeader class for SetCookieHeader and SetCookie2Header.
AbstractSetCookieHeader() - Constructor for class org.forgerock.http.header.AbstractSetCookieHeader
 
accept(File, String) - Method in class org.forgerock.audit.retention.TimestampFilenameFilter
Matches the name of a file to the FilenameFilter.
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.ActionRequest
 
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.CreateRequest
 
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.DeleteRequest
 
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.PatchRequest
 
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.QueryRequest
 
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.ReadRequest
 
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.Request
Applies a RequestVisitor to this Request.
accept(RequestVisitor<R, P>, P) - Method in interface org.forgerock.json.resource.UpdateRequest
 
accept(QueryFilterVisitor<R, P, F>, P) - Method in class org.forgerock.util.query.QueryFilter
Applies a QueryFilterVisitor to this QueryFilter.
accept(T) - Method in class org.forgerock.http.protocol.MdcAwareConsumer
 
accept(T) - Method in interface org.forgerock.util.Consumer
Consume the value.
AcceptApiVersionHeader - Class in org.forgerock.http.header
Processes the Accept-API-Version message header.
AcceptApiVersionHeader(Version, Version) - Constructor for class org.forgerock.http.header.AcceptApiVersionHeader
Constructs a new header, initialized with the specified protocol and resource versions.
ACCEPTED - Static variable in class org.forgerock.http.protocol.Status
The 202 (Accepted) status code indicates that the request has been accepted for processing, but the processing has not been completed.
acceptedOrigin(String) - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Adds an accepted origin to this configuration (case insensitive).
acceptHeaders(Predicate<Set<String>>) - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Will accept the set of headers accepted by the given predicate.
AcceptLanguageHeader - Class in org.forgerock.http.header
A header class representing the Accept-Language HTTP header.
acceptMethods(Predicate<String>) - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Will accept any method accepted by the given predicate.
acceptOrigin(String) - Method in class org.forgerock.http.filter.cors.CorsPolicy
Returns true if this policy is applicable for the given origin.
acceptOrigin(Predicate<String>) - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
This configuration accepts whatever origin is accepted by the given predicate.
accepts(Class<?>) - Method in class org.forgerock.openig.decoration.baseuri.BaseUriDecorator
 
accepts(Class<?>) - Method in class org.forgerock.openig.decoration.capture.CaptureDecorator
 
accepts(Class<?>) - Method in interface org.forgerock.openig.decoration.Decorator
Returns true if this decorator is compatible with the provided component type.
accepts(Class<?>) - Method in class org.forgerock.openig.decoration.global.GlobalDecorator
 
accepts(Class<?>) - Method in class org.forgerock.openig.decoration.global.NoOpGlobalDecorator
 
accepts(Class<?>) - Method in class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Deprecated.
 
accepts(Class<?>) - Method in class org.forgerock.openig.decoration.timer.TimerDecorator
 
AccessAuditEventBuilder<T extends AccessAuditEventBuilder<T>> - Class in org.forgerock.audit.events
Builder for audit access events.
AccessAuditEventBuilder() - Constructor for class org.forgerock.audit.events.AccessAuditEventBuilder
 
AccessAuditEventBuilder.ResponseStatus - Enum Class in org.forgerock.audit.events
The status of the access request.
accessEvent() - Static method in class org.forgerock.audit.events.AccessAuditEventBuilder
Starts to build an audit access event.
AccessTokenException - Exception in org.forgerock.http.oauth2
Represents an exception whilst retrieving an OAuth2 access token.
AccessTokenException(String) - Constructor for exception org.forgerock.http.oauth2.AccessTokenException
Builds an AccessTokenException with a given message.
AccessTokenException(String, Exception) - Constructor for exception org.forgerock.http.oauth2.AccessTokenException
Builds an AccessTokenException with a given message and cause.
AccessTokenInfo - Class in org.forgerock.http.oauth2
Represents an OAuth2 Access Token.
AccessTokenInfo(JsonValue, String, Set<String>, long) - Constructor for class org.forgerock.http.oauth2.AccessTokenInfo
Build an AccessTokenInfo with the provided information.
AccessTokenResolver - Interface in org.forgerock.http.oauth2
Resolves a given token against a dedicated OAuth2 Identity Provider (OpenAM, Google, Facebook, ...).
AccessTokenSecretStore - Class in org.forgerock.secrets.oauth2
A secret store that can obtain access tokens from an OAuth 2 provider.
AccessTokenSecretStore.Builder - Class in org.forgerock.secrets.oauth2
Builder object for the access token secret store.
action(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
 
action(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Performs an action against a specific resource, or set of resources.
action(Context, ActionRequest) - Method in interface org.forgerock.json.resource.Connection
Performs an action against a specific resource, or set of resources.
Action<E extends Exception> - Interface in org.forgerock.util
An Runnable functional interface which can throw a checked Exception.
ACTION - Enum constant in enum class org.forgerock.json.resource.RequestType
An action request.
ACTION_ID_CREATE - Static variable in interface org.forgerock.json.resource.ActionRequest
The name of the action which is reserved for performing "create" operations.
ACTION_ID_CREATE - Static variable in interface org.forgerock.json.resource.CreateRequest
The name of the action which is reserved for performing "create" operations.
ACTION_PARAM_TARGET_HANDLER - Static variable in class org.forgerock.audit.AuditServiceProxy
Parameter that may be used when using an action, to provide the name of the handler to use as a target.
actionAsync(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Asynchronously performs an action against a specific resource, or set of resources.
actionAsync(Context, ActionRequest) - Method in interface org.forgerock.json.resource.Connection
Asynchronously performs an action against a specific resource, or set of resources.
actionCollection(Context, ActionRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider
Performs the provided action against the resource collection.
actionCollection(Context, ActionRequest) - Method in class org.forgerock.json.resource.MemoryBackend
Performs the provided action against the resource collection.
actionCollection(Context, ActionRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
actionInstance(Context, String, ActionRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider
Performs the provided action against a resource within the collection.
actionInstance(Context, String, ActionRequest) - Method in class org.forgerock.json.resource.MemoryBackend
Performs the provided action against a resource within the collection.
actionInstance(Context, String, ActionRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
actionInstance(Context, ActionRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider
Performs the provided action against the single resource instance.
actionInstance(Context, ActionRequest) - Method in class org.forgerock.openig.http.ServerInfoSingletonProvider
 
ActionRequest - Interface in org.forgerock.json.resource
An implementation specific action, or operation, upon a JSON resource.
ActionResponse - Interface in org.forgerock.json.resource
Response object for JSON responses.
active(SecretsProvider, Purpose<T>, Clock) - Static method in class org.forgerock.secrets.SecretReference
Creates a reference to the active secret for the given purpose using the given secrets provider.
ActivityAuditEventBuilder<T extends ActivityAuditEventBuilder<T>> - Class in org.forgerock.audit.events
Builder for audit activity events.
ActivityAuditEventBuilder() - Constructor for class org.forgerock.audit.events.ActivityAuditEventBuilder
Creates the builder.
activityEvent() - Static method in class org.forgerock.audit.events.ActivityAuditEventBuilder
Starts to build an audit activity event.
adapt(Throwable) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil
Adapts a Throwable to a ResourceException.
add(int, E) - Method in class org.forgerock.util.LazyList
Inserts the specified element at the specified position in this list.
add(int, E) - Method in class org.forgerock.util.ListDecorator
Inserts the specified element at the specified position in this list.
add(int, Object) - Method in class org.forgerock.json.JsonValue
Adds the specified value to the list.
add(int, String, String) - Method in class org.forgerock.http.header.WarningHeader
Constructs a new header with the warnings defined in this WarningHeader in addition to the provided warning.
add(int, String, String, Date) - Method in class org.forgerock.http.header.WarningHeader
Constructs a new header with the warnings defined in this WarningHeader in addition to the provided warning.
add(E) - Method in class org.forgerock.http.util.SetDecorator
Adds the specified element to the set if it is not already present (optional operation).
add(E) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
 
add(E) - Method in class org.forgerock.util.LazyList
Appends the specified element to the end of this list.
add(E) - Method in class org.forgerock.util.ListDecorator
Appends the specified element to the end of this list.
add(Object) - Method in class org.forgerock.json.JsonValue
Adds the specified value to the end of the list.
add(String) - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
add(String, Object) - Method in class org.forgerock.http.protocol.Headers
A script compatible add method that will accept a Header, String, Collection<String> and String[] value.
add(String, Object) - Method in class org.forgerock.json.JsonValue
Adds the specified value.
add(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation
Creates a new "add" patch operation which will add the provided value(s) to the specified field.
add(K, V) - Method in class org.forgerock.http.util.MultiValueMap
Adds the specified value to the list for the specified key.
add(Warning) - Method in class org.forgerock.http.header.WarningHeader
Constructs a new header with the warnings defined in this WarningHeader in addition to the provided warning.
add(Header) - Method in class org.forgerock.http.protocol.Headers
An add method to add a particular Header instance.
add(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
Adds the value identified by the specified pointer, relative to this value as root.
add(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation
Creates a new "add" patch operation which will add the provided value(s) to the specified field.
addAll(int, Collection<? extends E>) - Method in class org.forgerock.util.LazyList
Inserts all of the elements in the specified collection into this list at the specified position.
addAll(int, Collection<? extends E>) - Method in class org.forgerock.util.ListDecorator
Inserts all of the elements in the specified collection into this list at the specified position.
addAll(Collection<? extends E>) - Method in class org.forgerock.http.util.SetDecorator
Adds all of the elements in the specified collection to the set if they're not already present (optional operation).
addAll(Collection<? extends E>) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
 
addAll(Collection<? extends E>) - Method in class org.forgerock.util.LazyList
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
addAll(Collection<? extends E>) - Method in class org.forgerock.util.ListDecorator
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
addAll(Collection<? extends String>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
addAll(Map<? extends String, ? extends Object>) - Method in class org.forgerock.http.protocol.Headers
A script compatible addAll method that will accept a Header, String, Collection<String> and String[] value.
addAll(Map<? extends K, Collection<? extends V>>) - Method in class org.forgerock.http.util.MultiValueMap
Adds the specified keys and values from the specified map into this map.
addAll(K, Collection<? extends V>) - Method in class org.forgerock.http.util.MultiValueMap
Adds the specified values to the list for the specified key.
addAll(MultiValueMap<K, V>) - Method in class org.forgerock.http.util.MultiValueMap
Adds the specified keys and values from the specified map into this map.
addAllRoutes(T) - Method in class org.forgerock.services.routing.AbstractRouter
Adds all of the routes defined in the provided router to this router.
addApiInfo(D) - Method in interface org.forgerock.http.ApiProducer
Add common API Info to the descriptor.
addApiInfo(Swagger) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
 
addAudience(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Adds an entry to the JWT's intended audience list, in the Claims Set.
addAudience(URI) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Adds an entry to the JWT's intended audience list, in the Claims Set.
addBinding(Handler, Expression<Boolean>) - Method in class org.forgerock.openig.handler.SequenceHandler
Binds sequenced handlers with sequence processing post-conditions.
addBinding(Expression<Boolean>, Handler, Expression<String>) - Method in class org.forgerock.openig.handler.DispatchHandler
Binds an expression to the current handler to dispatch to.
addChallenge(String, String, Map<String, String>) - Method in class org.forgerock.http.header.WwwAuthenticateHeader
Add a new challenge.
addChallenge(WwwAuthenticateHeader.Challenge) - Method in class org.forgerock.http.header.WwwAuthenticateHeader
Add a new authentication option.
addConnectionEventListener(Consumer<ConnectionEvent>) - Method in interface org.forgerock.openig.tools.notifications.NotificationService
Registers asynchronously a listener that will be notified on connection/disconnection events.
addConnectionEventListener(Consumer<ConnectionEvent>) - Method in class org.forgerock.openig.tools.notifications.ws.NotificationServiceImpl
 
addCookie(Cookie) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
 
addDateHeader(String, long) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
 
addDefaultDeclaration(DefaultDeclarationProvider.Declaration) - Method in class org.forgerock.openig.heap.HeapImpl
Add a default object declaration in this heap.
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
 
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
 
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.FilterChain
 
addDescriptorListener(Describable.Listener) - Method in interface org.forgerock.services.descriptor.Describable
Add a listener for API Descriptor changes.
addDescriptorListener(Describable.Listener) - Method in class org.forgerock.services.routing.AbstractRouter
 
addField(String...) - Method in interface org.forgerock.json.resource.ActionRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.CreateRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.DeleteRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.PatchRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.QueryRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.ReadRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.Request
Adds one or more fields which should be included with each JSON resource returned by this request.
addField(String...) - Method in interface org.forgerock.json.resource.UpdateRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.ActionRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.CreateRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.DeleteRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.PatchRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.QueryRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.ReadRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.Request
Adds one or more fields which should be included with each JSON resource returned by this request.
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.ResourceResponse
Adds a field to the list of fields which should be included in this JSON resource after field filtering has occurred.
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.UpdateRequest
 
addFormParameter(String, Expression<String>) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Adds a new form parameter using the given key with the given Expression.
addHeader(String, String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
 
addHeader(String, Expression<String>) - Method in class org.forgerock.openig.handler.StaticResponseHandler
Adds a pair key / expression to the header.
addHeaders(Header...) - Method in interface org.forgerock.http.protocol.Message
Add one or more headers to the message.
addHeaders(Header...) - Method in class org.forgerock.http.protocol.MessageImpl
 
addHeaderValue(String, Expression<String>) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Adds a new header value using the given key with the given Expression.
addHop(ForwardedHeader.Hop) - Method in class org.forgerock.http.header.ForwardedHeader
Add a new hop detail at the end of the list of hops.
addIfNotNull(String, Object) - Method in class org.forgerock.json.JsonValue
Adds the specified object value only if it is not null
addIntHeader(String, int) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
 
addIpAddress(String) - Method in class org.forgerock.http.header.XForwardedForHeader
Add an address as last hop to the list of addresses.
addLeadingSlash(String) - Static method in class org.forgerock.http.util.Paths
Add leading slash (if there is not already), returns the same value otherwise.
addOrReplace(KeyStoreSecretStore.AliasSpec) - Method in interface org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpecProvider
Adds a new AliasSpec in the list of usable aliases.
addOrReplace(KeyStoreSecretStore.AliasSpec) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.CompositeAliasSpecProvider
 
addOrReplace(KeyStoreSecretStore.AliasSpec) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.PredicateAliasSpecProvider
 
addOrReplace(KeyStoreSecretStore.AliasSpec) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.StaticAliasSpecProvider
 
addPatchOperation(String, String, JsonValue) - Method in interface org.forgerock.json.resource.PatchRequest
Adds a single patch operation which should be performed against the targeted resource.
addPatchOperation(PatchOperation...) - Method in interface org.forgerock.json.resource.PatchRequest
Adds one or more patch operations which should be performed against the targeted resource.
addPermissive(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
Adds the value identified by the specified pointer, relative to this value as root.
addQueryParameter(String, String) - Method in class org.forgerock.openig.filter.AuthRedirectContext
Add a query parameter to the context.
addRequestBinding(Expression<Boolean>, LeftValueExpression<?>, Expression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers a conditional binding on the request flow.
addRequestBinding(LeftValueExpression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the request flow.
addRequestBinding(LeftValueExpression<?>, Expression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the request flow.
addRequestCase(Expression<Boolean>, Handler) - Method in class org.forgerock.openig.filter.SwitchFilter
Add a request switch case with a condition and the handler to execute if condition yields.
addResponseBinding(Expression<Boolean>, LeftValueExpression<?>, Expression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers a conditional binding on the response flow.
addResponseBinding(LeftValueExpression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the response flow.
addResponseBinding(LeftValueExpression<?>, Expression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers an unconditional (always executed) binding on the response flow.
addResponseCase(Expression<Boolean>, Handler) - Method in class org.forgerock.openig.filter.SwitchFilter
Add a response switch case with a condition and the handler to execute if condition yields.
addRoute(RoutingMode, Router.UriTemplate, RequestHandler) - Method in class org.forgerock.json.resource.Router
Adds a new route to this router for the provided request handler.
addRoute(Version, CollectionResourceProvider) - Method in class org.forgerock.json.resource.Router
Adds a new route to this router for the provided collection resource provider.
addRoute(Version, RequestHandler) - Method in class org.forgerock.json.resource.Router
Adds a new route to this router for the provided request handler.
addRoute(Version, SingletonResourceProvider) - Method in class org.forgerock.json.resource.Router
Adds a new route to this router for the provided singleton resource provider.
addRoute(Router.UriTemplate, CollectionResourceProvider) - Method in class org.forgerock.json.resource.Router
Adds a new route to this router for the provided collection resource provider.
addRoute(Router.UriTemplate, SingletonResourceProvider) - Method in class org.forgerock.json.resource.Router
Adds a new route to this router for the provided singleton resource provider.
addRoute(RouteMatcher<R>, H) - Method in class org.forgerock.services.routing.AbstractRouter
Adds a new route to this router for the provided handler.
addSharedBearerOAuth2ClientFilterAttributes(ComponentTypeDefinition) - Method in class org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterTypeProvider
 
addShutdownListener(ShutdownListener) - Method in interface org.forgerock.util.thread.listener.ShutdownManager
Adds a ShutdownListener to this ShutdownManager with the default priority.
addShutdownListener(ShutdownListener, ShutdownPriority) - Method in interface org.forgerock.util.thread.listener.ShutdownManager
Adds a ShutdownListener to this ShutdownManager with the supplied priority.
addSortKey(String...) - Method in interface org.forgerock.json.resource.QueryRequest
Adds one or more sort keys which will be used for ordering the JSON resources returned by this query request.
addSortKey(SortKey...) - Method in interface org.forgerock.json.resource.QueryRequest
Adds one or more sort keys which will be used for ordering the JSON resources returned by this query request.
addStopAction(Runnable) - Method in class org.forgerock.openig.decoration.DecorationHandle
Adds an action to execute when the decoration stops.
addToBatch(String, JsonValue, StringBuilder) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchConsumer
Adds an audit event to a batch payload.
addToBatch(String, JsonValue, StringBuilder) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Adds an audit event to an Elasticsearch Bulk API payload.
addToBatch(String, JsonValue, StringBuilder) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
 
addToBatch(String, JsonValue, StringBuilder) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
 
addTrackingId(String) - Method in class org.forgerock.services.context.RequestAuditContext
Adds a tracking ID to the context.
addTrailer(String, Expression<String>) - Method in class org.forgerock.openig.handler.StaticResponseHandler
Adds a pair key / expression to the trailer.
addTrailers(String...) - Method in class org.forgerock.http.header.TrailerHeader
Add some new trailers that are expected to be received.
addTrailers(List<String>) - Method in class org.forgerock.http.header.TrailerHeader
Add some new trailers that are expected to be received.
addTrailers(Header...) - Method in class org.forgerock.http.protocol.Response
Add one or more trailers, aka trailing headers, to the response.
addTrailingSlash(String) - Static method in class org.forgerock.http.util.Paths
Adds a trailing slash at the end of the given raw path or returns the same value if an end slash is present.
addUnconditionalBinding(Handler, Expression<String>) - Method in class org.forgerock.openig.handler.DispatchHandler
Adds an unconditional bindings to the handler.
AdminHttpApplication - Interface in org.forgerock.openig.http
Configuration class for the Identity Gateway Administration.
AdviceContext - Class in org.forgerock.json.resource
A Context containing information which should be returned to the user in some appropriate form to the user.
AdviceContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.json.resource.AdviceContext
Restore from JSON representation.
AdviceContext(Context, Collection<String>) - Constructor for class org.forgerock.json.resource.AdviceContext
Creates a new AdviceContext with the provided parent.
AdviceWarning - Class in org.forgerock.json.resource
WarningHeader implements RFC 2616 section 14.46 - Warning.
AES_KEYWRAP - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithmType
AES KeyWrap.
AESKeyWrapEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Provides JWE key encapsulation using the AES KeyWrap algorithm.
AESKeyWrapEncryptionHandler(EncryptionMethod) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler
Constructs an AES KeyWrap encryption handler for the given underlying content encryption method.
after(String) - Method in class org.forgerock.audit.events.ConfigAuditEventBuilder
Records the new state of the modified object as a String.
after(JsonValue) - Method in class org.forgerock.audit.events.ConfigAuditEventBuilder
Records the new state of the modified object as JSON.
AFTER - Static variable in class org.forgerock.audit.events.ConfigAuditEventBuilder
 
afterRollingOver() - Method in interface org.forgerock.audit.events.handlers.writers.RotatableWriter.RolloverLifecycleHook
This method is called after the rotation and retention checks are done.
AGREE_KEY - Enum constant in enum class org.forgerock.secrets.keys.KeyUsage
Key is intended for deriving a key via a key agreement protocol such as Diffie-Hellman.
ALERT - Enum constant in enum class org.forgerock.audit.handlers.syslog.Severity
Action must be taken immediately.
alg(Algorithm) - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder
Sets the algorithm used to perform cryptographic signing and/or encryption on the JWT.
ALG - Enum constant in enum class org.forgerock.json.jose.jwt.JwtHeaderKey
Algorithm JWT header parameter.
algorithm - Variable in class org.forgerock.json.jose.jwk.JWK.Builder
The intended JOSE algorithm for the key, optional.
algorithm(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Sets the algorithm parameter of the JWK.
algorithm(Algorithm) - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Sets the algorithm parameter of the JWK.
Algorithm - Interface in org.forgerock.json.jose.jwt
The interface for each possible algorithm that can be used to sign and/or encrypt a JWT.
ALGORITHM_BCRYPT - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the BCrypt cryptographic hash algorithm.
ALGORITHM_MD5 - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the message digest algorithm that should be used to generate MD5 hashes.
ALGORITHM_PBKDF2 - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the Password-Based Key Derivation Function 2 (PBKDF2) cryptographic hash algorithm.
ALGORITHM_SCRYPT - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the SCrypt cryptographic hash algorithm.
ALGORITHM_SHA_1 - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the message digest algorithm that should be used to generate SHA-1 hashes.
ALGORITHM_SHA_256 - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the message digest algorithm that should be used to generate 256-bit SHA-2 hashes.
ALGORITHM_SHA_384 - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the message digest algorithm that should be used to generate 384-bit SHA-2 hashes.
ALGORITHM_SHA_512 - Static variable in class org.forgerock.util.crypto.CryptoConstants
The name of the message digest algorithm that should be used to generate 512-bit SHA-2 hashes.
AliasSpec(String, BooleanSupplier) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpec
Create an alias specification.
aliasSpecs(List<String>) - Method in interface org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpecProvider
Returns a list of every usable aliases in a KeyStore, may use a KeyStore's aliases list.
aliasSpecs(List<String>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.CompositeAliasSpecProvider
 
aliasSpecs(List<String>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.PredicateAliasSpecProvider
 
aliasSpecs(List<String>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.StaticAliasSpecProvider
 
ALL - Enum constant in enum class org.forgerock.openig.decoration.capture.CapturePoint
Prints all of the messages.
allDone(Collection<Promise<?, ?>>) - Static method in class org.forgerock.util.promise.Promises
Returns a Promise which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions).
allDone(Collection<Promise<?, ?>>, V) - Static method in class org.forgerock.util.promise.Promises
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.
ALLOW_ALL - Enum constant in enum class org.forgerock.http.handler.HttpClientHandler.HostnameVerifier
Deprecated.
this should never be used as it is a security risk.
allowCredentials(boolean) - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Sets to true to inform the CORS client that credentials are allowed.
allowedAlgorithm(String) - Static method in interface org.forgerock.secrets.SecretConstraint
Enforces that the key is allowed to be used with the given algorithm.
allowedAlgorithm(Algorithm) - Static method in class org.forgerock.json.jose.utils.JoseSecretConstraints
Enforces that the key is allowed to be used with the given JWA algorithm.
allowedAlgorithms(Collection<String>) - Method in class org.forgerock.secrets.SecretBuilder
Sets the cryptographic algorithms that can be used with this key.
allowedAlgorithms(Predicate<String>) - Method in class org.forgerock.secrets.SecretBuilder
Sets the cryptographic algorithms that can be used with this key.
allowedKeyType(KeyType) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Enforce that a CryptoKey satisfies the given key type constraint.
allowedKeyUsages(Set<KeyUsage>) - Static method in interface org.forgerock.secrets.SecretConstraint
Enforces that the key satisfies at least one of the given key usage constraints.
allowedKeyUsages(KeyUsage, KeyUsage...) - Static method in interface org.forgerock.secrets.SecretConstraint
Enforces that the key satisfies at least one of the given key usage constraints.
allowMultiPartJsonRequests() - Method in interface org.forgerock.json.resource.CrestApplication
Whether the JSON content for a request can be sent in a mulipart/form-data payload.
AllowOnlyFilter - Class in org.forgerock.openig.filter.allow
This filter authorizes a request to continue processing if any of the declared rules is satisfied (logical or).
AllowOnlyFilter(TraceablePredicate, Handler, ReporterFactory) - Constructor for class org.forgerock.openig.filter.allow.AllowOnlyFilter
Constructs an AllowOnlyFilter.
AllowOnlyFilter.Heaplet - Class in org.forgerock.openig.filter.allow
Creates an AllowOnlyFilter in a Heap environment.
allowsAlgorithm(String) - Method in class org.forgerock.secrets.keys.CryptoKey
Checks whether this key is allowed to be used with the given algorithm.
alwaysFalse() - Static method in class org.forgerock.util.query.QueryFilter
Returns a filter which does not match any resources.
alwaysTrue() - Static method in class org.forgerock.util.query.QueryFilter
Returns a filter which matches all resources.
am(Version) - Static method in class org.forgerock.openig.tools.am.AmVersion
Returns a normalized AM version from the given version.
AM_NOTIFICATION_SERVICE_PROTOCOL - Static variable in class org.forgerock.openig.tools.notifications.ws.NotificationsConstants
WebSocket protocol used by AM Notifications service.
AmLink - Interface in org.forgerock.openig.tools.notifications.ws.link
Represents a link to AM notification service.
AmLink.AmLinkSupplier - Interface in org.forgerock.openig.tools.notifications.ws.link
A supplier of AM Link.
AmLink.ResilientAmLinkSupplier - Interface in org.forgerock.openig.tools.notifications.ws.link
A supplier of Resilient AM Link.
AmLinkListener - Interface in org.forgerock.openig.tools.notifications.ws.link
Represent a listener willing to be notified upon AmLink events.
AmLinkListener.ResilientAmLinkListener - Interface in org.forgerock.openig.tools.notifications.ws.link
Represent a listener capable of handling reopening signals.
amService - Variable in class org.forgerock.openig.openam.AbstractConditionAdviceFilter
AmService instance supporting policy advice verification.
AmService - Class in org.forgerock.openig.tools.am
Creates a configuration class for AM.
AmService.Builder - Class in org.forgerock.openig.tools.am
Builder of AmService.
AmService.Discovery - Class in org.forgerock.openig.tools.am
A pre-builder class used to discover AM details such as its version and expected cookie name.
AmServiceHeaplet - Class in org.forgerock.openig.openam
This heaplet represents an instance of an AmService that can shared amongst AM related filters such as the SingleSignOnFilter and the PolicyEnforcementFilter.
AmServiceHeaplet() - Constructor for class org.forgerock.openig.openam.AmServiceHeaplet
 
AmServiceTypeProvider - Class in org.forgerock.openig.openam
Provide AmServiceHeaplet's TypeDefinition.
AmServiceTypeProvider() - Constructor for class org.forgerock.openig.openam.AmServiceTypeProvider
 
AmSessionIdleTimeoutFilter - Class in org.forgerock.openig.openam.session
This filter will track the AM sessions (stateless or stateful) and will revoke them if their idle timeout goes over a defined limit.
AmSessionIdleTimeoutFilter.Heaplet - Class in org.forgerock.openig.openam.session
This class is responsible of creating the AmSessionIdleTimeoutFilter heap object.
AmSessionIdleTimeoutFilterTypeProvider - Class in org.forgerock.openig.openam.session
Provide AmSessionIdleTimeoutFilter's TypeDefinition.
AmSessionIdleTimeoutFilterTypeProvider() - Constructor for class org.forgerock.openig.openam.session.AmSessionIdleTimeoutFilterTypeProvider
 
AmVersion - Class in org.forgerock.openig.tools.am
Normalized AM version.
and(Collection<FilterCondition>) - Static method in class org.forgerock.json.resource.Filters
Returns a FilterCondition which will only match requests which match all the provided conditions.
and(Collection<QueryFilter<FF>>) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new and filter using the provided list of sub-filters.
and(FilterCondition...) - Static method in class org.forgerock.json.resource.Filters
Returns a FilterCondition which will only match requests which match all the provided conditions.
and(QueryFilter<FF>...) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new and filter using the provided list of sub-filters.
AND - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "and" operator.
andLog(Predicate<T>, Consumer<Logger>) - Static method in class org.forgerock.openig.util.PredicateUtil
A method that tests a Predicate and perform the given Consumer's action on the class logger if the Predicate test returns false.
andThen(Function<? super VOUT, ? extends V, E>) - Method in interface org.forgerock.util.Function
Returns a composed function that first applies this function to its input, and then applies the after function to the result.
any() - Static method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Accepts any input value.
ANY_DISK_SPACE - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention
The disk space value when disk space is unrestricted.
anyOf(String...) - Static method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Accepts String that are contained within the given set (case sensitive).
anyResultFrom(Stream<Promise<V, E>>) - Static method in class org.forgerock.util.promise.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.
api - Variable in class org.forgerock.services.routing.AbstractRouter
Api of the current router.
api(ApiProducer<D>) - Method in interface org.forgerock.services.descriptor.Describable
Provide the API description for the component.
api(ApiProducer<D>) - Method in class org.forgerock.services.routing.AbstractRouter
 
api(ApiProducer<ApiDescription>) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
 
api(ApiProducer<ApiDescription>) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
 
api(ApiProducer<ApiDescription>) - Method in class org.forgerock.json.resource.FilterChain
 
API - Enum constant in enum class org.forgerock.json.resource.RequestType
An API Descriptor request.
API_PARAMETER - Static variable in class org.forgerock.http.swagger.OpenApiRequestFilter
Request parameter for the OpenAPI API Descriptor.
API_PROTECTION_FILTER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a Filter instance from the Heap of admin.json.
ApiProducer<D> - Interface in org.forgerock.http
A producer of API Descriptions.
ApiVersionProtocolHeaderFilter - Class in org.forgerock.openig.tools
This filter overrides the protocol version in Accept-Api-Version header.
ApiVersionProtocolHeaderFilter(Version) - Constructor for class org.forgerock.openig.tools.ApiVersionProtocolHeaderFilter
Creates a new ApiVersionProtocolHeaderFilter.
ApiVersionRouterContext - Class in org.forgerock.http.routing
A Context which is created when a request is and has been routed based on resource API version.
ApiVersionRouterContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.routing.ApiVersionRouterContext
Restore from JSON representation.
ApiVersionRouterContext(Context, DefaultVersionBehaviour, boolean) - Constructor for class org.forgerock.http.routing.ApiVersionRouterContext
Creates a new resource API version routing context having the provided parent, default versioning behaviour and whether warnings will be issued.
append(byte) - Method in interface org.forgerock.http.io.Buffer
Appends a single byte to the end of the buffer.
append(byte[], int, int) - Method in interface org.forgerock.http.io.Buffer
Appends len bytes from the specified byte array starting at offset off to the end of the buffer.
appendQuery(URI, Form) - Static method in class org.forgerock.http.util.Uris
Returns a new URI with the given query parameters appended to the original ones, if any.
appendRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form
Appends the form as additional query parameters on an existing request URI.
APPLICATION_JSON_CHARSET_UTF_8 - Static variable in class org.forgerock.http.protocol.Entity
The Content-Type used when setting the entity to JSON.
APPLICATION_X_WWW_FORM_URLENCODED - Static variable in class org.forgerock.http.protocol.Entity
The Content-Type when setting the entity to form.
Applications - Class in org.forgerock.http
Utility methods to work with CHF Applications.
Applications - Class in org.forgerock.json.resource
A utility class for dealing with CrestApplication instances.
apply(char[]) - Method in class org.forgerock.secrets.keystore.HsmKeyStoreLoader
 
apply(Flowable<ByteBuffer>) - Method in class org.forgerock.http.io.CharsetDecoderFlowableTransformer
 
apply(Flowable<CharBuffer>) - Method in class org.forgerock.openig.reactive.CharBufferToLineFlowableTransformer
 
apply(JsonValue) - Method in class org.forgerock.json.JsonValueTraverseFunction
 
apply(ContextAndRequest) - Method in class org.forgerock.openig.el.ExpressionRequestAsyncFunction
 
apply(ValidatorConstraintContext) - Method in class org.forgerock.openig.tools.jwt.validation.JweDecryptionConstraint
 
apply(ValidatorConstraintContext) - Method in interface org.forgerock.openig.tools.jwt.validation.JwtConstraint
Apply a constraint to the given JWT.
apply(ValidatorConstraintContext, String, T) - Method in interface org.forgerock.openig.tools.jwt.validation.JwtClaimConstraint
Apply a constraint to the given claim value.
apply(T, U) - Method in interface org.forgerock.util.BiFunction
Process the values.
apply(VIN) - Method in interface org.forgerock.util.AsyncFunction
Asynchronously applies this function to the input parameter value and returns a Promise for the result.
apply(VIN) - Method in class org.forgerock.util.CloseSilentlyAsyncFunction
Invokes the delegate async function's AsyncFunction.apply(Object) with the input parameter value, closes it when the delegated promise completes.
apply(VIN) - Method in class org.forgerock.util.CloseSilentlyFunction
Invokes the delegate function's Function.apply(Object) with the input parameter value, closes it, and returns the result.
apply(VIN) - Method in interface org.forgerock.util.Function
Applies this function to the input parameter value and returns the result.
applyTo(MatchResult) - Method in class org.forgerock.openig.regex.PatternTemplate
Performs a transformation of a match result by applying the template.
apu(String) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Sets the Agreement PartyUInfo header parameter for this JWE.
APU - Enum constant in enum class org.forgerock.json.jose.jwe.JweHeaderKey
Agreement PartyUInfo header parameter.
apv(String) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Sets the Agreement PartyVInfo header parameter for this JWE.
APV - Enum constant in enum class org.forgerock.json.jose.jwe.JweHeaderKey
Agreement PartyVInfo header parameter.
array(Object...) - Static method in class org.forgerock.json.JsonValue
Returns a mutable JSON array containing the provided objects.
array(String...) - Static method in class org.forgerock.openig.el.Functions
Create an array of String based on the strings given as parameters.
ARRAY_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper
Json array value type.
ArrayResolver - Class in org.forgerock.openig.resolver
Resolves native arrays of objects.
ArrayResolver() - Constructor for class org.forgerock.openig.resolver.ArrayResolver
 
as(Class<T>) - Method in class org.forgerock.services.context.AbstractContext
 
as(Class<T>) - Method in interface org.forgerock.services.context.Context
Returns an @{link Optional} which contains the first context in the chain whose type is a sub-type of the provided Context class if one exists, or an empty optional if none is present.
as(Function<JsonValue, V, E>) - Method in class org.forgerock.json.JsonValue
Returns the JSON value as an object whose type (and value) is specified by a transformation function.
asArrayOrNull(List<String>) - Static method in class org.forgerock.http.util.Lists
Returns the given list content as an array, or null if the list is empty.
asAsync(AsyncFunction<JsonValue, V, E>) - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a promised object whose type (and value) is specified by a transformation function.
asBoolean() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Boolean object.
ascendingOrder(String) - Static method in class org.forgerock.json.resource.SortKey
Creates a new ascending-order sort key for the provided JSON field.
ascendingOrder(JsonPointer) - Static method in class org.forgerock.json.resource.SortKey
Creates a new ascending-order sort key for the provided JSON field.
asClass(JsonValue) - Static method in class org.forgerock.openig.util.JsonValues
Returns the class object associated with a named class or interface, using the thread context class loader.
asCollection() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Collection object.
asCollection(Class<E>) - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Collection containing objects of the specified type.
asContext(Class<T>) - Method in class org.forgerock.services.context.AbstractContext
 
asContext(Class<T>) - Method in interface org.forgerock.services.context.Context
Returns the first context in the chain whose type is a sub-type of the provided Context class.
asCryptoKey() - Method in class org.forgerock.secrets.keys.DataDecryptionKey
 
asCryptoKey() - Method in class org.forgerock.secrets.keys.DataEncryptionKey
 
asCryptoKey() - Method in interface org.forgerock.secrets.keys.DecryptionKey
Returns the same object as a specific CryptoKey subclass.
asCryptoKey() - Method in interface org.forgerock.secrets.keys.EncryptionKey
Returns the same object as a specific CryptoKey subclass.
asCryptoKey() - Method in class org.forgerock.secrets.keys.KeyAgreementKey
 
asCryptoKey() - Method in class org.forgerock.secrets.keys.KeyDecryptionKey
 
asCryptoKey() - Method in class org.forgerock.secrets.keys.KeyEncryptionKey
 
asDescribableHandler(Handler) - Static method in class org.forgerock.http.handler.Handlers
Adapts a Handler to a DescribableHandler without adding support for API Descriptions if it is not already implemented.
asDouble() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Double object.
asEnum(String, Class<T>) - Static method in class org.forgerock.util.Strings
Returns the string value as an enum constant of the specified enum type.
asEnum(String, Class<T>) - Static method in class org.forgerock.util.Utils
asInfiniteRetrySupplier(Duration, AsyncRefreshableSupplier<SsoToken, AuthenticationException>, RetryableAmLink.AmLinkSupplierFromToken, ScheduledExecutorService) - Static method in class org.forgerock.openig.tools.notifications.ws.link.RetryableAmLink
Builds a supplier of RetryableAmLink without any retry limit.
asInteger() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as an Integer object.
asJsonValue() - Method in class org.forgerock.http.oauth2.AccessTokenInfo
Returns the raw JSON as a JsonValue.
asJsonValue() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the raw information of the SessionInfo object as JsonValue.
asJsonValue() - Method in class org.forgerock.openig.openam.SsoTokenContext
Returns the info associated with this context as a JsonValue.
asJsonValue() - Method in class org.forgerock.openig.openam.UserProfileContext
Get the raw JSON representation as a JsonValue.
asJwt() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder
 
asJwt() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder
 
asJwt() - Method in interface org.forgerock.json.jose.builders.JwtBuilder
Builds the JWT object from its constituent parts.
asJwt() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
 
asJwt() - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder
 
asKeyStore(Set<Purpose<? extends CryptoKey>>) - Method in class org.forgerock.secrets.SecretsProvider
Returns a view of this secrets provider as a keystore for the given purposes.
asKeyStore(Purpose<T>) - Method in interface org.forgerock.openig.secrets.SecretsService
Returns a view of this secrets provider as a keystore for the given purpose.
asKeyStore(Purpose<T>) - Method in class org.forgerock.secrets.SecretsProvider
Returns a view of this secrets provider as a keystore for the given purpose.
asList() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a List object.
asList(Class<E>) - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a List containing objects of the specified type.
asLong() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Long object.
asMap() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Map object.
asMap() - Method in class org.forgerock.openig.el.Bindings
Returns an unmodifiable Map view of this Bindings instance.
asMap() - Method in class org.forgerock.util.Pair
Get the pair as a map of key to value.
asMap(Class<V>) - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Map containing objects of the specified type.
asMapOfHeaders() - Method in class org.forgerock.http.protocol.Headers
The Headers class extends Map<String, Object> to support flexible parameters in scripting.
asMapOfList(Class<E>) - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Map containing a collection of objects of the specified type.
asNumber() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Number object.
asPromise() - Method in interface org.forgerock.json.resource.ActionResponse
Return this response as a result Promise.
asPromise() - Method in interface org.forgerock.json.resource.QueryResponse
Return this response as a result Promise.
asPromise() - Method in exception org.forgerock.json.resource.ResourceException
Return this ResourceException as a Promise.
asPromise() - Method in interface org.forgerock.json.resource.ResourceResponse
Return this response as a result Promise.
asPromise() - Method in class org.forgerock.openig.filter.oauth2.cnf.Result
Returns a new completed promise wrapping this result.
asPromise() - Method in class org.forgerock.openig.tools.jwt.validation.Result
Return this result as a completed Promise.
asRawJson() - Method in class org.forgerock.openig.tools.userprofile.UserProfile
Get the raw JSON representation as a JsonValue.
asRequestHandler(SynchronousRequestHandler) - Static method in class org.forgerock.json.resource.Resources
Adapts the provided SynchronousRequestHandler as a RequestHandler.
assertionClaims() - Method in record class org.forgerock.openig.handler.assertion.IdentityAssertionClaims
Returns the value of the assertionClaims record component.
AssertionClassAliasResolver - Class in org.forgerock.openig.assertion
Register all the aliases supported by the openig-identity-assertion module.
AssertionClassAliasResolver() - Constructor for class org.forgerock.openig.assertion.AssertionClassAliasResolver
 
AssignmentFilter - Class in org.forgerock.openig.filter
Conditionally assigns values to expressions before and after the request is handled.
AssignmentFilter() - Constructor for class org.forgerock.openig.filter.AssignmentFilter
 
AssignmentFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an assignment filter in a heap environment.
asString() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a String object.
asString(InputStream, Charset) - Static method in class org.forgerock.openig.util.StringUtil
Reads the provided input stream as a string and then closes the stream.
asSupplier(boolean, int, Duration, AsyncRefreshableSupplier<SsoToken, AuthenticationException>, RetryableAmLink.AmLinkSupplierFromToken, ScheduledExecutorService) - Static method in class org.forgerock.openig.tools.notifications.ws.link.RetryableAmLink
Builds a supplier of RetryableAmLink.
asSupplier(AmLink.ResilientAmLinkSupplier) - Static method in class org.forgerock.openig.tools.notifications.ws.link.StableAmLink
Builds a supplier of StableAmLink.
asSupplier(AmLink.ResilientAmLinkSupplier) - Static method in class org.forgerock.openig.tools.notifications.ws.link.TopicMultiplexerAmLink
Create a supplier that adds a TopicMultiplexerAmLink in front of a resilient AmLink.
asSupplier(WebSocketAdapter) - Static method in class org.forgerock.openig.tools.notifications.ws.link.DirectAmLink
Builds a supplier of DirectAmLink.
asSupplier(Duration, AmLink.AmLinkSupplier, AutoReconnectAmLink.AmLinkSupplierFromTopics, ScheduledExecutorService) - Static method in class org.forgerock.openig.tools.notifications.ws.link.AutoReconnectAmLink
Builds a supplier of AutoReconnectAmLink.
asURI() - Method in class org.forgerock.http.MutableUri
Returns the equivalent URI instance.
asWwwAuthenticateHeader() - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns a representation of this error as a WWW-Authenticate header.
AsyncFunction<VIN,VOUT,E extends Exception> - Interface in org.forgerock.util
An asynchronous Function which returns a result at some point in the future.
AsyncFunctions - Class in org.forgerock.openig.util
Collection of AsyncFunction utilities.
AsynchronousTextWriter - Class in org.forgerock.audit.events.handlers.writers
A Text Writer which writes log records asynchronously to character-based stream.
AsynchronousTextWriter(String, boolean, TextWriter) - Constructor for class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter
Construct a new AsynchronousTextWriter wrapper.
asyncProxyInfo(URI, CredentialPair<GenericSecret>, Clock, Duration) - Static method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo
Creates an instance of ProxyInfo for a proxy that requires authentication, this will update its secrets in the background and will not block threads.
AsyncRefreshableSupplier<V,E extends Exception> - Class in org.forgerock.openig.tools.authentication.chf
This utility class supports a lock-downgrading strategy to make sure that 2 concurrent calls to compute the "cached" value will result in a single computation.
AsyncRefreshableSupplier(AsyncFunction<Context, V, E>) - Constructor for class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier
Creates a provider ensuring "only-once" invocation of the given compute function.
asyncResultHandler(AsyncFunction<V, Void, E>) - Static method in class org.forgerock.openig.util.AsyncFunctions
Utility async function that will allow to use the calling promise's result asynchronously.
AsyncSessionManager - Interface in org.forgerock.http.session
A session manager is responsible to create/save a new type of Session.
ATTR_HEADERS - Static variable in class org.forgerock.json.resource.http.HttpContext
Attribute in the serialized JSON form that holds the request headers.
ATTR_METHOD - Static variable in class org.forgerock.json.resource.http.HttpContext
Attribute in the serialised JSON form that holds the HTTP method of the request.
ATTR_PARAMETERS - Static variable in class org.forgerock.json.resource.http.HttpContext
Attribute in the serialized JSON form that holds the query and/or form parameters.
ATTR_PATH - Static variable in class org.forgerock.json.resource.http.HttpContext
Attribute in the serialised JSON form that holds the full URI of the request, excluding anything beyond the path component (i.e., no query parameters).
ATTRIBUTE_AUTHCID - Static variable in class org.forgerock.json.resource.http.SecurityContextFactory
Deprecated.
The name of the HTTP Request attribute where this factory expects to find the authenticated user's authentication ID.
ATTRIBUTE_AUTHZID - Static variable in class org.forgerock.json.resource.http.SecurityContextFactory
Deprecated.
The name of the HTTP Request attribute where this factory expects to find the authenticated user's authorization ID.
attributeDefinitions() - Method in class org.forgerock.openig.assertion.plugin.ScriptableIdentityAssertionPluginTypeProvider
 
attributeDefinitions() - Method in class org.forgerock.openig.script.AbstractScriptableTypeProvider
Return any additional AttributeDefinition's of the ScriptableTypeProvider.
AttributesContext - Class in org.forgerock.services.context
An AttributesContext is a mechanism for transferring transient state between components when processing a single request.
AttributesContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.AttributesContext
Restore from JSON representation.
AttributesContext(Context) - Constructor for class org.forgerock.services.context.AttributesContext
Constructs a new AttributesContext.
aud(List<String>) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets the JWT's intended audience list in the Claims Set.
AUD - Enum constant in enum class org.forgerock.json.jose.jwt.JwtClaimsSetKey
Audience Claim.
Audit - Annotation Interface in org.forgerock.audit
Denotes audit dependencies.
AUDIT_DATASOURCE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the DataSource to use for auditing.
AUDIT_SERVICE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve an AuditService instance from the Heap.
AuditEvent - Class in org.forgerock.audit.events
Represents an audit event.
AuditEventBuilder<T extends AuditEventBuilder<T>> - Class in org.forgerock.audit.events
Root builder for all audit events.
AuditEventBuilder() - Constructor for class org.forgerock.audit.events.AuditEventBuilder
Creates the builder.
AuditEventHandler - Interface in org.forgerock.audit.events.handlers
The interface for an AuditEventHandler.
AuditEventHandlerBase - Class in org.forgerock.audit.events.handlers
Abstract AuditEventHandler class.
AuditEventHandlerBase(String, EventTopicsMetaData, Set<String>, boolean) - Constructor for class org.forgerock.audit.events.handlers.AuditEventHandlerBase
Create a new AuditEventHandler instance.
AuditEventHandlerFactory - Interface in org.forgerock.audit.events.handlers
Factory interface for creating instances of AuditEventHandler.
AuditEventHelper - Class in org.forgerock.audit.events
Helper methods for AuditEvents.
auditEvents() - Method in class org.forgerock.openig.audit.AbstractAuditEvents
The Set of the audit events.
AuditEvents - Interface in org.forgerock.openig.audit
Audit events interface.
AuditEventTopicState - Class in org.forgerock.audit.events.handlers
Stores the state of the details sent to AuditEventHandler.publishEvent(Context, String, JsonValue).
AuditEventTopicState(Context, String, JsonValue) - Constructor for class org.forgerock.audit.events.handlers.AuditEventTopicState
Creates a (topic,event) pair.
AuditException - Exception in org.forgerock.audit
Root class of all exceptions in the Commons Audit Framework.
AuditException(String) - Constructor for exception org.forgerock.audit.AuditException
Constructs an AuditException using the given message.
AuditException(String, Throwable) - Constructor for exception org.forgerock.audit.AuditException
Constructs an AuditException using the given message and parent cause.
AuditException(Throwable) - Constructor for exception org.forgerock.audit.AuditException
Constructs an AuditException using the given parent cause.
AuditingContext - Class in org.forgerock.audit
A Context used when auditing over the router.
AuditingContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.audit.AuditingContext
Restore a serialized audit context.
AuditingContext(Context) - Constructor for class org.forgerock.audit.AuditingContext
Construct a new audit context with the provided parent.
AuditJsonConfig - Class in org.forgerock.audit.json
Utility class to facilitate creation and configuration of audit service and audit event handlers through JSON.
auditLogFileUnexpectedlyDisappearedErrorMsg(Path) - Static method in class org.forgerock.audit.util.AuditUtils
Returns an error message to be used when an audit log file got unexpectedly removed by an external program.
auditService() - Method in class org.forgerock.openig.types.importer.RouteInstance
Returns the component instance of the AuditService of this route.
auditService(ComponentInstance) - Method in class org.forgerock.openig.types.importer.RouteInstance
Sets the component instance supporting the AuditService of this route.
AuditService - Interface in org.forgerock.audit
CREST RequestHandler responsible for storing and retrieving audit events.
AuditServiceBuilder - Class in org.forgerock.audit
Builder for AuditService.
AuditServiceConfiguration - Class in org.forgerock.audit
Configuration of the audit service.
AuditServiceConfiguration() - Constructor for class org.forgerock.audit.AuditServiceConfiguration
Empty constructor.
AuditServiceConfiguration(AuditServiceConfiguration) - Constructor for class org.forgerock.audit.AuditServiceConfiguration
Copy-constructor, in order to obtain a copy from an existing configuration.
AuditServiceObjectHeaplet - Class in org.forgerock.openig.audit
Creates and initializes an AuditService in a heap environment.
AuditServiceObjectHeaplet() - Constructor for class org.forgerock.openig.audit.AuditServiceObjectHeaplet
 
AuditServiceProxy - Class in org.forgerock.audit
AuditService proxy that allows products to implement threadsafe hot-swappable configuration updates.
AuditServiceProxy(AuditService) - Constructor for class org.forgerock.audit.AuditServiceProxy
Create a new AuditServiceProxy.
AuditUtils - Class in org.forgerock.audit.util
General utilities for commons audit.
AUTH - Enum constant in enum class org.forgerock.audit.handlers.syslog.Facility
Security/authorization messages.
authenticate(HttpServletResponse) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
 
authenticate(Context, String, SecretReference<GenericSecret>) - Method in interface org.forgerock.openig.tools.authentication.AuthenticationService
Authenticates a subject (identified with the given username and passwordRef credentials), returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException on failures (I/O, invalid credentials, ...).
authenticate(Context, String, SecretReference<GenericSecret>) - Method in class org.forgerock.openig.tools.authentication.AuthenticatorAuthenticationService
 
AuthenticationAuditEventBuilder<T extends AuthenticationAuditEventBuilder<T>> - Class in org.forgerock.audit.events
Builder for audit authentication events.
AuthenticationAuditEventBuilder() - Constructor for class org.forgerock.audit.events.AuthenticationAuditEventBuilder
 
AuthenticationAuditEventBuilder.Status - Enum Class in org.forgerock.audit.events
Defines a fixed set of authentication statuses that can be logged.
authenticationEvent() - Static method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Starts to build an audit authentication event.
AuthenticationException - Exception in org.forgerock.openig.tools.authentication
Represents an authentication error or failure.
AuthenticationException(String) - Constructor for exception org.forgerock.openig.tools.authentication.AuthenticationException
Constructs a new exception with the given message.
AuthenticationException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.authentication.AuthenticationException
Constructs a new exception with the given message and root cause.
AuthenticationService - Interface in org.forgerock.openig.tools.authentication
Asynchronous AM authentication service delivering SsoToken.
AuthenticatorAuthenticationService - Class in org.forgerock.openig.tools.authentication
Provides an implementation of the AuthenticationService using a Authenticator plugin.
AuthorizationCodeGrantTypeHandler - Class in org.forgerock.secrets.oauth2
A handler that can send an authorization code and optional PKCE verifier to the token endpoint to receive an access token.
AuthorizationCodeGrantTypeHandler(String, String) - Constructor for class org.forgerock.secrets.oauth2.AuthorizationCodeGrantTypeHandler
Initialises the grant type handler with the given parameters.
AuthorizationCodeGrantTypeHandler(String, String, String, String) - Constructor for class org.forgerock.secrets.oauth2.AuthorizationCodeGrantTypeHandler
Initialises the grant type handler with the given parameters.
AuthorizationHeader - Class in org.forgerock.http.header
A header class representing the Authorization HTTP header.
AuthorizationHeader() - Constructor for class org.forgerock.http.header.AuthorizationHeader
 
AuthorizationHeader.Factory - Class in org.forgerock.http.header
A factory for creating AuthorizationHeader instances.
AUTHPRIV - Enum constant in enum class org.forgerock.audit.handlers.syslog.Facility
Security/authorization messages.
AuthRedirectContext - Class in org.forgerock.openig.filter
Used by the FragmentFilter and the DataPreservationFilter to know if a filter has attempted an impending IG redirection.
AuthRedirectContext(Context) - Constructor for class org.forgerock.openig.filter.AuthRedirectContext
Create an AuthRedirectContext instance.
AUTHZID_COMPONENT - Static variable in class org.forgerock.services.context.SecurityContext
The authorization ID name reserved for the name of the component in which a user's resource is located, e.g.
AUTHZID_DN - Static variable in class org.forgerock.services.context.SecurityContext
The authorization ID name reserved for the user's LDAP distinguished name.
AUTHZID_ID - Static variable in class org.forgerock.services.context.SecurityContext
The authorization ID principal name reserved for a user's unique identifier.
AUTHZID_REALM - Static variable in class org.forgerock.services.context.SecurityContext
The authorization ID name reserved for a user's realm.
AUTHZID_ROLES - Static variable in class org.forgerock.services.context.SecurityContext
The authorization ID name reserved for the array of roles associated with the user.
AUTO - Enum constant in enum class org.forgerock.audit.handlers.jms.SessionModeConfig
Auto-acknowledge session mode.
autoFlush(boolean) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Whether events to should be automatically flushed on shutdown.
AutoReconnectAmLink - Class in org.forgerock.openig.tools.notifications.ws.link
Restart an AmLink automatically upon disconnection.
AutoReconnectAmLink.AmLinkSupplierFromTopics - Interface in org.forgerock.openig.tools.notifications.ws.link
A helper class to ease readability.
available() - Method in class org.forgerock.http.io.FailableInputStream
 
averagePerEventPayloadSize(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Sets the average event payload size, used to initialise string buffers.
awaitTermination(long, TimeUnit) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 

B

BAD_GATEWAY - Static variable in class org.forgerock.http.protocol.Status
The 502 (Bad Gateway) status code indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
BAD_REQUEST - Static variable in class org.forgerock.http.protocol.Status
The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
BAD_REQUEST - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the request could not be understood by the resource due to malformed syntax.
BAD_REQUEST - Static variable in class org.forgerock.openig.handler.Handlers
A default Handler implementation that returns an empty (400 Bad Request) Response.
BadRequestException - Exception in org.forgerock.json.resource
An exception that is thrown during a operation on a resource when the requested operation is malformed.
BadRequestException() - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with null as its detail message.
BadRequestException(String) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified detail message.
BadRequestException(String, Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified detail message and cause.
BadRequestException(Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified cause.
Base64 - Class in org.forgerock.util.encode
Provides RFC 4648 / RFC 2045 compatible Base64 encoding and decoding.
BASE64 - Enum constant in enum class org.forgerock.secrets.propertyresolver.PropertyFormatBase64
Traditional base64 encoding.
BASE64_PROPERTY_FORMAT - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a SecretPropertyFormat that decodes BASE64 strings.
base64Binary() - Static method in class org.forgerock.json.JsonValueFunctions
Returns a byte[] by converting the JsonValue using JsonValue.asString() and then Base64-decoding the result.
Base64EncodedSecretStore - Class in org.forgerock.openig.secrets
A Base64EncodedSecretStore stores secret values (such as password or simple shared secrets) in a base64-encoded form in memory.
Base64EncodedSecretStore.Heaplet - Class in org.forgerock.openig.secrets
Creates and initializes a Base64EncodedSecretStore in a heap environment.
Base64EncodedSecretStoreTypeProvider - Class in org.forgerock.openig.secrets
Provide the Base64EncodedSecretStore's TypeDefinition.
Base64EncodedSecretStoreTypeProvider() - Constructor for class org.forgerock.openig.secrets.Base64EncodedSecretStoreTypeProvider
 
Base64PropertyFormat - Class in org.forgerock.openig.secrets
A SecretPropertyFormat for a BASE64 format.
Base64PropertyFormat() - Constructor for class org.forgerock.openig.secrets.Base64PropertyFormat
 
Base64url - Class in org.forgerock.util.encode
Makes use of the Base64 class to encode and decode to and from URL-safe Base64.
BASE64URL - Enum constant in enum class org.forgerock.secrets.propertyresolver.PropertyFormatBase64
URL-safe base64 encoding.
base64urlBinary() - Static method in class org.forgerock.json.JsonValueFunctions
Returns a byte[] by converting the JsonValue using JsonValue.asString() and then Base64url-decoding the result.
base64urlDecode(String) - Static method in class org.forgerock.json.jose.utils.Utils
base64UrlDecode(String) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils
Decode a big-endian base64 url encoding of a magnitude big integer and transform it as a positive big integer.
base64urlEncode(String) - Static method in class org.forgerock.json.jose.utils.Utils
base64UrlEncodeUnsignedBigEndian(BigInteger) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils
Encode a big integer into a base 64 url encoded unsigned big endian.
BaseAdminHttpApplication - Class in org.forgerock.openig.http
Configuration class for the Identity Gateway Administration.
BaseAdminHttpApplication(String, JsonValue, Environment, RunMode, boolean, PropertyResolver, MeterRegistry, StartupMetrics, HttpClientProvider, WebSocketClientProvider, Clock, IgTicker, AsyncSessionManager, ProductInfo) - Constructor for class org.forgerock.openig.http.BaseAdminHttpApplication
Construct a BaseAdminHttpApplication.
BaseQueryFilterVisitor<R,P,F> - Class in org.forgerock.util.query
A base implementation of QueryFilterVisitor where all methods throw an UnsupportedOperationException by default - override just the methods you need.
BaseQueryFilterVisitor() - Constructor for class org.forgerock.util.query.BaseQueryFilterVisitor
 
BASEURI_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a BaseUriDecorator instance from the Heap.
BaseUriDecorator - Class in org.forgerock.openig.decoration.baseuri
The baseURI decorator can decorate both Filter and Handler instances.
BaseUriDecorator(String) - Constructor for class org.forgerock.openig.decoration.baseuri.BaseUriDecorator
Builds a new BaseUriDecorator.
BaseUriDecorator.Heaplet - Class in org.forgerock.openig.decoration.baseuri
Creates and initializes a baseUri in a heap environment.
BaseUriFactory<T> - Interface in org.forgerock.openig.decoration.baseuri
A factory for the BaseUriDecorator.
BaseUriUtil - Class in org.forgerock.openig.util
Utility to help with baseUri expressions.
basic(String) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader
Create a basic authentication challenge header.
BasicCredentials - Class in org.forgerock.http.header.authorization
A rich representation of basic credentials.
BasicCredentials(String, String) - Constructor for class org.forgerock.http.header.authorization.BasicCredentials
Construct a new set of Basic authorization credentials.
BatchConfiguration() - Constructor for class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.BatchConfiguration
 
BatchConsumer - Interface in org.forgerock.audit.events.handlers.buffering
Implementation is responsible for being able to build up a batch payload and to publish that payload.
BatchException - Exception in org.forgerock.audit.events.handlers.buffering
Indicates failure during a batch operation.
BatchException(String) - Constructor for exception org.forgerock.audit.events.handlers.buffering.BatchException
Constructs a new BatchException with given message.
BatchException(String, Throwable) - Constructor for exception org.forgerock.audit.events.handlers.buffering.BatchException
Constructs a new BatchException with given message and cause.
BatchPublisher - Interface in org.forgerock.audit.events.handlers.buffering
Implementations of BatchPublisher are able to consume multiple audit events and build batches out of them.
BatchPublisherFactory - Interface in org.forgerock.audit.events.handlers.buffering
Batch publisher factory provides new instances of BatchPublisher.
BatchPublisherFactoryImpl - Class in org.forgerock.audit.events.handlers.buffering
Basic batch publisher factory implementation.
BatchPublisherFactoryImpl() - Constructor for class org.forgerock.audit.events.handlers.buffering.BatchPublisherFactoryImpl
 
BeanResolver - Class in org.forgerock.openig.resolver
Resolves Java Beans objects.
BeanResolver() - Constructor for class org.forgerock.openig.resolver.BeanResolver
Builds a new BeanResolver around an EL BeanELResolver instance.
bearer(String, Map<String, String>) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader
Create a bearer authentication challenge header.
BearerToken - Class in org.forgerock.http.header.authorization
A rich representation of bearer credentials.
BearerToken(String) - Constructor for class org.forgerock.http.header.authorization.BearerToken
Construct a new set of Bearer authorization credentials.
before(String) - Method in class org.forgerock.audit.events.ConfigAuditEventBuilder
Records the previous state of the modified object as a String.
before(JsonValue) - Method in class org.forgerock.audit.events.ConfigAuditEventBuilder
Records the previous state of the modified object as JSON.
BEFORE - Static variable in class org.forgerock.audit.events.ConfigAuditEventBuilder
 
beforeRollingOver() - Method in interface org.forgerock.audit.events.handlers.writers.RotatableWriter.RolloverLifecycleHook
This method is called before the rotation and retention checks are done.
bestEffortResourceServerError(Status, OAuth2Error) - Static method in class org.forgerock.http.oauth2.OAuth2Error
Returns an OAuth 2.0 resource server error whose values are determined on a best-effort basis from the provided incomplete error and HTTP status code.
between(Version, Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies if this version is in between the given minInclusive and maxInclusive versions (inclusive).
BiFunction<T,U,R,E extends Exception> - Interface in org.forgerock.util
A BiFunction functional interface which can throw a checked Exception.
BigIntegerUtils - Class in org.forgerock.json.jose.utils
Utils to complement bit operations not covered by the BigInteger functions.
bind(String, Object) - Method in class org.forgerock.openig.el.Bindings
Binds a new value to the given name.
bind(Bindings) - Method in class org.forgerock.openig.el.Bindings
Binds all the bindings already bound from source.
bindings() - Static method in class org.forgerock.openig.el.Bindings
Returns an empty Bindings instance (mutable).
bindings() - Static method in class org.forgerock.openig.util.JsonValues
Returns a function that will create some bindings based of a Map-based JsonValue.
bindings(String, Object) - Static method in class org.forgerock.openig.el.Bindings
Returns a singleton Bindings initialized with the given name and value.
bindings(Bindings) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function that will create some bindings based of a Map-based JsonValue.
bindings(Context) - Static method in class org.forgerock.openig.el.Bindings
Returns a Bindings initialized with the given context and request.
bindings(Context, Request) - Static method in class org.forgerock.openig.el.Bindings
Returns a Bindings initialized with the given context and request.
bindings(Context, Request, Response) - Static method in class org.forgerock.openig.el.Bindings
Returns a Bindings initialized with the given context, request and response.
Bindings - Class in org.forgerock.openig.el
Bindings represents the Expression bindings used during evaluation and assignation.
Bindings() - Constructor for class org.forgerock.openig.el.Bindings
 
BlackAndWhitelistFilter - Class in org.forgerock.util
This class can be used for filtering string elements by using blacklists and/or whitelists.
BlackAndWhitelistFilter(Collection<Pattern>, Collection<Pattern>) - Constructor for class org.forgerock.util.BlackAndWhitelistFilter
Creates a new BlackAndWhitelistFilter with provided collections.
blockingProxyInfo(URI, CredentialPair<GenericSecret>) - Static method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo
Creates an instance of ProxyInfo for a proxy that requires authentication, this will block and wait for a credentialPair to return a value.
body() - Method in record class org.forgerock.openig.tools.notifications.Notification
Returns the value of the body record component.
bool(String) - Static method in class org.forgerock.openig.el.Functions
Transforms a String to an Boolean.
BOOLEAN_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper
Json boolean value type.
branch() - Method in class org.forgerock.http.io.BranchingInputStream
Creates a new branch at this stream's current position.
branch() - Method in class org.forgerock.http.io.FileBranchingStream
 
BranchingInputStream - Class in org.forgerock.http.io
An input stream that can branch into separate input streams to perform divergent reads.
BranchingInputStream(BranchingInputStream) - Constructor for class org.forgerock.http.io.BranchingInputStream
Initialise the BranchingInputStream with the specified parent.
Buffer - Interface in org.forgerock.http.io
A dynamically growing data buffer.
BufferedBatchPublisher - Class in org.forgerock.audit.events.handlers.buffering
Buffers audit events to a bounded queue, periodically flushing the queue to a provided BatchConsumer.
BufferedBatchPublisher.Builder - Interface in org.forgerock.audit.events.handlers.buffering
Builder used to construct a new BufferedBatchPublisher.
buffering - Variable in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
Event buffering is disabled by default.
buffering - Variable in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration
Event buffering is disabled by default.
BufferingConfiguration() - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration
 
build() - Method in class org.forgerock.audit.AuditServiceBuilder
Creates a new AuditService instance.
build() - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder
Create a new instance of EventTopicsMetaData.
build() - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Constructs a new BatchPublisher.
build() - Method in class org.forgerock.audit.filter.FilterBuilder
Builds the Filter.
build() - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Returns a new CorsPolicy immutable instance.
build() - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Builds the CSRF filter with the configured settings.
build() - Method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder
Builds the EncryptedPrivateKeyAuthFilter instance.
build() - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder
Builds the PrivateKey Jwt ClientAuthentication Filter.
build() - Method in class org.forgerock.http.routing.UriRouterContext.Builder
Returns a new UriRouterContext build from provided values.
build() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder
Builds the JWE into a String by calling the build method on the JWE object.
build() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder
Builds the JWS into a String by calling the build method on the JWS object.
build() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtHeaderBuilder
Creates a JwsHeader instance from the header parameters set in this builder.
build() - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Creates a JweHeader instance from the header parameters set in this builder.
build() - Method in class org.forgerock.json.jose.builders.JwsHeaderBuilder
Creates a JwsHeader instance from the header parameters set in this builder.
build() - Method in interface org.forgerock.json.jose.builders.JwtBuilder
Builds the JWT into a String by calling the build method on the JWT object.
build() - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Creates a JwtClaimsSet instance from the claims set in this builder.
build() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder
Creates a JwtHeader instance from the header parameters set in this builder.
build() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
Builds the JWS into a String by calling the build method on the JWS object.
build() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
 
build() - Method in class org.forgerock.json.jose.jwk.EcJWK.Builder
Build the EC JWK.
build() - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Builds the JWK.
build() - Method in class org.forgerock.json.jose.jwk.OctJWK.Builder
Build the Octet JWK.
build() - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
 
build() - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Build the RSA JWK.
build() - Method in class org.forgerock.json.jose.jws.SignedJwt
Builds the JWT into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
build() - Method in interface org.forgerock.json.jose.jwt.Jwt
Builds the JWT into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
build() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Builds the JWT's Claims Set into a String representation of a JSON object.
build() - Method in class org.forgerock.json.jose.jwt.JwtHeader
Builds the JWT's header into a String representation of a JSON object.
build() - Method in interface org.forgerock.json.jose.jwt.Payload
Builds the JWTs Payload into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
build() - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder
Builds the SecretsJwtTokenHandler based on the configuration specified.
build() - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Builder
Returns a new CaffeineCacheAccessTokenResolver instance.
build() - Method in class org.forgerock.openig.filter.RetryFilter.Builder
Build the RetryFilter.
build() - Method in class org.forgerock.openig.tools.am.AmService.Builder
Returns a new AmService instance.
build() - Method in class org.forgerock.openig.tools.am.NotificationsConfig.Builder
build() - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder
Builds the JwtValidator.
build() - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder
Builds the access token secret store.
build() - Method in class org.forgerock.secrets.propertyresolver.FileSystemSecretStore.FileSystemSecretStoreBuilder
Builds the secret store.
build() - Method in class org.forgerock.services.context.ClientContext.Builder
Creates a ClientContext instance from the specified properties.
build(Class<T>) - Method in class org.forgerock.secrets.SecretBuilder
Deprecated.
build(AmVersion) - Method in class org.forgerock.openig.tools.session.CrestSessionService.Builder
Returns a SessionService implementation based on the AmVersion.
build(Purpose<T>) - Method in class org.forgerock.secrets.SecretBuilder
Builds a secret of the given type, enforcing any constraints attached to the purpose.
buildApi(ApiProducer<D>) - Method in class org.forgerock.services.routing.AbstractRouter
Build an api with a given ApiProducer.
buildBaseUri() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Builds an Elasticsearch API base URI.
buildBasicAuthHeaderValue() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Builds a basic authentication header-value, if username and password are provided in configuration.
buildBulkUri() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Builds an Elasticsearch API URI for Bulk API.
builder() - Static method in class org.forgerock.http.filter.cors.CorsPolicy
Returns a new CorsPolicy builder.
builder() - Static method in class org.forgerock.json.jose.jwk.OkpJWK
Creates a new builder object for an OKP key.
builder() - Static method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler
Creates a new SecretsJwtTokenHandler.Builder object to configure a SecretsJwtTokenHandler instance.
builder() - Static method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore
Creates a builder for the access token secret store.
builder(Caffeine<Object, Object>, AccessTokenResolver, Clock, Duration, Duration) - Static method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver
builder(String) - Static method in class org.forgerock.json.jose.jwk.OctJWK
Get the Octet JWK builder.
builder(String, String) - Static method in class org.forgerock.json.jose.jwk.RsaJWK
Get the builder.
builder(String, String, String) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Get the builder.
builder(ECPublicKey) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Get the builder.
builder(RSAPublicKey) - Static method in class org.forgerock.json.jose.jwk.RsaJWK
Get the builder.
builder(Clock) - Static method in class org.forgerock.openig.tools.jwt.validation.JwtValidator
Builder for the JwtValidator with a clock to use for temporal constraints.
builder(ScheduledExecutorService, MeterRegistry) - Static method in class org.forgerock.openig.filter.RetryFilter
Create a RetryFilter builder.
builder(SupportedEllipticCurve, String, String) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Get the builder.
builder(RequestHandler, RequestHandler, Clock) - Static method in class org.forgerock.openig.tools.session.CrestSessionService
Returns a new CrestSessionService.Builder for creating a new CrestSessionService instance.
Builder() - Constructor for class org.forgerock.http.filter.cors.CorsPolicy.Builder
 
Builder() - Constructor for class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder
 
Builder() - Constructor for class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder
 
Builder() - Constructor for class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder
 
Builder(Caffeine<Object, Object>, AccessTokenResolver, Clock, Duration, Duration) - Constructor for class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Builder
Creates a CaffeineCacheAccessTokenResolver.Builder delegating to the given AccessTokenResolver using the given (pre-configured) cache.
Builder(ScheduledExecutorService, MeterRegistry) - Constructor for class org.forgerock.openig.filter.RetryFilter.Builder
Create a new RetryFilter builder.
Builder(Handler, Clock, String, String, AmVersion, UriService, AsyncRefreshableSupplier<SsoToken, AuthenticationException>) - Constructor for class org.forgerock.openig.tools.am.AmService.Builder
Create a Builder instance with every mandatory parameters.
Builder(KeyType) - Constructor for class org.forgerock.json.jose.jwk.JWK.Builder
The builder constructor.
Builder(WebSocketClientProvider) - Constructor for class org.forgerock.openig.tools.am.NotificationsConfig.Builder
Create a NotificationsConfig builder.
buildEventUri(String, String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Builds an Elasticsearch API URI for operating on a single event (e.g., index, get, etc.).
buildExternalClientContext(Context) - Static method in class org.forgerock.services.context.ClientContext
Creates a ClientContext.Builder for creating an external ClientContext instance.
buildRetentionPolicies() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention
Builds RetentionPolicy instances from configuration options.
buildRotationPolicies() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Builds RotationPolicy instances from configuration options.
buildSearchUri(String, int, int) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Builds an Elasticsearch API URI for Search API.
buildSecretReferences() - Method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
buildSecretReferences() - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder
Deprecated, for removal: This API element is subject to removal in a future version.
for removal with PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningPurpose(Purpose). Will be removed in winter 2021 season.
buildTimeStampFileNamingPolicy(File) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Builds a TimeStampFileNamingPolicy instance from configuration options.
buildWithExpirer(Purpose<T>) - Method in class org.forgerock.secrets.SecretBuilder
Builds a secret of the given type, enforcing any constraints attached to the purpose.

C

cache() - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Builder
Bind the various cache invalidation callbacks and return a cache based on the properties set on the builder.
CacheAccessTokenResolverTypeProvider - Class in org.forgerock.openig.filter.oauth2
Provide a TypeDefinitionProvider for CacheAccessTokenResolver.
CacheAccessTokenResolverTypeProvider() - Constructor for class org.forgerock.openig.filter.oauth2.CacheAccessTokenResolverTypeProvider
 
CachePolicyDecisionFilter - Class in org.forgerock.openig.tools
A CREST Filter that caches policy decisions.
CachePolicyDecisionFilter(Caffeine<Object, Object>, Clock, Duration, Duration, NotificationService, DisconnectionStrategy) - Constructor for class org.forgerock.openig.tools.CachePolicyDecisionFilter
Builds a CachePolicyDecisionFilter.
CacheSessionService - Class in org.forgerock.openig.tools.session
Create a CacheSessionService which is responsible to manage the cache for the SessionInfo.
CacheSessionService(SessionService, NotificationService, String, Caffeine<Object, Object>, Supplier<String>, Clock, Duration, DisconnectionStrategy, boolean) - Constructor for class org.forgerock.openig.tools.session.CacheSessionService
Creates a new CacheSessionService.
CacheUserProfileService - Class in org.forgerock.openig.tools.userprofile
Create a CacheUserProfileService which is responsible for managing the UserProfile cache.
CacheUserProfileService(UserProfileService, Caffeine<Object, Object>, Duration) - Constructor for class org.forgerock.openig.tools.userprofile.CacheUserProfileService
Creates a new CacheUserProfileService.
CachingAccessTokenResolver - Class in org.forgerock.http.oauth2.resolver
A CachingAccessTokenResolver is a delegating AccessTokenResolver that uses a write-through cache to enable fast AccessTokenInfo resolution.
CachingAccessTokenResolver(Clock, AccessTokenResolver, PerItemEvictionStrategyCache<String, Promise<AccessTokenInfo, AccessTokenException>>) - Constructor for class org.forgerock.http.oauth2.resolver.CachingAccessTokenResolver
Builds a CachingAccessTokenResolver delegating to the given AccessTokenResolver using the given (pre-configured) cache.
CaffeineCacheAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2
A CaffeineCacheAccessTokenResolver is a delegating AccessTokenResolver that uses a write-through Caffeine cache to enable fast AccessTokenInfo resolution.
CaffeineCacheAccessTokenResolver.Builder - Class in org.forgerock.openig.filter.oauth2
CaffeineCacheAccessTokenResolver.Heaplet - Class in org.forgerock.openig.filter.oauth2
Creates and initializes an CaffeineCacheAccessTokenResolver in the heap environment.
CaffeineUtils - Class in org.forgerock.openig.tools
Utility class for Caffeine-related workarounds.
canBeDecrypted(SecretsProvider, Purpose<DataDecryptionKey>) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints
Provides a JwtConstraint configured with the supplied SecretsProvider that contain a secret capable of decrypting and verifying a JWT's encryption.
cancel() - Method in class org.forgerock.util.DirectoryWatcher.ChangeListener
Cancels this change listener.
cancel(boolean) - Method in interface org.forgerock.util.promise.Promise
Attempts to cancel the asynchronous task associated with this Promise.
cancel(boolean) - Method in class org.forgerock.util.promise.PromiseImpl
 
candidatesForPurpose(Stream<SecretResource>, String) - Method in class org.forgerock.secrets.propertyresolver.OrderedStableIdResolver
 
candidatesForPurpose(Stream<SecretResource>, String) - Method in class org.forgerock.secrets.propertyresolver.SingletonStableIdResolver
 
candidatesForPurpose(Stream<SecretResource>, String) - Method in interface org.forgerock.secrets.propertyresolver.StableIdResolver
Creates candidate stream in order from latest to oldest, latest being the active secret for the purpose label.
canParse(String) - Method in interface org.forgerock.http.header.authorization.CredentialsParser
Whether this parser parses the given authorization type.
capacity(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Sets the maximum queue capacity.
CAPTURE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a CaptureDecorator instance from the Heap.
CaptureDecorator - Class in org.forgerock.openig.decoration.capture
The capture decorator can decorates both Filter and Handler instances.
CaptureDecorator(String, boolean, boolean) - Constructor for class org.forgerock.openig.decoration.capture.CaptureDecorator
Builds a new capture decorator.
CaptureDecorator(String, boolean, boolean, int, KeyValueProcessor, KeyValueProcessor, KeyValueProcessor) - Constructor for class org.forgerock.openig.decoration.capture.CaptureDecorator
Builds a new capture decorator.
CaptureDecorator.Heaplet - Class in org.forgerock.openig.decoration.capture
Creates and initializes a CaptureDecorator in a heap environment.
CapturedUserPasswordContext - Class in org.forgerock.openig.openam
A CapturedUserPasswordContext to store the user's decrypted password.
CapturedUserPasswordFilter - Class in org.forgerock.openig.openam
The CapturedUserPasswordFilter is responsible for retrieving the user password from AM and to decrypt it.
CapturedUserPasswordFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initializes the filter in a heap environment.
CaptureFactory<T> - Interface in org.forgerock.openig.decoration.capture
A factory for the CaptureDecorator.
CapturePoint - Enum Class in org.forgerock.openig.decoration.capture
Specify where the message capture takes place.
CaseInsensitiveMap<V> - Class in org.forgerock.http.util
An implementation of a map whose keys are case-insensitive strings.
CaseInsensitiveMap() - Constructor for class org.forgerock.http.util.CaseInsensitiveMap
Constructs a new empty case-insensitive map.
CaseInsensitiveMap(Map<String, V>) - Constructor for class org.forgerock.http.util.CaseInsensitiveMap
Wraps an existing map with a new case insensitive map.
CaseInsensitiveSet - Class in org.forgerock.http.util
An implementation of a set whose values are case-insensitive strings.
CaseInsensitiveSet() - Constructor for class org.forgerock.http.util.CaseInsensitiveSet
Constructs a new empty case-insensitive set.
CaseInsensitiveSet(int) - Constructor for class org.forgerock.http.util.CaseInsensitiveSet
Constructs a new, empty case-insensitive set; the backing HashSet instance has the specified initial capacity and default load factor.
CaseInsensitiveSet(int, float) - Constructor for class org.forgerock.http.util.CaseInsensitiveSet
Constructs a new, empty case-insensitive set; the backing HashSet instance has the specified initial capacity and the specified load factor.
CaseInsensitiveSet(Collection<String>) - Constructor for class org.forgerock.http.util.CaseInsensitiveSet
Constructs a new case-insensitive set containing the elements in the specified collection.
CC20_P1305 - Enum constant in enum class org.forgerock.json.jose.jwe.EncryptionMethod
The ChaCha20-Poly1305 algorithm as described in RFC 7539.
CdSsoConditionAdviceFilter - Class in org.forgerock.openig.openam
This filter handles any condition advices returned from AM during a policy evaluation, which one will depend on the policy.
CdSsoContext - Class in org.forgerock.openig.openam
Context implementation to maintain cross-domain SSO properties.
CdSsoContext(Context, String, JwtClaimsSet, String, CookieBuilder) - Constructor for class org.forgerock.openig.openam.CdSsoContext
Create CdSsoContext for supplied JWT.
CdSsoFailureContext - Class in org.forgerock.openig.openam
Context implementation to hold error details, should an error occur during cross-domain SSO authentication.
certificate(Certificate) - Method in class org.forgerock.secrets.SecretBuilder
Sets the certificate associated with this secret.
CERTIFICATE_THUMBPRINT_ATTRIBUTE - Static variable in class org.forgerock.openig.filter.oauth2.cnf.CertificateThumbprintFilter
The certificate attribute name.
certificateChain(Certificate...) - Method in class org.forgerock.secrets.SecretBuilder
Sets the certificate chain associated with this secret.
certificateChain(List<? extends Certificate>) - Method in class org.forgerock.secrets.SecretBuilder
Sets the certificate chain associated with this secret.
certificates(Certificate...) - Method in class org.forgerock.services.context.ClientContext.Builder
Sets the client's certificates.
certificates(List<Certificate>) - Method in class org.forgerock.services.context.ClientContext.Builder
Sets the client's certificates.
CertificateThumbprintFilter - Class in org.forgerock.openig.filter.oauth2.cnf
A filter that evaluates a required EL expression to establish the client certificate from both context and request, then calculates the thumbprint for that certificate (sha-256 hash and base64 url encoding) before storing it in the attributes context for later retrieval in downstream components.
CertificateThumbprintFilter(Expression<Certificate>, Handler) - Constructor for class org.forgerock.openig.filter.oauth2.cnf.CertificateThumbprintFilter
Build a CertificateThumbprintFilter that will compute a certificate thumbprint based on the given certExpr.
CertificateThumbprintFilter.Heaplet - Class in org.forgerock.openig.filter.oauth2.cnf
Creates and initializes a certificate thumbprint filter in a heap environment.
CertificateVerificationKey - Class in org.forgerock.secrets.keys
A key used for verifying certificate signatures.
CertificateVerificationKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.CertificateVerificationKey
Initialises the key with the given secret data.
chain(KeyValueProcessor...) - Static method in interface org.forgerock.openig.decoration.capture.KeyValueProcessor
Process a chain of KeyValueProcessor processors in the order they are added.
ChainFilterHeaplet - Class in org.forgerock.openig.filter
Allow to build a chain of filters as one filter.
ChainFilterHeaplet() - Constructor for class org.forgerock.openig.filter.ChainFilterHeaplet
 
ChainHandlerHeaplet - Class in org.forgerock.openig.filter
A chain of zero or more filters and one handler.
ChainHandlerHeaplet() - Constructor for class org.forgerock.openig.filter.ChainHandlerHeaplet
 
ChainHandlerTypeProvider - Class in org.forgerock.openig.filter
Provide the HTTP Filter's Chain TypeDefinition.
ChainHandlerTypeProvider() - Constructor for class org.forgerock.openig.filter.ChainHandlerTypeProvider
 
chainOf(List<Filter>) - Static method in class org.forgerock.http.filter.Filters
Creates a Filter which encapsulates the provided filters into a single Filter.
chainOf(Filter...) - Static method in class org.forgerock.http.filter.Filters
Creates a Filter which encapsulates the provided filters into a single Filter.
chainOf(Handler, List<Filter>) - Static method in class org.forgerock.http.handler.Handlers
Creates a Handler which wraps the provided filters around the provided target handler.
chainOf(Handler, Filter...) - Static method in class org.forgerock.http.handler.Handlers
Creates a Handler which wraps the provided filters around the provided target handler.
Challenge(String, String, Map<String, String>) - Constructor for class org.forgerock.http.header.WwwAuthenticateHeader.Challenge
Create a new authentication option.
CHANGED_FIELDS - Static variable in class org.forgerock.audit.events.ConfigAuditEventBuilder
 
changedFields(String...) - Method in class org.forgerock.audit.events.ConfigAuditEventBuilder
Sets the list of fields that were changed by this update.
changeSessionId() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
 
character() - Method in record class org.forgerock.openig.text.Separator
Returns the value of the character record component.
CharBufferToLineFlowableTransformer - Class in org.forgerock.openig.reactive
Transforms a Flowable of CharBuffer into a Flowable of String, by splitting on EOL chars ('\r' and '\n').
CharBufferToLineFlowableTransformer() - Constructor for class org.forgerock.openig.reactive.CharBufferToLineFlowableTransformer
 
charset() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a character set used for byte encoding/decoding.
CHARSET - Static variable in class org.forgerock.json.jose.utils.Utils
UTF-8 Charset.
CharsetDecoderFlowableTransformer - Class in org.forgerock.http.io
A CharsetDecoderFlowableTransformer decodes bytes from a stream of ByteBuffer into a stream of CharBuffer using the given Charset.
checkClientTrusted(X509Certificate[], String) - Method in class org.forgerock.openig.security.TrustAllManager
 
checkClientTrusted(X509Certificate[], String) - Method in class org.forgerock.secrets.SecretsTrustManager
 
checkClientTrusted(X509Certificate[], String, Socket) - Method in class org.forgerock.secrets.SecretsTrustManager
 
checkClientTrusted(X509Certificate[], String, SSLEngine) - Method in class org.forgerock.secrets.SecretsTrustManager
 
checkJsonCompatibility(String, Object) - Static method in class org.forgerock.http.util.Json
Verify that the given parameter object is of a JSON compatible type (recursively).
checkListValuesAreOfType(List<?>, Class<?>) - Method in class org.forgerock.json.jose.jwt.JWObject
Checks that the given List's type is of an assignable type from the required class.
checkNotBlank(String) - Static method in class org.forgerock.util.Reject
Throws a NullPointerException if the str parameter is null, throws IllegalArgumentException if empty or only contains whitespace, and returns the string otherwise.
checkNotBlank(String, String) - Static method in class org.forgerock.util.Reject
Throws a NullPointerException if the str parameter is null, throws IllegalArgumentException if empty or only contains whitespace, and returns the string otherwise.
checkNotNull(T) - Static method in class org.forgerock.util.Reject
Deprecated.
checkNotNull(T, String) - Static method in class org.forgerock.util.Reject
checkRsaKeySize(Key, String) - Static method in class org.forgerock.json.jose.utils.Utils
Verifies that the RSA key being used meets minimum key size requirement of 2048 bits as specified in the JOSE specifications.
checkRsaKeySize(CryptoKey) - Static method in class org.forgerock.json.jose.utils.Utils
Verifies that the RSA key being used meets minimum key size requirement of 2048 bits as specified in the JOSE specifications.
checkServerTrusted(X509Certificate[], String) - Method in class org.forgerock.openig.security.TrustAllManager
 
checkServerTrusted(X509Certificate[], String) - Method in class org.forgerock.secrets.SecretsTrustManager
 
checkServerTrusted(X509Certificate[], String, Socket) - Method in class org.forgerock.secrets.SecretsTrustManager
 
checkServerTrusted(X509Certificate[], String, SSLEngine) - Method in class org.forgerock.secrets.SecretsTrustManager
 
checkValueIsOfType(Object, Class<?>) - Method in class org.forgerock.json.jose.jwt.JWObject
Checks that the given value is of an assignable type from the required class.
ChfHttpServletRequestAdapter - Class in org.forgerock.openig.handler.saml
Just enough of a HttpServletRequest wrapper around a CHF Request to keep the AM SAML2 components happy.
ChfHttpServletResponseAdapter - Class in org.forgerock.openig.handler.saml
Just enough of a HttpServletResponse wrapper around a CHF Response to keep the AM SAML2 components happy.
child(int) - Method in class org.forgerock.json.JsonPointer
Returns a new JSON pointer, which identifies a specified child element of the array identified by this pointer.
child(Object) - Method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path which is a child of this resource path.
child(String) - Method in class org.forgerock.json.JsonPointer
Returns a new JSON pointer, which identifies a specified child member of the object identified by this pointer.
child(String) - Method in class org.forgerock.openig.heap.Name
Creates a new Name, relative to this Name with the given leaf name.
chooseClientAlias(String[], Principal[], Socket) - Method in class org.forgerock.secrets.SecretsKeyManager
 
chooseEngineClientAlias(String[], Principal[], SSLEngine) - Method in class org.forgerock.secrets.SecretsKeyManager
 
chooseEngineServerAlias(String, Principal[], SSLEngine) - Method in class org.forgerock.secrets.SecretsKeyManager
 
chooseServerAlias(String, Principal[], Socket) - Method in class org.forgerock.secrets.SecretsKeyManager
 
CIPHER_AES_CBC_PKCS5 - Static variable in class org.forgerock.util.crypto.CryptoConstants
A cipher value for the AES/CBC/PKCS5Padding algorithm.
circuitBreakerFilter(JsonValue) - Method in class org.forgerock.openig.handler.HttpClientHandlerHeaplet
Create a circuit breaker filter from configurations.
CircuitBreakerFilter - Class in org.forgerock.openig.filter.circuitbreaker
Filter implementing the Circuit Breaker pattern to avoid cascading failures.
CircuitBreakerFilter.Heaplet - Class in org.forgerock.openig.filter.circuitbreaker
The Heaplet used to create a CircuitBreakerFilter heap object.
CircuitBreakerFilterTypeProvider - Class in org.forgerock.openig.filter.circuitbreaker
The TypeDefinitionProvider of the CircuitBreakerFilter.
CircuitBreakerFilterTypeProvider() - Constructor for class org.forgerock.openig.filter.circuitbreaker.CircuitBreakerFilterTypeProvider
 
claim(String, Object) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Adds a custom claim to the JWT Claims Set.
claim(String, JwtClaimConstraint<JsonValue>) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder
Adds a JwtClaimConstraint on a claim.
claim(String, Function<JsonValue, ? extends T, E>, JwtClaimConstraint<T>) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder
Adds a JwtClaimConstraint on a claim.
claims() - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory
Creates a builder for building a JWT Claims Set to be used in the building of JWTs.
claims() - Method in record class org.forgerock.openig.assertion.IdentityAssertionClaims
Returns the value of the claims record component.
claims() - Method in class org.forgerock.openig.filter.JwtBuilderContext
Returns the JWT claims as unmodifiable Map.
claims(String, JwtClaimConstraint<String>) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder
Adds a JwtClaimConstraint on a claim.
claims(Map<String, Object>) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets all of the claims the JWT Claims Set with the values contained in the specified map.
claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.AbstractJwtBuilder
Sets the JwtClaimsSet for this JwtBuilder.
claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder
Sets the JwtClaimsSet for this JwtBuilder.
claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
Sets the JwtClaimsSet for this JwtBuilder.
claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder
 
claimsAsJsonValue() - Method in class org.forgerock.openig.filter.JwtBuilderContext
Returns the JWT claims as unmodifiable JsonValue.
claimSet(String, Function<Optional<JwtClaimsSet>, Optional<T>>, JwtClaimConstraint<T>) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder
claimSet(String, Function<Optional<JwtClaimsSet>, Optional<T>>, JwtClaimConstraint<T>, boolean) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder
Adds a JwtClaimConstraint on the claimSet.
ClassAliasResolver - Interface in org.forgerock.openig.alias
This interface has to be implemented by each Identity Gateway module that wants to register new class aliases.
clear() - Method in class org.forgerock.http.protocol.Headers
 
clear() - Method in class org.forgerock.http.util.CaseInsensitiveMap
 
clear() - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
clear() - Method in class org.forgerock.http.util.SetDecorator
Removes all of the elements from the set (optional operation).
clear() - Method in class org.forgerock.json.JsonValue
Removes all child values from this JSON value, if it has any.
clear() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
 
clear() - Method in class org.forgerock.openig.session.jwt.dirty.DirtySet
 
clear() - Method in class org.forgerock.util.LazyList
Removes all of the elements from this list.
clear() - Method in class org.forgerock.util.LazyMap
Removes all of the mappings from the map.
clear() - Method in class org.forgerock.util.ListDecorator
Removes all of the elements from this list.
clear() - Method in class org.forgerock.util.MapDecorator
Removes all of the mappings from the map.
clear() - Method in class org.forgerock.util.NonExpiringCache
Clears the cache.
clear() - Method in class org.forgerock.util.PerItemEvictionStrategyCache
Clean-up the cache entries.
CLEAR_ON_DISCONNECT - Enum constant in enum class org.forgerock.openig.tools.notifications.DisconnectionStrategy
Clear the cache when the notification service is disconnected.
CLEAR_ON_RECONNECT - Enum constant in enum class org.forgerock.openig.tools.notifications.DisconnectionStrategy
Clear the cache when the notification service gets reconnected.
clearSession() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext
Clear the existing managed session.
client(String) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided client ip for the event.
client(String, int) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided client ip and port for the event.
Client - Class in org.forgerock.http
An HTTP client which forwards requests to a wrapped Handler.
Client(Handler) - Constructor for class org.forgerock.http.Client
Creates a new Client which will route HTTP requests to the provided Handler using a RootContext allocated during construction when none is provided.
Client(Handler, Context) - Constructor for class org.forgerock.http.Client
Creates a new Client which will route HTTP requests to the provided Handler using the specified Context if none is provided.
CLIENT - Enum constant in enum class org.forgerock.audit.handlers.jms.SessionModeConfig
Client-acknowledge session mode.
CLIENT - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The client event payload field name.
CLIENT_ERROR - Enum constant in enum class org.forgerock.http.protocol.Status.Family
The 4xx (Client Error) class of status code indicates that the client seems to have erred.
CLIENT_HANDLER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the default ClientHandler instance from the Heap.
CLIENT_HANDLER_PROVIDER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the ClientHandler's loader instance from the Heap.
ClientAuthenticationException - Exception in org.forgerock.openig.filter.oauth2.client
Represents a ClientAuthenticationException when the client fails to authenticate.
ClientAuthenticationException(String, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.ClientAuthenticationException
Constructs a new exception with the given message and root cause.
ClientContext - Class in org.forgerock.services.context
Client context gives easy access to client-related information that are available into the request.
ClientContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.ClientContext
Restore from JSON representation.
ClientContext.Builder - Class in org.forgerock.services.context
Builder for creating ClientContext instances.
ClientContextCertificateThumbprintVerifier - Class in org.forgerock.openig.filter.oauth2.cnf
Verifies a certificate thumbprint by computing a digest of the client certificate (found in ClientContext) and comparing the result with the base64-url-encoded value provided within the confirmation key node.
ClientContextCertificateThumbprintVerifier(String) - Constructor for class org.forgerock.openig.filter.oauth2.cnf.ClientContextCertificateThumbprintVerifier
Constructs a new verifier with the given MessageDigest algorithm name.
ClientCredentialsGrantTypeHandler - Class in org.forgerock.secrets.oauth2
A grant type handler that can retrieve an access token using the client_credentials grant type.
ClientCredentialsGrantTypeHandler() - Constructor for class org.forgerock.secrets.oauth2.ClientCredentialsGrantTypeHandler
Initialises the grant type handler with only the default scope.
ClientCredentialsGrantTypeHandler(String) - Constructor for class org.forgerock.secrets.oauth2.ClientCredentialsGrantTypeHandler
Initialises the grant type handler with the given client id and default scope.
ClientCredentialsGrantTypeHandler(String, Collection<String>) - Constructor for class org.forgerock.secrets.oauth2.ClientCredentialsGrantTypeHandler
Initialises the grant type handler with the given client id and scope.
ClientCredentialsGrantTypeHandler(Collection<String>) - Constructor for class org.forgerock.secrets.oauth2.ClientCredentialsGrantTypeHandler
Initialises the grant type handler with only the scope.
ClientCredentialsOAuth2ClientFilterHeaplet - Class in org.forgerock.openig.filter.oauth2.client
Creates and initializes a Filter supporting the transformation of client credentials to an access_token.
ClientCredentialsOAuth2ClientFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterHeaplet
 
ClientCredentialsOAuth2ClientFilterTypeProvider - Class in org.forgerock.openig.filter.oauth2.client
The TypeDefinitionProvider of the ClientCredentialsOAuth2ClientFilterHeaplet.
ClientCredentialsOAuth2ClientFilterTypeProvider() - Constructor for class org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterTypeProvider
 
clientFromContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets client ip, port and host from ClientContext, if the provided Context contains a ClientContext.
ClientHandlerHeaplet - Class in org.forgerock.openig.handler
Creates and initializes a ClientHandler in a heap environment.
ClientHandlerHeaplet() - Constructor for class org.forgerock.openig.handler.ClientHandlerHeaplet
 
ClientHandlerTypeProvider - Class in org.forgerock.openig.handler
Provide ClientHandler's TypeDefinition.
ClientHandlerTypeProvider() - Constructor for class org.forgerock.openig.handler.ClientHandlerTypeProvider
 
clientId() - Method in class org.forgerock.openig.filter.oauth2.client.ResourceOwnerOAuth2ClientFilterHeaplet
 
ClientRegistration - Class in org.forgerock.openig.filter.oauth2.client
A configuration for an OpenID Connect Provider.
ClientRegistration.Heaplet - Class in org.forgerock.openig.filter.oauth2.client
Creates and initializes a Client Registration object in a heap environment.
ClientRegistrationFilter - Class in org.forgerock.openig.filter.oauth2.client
The client registration filter is the way to dynamically register an OpenID Connect Relying Party with the End-User's OpenID Provider.
ClientRegistrationFilter(ClientRegistrationRepository, ClientRegistrationStrategy) - Constructor for class org.forgerock.openig.filter.oauth2.client.ClientRegistrationFilter
Creates a new dynamic registration filter.
ClientRegistrationStrategy - Interface in org.forgerock.openig.filter.oauth2.client
Strategy supporting different client registration mechanisms.
ClientSecretBasicAuthenticationFilter - Class in org.forgerock.http.oauth2
Deprecated.
ClientSecretBasicAuthenticationFilter(String, SecretReference<GenericSecret>) - Constructor for class org.forgerock.http.oauth2.ClientSecretBasicAuthenticationFilter
Deprecated.
Creates and instance of ClientSecretBasicAuthenticationFilter.
ClientSecretBasicAuthenticationFilterHeaplet - Class in org.forgerock.openig.filter.oauth2.client.authentication
Heaplet supporting creation of a client-secret-basic authentication Filter.
ClientSecretBasicAuthenticationFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.authentication.ClientSecretBasicAuthenticationFilterHeaplet
 
ClientSecretPostAuthenticationFilter - Class in org.forgerock.http.oauth2
A Filter implementation to add the credentials to request body for authenticating as per the OAuth 2.0 Authorization Framework specification.
ClientSecretPostAuthenticationFilter(String, SecretReference<GenericSecret>) - Constructor for class org.forgerock.http.oauth2.ClientSecretPostAuthenticationFilter
Deprecated, for removal: This API element is subject to removal in a future version.
ClientSecretPostAuthenticationFilter(CredentialPair<GenericSecret>) - Constructor for class org.forgerock.http.oauth2.ClientSecretPostAuthenticationFilter
Creates a filter that will add the client credentials to the request body.
ClientSecretPostAuthenticationFilterHeaplet - Class in org.forgerock.openig.filter.oauth2.client.authentication
Heaplet supporting creation of a client-secret-post authentication Filter.
ClientSecretPostAuthenticationFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.authentication.ClientSecretPostAuthenticationFilterHeaplet
 
ClientTlsOptions - Class in org.forgerock.openig.tools
Extension to TlsOptions to support changing the behaviour of how hostname verification is enforced.
ClientTlsOptions(String, KeyManager[], TrustManager[], List<String>, List<String>, boolean, HttpClientHandler.HostnameVerifier) - Constructor for class org.forgerock.openig.tools.ClientTlsOptions
Constructs TLS options with provided values.
ClientTlsOptionsHeaplet - Class in org.forgerock.openig.security
Creates and initializes client-side TLS options in a heap environment.
ClientTlsOptionsHeaplet() - Constructor for class org.forgerock.openig.security.ClientTlsOptionsHeaplet
 
ClientTlsOptionsTypeProvider - Class in org.forgerock.openig.security
Provide ClientTlsOptionsHeaplet's TypeDefinition.
ClientTlsOptionsTypeProvider() - Constructor for class org.forgerock.openig.security.ClientTlsOptionsTypeProvider
 
clock(Clock) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder
Specifies the clock to use for checking if tokens have expired.
clock(Clock) - Method in class org.forgerock.secrets.SecretBuilder
Set the source of time for the default (relative) secret expiry time.
CLOCK - Static variable in interface org.forgerock.secrets.SecretStore
Specifies the clock to use when making time comparisons.
CLOCK_BINDING_KEY - Static variable in class org.forgerock.openig.el.Expression
The key of the Clock when it is added to bindings.
CLOCK_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a Clock instance from the Heap.
CLOCKD - Enum constant in enum class org.forgerock.audit.handlers.syslog.Facility
Clock daemon.
clone() - Method in class org.forgerock.json.JsonValue
Returns a shallow copy of this JSON value.
clone(Swagger) - Static method in class org.forgerock.http.swagger.SwaggerUtils
Clone a Swagger instance.
close() - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream
Close the output stream which closes the target output stream.
close() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
 
close() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
 
close() - Method in interface org.forgerock.audit.rotation.RotatableObject
Closes the rotatable file.
close() - Method in class org.forgerock.http.handler.HttpClientHandler
Completes all pending requests and release resources associated with underlying implementation.
close() - Method in class org.forgerock.http.io.BranchingInputStream
Closes this branching stream and all of the branches created from it.
close() - Method in interface org.forgerock.http.io.Buffer
Closes the buffer and releases any system resources associated with it.
close() - Method in class org.forgerock.http.io.FileBranchingStream
 
close() - Method in class org.forgerock.http.protocol.Entity
Closes all resources associated with this entity.
close() - Method in interface org.forgerock.http.protocol.Message
Closes all resources associated with the entity.
close() - Method in class org.forgerock.http.protocol.MessageImpl
 
close() - Method in interface org.forgerock.http.spi.HttpClient
Completes all pending requests and release resources associated with underlying implementation.
close() - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Releases any resources associated with this connection.
close() - Method in interface org.forgerock.json.resource.Connection
Releases any resources associated with this connection.
close() - Method in interface org.forgerock.json.resource.ConnectionFactory
Releases any resources associated with this connection factory.
close() - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver
 
close() - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject
 
close() - Method in class org.forgerock.openig.session.cookie.LocalSessionStore
 
close() - Method in class org.forgerock.openig.text.SeparatedValuesReader
Closes the reader and releases any system resources associated with it.
close() - Method in class org.forgerock.openig.tools.CachePolicyDecisionFilter
 
close() - Method in interface org.forgerock.openig.tools.notifications.ws.HttpWebSocketClient
Close this WebSocket client.
close() - Method in interface org.forgerock.openig.tools.notifications.ws.link.AmLink
Close the AmLink and its associated resources.
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.AutoReconnectAmLink
 
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.DirectAmLink
 
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.GracefulShutdownAmLink
 
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.InitializedAmLink
 
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.PeriodicallyRenewedAmLink
 
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.RetryableAmLink
 
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.StableAmLink
 
close() - Method in class org.forgerock.openig.tools.notifications.ws.link.TopicMultiplexerAmLink
 
close() - Method in interface org.forgerock.openig.tools.notifications.ws.WebSocketAdapter
Close the WebSocketAdapter.
close() - Method in class org.forgerock.secrets.propertyresolver.FileSystemSecretStore
 
close() - Method in class org.forgerock.util.LazySupplier
If the lazily-cached value has been initialized and is AutoCloseable then it is closed.
Closeables - Class in org.forgerock.util
Common utility methods for Closeables.
closeSilently(Closeable...) - Static method in class org.forgerock.util.Closeables
Closes the provided resources ignoring any errors which occurred.
closeSilently(Closeable...) - Static method in class org.forgerock.util.Utils
closeSilently(AutoCloseable...) - Static method in class org.forgerock.util.Closeables
Closes the provided resources ignoring any errors which occurred.
closeSilently(Iterable<? extends Closeable>) - Static method in class org.forgerock.util.Utils
closeSilently(Iterable<? extends AutoCloseable>) - Static method in class org.forgerock.util.Closeables
Closes the provided resources ignoring any errors which occurred.
closeSilently(AsyncFunction<IN, OUT, EX>) - Static method in class org.forgerock.util.CloseSilentlyAsyncFunction
Wraps a delegate asynchronous function in a CloseSilentlyAsyncFunction.
closeSilently(Function<IN, OUT, EX>) - Static method in class org.forgerock.util.CloseSilentlyFunction
Wraps a delegate function in a CloseSilentlyFunction.
closeSilentlyAsync(Closeable...) - Static method in class org.forgerock.util.Closeables
Closes asynchronously the provided resources ignoring any errors which occurred.
closeSilentlyAsync(AutoCloseable...) - Static method in class org.forgerock.util.Closeables
Closes asynchronously the provided resources ignoring any errors which occurred.
CloseSilentlyAsyncFunction<VIN extends Closeable,VOUT,E extends Exception> - Class in org.forgerock.util
AsyncFunction that silently closes an input-parameter after a delegate-function's AsyncFunction.apply(Object) is completed.
CloseSilentlyFunction<VIN extends Closeable,VOUT,E extends Exception> - Class in org.forgerock.util
Function that silently closes an input-parameter after a delegate-function's Function.apply(Object) is invoked.
CloseSilentlyFunction(Function<VIN, VOUT, E>) - Constructor for class org.forgerock.util.CloseSilentlyFunction
Creates a new CloseSilentlyFunction instance.
CollectionResourceProvider - Interface in org.forgerock.json.resource
An implementation interface for resource providers which exposes a collection of resource instances.
COLON - Enum constant in enum class org.forgerock.openig.text.Separators
Unix-style colon separated values, with backslash escape character.
combine(SecretBuilder) - Method in class org.forgerock.secrets.SecretBuilder
Returns a fresh SecretBuilder that combines the data from this secret builder and the argument.
COMMA - Enum constant in enum class org.forgerock.openig.text.Separators
Comma separated values, with support for quoted literal strings.
CommonAuditBatchConfiguration - Class in org.forgerock.audit.batch
This class stores the common audit logging batch process configurations.
CommonsMonitoringStatsCounter - Class in org.forgerock.openig.tools
Expose Caffeine's StatsCounter in our own MeterRegistry.
CommonsMonitoringStatsCounter(MeterRegistry, String) - Constructor for class org.forgerock.openig.tools.CommonsMonitoringStatsCounter
Constructs a new Caffeine StatsCounter.
COMPARATOR - Static variable in class org.forgerock.util.Pair
Comparator for Pairs made of Comparable elements.
compare(JsonValue, JsonValue) - Method in class org.forgerock.json.resource.SortKeyComparator
 
compareTo(MutableUri) - Method in class org.forgerock.http.MutableUri
 
compareTo(Version) - Method in class org.forgerock.http.routing.Version
 
compareTo(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath
Compares this resource path with the provided resource path.
compareTo(Version) - Method in class org.forgerock.openig.tools.am.Version
 
compareTo(Duration) - Method in class org.forgerock.util.time.Duration
 
compareValues(Object, Object) - Static method in class org.forgerock.util.Objects
Compare two values based on types.
compareValues(Object, Object) - Static method in class org.forgerock.util.Utils
comparisonFilter(FF, String, Object) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new generic comparison filter using the provided field name, operator, and value assertion.
completeSamlConfig(JsonValue, String, SamlConfig.Builder) - Method in class org.forgerock.openig.handler.saml.AbstractSamlFederationHeaplet
Permit to complement the SamlConfig SamlConfig.Builder.
completeSamlConfig(JsonValue, String, SamlConfig.Builder) - Method in class org.forgerock.openig.handler.saml.SamlFederationFilterHeaplet
 
completeSamlConfig(JsonValue, String, SamlConfig.Builder) - Method in class org.forgerock.openig.handler.saml.SamlFederationHandlerHeaplet
Deprecated.
 
complex(FF, QueryFilter<FF>) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new complex filter using the provided field name and sub-filter expression.
componentTypeDefinition() - Method in class org.forgerock.openig.assertion.plugin.ScriptableIdentityAssertionPluginTypeProvider
 
componentTypeDefinition() - Method in class org.forgerock.openig.script.AbstractScriptableTypeProvider
Return the ComponentTypeDefinition of the ScriptableTypeProvider.
compose(Function<? super V, ? extends VIN, E>) - Method in interface org.forgerock.util.Function
Returns a composed function that first applies the before function to its input, and then applies this function to the result.
CompositeAliasSpecProvider(KeyStoreSecretStore.AliasSpecProvider...) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore.CompositeAliasSpecProvider
Constructor.
compress(byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.compression.CompressionHandler
Applies the compression algorithm to compress the given array of bytes.
compress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.DeflateCompressionHandler
Applies the compression algorithm to compress the given array of bytes.
compress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.NOPCompressionHandler
Simple returns the same byte array as it is given.
compress(CompressionAlgorithm, String) - Method in class org.forgerock.json.jose.jwe.CompressionManager
Convenience method equivalent to Base64url.encode(getCompressionHandler(compressionAlgorithm).compress(data.getBytes(Utils.CHARSET))).
CompressionAlgorithm - Enum Class in org.forgerock.json.jose.jwe
An Enum of the possible compression algorithms that can be applied to the JWE payload plaintext.
CompressionHandler - Interface in org.forgerock.json.jose.jwe.handlers.compression
The interface for CompressionHandlers for all the different compression algorithms.
CompressionManager - Class in org.forgerock.json.jose.jwe
A service to get the appropriate CompressionHandler for a specified Compression algorithm.
CompressionManager() - Constructor for class org.forgerock.json.jose.jwe.CompressionManager
 
concat(byte[], byte[]) - Static method in class org.forgerock.json.jose.utils.Utils
Concatenates two byte arrays.
concat(String) - Method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path which is a descendant of this resource path.
concat(JsonPointer) - Method in class org.forgerock.json.JsonPointer
Creates a new JSON pointer which is a descendant of this JSON pointer.
concat(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path which is a descendant of this resource path.
condition() - Method in class org.forgerock.openig.types.importer.RouteInstance
Returns the condition expression of this route.
condition(Expression<Boolean>) - Method in class org.forgerock.openig.filter.RetryFilter.Builder
Add a retry condition to the future RetryFilter.
condition(Expression<Boolean>) - Method in class org.forgerock.openig.types.importer.RouteInstance
Sets the condition expression that describes what requests are accepted by this route.
conditionalFilter(Filter, BiPredicate<Context, Request>) - Static method in class org.forgerock.http.filter.Filters
Create a Filter decorator that only delegates to the decorated filter if the supplied predicate returns true.
conditionalFilter(FilterCondition, Filter) - Static method in class org.forgerock.json.resource.Filters
Returns a Filter which will only invoke subFilter when the provided filter condition matches the request being processed.
ConditionalFilter - Class in org.forgerock.openig.filter
This filter conditionally executes a delegate Filter given the result of a 'condition' function.
ConditionalFilter(Filter, boolean) - Constructor for class org.forgerock.openig.filter.ConditionalFilter
Constructs a ConditionalFilter.
ConditionalFilter(Filter, AsyncFunction<ContextAndRequest, Boolean, Exception>) - Constructor for class org.forgerock.openig.filter.ConditionalFilter
Constructs a ConditionalFilter.
ConditionalFilterHeaplet - Class in org.forgerock.openig.filter
Creates a ConditionalFilter into a Heap environment.
ConditionalFilterHeaplet() - Constructor for class org.forgerock.openig.filter.ConditionalFilterHeaplet
 
ConditionEnforcementFilter - Class in org.forgerock.openig.filter
An ConditionEnforcementFilter makes sure that the handled Request verifies a condition.
ConditionEnforcementFilter(Expression<Boolean>) - Constructor for class org.forgerock.openig.filter.ConditionEnforcementFilter
ConditionEnforcementFilter(Expression<Boolean>, Handler) - Constructor for class org.forgerock.openig.filter.ConditionEnforcementFilter
ConditionEnforcementFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an ConditionEnforcementFilter in a heap environment.
config - Variable in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
The heaplet's object configuration object.
config - Variable in class org.forgerock.openig.heap.GenericHeaplet
The heaplet's object configuration object.
config() - Method in record class org.forgerock.openig.heap.DefaultDeclarationProvider.Declaration
Returns the value of the config record component.
CONFIG_WEBSOCKET - Static variable in class org.forgerock.openig.handler.ReverseProxyHandlerHeaplet
Constant for the configuration websocket.
ConfigAuditEventBuilder<T extends ConfigAuditEventBuilder<T>> - Class in org.forgerock.audit.events
Builder for audit config events.
ConfigAuditEventBuilder() - Constructor for class org.forgerock.audit.events.ConfigAuditEventBuilder
Creates the builder.
configEvent() - Static method in class org.forgerock.audit.events.ConfigAuditEventBuilder
Starts to build an audit config event.
configure(Options) - Method in class org.forgerock.openig.proxy.CustomProxyOptions
 
configure(Options) - Method in class org.forgerock.openig.proxy.NoProxyOptions
 
configure(Options) - Method in class org.forgerock.openig.proxy.SystemProxyOptions
 
configure(Options) - Method in interface org.forgerock.openig.tools.ProxyOptions
Configure proxy settings.
configuredBuilder(EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder) - Method in class org.forgerock.openig.filter.oauth2.client.authentication.EncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet
Supports fulfillment of the supplied EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder with configuration.
configuredBuilder(PrivateKeyJwtClientAuthenticationFilter.Builder<?>) - Method in class org.forgerock.openig.filter.oauth2.client.authentication.PrivateKeyJwtClientAuthenticationFilterHeaplet
Supports fulfillment of the supplied PrivateKeyJwtClientAuthenticationFilter.Builder with configuration.
configureJwksStore(String, Duration, Duration, URL) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService
configureJwksStore(String, Duration, Duration, URL, Clock) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService
configureJwksStoreAsync(String, Duration, Duration, URL, Clock) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService
Configure a JWKs store.
ConfirmationKeyVerifier - Interface in org.forgerock.openig.filter.oauth2.cnf
A ConfirmationKeyVerifier is responsible to verify a confirmation key node.
ConfirmationKeyVerifierAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2.cnf
A ConfirmationKeyVerifierAccessTokenResolver is responsible of validating confirmation keys bound to the access_token (such as certificate thumbprint).
ConfirmationKeyVerifierAccessTokenResolver.Heaplet - Class in org.forgerock.openig.filter.oauth2.cnf
Creates and initializes a Confirmation Key Verifier access_token resolver in the heap environment.
CONFLICT - Static variable in class org.forgerock.http.protocol.Status
The 409 (Conflict) status code indicates that the request could not be completed due to a conflict with the current state of the target resource.
CONFLICT - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates the request could not be completed due to a conflict with the current state of the resource.
ConflictException - Exception in org.forgerock.json.resource
An exception that is thrown during a operation on a resource when such an operation would result in a conflict.
ConflictException() - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with null as its detail message.
ConflictException(String) - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with the specified detail message.
ConflictException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with the specified detail message and cause.
ConflictException(Throwable) - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with the specified cause.
connection - Variable in class org.forgerock.json.resource.AbstractConnectionWrapper
The wrapped connection.
Connection - Interface in org.forgerock.json.resource
A client connection to a JSON resource provider over which read and update requests may be performed.
CONNECTION - Enum constant in enum class org.forgerock.openig.tools.notifications.ConnectionEvent
Sent when a notification session is established.
ConnectionConfiguration() - Constructor for class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration
 
ConnectionConfiguration() - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration
 
ConnectionEvent - Enum Class in org.forgerock.openig.tools.notifications
Describes if the event is a connection event or a disconnection event.
ConnectionFactory - Interface in org.forgerock.json.resource
A connection factory provides an interface for obtaining a connection to a JSON resource provider.
ConnectionHeader - Class in org.forgerock.http.header
Processes the Connection message header.
ConnectionHeader() - Constructor for class org.forgerock.http.header.ConnectionHeader
Constructs a new empty header.
ConnectionHeader(List<String>) - Constructor for class org.forgerock.http.header.ConnectionHeader
Constructs a new header with the provided connection tokens.
ConnectionPool() - Constructor for class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
 
connectionTimeout(Duration) - Method in class org.forgerock.openig.tools.am.NotificationsConfig.Builder
Set the connection timeout of the websocket.
constant(T) - Static method in class org.forgerock.secrets.SecretReference
Create a constant SecretReference for the given secret, that will never expire.
constantEquals(byte[], byte[]) - Static method in class org.forgerock.json.jose.utils.Utils
Compares two byte arrays for equality, in a constant time.
constantSecretReference() - Static method in class org.forgerock.openig.util.JsonValues
Returns a SecretReference.constant(Secret) from a GenericSecret attribute value.
Constraints - Class in org.forgerock.openig.tools.jwt.validation
Constraints defined for JWT validation.
consumeIfPresent(Consumer<T>) - Static method in class org.forgerock.openig.util.PromiseUtil
Execute the consumer if result is not null.
Consumer<T,E extends Exception> - Interface in org.forgerock.util
A Consumer functional interface which can throw a checked Exception.
containedIn(Set<String>) - Static method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Accepts a set of values if all values from that set are contained in the given set of acceptedValues.
containedInIgnoringCase(String...) - Static method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Accepts a set of values if all values from that set are contained (case insensitively) in the given set of acceptedValues.
contains(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new contains filter using the provided field name and value assertion.
contains(Object) - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
contains(Object) - Method in class org.forgerock.http.util.SetDecorator
Returns true if the set contains the specified element.
contains(Object) - Method in class org.forgerock.json.JsonValue
Returns true this JSON value contains an item with the specified value.
contains(Object) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
 
contains(Object) - Method in class org.forgerock.util.LazyList
Returns true if this list contains the specified element.
contains(Object) - Method in class org.forgerock.util.ListDecorator
Returns true if this list contains the specified element.
contains(Object) - Method in class org.forgerock.util.RangeSet
Returns true if this set contains the specified element.
contains(Object, Object) - Static method in class org.forgerock.openig.el.Functions
Returns true if the object contains the value.
contains(T) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints
Returns empty if the list contains the expected value.
CONTAINS - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "contains" operator".
containsAll(Collection<?>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
containsAll(Collection<?>) - Method in class org.forgerock.http.util.SetDecorator
Returns true if the set contains all of the elements of the specified collection.
containsAll(Collection<?>) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
 
containsAll(Collection<?>) - Method in class org.forgerock.util.LazyList
Returns true if this list contains all of the elements of the specified collection.
containsAll(Collection<?>) - Method in class org.forgerock.util.ListDecorator
Returns true if this list contains all of the elements of the specified collection.
containsContext(Class<? extends Context>) - Method in class org.forgerock.services.context.AbstractContext
 
containsContext(Class<? extends Context>) - Method in interface org.forgerock.services.context.Context
Returns true if there is a context in the chain whose type is a sub-type of the provided Context class.
containsContext(String) - Method in class org.forgerock.services.context.AbstractContext
 
containsContext(String) - Method in interface org.forgerock.services.context.Context
Returns true if there is a context in the chain whose name matches the provided context name.
containsHeader(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
 
containsKey(Object) - Method in class org.forgerock.http.protocol.Headers
 
containsKey(Object) - Method in class org.forgerock.http.protocol.RequestCookies
 
containsKey(Object) - Method in class org.forgerock.http.util.CaseInsensitiveMap
 
containsKey(Object) - Method in class org.forgerock.util.LazyMap
Returns true if this map contains a mapping for the specified key.
containsKey(Object) - Method in class org.forgerock.util.MapDecorator
Returns true if this map contains a mapping for the specified key.
containsOnly(T) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints
Returns empty if the list contains only the expected value.
containsTopic(String) - Method in class org.forgerock.audit.events.EventTopicsMetaData
Returns true if this object has meta-data for the specified topic.
containsValue(Object) - Method in class org.forgerock.http.protocol.Headers
 
containsValue(Object) - Method in class org.forgerock.http.protocol.RequestCookies
 
containsValue(Object) - Method in class org.forgerock.util.LazyMap
Returns true if the map maps one or more keys to the specified value.
containsValue(Object) - Method in class org.forgerock.util.MapDecorator
Returns true if the map maps one or more keys to the specified value.
CONTENT_DISPOSITION - Static variable in class org.forgerock.json.resource.http.HttpUtils
the HTTP header for Content-Disposition.
ContentApiVersionHeader - Class in org.forgerock.http.header
Processes the Content-API-Version message header.
ContentApiVersionHeader(Version, Version) - Constructor for class org.forgerock.http.header.ContentApiVersionHeader
Constructs a new header, initialized with the specified protocol and resource versions.
ContentEncodingHeader - Class in org.forgerock.http.header
Processes the Content-Encoding message header.
ContentEncodingHeader() - Constructor for class org.forgerock.http.header.ContentEncodingHeader
Constructs a new empty header.
ContentEncodingHeader(List<String>) - Constructor for class org.forgerock.http.header.ContentEncodingHeader
Constructs a new header with the provided content encodings.
ContentLengthHeader - Class in org.forgerock.http.header
Processes the Content-Length message header.
ContentLengthHeader() - Constructor for class org.forgerock.http.header.ContentLengthHeader
Constructs a new empty header whose length is set to -1.
ContentLengthHeader(long) - Constructor for class org.forgerock.http.header.ContentLengthHeader
Constructs a new header with the provided content length.
ContentTypeHeader - Class in org.forgerock.http.header
Processes the Content-Type message header.
ContentTypeHeader() - Constructor for class org.forgerock.http.header.ContentTypeHeader
Constructs a new empty header whose type, charset, and boundary are all null.
ContentTypeHeader(String, String, String) - Constructor for class org.forgerock.http.header.ContentTypeHeader
Deprecated.
ContentTypeHeader(String, String, String, Map<String, String>) - Constructor for class org.forgerock.http.header.ContentTypeHeader
Deprecated.
ContentTypeHeader(String, Map<String, Directive>) - Constructor for class org.forgerock.http.header.ContentTypeHeader
Constructs a new header based on message type and any message directives.
context() - Method in record class org.forgerock.openig.http.ContextAndRequest
Returns the value of the context record component.
context(Map<String, Object>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Sets the context used in the authentication event.
Context - Interface in org.forgerock.openig.decoration
A decoration Context is a way to provide the decorator(s) all of the available information about the instance to decorate.
Context - Interface in org.forgerock.services.context
Type-safe contextual information associated with the processing of a request in an application.
CONTEXT - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Defines the context key.
ContextAndRequest - Record Class in org.forgerock.openig.http
This a value class to hold a Context and a Request during the processing of a request.
ContextAndRequest(Context, Request) - Constructor for record class org.forgerock.openig.http.ContextAndRequest
Creates an instance of a ContextAndRequest record class.
CONTINUE - Enum constant in enum class org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status
Authentication operation has not yet completed.
CONTINUE - Static variable in class org.forgerock.http.protocol.Status
The 100 (Continue) status code indicates that the initial part of a request has been received and has not yet been rejected by the server.
convertTo(TimeUnit) - Method in class org.forgerock.util.time.Duration
Convert the current duration to a given TimeUnit.
Cookie - Class in org.forgerock.http.protocol
An HTTP cookie.
Cookie() - Constructor for class org.forgerock.http.protocol.Cookie
Creates a new uninitialized cookie.
Cookie.SameSite - Enum Class in org.forgerock.http.protocol
Indicates the SameSite value of the cookie.
CookieBasedSessionManager - Class in org.forgerock.openig.session.cookie
An implementation of AsyncSessionManager storing sessions in memory.
CookieBasedSessionManager(CookieBuilder, LocalSessionStore) - Constructor for class org.forgerock.openig.session.cookie.CookieBasedSessionManager
Create a new CookieBasedSessionManager instance.
CookieFilter - Class in org.forgerock.openig.filter
Suppresses, relays and manages cookies.
CookieFilter() - Constructor for class org.forgerock.openig.filter.CookieFilter
 
CookieFilter.Action - Enum Class in org.forgerock.openig.filter
Action to be performed for a cookie.
CookieFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a cookie filter in a heap environment.
CookieHeader - Class in org.forgerock.http.header
Processes the Cookie request message header.
CookieHeader() - Constructor for class org.forgerock.http.header.CookieHeader
Constructs a new empty header.
CookieHeader(List<Cookie>) - Constructor for class org.forgerock.http.header.CookieHeader
Constructs a new header with the provided cookies.
COOKIES - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The cookies event payload field name.
copy() - Method in class org.forgerock.http.io.BranchingInputStream
Creates a twin of this stream at this stream's current position.
copy() - Method in class org.forgerock.http.io.FileBranchingStream
 
copy() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
 
copy() - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
 
copy() - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
 
copy() - Method in class org.forgerock.json.jose.jws.SignedJwt
 
copy() - Method in interface org.forgerock.json.jose.jwt.Jwt
Create a copy of the current JWT.
copy() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
 
copy() - Method in interface org.forgerock.json.jose.jwt.Payload
Create a copy of the current payload.
copy() - Method in class org.forgerock.json.JsonValue
Returns a deep copy of this JSON value.
copy(String, String) - Static method in class org.forgerock.json.resource.PatchOperation
Creates a new "copy" patch operation which will copy the value found at `from` to `path`.
copy(JsonPointer, JsonPointer) - Static method in class org.forgerock.json.resource.PatchOperation
Creates a new "copy" patch operation which will copy the value found at `from` to `path`.
copyAsMultiMapOfStrings() - Method in class org.forgerock.http.protocol.Headers
Returns a copy of these headers as a multi-valued map of strings.
copyDecodedContentTo(OutputStream) - Method in class org.forgerock.http.protocol.Entity
Copies the decoded content of this entity to the provided writer.
copyDecodedContentTo(Writer) - Method in class org.forgerock.http.protocol.Entity
Copies the decoded content of this entity to the provided writer.
copyOf(byte[]) - Static method in class org.forgerock.json.jose.utils.Utils
Copy the entire input bytes array in a new same-sized array.
copyOf(PatchOperation) - Static method in class org.forgerock.json.resource.PatchOperation
Returns a deep copy of the provided patch operation.
copyOf(Options) - Static method in class org.forgerock.util.Options
Returns a copy of the provided set of options.
copyOfActionRequest(ActionRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided action request.
copyOfApiRequest(Request) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided api request.
copyOfCreateRequest(CreateRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided create request.
copyOfDeleteRequest(DeleteRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided delete request.
copyOfPatchRequest(PatchRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided patch request.
copyOfQueryRequest(QueryRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided query request.
copyOfReadRequest(ReadRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided read request.
copyOfUpdateRequest(UpdateRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided update request.
copyRawContentTo(OutputStream) - Method in class org.forgerock.http.protocol.Entity
Copies the raw content of this entity to the provided output stream.
CoreClassAliasResolver - Class in org.forgerock.openig.alias
Register all the aliases supported by the openig-core module.
CoreClassAliasResolver() - Constructor for class org.forgerock.openig.alias.CoreClassAliasResolver
 
CoreDefaultDeclarationProvider - Class in org.forgerock.openig.heap
Core default declarations to add in Heap.
CoreDefaultDeclarationProvider() - Constructor for class org.forgerock.openig.heap.CoreDefaultDeclarationProvider
 
coreTopicSchemas() - Static method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder
Create a new instance of EventTopicsMetaDataBuilder that will populate EventTopicsMetaData objects its creates with the schema meta-data for core topics.
CorsFilter - Class in org.forgerock.http.filter.cors
This filters implements the resource processing of the CORS protocol.
CorsFilter(CorsPolicyProvider, Handler) - Constructor for class org.forgerock.http.filter.cors.CorsFilter
Constructs a new CORS filter using the given CorsPolicyProvider and failureHandler.
CorsFilterHeaplet - Class in org.forgerock.openig.filter
A CorsFilterHeaplet configures a CorsFilter in a heap environment.
CorsFilterHeaplet() - Constructor for class org.forgerock.openig.filter.CorsFilterHeaplet
 
CorsPolicy - Class in org.forgerock.http.filter.cors
The CORS policy is responsible to handle both actual and preflight CORS requests and set the appropriate set of response headers based on its own configuration.
CorsPolicy.Builder - Class in org.forgerock.http.filter.cors
Builder for CorsPolicy instances.
CorsPolicyProvider - Interface in org.forgerock.http.filter.cors
A CorsPolicyProvider allows the CorsFilter to lookup its configuration at runtime, also based on contextual information.
CountPolicy - Enum Class in org.forgerock.json.resource
An enum of count policy types.
create() - Method in class org.forgerock.openig.assertion.handler.IdentityAssertionHandler.Heaplet
 
create() - Method in class org.forgerock.openig.assertion.plugin.kerberos.KerberosIdentityAssertionPlugin.Heaplet
 
create() - Method in class org.forgerock.openig.assertion.plugin.kerberos.KeytabServiceLogin.Heaplet
 
create() - Method in class org.forgerock.openig.assertion.plugin.kerberos.UsernamePasswordServiceLogin.Heaplet
 
create() - Method in class org.forgerock.openig.assertion.plugin.ScriptableIdentityAssertionPlugin.Heaplet
 
create() - Method in class org.forgerock.openig.audit.AuditServiceObjectHeaplet
 
create() - Method in class org.forgerock.openig.audit.NoOpAuditService.Heaplet
 
create() - Method in class org.forgerock.openig.decoration.baseuri.BaseUriDecorator.Heaplet
 
create() - Method in class org.forgerock.openig.decoration.capture.CaptureDecorator.Heaplet
 
create() - Method in class org.forgerock.openig.decoration.DelegateHeaplet
 
create() - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
Called to request the heaplet create an object.
create() - Method in class org.forgerock.openig.decoration.timer.TimerDecorator.Heaplet
 
create() - Method in class org.forgerock.openig.filter.allow.AllowOnlyFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.AssignmentFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.ChainFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.ChainHandlerHeaplet
 
create() - Method in class org.forgerock.openig.filter.circuitbreaker.CircuitBreakerFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.ConditionalFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.ConditionEnforcementFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.CookieFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.CorsFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.CsrfFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.DataPreservationFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.DateHeaderFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.EntityExtractFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.FileAttributesFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.finance.FapiInteractionIdFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.ForwardedRequestFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.FragmentFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.HeaderFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.HttpBasicAuthenticationClientFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.HttpBasicAuthFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.jwt.JwtValidationFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.JwtBuilderFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.LocationHeaderFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.authentication.ClientSecretPostAuthenticationFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.authentication.EncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.authentication.PrivateKeyJwtClientAuthenticationFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.ResourceOwnerOAuth2ClientFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.GrantSwapJwtAssertionOAuth2ClientFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.IssuerHeaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.IssuerRepository.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.cnf.CertificateThumbprintFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.cnf.ConfirmationKeyVerifierAccessTokenResolver.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.StatelessAccessTokenResolver.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.TokenIntrospectionAccessTokenResolverHeaplet
 
create() - Method in class org.forgerock.openig.filter.PasswordReplayFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.SetCookieUpdateFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.StaticRequestFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.SwitchFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet
 
create() - Method in class org.forgerock.openig.filter.throttling.MappedThrottlingPolicyHeaplet
 
create() - Method in class org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.UriPathRewriteFilter.Heaplet
 
create() - Method in class org.forgerock.openig.handler.assertion.IdentityAssertionHandlerTechPreview.Heaplet
 
create() - Method in class org.forgerock.openig.handler.assertion.ScriptableIdentityAssertionPluginTechPreview.Heaplet
 
create() - Method in class org.forgerock.openig.handler.DispatchHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.HttpClientHandlerHeaplet
 
create() - Method in class org.forgerock.openig.handler.JwkSetHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.resources.ResourceHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.saml.AbstractSamlFederationHeaplet
 
create() - Method in class org.forgerock.openig.handler.SequenceHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.StaticResponseHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.WelcomeHandler.Heaplet
 
create() - Method in class org.forgerock.openig.heap.GenericHeaplet
Called to request the heaplet create an object.
create() - Method in class org.forgerock.openig.io.TemporaryStorageHeaplet
 
create() - Method in class org.forgerock.openig.openam.AmServiceHeaplet
 
create() - Method in class org.forgerock.openig.openam.CapturedUserPasswordFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.RequestResourceUriProvider.Heaplet
 
create() - Method in class org.forgerock.openig.openam.session.AmSessionIdleTimeoutFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.SessionInfoFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.SingleSignOnFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.TokenTransformationFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.UserProfileFilterHeaplet
 
create() - Method in class org.forgerock.openig.openam.UserProfileServiceHeaplet
 
create() - Method in class org.forgerock.openig.ping.PingOneApiAccessManagementFilterHeaplet
 
create() - Method in class org.forgerock.openig.ping.protect.PingOneProtectEvaluationFilter.Heaplet
 
create() - Method in class org.forgerock.openig.ping.protect.PingOneProtectFeedbackFilter.Heaplet
 
create() - Method in class org.forgerock.openig.ping.protect.PingOneProtectThreatLevelRoutingHandler.Heaplet
 
create() - Method in class org.forgerock.openig.proxy.CustomProxyOptions.Heaplet
 
create() - Method in class org.forgerock.openig.proxy.NoProxyOptions.Heaplet
 
create() - Method in class org.forgerock.openig.proxy.SystemProxyOptions.Heaplet
 
create() - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
create() - Method in class org.forgerock.openig.secrets.KeyStoreSecretStoreHeaplet
 
create() - Method in class org.forgerock.openig.secrets.Base64EncodedSecretStore.Heaplet
 
create() - Method in class org.forgerock.openig.secrets.JwkPropertyFormatHeaplet
 
create() - Method in class org.forgerock.openig.secrets.JwkSetSecretStoreHeaplet
 
create() - Method in class org.forgerock.openig.secrets.PemPropertyFormatHeaplet
 
create() - Method in class org.forgerock.openig.secrets.FileSystemSecretStoreHeaplet
 
create() - Method in class org.forgerock.openig.secrets.SecretKeyPropertyFormatHeaplet
 
create() - Method in class org.forgerock.openig.secrets.SecretsKeyManagerHeaplet
 
create() - Method in class org.forgerock.openig.secrets.SecretsProviderHeaplet
 
create() - Method in class org.forgerock.openig.secrets.SecretsTrustManagerHeaplet
 
create() - Method in class org.forgerock.openig.security.KeyManagerHeaplet
Deprecated.
 
create() - Method in class org.forgerock.openig.security.KeyStoreHeaplet
Deprecated.
 
create() - Method in class org.forgerock.openig.security.ClientTlsOptionsHeaplet
 
create() - Method in class org.forgerock.openig.security.TrustAllManager.Heaplet
 
create() - Method in class org.forgerock.openig.security.TrustManagerHeaplet
Deprecated.
 
create() - Method in class org.forgerock.openig.session.jwt.JwtSessionFilterHeaplet
 
create() - Method in class org.forgerock.openig.sql.JdbcDataSourceHeaplet
 
create() - Method in class org.forgerock.openig.sql.SqlAttributesFilter.Heaplet
 
create() - Method in class org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet
 
create() - Method in class org.forgerock.openig.uma.UmaResourceServerFilter.Heaplet
 
create() - Method in class org.forgerock.openig.uma.UmaSharingService.Heaplet
 
create() - Static method in class org.forgerock.util.promise.PromiseImpl
Creates a new pending Promise implementation.
create(String, Class<T>, EventHandlerConfiguration, EventTopicsMetaData) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandlerFactory
Create a new AuditEventHandler instance.
create(String, Class<T>, EventHandlerConfiguration, EventTopicsMetaData) - Method in class org.forgerock.audit.events.handlers.DependencyProviderAuditEventHandlerFactory
 
create(String, String, String, int, String, String, String) - Static method in class org.forgerock.http.util.Uris
Returns a hierarchical URI constructed from the given components.
create(String, String, String, String, String) - Static method in class org.forgerock.http.util.Uris
Returns a hierarchical URI constructed from the given components.
create(Supplier<Promise<T, NeverThrowsException>>, Clock, Duration) - Static method in class org.forgerock.secrets.PeriodicallyRefreshedReferenceAsync
create(Map<String, Object>) - Method in class org.forgerock.openig.tools.jwt.factory.SignedThenEncryptedJwtFactory
 
create(Map<String, Object>) - Method in interface org.forgerock.openig.tools.jwt.factory.JwtFactory
Produces a new Jwt.
create(JsonValue) - Method in class org.forgerock.openig.ui.record.RecordService
Store the given content on disk and returns a Record that represents the new resource.
create(SamlConfig) - Method in class org.forgerock.openig.handler.saml.AbstractSamlFederationHeaplet
Create the final Heap Object.
create(SamlConfig) - Method in class org.forgerock.openig.handler.saml.SamlFederationFilterHeaplet
 
create(SamlConfig) - Method in class org.forgerock.openig.handler.saml.SamlFederationHandlerHeaplet
Deprecated.
 
create(Name, JsonValue, Heap) - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
 
create(Name, JsonValue, Heap) - Method in class org.forgerock.openig.heap.GenericHeaplet
 
create(Name, JsonValue, Heap) - Method in interface org.forgerock.openig.heap.Heaplet
Called to request the heaplet to create an object.
create(Context, CreateRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
 
create(Context, CreateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Adds a new JSON resource.
create(Context, CreateRequest) - Method in interface org.forgerock.json.resource.Connection
Adds a new JSON resource.
CREATE - Enum constant in enum class org.forgerock.json.resource.RequestType
A create request.
createActiveReference(Purpose<S>) - Method in interface org.forgerock.openig.secrets.SecretsService
Create a SecretReference for the given Purpose.
createActiveReference(Purpose<S>) - Method in class org.forgerock.secrets.SecretsProvider
Creates the secret reference from the given purpose.
createAgentAuthenticationService(Handler, URI, AmVersion) - Static method in class org.forgerock.openig.tools.authentication.AuthenticatorAuthenticationService
Return an instance of an AuthenticationService for Agent authentication based on the AmVersion.
createApiVersionRouterContext(Context) - Method in class org.forgerock.http.routing.ResourceApiVersionRoutingFilter
Creates a ApiVersionRouterContext using the default version behaviour and whether to issue warnings from the behaviourManager instance.
createAsync(Context, CreateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Asynchronously adds a new JSON resource.
createAsync(Context, CreateRequest) - Method in interface org.forgerock.json.resource.Connection
Asynchronously adds a new JSON resource.
createCachedThreadPool() - Method in class org.forgerock.util.thread.ExecutorServiceFactory
createCachedThreadPool(String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Generates a Cached Thread Pool ExecutorService using the provided name as a prefix of the thread names.
createCachedThreadPool(ThreadFactory) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Generates a Cached Thread Pool ExecutorService which has been pre-registered with the ShutdownManager.
createCancellableScheduledService(int, String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Generates a ScheduledExecutorService which has been pre-registered with the ShutdownManager and has the remove on cancel policy enabled.
createChild(String, String, String, String...) - Method in class org.forgerock.openig.util.StartupMetrics
Create a child instance of StartupMetrics.
createContext(Context) - Method in class org.forgerock.json.resource.http.SecurityContextFactory
Deprecated.
Creates a new SecurityContext using the attributes contained in the provided HTTP request.
createContext(Context, Request) - Method in interface org.forgerock.json.resource.http.HttpContextFactory
Returns the context which should be used for the provided HTTP request.
createContext(Context, Request) - Method in class org.forgerock.json.resource.http.SecurityContextFactory
Deprecated.
Creates a new SecurityContext using the attributes contained in the provided HTTP request.
CREATED - Static variable in class org.forgerock.http.protocol.Status
The 201 (Created) status code indicates that the request has been fulfilled and has resulted in one or more new resources being created.
createFilter(CredentialPair<GenericSecret>) - Method in class org.forgerock.openig.filter.oauth2.client.authentication.ClientSecretBasicAuthenticationFilterHeaplet
 
createFilter(CredentialPair<GenericSecret>) - Method in class org.forgerock.openig.filter.oauth2.client.authentication.ClientSecretPostAuthenticationFilterHeaplet
 
createFixedThreadPool(int) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Deprecated.
ExecutorServiceFactory.createFixedThreadPool(int, String) should be used so that threads have meaningful names.
createFixedThreadPool(int, String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Create a fixed size Thread Pool ExecutorService using the provided name as the prefix of the thread names.
createFixedThreadPool(int, ThreadFactory) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Creates a fixed size Thread Pool ExecutorService which has been pre-registered with the ShutdownManager.
createGrantTypeHandler() - Method in class org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterHeaplet
 
createGrantTypeHandler() - Method in class org.forgerock.openig.filter.oauth2.client.ResourceOwnerOAuth2ClientFilterHeaplet
 
createInline(String...) - Method in class org.forgerock.openig.script.GroovyScriptFactory
 
createInline(String...) - Method in interface org.forgerock.openig.script.ScriptFactory
Build a new Script instance from the given lines representing the script content.
createInstance(Context, CreateRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider
Adds a new resource instance to the collection.
createInstance(Context, CreateRequest) - Method in class org.forgerock.json.resource.MemoryBackend
Adds a new resource instance to the collection.
createInstance(Context, CreateRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
createNamedReference(Purpose<S>, String) - Method in interface org.forgerock.openig.secrets.SecretsService
Creates a reference to a secret with the given name (stable id) for the given purpose.
createNamedReference(Purpose<S>, String) - Method in class org.forgerock.secrets.SecretsProvider
Creates a reference to a secret with the given name (stable id) for the given purpose.
createNewSession() - Method in class org.forgerock.openig.session.cookie.LocalSessionStore
Create a new session.
createNonStrict(String, String, String, int, String, String, String) - Static method in class org.forgerock.http.util.Uris
Returns a hierarchical URI constructed from the given components.
CreateNotSupportedException - Exception in org.forgerock.json.resource
A specific exception for when Create is not supported, but Upsert might be being attempted so distinguish from other BadRequestExceptions.
CreateNotSupportedException() - Constructor for exception org.forgerock.json.resource.CreateNotSupportedException
Constructor with default message.
CreateNotSupportedException(String) - Constructor for exception org.forgerock.json.resource.CreateNotSupportedException
Constructor with custom message.
CreateRequest - Interface in org.forgerock.json.resource
A request to create a new JSON resource.
createResource(String) - Method in class org.forgerock.openig.script.GroovyScriptFactory
 
createResource(String) - Method in interface org.forgerock.openig.script.ScriptFactory
Build a new Script instance from a resource name.
createScheduledService(int) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Deprecated.
ExecutorServiceFactory.createScheduledService(int, String) should be used so that threads have meaningful names.
createScheduledService(int, String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Generates a ScheduledExecutorService which has been pre-registered with the ShutdownManager.
createShare(Context, String, String) - Method in class org.forgerock.openig.uma.UmaSharingService
Creates a Share that will be used to protect the given resourcePath.
createSubTransactionId() - Method in class org.forgerock.services.TransactionId
Creates a new TransactionId, child of this one.
createThreadPool(int, int, long, TimeUnit, BlockingQueue<Runnable>) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Deprecated.
createThreadPool(int, int, long, TimeUnit, BlockingQueue<Runnable>, String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Generates a ThreadPoolExecutor with the provided values, and registers that executor as listening for shutdown messages.
createUri(String, String, String, int, String, String, String, boolean) - Static method in class org.forgerock.http.util.Uris
Create a new URI given all provided URI components, query string can be strictly processed or not.
createValidOrNamedReference(Purpose<S>, String) - Method in class org.forgerock.secrets.SecretsProvider
Creates the valid secrets reference from the given purpose.
createValidReference(Purpose<S>) - Method in class org.forgerock.secrets.SecretsProvider
Creates the valid secrets reference from the given purpose.
credentialPair(SecretReference<T>, Function<T, PrincipalAndSecret<T>>) - Static method in class org.forgerock.secrets.credentials.CredentialPair
Factory method to create a new instance of CredentialPair from a reference to a secret containing both the principal and secret.
CredentialPair<T extends Secret> - Class in org.forgerock.secrets.credentials
Credential pair implementation.
credentialPairs(ValidSecretsReference<S, E>, Function<S, PrincipalAndSecret<S>>) - Static method in class org.forgerock.secrets.credentials.ValidCredentialPairs
Factory method to create a new instance of ValidCredentialPairs from a reference to a set of secrets that each contain a credential pair.
CredentialsParser<C> - Interface in org.forgerock.http.header.authorization
This interface is used to parse the credentials component of an Authorization HTTP header.
CREST_PROTOCOL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The protocol field CREST value.
CrestApplication - Interface in org.forgerock.json.resource
Declare a CREST Application.
CrestHttp - Class in org.forgerock.json.resource.http
A CREST HTTP utility class which creates instances of the HttpAdapter to handle CREST HTTP requests.
CrestSessionService - Class in org.forgerock.openig.tools.session
The CrestSessionService is responsible for performing interactions with the AM sessions endpoint.
CrestSessionService.Builder - Class in org.forgerock.openig.tools.session
Builder of the CrestSessionService.
CrestUserProfileService - Class in org.forgerock.openig.tools.userprofile
The CrestUserProfileService is responsible for interactions with AM users endpoint using resource version 3.0; since AM v13.
CrestUserProfileService(RequestHandler, Set<String>) - Constructor for class org.forgerock.openig.tools.userprofile.CrestUserProfileService
Creates a new CrestUserProfileService which is responsible for interactions with AM users endpoint.
CrestUtil - Class in org.forgerock.openig.util
CREST utility class.
crit(List<String>) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the critical header parameters for this JWS.
CRIT - Enum constant in enum class org.forgerock.json.jose.jws.JwsHeaderKey
Critical header parameter.
CRITICAL - Enum constant in enum class org.forgerock.audit.handlers.syslog.Severity
Critical conditions.
CRON - Enum constant in enum class org.forgerock.audit.handlers.syslog.Facility
Clock daemon.
CrossDomainSingleSignOnFilter - Class in org.forgerock.openig.openam
This filter verifies the presence of a JWT authentication token in the configured cookie name: If the JWT is present then its validity is checked and the request is forwarded to the next handler. If the JWT is not present, then the user-agent is redirected to Access Management via its OAuth2 authorization endpoint, to obtain user authentication.
CrossDomainSingleSignOnFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initialises an authentication filter in a heap environment.
crtCoefficient(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Set the RSA First CRT Coefficient value.
CRYPTO - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the crypto json object.
CRYPTO_ALGORITHM - Static variable in class org.forgerock.util.crypto.CryptoConstants
Key for the crypto algorithm used to crypt the data.
CRYPTO_CIPHER - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the cipher used to crypt the data.
CRYPTO_DATA - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the password data within crypto json.
CRYPTO_IV - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the Initialization Vector (a.k.a.
CRYPTO_KEY - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the name of the key-store alias used to crypt the data.
CRYPTO_TYPE - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for crypt type used to generate the crypt value.
CRYPTO_VALUE - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the crypt value, holding the crypt meta-data.
CryptoConstants - Class in org.forgerock.util.crypto
Constants for Crypto Algorithms and Json Crypto Json pointer keys.
CryptoKey - Class in org.forgerock.secrets.keys
Base class for all secrets that are used as keys for cryptographic operations.
CsrfFilter - Class in org.forgerock.http.filter
A generic filter for preventing cross-site request forgery (CSRF) attacks when using cookie-based authentication.
CsrfFilter.Builder - Class in org.forgerock.http.filter
Builder class for the CSRF filter.
CsrfFilterHeaplet - Class in org.forgerock.openig.filter
Creates and initializes a CsrfFilter supporting the injection and validation of an anti-CSRF token in the request header.
CsrfFilterHeaplet() - Constructor for class org.forgerock.openig.filter.CsrfFilterHeaplet
 
CsvAuditEventHandler - Class in org.forgerock.audit.handlers.csv
Handles AuditEvents by writing them to a CSV file.
CsvAuditEventHandler(CsvAuditEventHandlerConfiguration, EventTopicsMetaData, KeyStoreHandlerProvider) - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandler
Create a new CsvAuditEventHandler instance.
CsvAuditEventHandler.ParseJsonValue - Class in org.forgerock.audit.handlers.csv
CellProcessor for parsing JsonValue objects from CSV file.
CsvAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.csv
A configuration for CSV audit event handler.
CsvAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
 
CsvAuditEventHandlerConfiguration.CsvFormatting - Class in org.forgerock.audit.handlers.csv
Contains the csv writer configuration parameters.
CsvAuditEventHandlerConfiguration.CsvSecurity - Class in org.forgerock.audit.handlers.csv
Contains the configuration parameters to configure tamper evident logging.
CsvAuditEventHandlerConfiguration.EventBufferingConfiguration - Class in org.forgerock.audit.handlers.csv
Configuration of event buffering.
CsvFormatting() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting
 
CsvSecureArchiveVerifierCli - Class in org.forgerock.audit.handlers.csv
Command line interface for verifying an archived set of tamper evident CSV audit log files for a particular topic.
CsvSecurity() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity
 
cty(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the content type header parameter for this JWS.
CTY - Enum constant in enum class org.forgerock.json.jose.jws.JwsHeaderKey
Content Type header parameter.
curve(Key) - Static method in class org.forgerock.json.jose.utils.XECUtils
Returns the curve that this XECKey is for.
curve(SupportedEllipticCurve) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the elliptic curve that this key uses.
CUSTOM - Enum constant in enum class org.forgerock.json.jose.jwe.JweHeaderKey
Generic header key for a custom header parameter.
CUSTOM - Enum constant in enum class org.forgerock.json.jose.jws.JwsHeaderKey
Generic header key for a custom header parameter.
CUSTOM - Enum constant in enum class org.forgerock.json.jose.jwt.JwtClaimsSetKey
Custom (private) Claim.
CUSTOM - Enum constant in enum class org.forgerock.json.jose.jwt.JwtHeaderKey
Generic header key for a custom header parameter.
customAdvicesResponse(Context, Request, List<AbstractConditionAdviceFilter.Advice>) - Method in class org.forgerock.openig.openam.AbstractConditionAdviceFilter
Provide extenders a change to provide a custom advices response.
CustomProxyOptions - Class in org.forgerock.openig.proxy
A ProxyOptions representing custom proxy settings.
CustomProxyOptions(URI) - Constructor for class org.forgerock.openig.proxy.CustomProxyOptions
Create a new CustomProxyOptions without login/password.
CustomProxyOptions(URI, String, SecretReference<GenericSecret>) - Constructor for class org.forgerock.openig.proxy.CustomProxyOptions
Creates a new CustomProxyOptions with login/password.
CustomProxyOptions.Heaplet - Class in org.forgerock.openig.proxy
Creates and initializes a CustomProxyOptions in a heap environment.
CustomProxyOptionsTypeProvider - Class in org.forgerock.openig.proxy
Provide the CustomProxyOptions's TypeDefinition.
CustomProxyOptionsTypeProvider() - Constructor for class org.forgerock.openig.proxy.CustomProxyOptionsTypeProvider
 

D

d(String) - Method in class org.forgerock.json.jose.jwk.EcJWK.Builder
Set the unsigned big-endian base64 url encoding of the d value for the elliptical curve private key.
d(String) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the private key d-value of the key.
DAEMON - Enum constant in enum class org.forgerock.audit.handlers.syslog.Facility
System daemons.
data - Variable in class org.forgerock.services.context.AbstractContext
The Context data.
DATA_CLAIM - Static variable in class org.forgerock.openig.assertion.IdentityRequestJwtContext
The identity request data claim name.
DATA_DECRYPTION - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for decrypting data.
DATA_ENCRYPTION - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for encrypting data.
dataClaims() - Method in class org.forgerock.openig.assertion.IdentityRequestJwtContext
Returns any data claims from the Identity Request JWT.
DataDecryptionKey - Class in org.forgerock.secrets.keys
A key that is used for decrypting confidential data.
DataDecryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.DataDecryptionKey
Initialises the key with the given secret data.
DataEncryptionKey - Class in org.forgerock.secrets.keys
A key that is used for encrypting confidential data.
DataEncryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.DataEncryptionKey
Initialises the key with the given secret data.
DataPreservationFilter - Class in org.forgerock.openig.filter
The DataPreservationFilter supports preserving POSTed data from a request that triggers a login redirect.
DataPreservationFilter(String, int, Randoms.UrlFriendlyRandomStringGenerator, Duration, Clock) - Constructor for class org.forgerock.openig.filter.DataPreservationFilter
Creates a new DataPreservationFilter.
DataPreservationFilter.Heaplet - Class in org.forgerock.openig.filter
Create a DataPreservationFilter heap object.
DataPreservationFilterTypeProvider - Class in org.forgerock.openig.filter
A TypeDefinitionProvider for DataPreservationFilter.
DataPreservationFilterTypeProvider() - Constructor for class org.forgerock.openig.filter.DataPreservationFilterTypeProvider
 
DateHeaderFilter - Class in org.forgerock.openig.filter
This filter inserts a Date header into the response if it is not present.
DateHeaderFilter(Clock) - Constructor for class org.forgerock.openig.filter.DateHeaderFilter
Creates a DateHeaderFilter.
DateHeaderFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a DateHeaderFilter in a heap environment.
DEBUG - Enum constant in enum class org.forgerock.audit.handlers.syslog.Severity
Debug-level messages.
Declaration(String, Heaplet) - Constructor for record class org.forgerock.openig.heap.DefaultDeclarationProvider.Declaration
Alternative constructor when no config is needed.
Declaration(String, Heaplet, JsonValue) - Constructor for record class org.forgerock.openig.heap.DefaultDeclarationProvider.Declaration
Alternative constructor when no decorator is needed.
Declaration(String, Heaplet, JsonValue, Map<String, JsonValue>) - Constructor for record class org.forgerock.openig.heap.DefaultDeclarationProvider.Declaration
Public constructor.
decode(byte[]) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded byte array.
decode(byte[], String) - Method in enum class org.forgerock.secrets.keys.KeyType
Attempts to decode an encoded key value of the given type into an appropriate key object for the given algorithm.
decode(char[]) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded char array.
decode(Flowable<ByteBuffer>) - Method in interface org.forgerock.http.decoder.FlowableDecoder
Returns an instance of a flowable that decodes the specified input.
decode(Flowable<ByteBuffer>) - Method in class org.forgerock.http.header.ContentEncodingHeader
Returns a flowable that decodes the specified flowable, given the content-codings that are specified in the codings list.
decode(InputStream) - Method in interface org.forgerock.http.decoder.Decoder
Returns an instance of an input stream that decodes the specified input.
decode(InputStream) - Method in class org.forgerock.http.header.ContentEncodingHeader
Returns an input stream that decodes the specified input stream, given the content-codings that are specified in the codings list.
decode(String) - Method in class org.forgerock.openig.secrets.Base64PropertyFormat
 
decode(String) - Method in class org.forgerock.secrets.propertyresolver.JwkPropertyFormat
 
decode(String) - Method in class org.forgerock.secrets.propertyresolver.JwtWrappedPropertyFormat
 
decode(String) - Method in class org.forgerock.secrets.propertyresolver.PemPropertyFormat
 
decode(String) - Method in enum class org.forgerock.secrets.propertyresolver.PropertyFormatBase64
 
decode(String) - Method in class org.forgerock.secrets.propertyresolver.SecretKeyPropertyFormat
 
decode(String) - Method in interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat
Decodes the input property value, setting relevant properties on a SecretBuilder object.
decode(String) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded String.
decode(String) - Static method in class org.forgerock.util.encode.Base64url
Decodes the given Base64url encoded String into a byte array.
decode(String) - Static method in class org.forgerock.util.encode.Hex
Decodes a hexadecimal-encoded string into an equivalent byte array, treating each two-character sequence as a single byte in big-endian order.
decode(Charset) - Static method in class org.forgerock.http.io.CharsetDecoderFlowableTransformer
Decodes a flow of ByteBuffer into a flow of CharBuffer using the given Charset.
decode(Supplier<CharsetDecoder>) - Static method in class org.forgerock.http.io.CharsetDecoderFlowableTransformer
Decodes a flow of ByteBuffer into a flow of CharBuffer using the given CharsetDecoder supplier.
decode(Supplier<CharsetDecoder>, int, Supplier<CharBuffer>) - Static method in class org.forgerock.http.io.CharsetDecoderFlowableTransformer
Decodes a flow of ByteBuffer into a flow of CharBuffer using the given CharBuffer and CharsetDecoder suppliers.
decodeBase64(String) - Static method in class org.forgerock.openig.el.Functions
Decode the given Base64 String input.
decodeBase64url(String) - Static method in class org.forgerock.openig.el.Functions
Decode the given Base64url String input.
decodeCoordinate(String) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Decode the unsigned big-endian base64 url encoding of an elliptical curve point.
decodedContentAsFlowable(Charset) - Method in class org.forgerock.http.protocol.Entity
Returns a publisher of chars representing decoded content of this entity, honouring the charset if provided.
decodeEcdsaSignature(byte[], int) - Static method in class org.forgerock.json.jose.utils.DerUtils
Minimal DER decoder for the format returned by the SunEC signature provider.
decodeFast(byte[]) - Static method in class org.forgerock.util.encode.Base64
Deprecated.
decodeFast(char[]) - Static method in class org.forgerock.util.encode.Base64
Deprecated.
decodeFast(String) - Static method in class org.forgerock.util.encode.Base64
Deprecated.
decodeJwtComponent(String) - Static method in class org.forgerock.json.jose.utils.Utils
Decodes the given String and converts the decoded bytes into a UTF-8 String.
Decoder - Interface in org.forgerock.http.decoder
Decodes an HTTP message entity input stream.
decodeStrict(byte[]) - Static method in class org.forgerock.util.encode.Base64
Decodes the input using a strict decoder that rejects any invalid characters or line separators.
decodeStrict(char[]) - Static method in class org.forgerock.util.encode.Base64
Decodes the input using a strict decoder that rejects any invalid characters or line separators.
decodeStrict(String) - Static method in class org.forgerock.util.encode.Base64
Decodes the input using a strict decoder that rejects any invalid characters or line separators.
decodeStrict(String) - Static method in class org.forgerock.util.encode.Base64url
Decodes the given Base64url encoded String into a byte array.
decodeStrict(String) - Static method in class org.forgerock.util.encode.Hex
Decodes a hexadecimal-encoded string into an equivalent byte array, treating each two-character sequence as a single byte in big-endian order.
decodeToPromise(byte[]) - Method in interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat
Decodes the data as a UTF-8 string and then calls SecretPropertyFormat.decodeToPromise(String) to decode the string value.
decodeToPromise(byte[]) - Method in interface org.forgerock.secrets.SecretDecoder
Decodes the raw data retrieved from a backend into a SecretBuilder for further processing.
decodeToPromise(String) - Method in class org.forgerock.secrets.propertyresolver.JwtWrappedPropertyFormat
 
decodeToPromise(String) - Method in class org.forgerock.secrets.propertyresolver.PemPropertyFormat
 
decodeToPromise(String) - Method in interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat
Decodes the input property value, setting relevant properties on a SecretBuilder object.
decodeToString(String) - Static method in class org.forgerock.util.encode.Base64url
Decodes the given Base64url encoded string into a String.
decompress(byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.compression.CompressionHandler
Applies the compression algorithm to decompress the given array of bytes.
decompress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.DeflateCompressionHandler
Applies the compression algorithm to decompress the given array of bytes.
decompress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.NOPCompressionHandler
Simply returns the same byte array as it is given.
decompress(CompressionAlgorithm, String) - Method in class org.forgerock.json.jose.jwe.CompressionManager
Convenience method equivalent to getCompressionHandler(compressionAlgorithm).decompress(Base64url.decode(data)).
decorate(Object, JsonValue, Context) - Method in class org.forgerock.openig.decoration.baseuri.BaseUriDecorator
 
decorate(Object, JsonValue, Context) - Method in class org.forgerock.openig.decoration.capture.CaptureDecorator
 
decorate(Object, JsonValue, Context) - Method in interface org.forgerock.openig.decoration.Decorator
Decorates the provided delegate instance with the provided decoratorConfig configuration.
decorate(Object, JsonValue, Context) - Method in class org.forgerock.openig.decoration.global.GlobalDecorator
Decorate the given object instance with the previously declared set of decorations instead of the provided one.
decorate(Object, JsonValue, Context) - Method in class org.forgerock.openig.decoration.global.NoOpGlobalDecorator
 
decorate(Object, JsonValue, Context) - Method in class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Deprecated.
 
decorate(Object, JsonValue, Context) - Method in class org.forgerock.openig.decoration.timer.TimerDecorator
 
decorateContext(Context) - Method in interface org.forgerock.services.routing.RouteMatch
Decorates the given context with any routing information for the route.
decorated(String) - Method in class org.forgerock.openig.heap.Name
Returns this name with the last segment adapted to include the decorator name.
decorateFilter(Filter, JsonValue, Context) - Method in class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Deprecated.
Decorates the provided delegate Filter instance with the provided decoratorConfig configuration.
decorateHandler(Handler, JsonValue, Context) - Method in class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Deprecated.
Decorates the provided delegate Handler instance with the provided decoratorConfig configuration.
DecorationHandle - Class in org.forgerock.openig.decoration
A DecorationHandle is handle to get the decorated object and being able to notify the decoration to stop.
DecorationHandle(Object) - Constructor for class org.forgerock.openig.decoration.DecorationHandle
Constructs a DecorationHandle.
DecorationHandle(Object, Runnable) - Constructor for class org.forgerock.openig.decoration.DecorationHandle
Constructs a DecorationHandle.
decorations() - Method in record class org.forgerock.openig.heap.DefaultDeclarationProvider.Declaration
Returns the value of the decorations record component.
Decorator - Interface in org.forgerock.openig.decoration
A Decorator is responsible for decorating existing object's instances.
DecoratorHeaplet - Class in org.forgerock.openig.decoration.helper
A base class for decorator heaplets.
DecoratorHeaplet() - Constructor for class org.forgerock.openig.decoration.helper.DecoratorHeaplet
Can only be called by sub-classes.
decrypt(String, Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler
Deprecated.
Decrypts the given ciphertext using the private key and with the same encryption algorithm that was used in the encryption.
decrypt(String, Key, byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler
Deprecated.
Decrypts the given ciphertext using the private key and initialisation vector with the same encryption algorithm that was used in the encryption.
decrypt(Key) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
decrypt(Key) - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
decrypt(SecretsProvider, Purpose<? extends CryptoKey>) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
Attempts to decrypt the JWT using any available keys for the given Purpose from the given SecretsProvider.
decrypt(SecretsProvider, Purpose<? extends CryptoKey>) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
 
decrypt(SecretsProvider, Purpose<? extends CryptoKey>) - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
Decrypts the inner encrypted JWE so that the payload can be accessed.
decrypt(ValidSecretsReference<? extends CryptoKey, NeverThrowsException>) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
Attempts to decrypt the JWT using any available keys from the given ValidSecretsReference.
decrypt(ValidSecretsReference<? extends CryptoKey, NeverThrowsException>) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
 
decrypt(ValidSecretsReference<? extends CryptoKey, NeverThrowsException>) - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
Decrypts the inner encrypted JWE so that the payload can be accessed.
DECRYPT - Enum constant in enum class org.forgerock.json.jose.jwk.KeyOperation
Use Key to decrypt content and validate decryption, if applicable.
DECRYPT - Enum constant in enum class org.forgerock.secrets.keys.KeyUsage
Key is intended for decrypting data directly.
decryptAndVerify(Key, SigningHandler) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
decryptAndVerify(SecretsProvider, Purpose<? extends CryptoKey>, Purpose<VerificationKey>) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
Decrypts the outer JWT and then verifies the signature on the inner JWT using secrets from the supplied SecretsProvider.
decryptAndVerify(ValidSecretsReference<? extends CryptoKey, NeverThrowsException>, ValidSecretsReference<VerificationKey, NeverThrowsException>) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
Decrypts the outer JWT and then verifies the signature on the inner JWT using supplied valid secrets.
decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler
Deprecated.
Decrypts the ciphertext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.
decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler
 
decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
 
decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.ECDHEncryptionHandler
 
decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler
Decrypts the ciphertext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.
decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler
Decrypts the ciphertext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.
decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler
Deprecated.
Decrypts the JWE Encrypted Key to produce the Content Encryption Key (CEK).
decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler
 
decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
 
decryptContentEncryptionKey(Key, byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler
decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler
Decrypts the JWE Encrypted Key to produce the Content Encryption Key (CEK).
decryptContentEncryptionKey(Key, byte[], JweHeader) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler
Deprecated.
Decrypts the JWE Encrypted Key to produce the Content Encryption Key (CEK).
decryptContentEncryptionKey(Key, byte[], JweHeader) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.ECDHEncryptionHandler
 
decryptContentEncryptionKey(Key, byte[], JweHeader) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler
Decrypts the Content Encryption Key (CEK) following the appropriate steps defined by the EncryptionHandler JweAlgorithm.
DecryptionKey<T extends CryptoKey> - Interface in org.forgerock.secrets.keys
Marker interface for all key types that can be used for decryption.
decryptionPurpose(Purpose<? extends CryptoKey>) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder
Specifies the Purpose used to retrieve decryption keys from the secrets provider.
decryptRawPayload(Key) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
decryptRawPayload(SecretsProvider, Purpose<? extends CryptoKey>) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
Attempts to decrypt the raw payload of the JWT using any keys from the given SecretsProvider that satisfy the supplied Purpose.
decryptRawPayload(ValidSecretsReference<? extends CryptoKey, NeverThrowsException>) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
Attempts to decrypt the raw payload of the JWT using any keys from the given the Secrets contained in the given ValidSecretsReference.
deepTransformBy(Function<JsonValue, ?, JsonValueException>) - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON value as the result of a deep JsonValue object-traversal, applying the provided transform function to each element.
DEF - Enum constant in enum class org.forgerock.json.jose.jwe.CompressionAlgorithm
A lossless compressed data format that compresses data using a combination of the LZ77 algorithm and Huffman coding.
DEFAULT - Enum constant in enum class org.forgerock.util.thread.listener.ShutdownPriority
DEFAULT is the priority pre-defined in the system.
DEFAULT - Static variable in interface org.forgerock.util.generator.IdGenerator
The default implementation of IdGenerator.
DEFAULT_AM_VERSION - Static variable in class org.forgerock.openig.tools.am.AmService
AM 6.0.0.
DEFAULT_CASE_INSENSITIVE_FIELDS - Static variable in class org.forgerock.audit.AuditServiceConfiguration
DEFAULT_ISSUER_REPOSITORY_HEAP_KEY - Static variable in class org.forgerock.openig.filter.oauth2.client.IssuerRepository.Heaplet
The heap key of an issuer repository guaranteed to be present in the Heap.
DEFAULT_PROTOCOL_VERSION - Static variable in class org.forgerock.json.resource.http.HttpUtils
The default version of the named protocol.
DEFAULT_ROTATION_FILE_SUFFIX - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
The default file rotation suffix format.
DEFAULT_SESSION_TIMEOUT - Static variable in class org.forgerock.openig.session.jwt.JwtSessionFilterHeaplet
Default sessionTimeout duration.
DEFAULT_TMP_FILE_LIMIT - Static variable in class org.forgerock.http.io.IO
1 GiB.
DEFAULT_TMP_INIT_LENGTH - Static variable in class org.forgerock.http.io.IO
8 KiB.
DEFAULT_TMP_MEMORY_LIMIT - Static variable in class org.forgerock.http.io.IO
64 KiB.
DEFAULT_TOKEN_KEY - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
The expression which will be used for storing authorization information in the context.
DefaultDeclarationProvider - Interface in org.forgerock.openig.heap
This interface has to be implemented by each Identity Gateway module that wants to register new default heaplet declaration to put in the Gateway heap.
DefaultDeclarationProvider.Declaration - Record Class in org.forgerock.openig.heap
A Heaplet declaration definition.
defaultDeclarations() - Method in class org.forgerock.openig.filter.oauth2.OAuth2DefaultDeclarationProvider
 
defaultDeclarations() - Method in class org.forgerock.openig.heap.CoreDefaultDeclarationProvider
 
defaultDeclarations() - Method in interface org.forgerock.openig.heap.DefaultDeclarationProvider
Return every Heaplet declaration to add to the main heap.
DefaultEnvironment - Class in org.forgerock.openig.config.env
Reify the normal environment structure with pre-configured shortcuts.
DefaultEnvironment(File) - Constructor for class org.forgerock.openig.config.env.DefaultEnvironment
Builds a new file based Environment using the given file as the instance directory.
DefaultEnvironment(File, File) - Constructor for class org.forgerock.openig.config.env.DefaultEnvironment
Builds a new file based Environment using the given file as the instance directory.
defaultFailureHandler(Context, Request) - Method in class org.forgerock.openig.handler.saml.AbstractSamlFederationHeaplet
The default failure handler to use should none be provided in the configuration.
defaultKey() - Method in record class org.forgerock.openig.tools.ServerTlsOptions.SniConfiguration
Returns the value of the defaultKey record component.
DefaultKeyStoreHandlerProvider - Class in org.forgerock.audit.providers
Default implementation of KeyStoreHandlerProvider.
DefaultKeyStoreHandlerProvider() - Constructor for class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider
Creates a initially empty provider.
DefaultKeyStoreHandlerProvider(Map<String, KeyStoreHandler>) - Constructor for class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider
Creates a provider with some KeyStoreHandler instances.
DefaultLocalHostNameProvider - Class in org.forgerock.audit.providers
Default implementation of LocalHostNameProvider using InetAddress to lookup host name of local host.
DefaultLocalHostNameProvider() - Constructor for class org.forgerock.audit.providers.DefaultLocalHostNameProvider
 
defaultOidcJwkSetUri() - Method in class org.forgerock.openig.tools.am.AmService
Returns the default Open ID Connect JWK Set URI exposed by AM.
defaultOptions() - Static method in class org.forgerock.util.Options
Returns a new set of options with default settings.
DefaultRateThrottlingPolicy - Class in org.forgerock.openig.filter.throttling
A DefaultRateThrottlingPolicy is a delegating ThrottlingPolicy that ensures the returned ThrottlingRate is never null.
DefaultRateThrottlingPolicy(ThrottlingRate, ThrottlingPolicy) - Constructor for class org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicy
Constructs a new DefaultRateThrottlingPolicy.
DefaultRateThrottlingPolicyHeaplet - Class in org.forgerock.openig.filter.throttling
Creates and initializes a DefaultRateThrottlingPolicy in a heap environment.
DefaultRateThrottlingPolicyHeaplet() - Constructor for class org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet
 
DefaultScriptFactoryManager - Class in org.forgerock.openig.script
Default implementation of ScriptFactoryManager supporting dynamic registration and un-registration of ScriptFactory.
DefaultScriptFactoryManager() - Constructor for class org.forgerock.openig.script.DefaultScriptFactoryManager
 
DefaultSecureStorageProvider - Class in org.forgerock.audit.providers
Default implementation of SecureStorageProvider.
DefaultSecureStorageProvider() - Constructor for class org.forgerock.audit.providers.DefaultSecureStorageProvider
Creates a initially empty provider.
DefaultSecureStorageProvider(Map<String, SecureStorage>) - Constructor for class org.forgerock.audit.providers.DefaultSecureStorageProvider
Creates a provider with some storages instances.
defaultTo(Object) - Method in class org.forgerock.json.JsonValue
Defaults the JSON value to the specified value if it is currently null.
DefaultVersionBehaviour - Enum Class in org.forgerock.http.routing
The default routing behaviour to use when no Accept-API-Version is set on the request.
DeflateCompressionHandler - Class in org.forgerock.json.jose.jwe.handlers.compression
An implementation of the CompressionHandler for DEFLATE Compressed Data Format Specification.
DeflateCompressionHandler() - Constructor for class org.forgerock.json.jose.jwe.handlers.compression.DeflateCompressionHandler
 
delay(Duration) - Method in class org.forgerock.openig.filter.RetryFilter.Builder
Set the delay between each tries.
DelegateHeaplet - Class in org.forgerock.openig.decoration
This heaplet aims to be be a placeholder so you can decorate the delegate object with any decorators.
DelegateHeaplet() - Constructor for class org.forgerock.openig.decoration.DelegateHeaplet
 
DelegateTypeProvider - Class in org.forgerock.openig.decoration
Provide the Delegate's TypeDefinition.
DelegateTypeProvider() - Constructor for class org.forgerock.openig.decoration.DelegateTypeProvider
 
DelegatingRouteMatcher<R> - Class in org.forgerock.services.routing
A route matcher that delegates to a provided route matcher.
DelegatingRouteMatcher(RouteMatcher<R>) - Constructor for class org.forgerock.services.routing.DelegatingRouteMatcher
Create a new route matcher, delegating to the provided delegate.
delete(String, String) - Method in class org.forgerock.openig.ui.record.RecordService
Deletes a Record identified by id (possibly at a given revision), returns null if not found.
delete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
 
delete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Deletes a JSON resource.
delete(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.Connection
Deletes a JSON resource.
DELETE - Enum constant in enum class org.forgerock.json.resource.RequestType
A delete request.
deleteAsync(Context, DeleteRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Asynchronously deletes a JSON resource.
deleteAsync(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.Connection
Asynchronously deletes a JSON resource.
deleteFiles(boolean, FileNamingPolicy) - Method in class org.forgerock.audit.retention.DiskSpaceUsedRetentionPolicy
 
deleteFiles(boolean, FileNamingPolicy) - Method in class org.forgerock.audit.retention.FreeDiskSpaceRetentionPolicy
 
deleteFiles(boolean, FileNamingPolicy) - Method in interface org.forgerock.audit.retention.RetentionPolicy
Returns all files that should be deleted according to the policy.
deleteFiles(boolean, FileNamingPolicy) - Method in class org.forgerock.audit.retention.SizeBasedRetentionPolicy
 
deleteInstance(Context, String, DeleteRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider
Removes a resource instance from the collection.
deleteInstance(Context, String, DeleteRequest) - Method in class org.forgerock.json.resource.MemoryBackend
Removes a resource instance from the collection.
deleteInstance(Context, String, DeleteRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
DeleteRequest - Interface in org.forgerock.json.resource
A request to delete a JSON resource.
DeliveryModeConfig - Enum Class in org.forgerock.audit.handlers.jms
Configuration wrapper for JMS DeliveryMode persistence constants.
denormalizeJson(JsonValue) - Static method in class org.forgerock.audit.util.ElasticsearchUtil
De-normalizes JSON that was previously normalized by ElasticsearchUtil.normalizeJson(JsonValue).
DependencyProvider - Interface in org.forgerock.audit
An interface for a simple dependency provider.
DependencyProviderAuditEventHandlerFactory - Class in org.forgerock.audit.events.handlers
AuditEventFactory capable of performing construction injection by resolving dependencies using a DependencyProvider.
DependencyProviderAuditEventHandlerFactory(DependencyProvider) - Constructor for class org.forgerock.audit.events.handlers.DependencyProviderAuditEventHandlerFactory
Construct a new instance.
DependencyProviderBase - Class in org.forgerock.audit
Base DependencyProvider that has provides no dependencies.
DependencyProviderBase() - Constructor for class org.forgerock.audit.DependencyProviderBase
 
deploy(String, String, JsonValue) - Method in class org.forgerock.openig.handler.router.RouterHandler
Deploy a route, meaning that it loads it but also stores it in a file.
deregister() - Method in class org.forgerock.openig.util.StartupMetrics
Deregister the startup metric when it is no longer required.
DERIVE_BITS - Enum constant in enum class org.forgerock.json.jose.jwk.KeyOperation
Use Key to derive bits not to be used as a key.
DERIVE_KEY - Enum constant in enum class org.forgerock.json.jose.jwk.KeyOperation
Use Key to derive key.
DerUtils - Class in org.forgerock.json.jose.utils
Utility methods for reading and writing DER-encoded values.
descendingOrder(String) - Static method in class org.forgerock.json.resource.SortKey
Creates a new descending-order sort key for the provided JSON field.
descendingOrder(JsonPointer) - Static method in class org.forgerock.json.resource.SortKey
Creates a new descending-order sort key for the provided JSON field.
Describable<D,R> - Interface in org.forgerock.services.descriptor
A routing component (a CHF Handler or CREST RequestHandler) can describe its API by implementing this interface.
Describable.Listener - Interface in org.forgerock.services.descriptor
Interface for listener instances.
DescribableHandler - Interface in org.forgerock.http.handler
A handler that both handles Requests, and also supports querying for API Descriptors.
describedHttpApplication(Handler, Factory<Buffer>, ApiProducer<Swagger>) - Static method in class org.forgerock.http.Applications
Create a simple DescribedHttpApplication that just returns the provided arguments from the appropriate methods.
DescribedHttpApplication - Interface in org.forgerock.http
An HttpApplication that produces OpenAPI API Descriptors.
DescribedSyncRequestHandlerAdapter - Class in org.forgerock.json.resource
Version of SynchronousRequestHandlerAdapter that exposes a described handler.
description() - Method in record class org.forgerock.openig.tools.jwt.validation.Violation
Returns the value of the description record component.
destroy() - Method in class org.forgerock.openig.audit.AuditServiceObjectHeaplet
 
destroy() - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
 
destroy() - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Heaplet
 
destroy() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter.Heaplet
 
destroy() - Method in class org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet
 
destroy() - Method in class org.forgerock.openig.handler.HttpClientHandlerHeaplet
 
destroy() - Method in class org.forgerock.openig.handler.ReverseProxyHandlerHeaplet
 
destroy() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
 
destroy() - Method in class org.forgerock.openig.handler.saml.AbstractSamlFederationHeaplet
 
destroy() - Method in class org.forgerock.openig.heap.GenericHeaplet
 
destroy() - Method in class org.forgerock.openig.heap.HeapImpl
Destroys the objects on the heap and dereferences all associated objects.
destroy() - Method in interface org.forgerock.openig.heap.Heaplet
Called to indicate that the object created by the heaplet is going to be dereferenced.
destroy() - Method in class org.forgerock.openig.openam.AmServiceHeaplet
 
destroy() - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter.Heaplet
 
destroy() - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
destroy() - Method in class org.forgerock.openig.secrets.FileSystemSecretStoreHeaplet
 
destroy() - Method in class org.forgerock.openig.secrets.KeyStoreSecretStoreHeaplet
 
destroy() - Method in class org.forgerock.openig.sql.JdbcDataSourceHeaplet
 
destroy() - Method in class org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet
 
DETAIL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The detail event payload field name.
determineRequestType(Request) - Static method in class org.forgerock.json.resource.http.HttpUtils
Determines which CREST operation (CRUDPAQ) of the incoming request.
DEVELOPMENT - Enum constant in enum class org.forgerock.openig.http.RunMode
Denotes a mode where openness (and not security) is the focus (default mode).
diff(JsonValue) - Method in class org.forgerock.json.JsonValue
Performs a deep comparison of this JSON vlaue with another JSON value, and produces a JSON Patch value, which contains the operations necessary to modify the current value to arrive at the target value.
diff(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch
Compares two JSON values, and produces a JSON Patch value, which contains the operations necessary to modify the original value to arrive at the target value.
digestSha256(Object) - Static method in class org.forgerock.openig.el.Functions
Calculate the SHA256 hash of the incoming object, which may be a byte array or a string.
DIRECT - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
Direct encryption with a shared symmetric key.
DIRECT - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithmType
Direct symmetric encryption.
DirectAmLink - Class in org.forgerock.openig.tools.notifications.ws.link
Manage the WebSocketAdapter and run subscribe and unsubscribe operations on it.
DirectEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Supports direct encryption using a shared symmetric key.
DirectEncryptionHandler(EncryptionMethod) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
Constructs the direct encryption handler for the given content encryption method.
directive(String, String) - Static method in class org.forgerock.http.header.Directive
Return a Directive based on the name and value, if value was quoted then this is also captured.
Directive - Class in org.forgerock.http.header
Represents the name/value pair of a HTTP header directives.
DirectoryWatcher - Class in org.forgerock.util
High-level interface to the WatchService API for detecting filesystem change events.
DirectoryWatcher(ScheduledExecutorService, WatchEvent.Modifier...) - Constructor for class org.forgerock.util.DirectoryWatcher
Initializes the directory watcher.
DirectoryWatcher.ChangeListener - Class in org.forgerock.util
A change listener for a single directory that can be used to register notification callbacks and to cancel observing this directory.
DirtyCollection<E> - Class in org.forgerock.openig.session.jwt.dirty
A Collection decorator that notifies the provided DirtyListener when one ore more elements are removed.
DirtyCollection(Collection<E>, DirtyListener) - Constructor for class org.forgerock.openig.session.jwt.dirty.DirtyCollection
Builds a new DirtyCollection delegating to the given Collection and notifying the provided observer.
DirtyIterator<E> - Class in org.forgerock.openig.session.jwt.dirty
An Iterator decorator that notifies the provided DirtyListener when one element is removed.
DirtyIterator(Iterator<E>, DirtyListener) - Constructor for class org.forgerock.openig.session.jwt.dirty.DirtyIterator
Builds a new DirtyIterator delegating to the given Iterator and notifying the provided observer.
DirtyListener - Interface in org.forgerock.openig.session.jwt.dirty
Enable observers to be notified when one or more element are removed from a Map.
DirtySet<E> - Class in org.forgerock.openig.session.jwt.dirty
A Set decorator that notifies the provided DirtyListener when one ore more elements are removed.
DirtySet(Set<E>, DirtyListener) - Constructor for class org.forgerock.openig.session.jwt.dirty.DirtySet
Constructs a new set decorator, wrapping the specified set.
disableCaching() - Static method in class org.forgerock.json.resource.ResponseCacheControl
Indicates that clients and proxies should never cache the response under any circumstances.
DISCONNECTED_OPERATION - Static variable in class org.forgerock.http.header.WarningHeader
112 Disconnected operation SHOULD be included if the cache is intentionally disconnected from the rest of the network for a period of time.
DISCONNECTED_OPERATION - Static variable in class org.forgerock.json.resource.AdviceWarning
112 Disconnected operation SHOULD be included if the cache is intentionally disconnected from the rest of the network for a period of time.
DISCONNECTION - Enum constant in enum class org.forgerock.openig.tools.notifications.ConnectionEvent
Sent when a notification session is terminated (for any reason).
disconnectionStrategy(DisconnectionStrategy) - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Builder
Bind a DisconnectionStrategy instance to this builder.
DisconnectionStrategy - Enum Class in org.forgerock.openig.tools.notifications
The different behaviours that can be applied in case of notifications disconnections.
discover(Clock) - Method in class org.forgerock.openig.tools.am.AmService.Discovery
Will Call AM instance to get missing information in order to create the AmService builder.
discovery(URI, Realm, String, Version, String, SecretReference<GenericSecret>, Handler) - Static method in class org.forgerock.openig.tools.am.AmService
Create an AM Discovery object which will get information from AM upon building.
DiscoveryException - Exception in org.forgerock.openig.filter.oauth2.client
Represents an exception whilst performing OpenID discovery.
DiscoveryException(String) - Constructor for exception org.forgerock.openig.filter.oauth2.client.DiscoveryException
Builds an DiscoveryException with a given message.
DiscoveryException(String, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.DiscoveryException
Builds an DiscoveryException with a given message and cause.
DiscoveryFilter - Class in org.forgerock.openig.filter.oauth2.client
In order for an OpenID Connect Relying Party to utilize OpenID Connect services for an End-User, the RP needs to know where the OpenID Provider is.
DiskSpaceUsedRetentionPolicy - Class in org.forgerock.audit.retention
A RetentionPolicy that will retain/delete log files based off the total disk space used.
DiskSpaceUsedRetentionPolicy(long) - Constructor for class org.forgerock.audit.retention.DiskSpaceUsedRetentionPolicy
Constructs a DiskSpaceUsedRetentionPolicy with a given maximum of disk space to use in bytes.
DispatchHandler - Class in org.forgerock.openig.handler
Dispatches to one of a list of handlers.
DispatchHandler() - Constructor for class org.forgerock.openig.handler.DispatchHandler
 
DispatchHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a dispatch handler in a heap environment.
DispatchHandlerTypeProvider - Class in org.forgerock.openig.handler
Provide DispatchHandler's TypeDefinition.
DispatchHandlerTypeProvider() - Constructor for class org.forgerock.openig.handler.DispatchHandlerTypeProvider
 
doFilter(String, JsonValue) - Method in interface org.forgerock.audit.filter.Filter
Runs a filter on the given audit event.
doImport(JsonValue, Model, String) - Method in class org.forgerock.openig.types.importer.RouteImporter
Import the given routeJson into a fully loaded component instance model.
done() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder
Marks the end to the building of the JWT header.
doRedirect(Context, Request, Handler, List<AbstractConditionAdviceFilter.Advice>, URI) - Method in class org.forgerock.openig.openam.AbstractConditionAdviceFilter
Handle redirect to the instance to verify the required advices.
doRedirect(Context, Request, Handler, List<AbstractConditionAdviceFilter.Advice>, URI) - Method in class org.forgerock.openig.openam.CdSsoConditionAdviceFilter
 
dotNotationToJsonPointer(String) - Static method in class org.forgerock.audit.events.AuditEventHelper
Converts dotted-path field identifier to JsonPointer form.
DUPS_OK - Enum constant in enum class org.forgerock.audit.handlers.jms.SessionModeConfig
Dups-OK-acknowledge session mode.
duration() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a Duration.
duration(long, TimeUnit) - Static method in class org.forgerock.util.time.Duration
Provides a Duration, given a number and time unit.
duration(String) - Static method in class org.forgerock.openig.types.Values
Wrap a textual Duration as a StringValue.
duration(String) - Static method in class org.forgerock.util.time.Duration
Provides a Duration that represents the given duration expressed in english.
duration(Duration) - Static method in class org.forgerock.openig.types.Values
Wrap a Duration as a StringValue.
Duration - Class in org.forgerock.util.time
Represents a duration in english.
Duration(Long, TimeUnit) - Constructor for class org.forgerock.util.time.Duration
Deprecated.
DURATION_TYPE - Static variable in class org.forgerock.openig.types.TypeDefinitions
Represents the "Duration" type, which is a String with a specific Syntax.

E

E_ACCESS_DENIED - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The resource owner or authorization server denied the request.
E_ACCESS_DENIED - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating access denied.
E_INSUFFICIENT_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The request requires higher privileges than provided by the access token.
E_INVALID_CLIENT - Static variable in class org.forgerock.http.oauth2.OAuth2Error
Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).
E_INVALID_GRANT - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
E_INVALID_REQUEST - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed.
E_INVALID_REQUEST - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating invalid request.
E_INVALID_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
E_INVALID_TOKEN - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The access token provided is expired, revoked, malformed, or invalid for other reasons.
E_INVALID_TOKEN - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating invalid token.
E_SERVER_ERROR - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization server encountered an unexpected condition that prevented it from fulfilling the request.
E_SERVER_ERROR - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating server error.
E_TEMPORARILY_UNAVAILABLE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
E_UNAUTHORIZED_CLIENT - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authenticated client is not authorized to use this authorization grant type.
E_UNSUPPORTED_GRANT_TYPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization grant type is not supported by the authorization server.
E_UNSUPPORTED_RESPONSE_TYPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization server does not support obtaining an authorization code using this method.
EC - Enum constant in enum class org.forgerock.json.jose.jwk.KeyType
Elliptical Curve Key.
ECDH_ES - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
Elliptic Curve Diffie-Hellman (ECDH) key agreement, directly using the derived key for encryption.
ECDH_ES - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithmType
Elliptic Curve Diffie-Hellman (ECDH) key agreement in Ephemeral-Static (ES) configuration.
ECDH_ES_A128KW - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 128-bit AES Key Wrapping.
ECDH_ES_A192KW - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 192-bit AES Key Wrapping.
ECDH_ES_A256KW - Enum constant in enum class org.forgerock.json.jose.jwe.JweAlgorithm
Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 256-bit AES Key Wrapping.
ECDHEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Implements Elliptic Curve Diffie-Hellman (ECDH) key agreement in ephemeral-static (ECDH-ES) mode.
ECDSA - Enum constant in enum class org.forgerock.json.jose.jws.JwsAlgorithmType
Elliptic Curve DSA signing algorithm.
ECDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers
Deprecated.
ECDSASigningHandler(ECPrivateKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
Deprecated.
Constructs the ECDSA signing handler for signing only.
ECDSASigningHandler(ECPublicKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
Deprecated.
Constructs the ECDSA signing handler for verification only.
ECDSASigningHandler(PrivateKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
Deprecated.
Constructs the ECDSA signing handler for signing only.
EcJWK - Class in org.forgerock.json.jose.jwk
This class implements an Elliptical Curve Json Web Key storage and manipulation class.
EcJWK(String, String, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
Use the builder instead.
EcJWK(String, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
Use the builder instead.
EcJWK(ECPublicKey, String, String) - Constructor for class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
Use the builder instead.
EcJWK(ECPublicKey, ECPrivateKey, String, String) - Constructor for class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
Use the builder instead.
EcJWK.Builder - Class in org.forgerock.json.jose.jwk
EC JWK builder.
ED25519 - Enum constant in enum class org.forgerock.json.jose.jws.SupportedEllipticCurve
The Ed25519 curve used for EdDSA signatures.
ED448 - Enum constant in enum class org.forgerock.json.jose.jws.SupportedEllipticCurve
The Ed448 curve used for EdDSA signatures.
EDDSA - Enum constant in enum class org.forgerock.json.jose.jws.JwsAlgorithm
Edwards Curve DSA (EdDSA), as defined in RFC 8037.
EDDSA - Enum constant in enum class org.forgerock.json.jose.jws.JwsAlgorithmType
Edwards Curve DSA signing algorithm.
EdDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers
Deprecated.
ELAPSED_TIME - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The elapsed time event payload field name.
ELAPSED_TIME_UNITS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The elapsed time unit event payload field name.
elapsedTime() - Method in class org.forgerock.openig.util.StartupMetrics
Returns the current elapsed time since StartupMetrics.starting().
ElasticsearchAuditEventHandler - Class in org.forgerock.audit.handlers.elasticsearch
AuditEventHandler for Elasticsearch.
ElasticsearchAuditEventHandler(ElasticsearchAuditEventHandlerConfiguration, EventTopicsMetaData, Client) - Constructor for class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Create a new ElasticsearchAuditEventHandler instance.
ElasticsearchAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.elasticsearch
A configuration for Elasticsearch audit event handler.
ElasticsearchAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration
 
ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration - Class in org.forgerock.audit.handlers.elasticsearch
Configuration of connection to Elasticsearch.
ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration - Class in org.forgerock.audit.handlers.elasticsearch
Configuration of event buffering.
ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration - Class in org.forgerock.audit.handlers.elasticsearch
Configuration of index mapping.
ElasticsearchUtil - Class in org.forgerock.audit.util
Utilities for working with Elasticsearch.
EllipticCurveJwk - Interface in org.forgerock.json.jose.jwk
Encapsulates common functionality for JWKs that represent elliptic curve keys: EcJWK and OkpJWK.
ellipticCurveKeyParameters(ECParameterSpec) - Static method in interface org.forgerock.secrets.SecretConstraint
Enforces that the key is an elliptic curve key with the given parameters.
EMERGENCY - Enum constant in enum class org.forgerock.audit.handlers.syslog.Severity
System is unusable.
empty() - Static method in class org.forgerock.json.resource.ResourcePath
Returns the empty resource path whose string representation is the empty string and which has zero path elements.
empty() - Static method in class org.forgerock.openig.util.ProductInfo
Create a ProductInfo without any information.
empty() - Static method in class org.forgerock.util.Pair
Returns an empty Pair matching the required types.
EMPTY - Static variable in class org.forgerock.util.Pair
An empty Pair.
ENABLE_REVOCATION_CHECKING - Static variable in class org.forgerock.secrets.SecretsTrustManager
Whether the trust manager should perform recovation checking or not.
enc(EncryptionMethod) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Sets the Encryption Method header parameter for this JWE.
ENC - Enum constant in enum class org.forgerock.json.jose.jwe.JweHeaderKey
Encryption Method header parameter.
ENC - Static variable in class org.forgerock.json.jose.jwk.KeyUseConstants
Use Key as a encryption key.
encode(byte[]) - Static method in class org.forgerock.util.encode.Base64
This method is using Base64.encode(byte[], boolean), and it only exists so we don't break the API.
encode(byte[]) - Static method in class org.forgerock.util.encode.Base64url
Encodes the given byte array into a Base64url encoded String.
encode(byte[]) - Static method in class org.forgerock.util.encode.Hex
Encodes binary data into hexadecimal format.
encode(byte[], boolean) - Static method in class org.forgerock.util.encode.Base64
Encodes a raw byte array into a BASE64 String representation i accordance with RFC 2045.
encode(String) - Static method in class org.forgerock.util.encode.Base64url
Encodes the given UTF-8 encoded String into a Base64url encoded String.
encodeBase64(Object) - Static method in class org.forgerock.openig.el.Functions
Encode the given String input into Base64.
encodeBase64url(Object) - Static method in class org.forgerock.openig.el.Functions
Encode the given String input into Base64url.
encodeCoordinate(int, BigInteger) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Base64url encode the unsigned big-endian representation of an elliptical curve point.
encodeEcdsaSignature(byte[]) - Static method in class org.forgerock.json.jose.utils.DerUtils
Minimal DER encoder for the format expected by the SunEC signature provider.
encodeJwtComponent(String) - Static method in class org.forgerock.json.jose.utils.Utils
Encodes the given String, converting the String to UTF-8 bytes.
encodeLowerCase(byte[]) - Static method in class org.forgerock.util.encode.Hex
Encodes binary data into hexadecimal format using lowercase characters for 'a' to 'f'.
encodeRedirectUrl(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
Deprecated.
As of version 2.1, use encodeRedirectURL(String url) instead
encodeRedirectURL(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
 
encodeToByte(byte[], boolean) - Static method in class org.forgerock.util.encode.Base64
Encodes a raw byte array into a BASE64 byte[] representation i accordance with RFC 2045.
encodeToChar(byte[], boolean) - Static method in class org.forgerock.util.encode.Base64
Encodes a raw byte array into a BASE64 char[] representation i accordance with RFC 2045.
encodeUpperCase(byte[]) - Static method in class org.forgerock.util.encode.Hex
Encodes binary data into hexadecimal format using uppercase characters for 'A' to 'F'.
encodeUrl(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
Deprecated.
As of version 2.1, use encodeURL(String url) instead
encodeURL(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
 
encrypt(String, Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler
Deprecated.
Encrypts the given plaintext using the specified key with the specified encryption algorithm.
encrypt(String, Key, byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler
Deprecated.
Encrypts the given plaintext using the specified key and initialisation vector with the specified encryption algorithm.
encrypt(Key) - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
Deprecated.
encrypt(EncryptionKey<?>) - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
Wraps the signed JWT in an outer encrypted JWE envelope.
ENCRYPT - Enum constant in enum class org.forgerock.json.jose.jwk.KeyOperation
Use Key to encrypt content.
ENCRYPT - Enum constant in enum class org.forgerock.secrets.keys.KeyUsage
Key is intended for encrypting data directly.
EncryptedJwt - Class in org.forgerock.json.jose.jwe
A JWE implementation of the Jwt interface.
EncryptedJwt(EncryptedJwt) - Constructor for class org.forgerock.json.jose.jwe.EncryptedJwt
Construct an encrypted JWT from an existent one.
EncryptedJwt(JweHeader, String, byte[], byte[], byte[], byte[]) - Constructor for class org.forgerock.json.jose.jwe.EncryptedJwt
Constructs a reconstructed EncryptedJwt from its constituent parts, the JweHeader, encrypted Content Encryption Key (CEK), initialisation vector, ciphertext and additional authentication data.
EncryptedJwt(JweHeader, JwtClaimsSet, Key) - Constructor for class org.forgerock.json.jose.jwe.EncryptedJwt
Constructs a fresh, new EncryptedJwt from the given JweHeader and JwtClaimsSet.
EncryptedJwtBuilder - Class in org.forgerock.json.jose.builders
An implementation of a JwtBuilder that can build a JWT and encrypt it, resulting in an EncryptedJwt object.
EncryptedJwtBuilder(Key) - Constructor for class org.forgerock.json.jose.builders.EncryptedJwtBuilder
EncryptedJwtFactory - Class in org.forgerock.openig.tools.jwt.factory
Support for JWT encryption, both asymmetric and symmetric (authenticated encryption) are supported.
EncryptedJwtFactory(JweAlgorithm, EncryptionMethod, SecretReference<DataEncryptionKey>) - Constructor for class org.forgerock.openig.tools.jwt.factory.EncryptedJwtFactory
Create a new instance of an JwtFactory for EncryptedJwt.
encryptedPrivateKeyJwtClientAuthenticationFilter() - Static method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter
EncryptedPrivateKeyJwtClientAuthenticationFilter - Class in org.forgerock.http.oauth2
A Filter implementation to add the client credentials to request as signed then encrypted private key jwt as per the OpenID Connect Client Authentication specification.
EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder - Class in org.forgerock.http.oauth2
Builder class for creating the Encrypted PrivateKey Jwt ClientAuthentication Filter.
EncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet - Class in org.forgerock.openig.filter.oauth2.client.authentication
Heaplet supporting creation of an encrypted private-key-jwt authentication Filter.
EncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.authentication.EncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet
 
EncryptedThenSignedJwt - Class in org.forgerock.json.jose.jws
An implementation of a JWS with a nested JWE as its payload.
EncryptedThenSignedJwt(JwsHeader, EncryptedJwt, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
Constructs a reconstructed SignedEncryptedJwt from its constituent parts, the JwsHeader, nested Encrypted JWT, signing input and signature.
EncryptedThenSignedJwt(JwsHeader, EncryptedJwt, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
Constructs a fresh, new SignedEncryptedJwt from the given JwsHeader and nested Encrypted JWT.
EncryptedThenSignedJwtBuilder - Class in org.forgerock.json.jose.builders
An implementation of a JwtBuilder that can build a JWT and encrypt it and nest it within another signed JWT, resulting in an SignedEncryptedJwt object.
EncryptedThenSignedJwtBuilder(EncryptedJwtBuilder, SigningHandler, JwsAlgorithm) - Constructor for class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder
Constructs a new SignedEncryptedJwtBuilder that will use the given EncryptedJwtBuilder, to build the nested Encrypted JWT, and the private key and JwsAlgorithm to sign the outer JWT.
EncryptedThenSignedJwtHeaderBuilder - Class in org.forgerock.json.jose.builders
An implementation of a JWS Header builder that provides a fluent builder pattern to create JWS headers for signed encrypted JWTs.
EncryptedThenSignedJwtHeaderBuilder(EncryptedThenSignedJwtBuilder) - Constructor for class org.forgerock.json.jose.builders.EncryptedThenSignedJwtHeaderBuilder
Constructs a new JwsHeaderBuilder, parented by the given JwtBuilder.
EncryptionHandler - Interface in org.forgerock.json.jose.jwe.handlers.encryption
The interface for EncryptionHandlers for all the different encryption algorithms.
EncryptionKey<T extends CryptoKey> - Interface in org.forgerock.secrets.keys
Marker interface for all key types that can be used for encryption.
EncryptionManager - Class in org.forgerock.json.jose.jwe
A service to get the appropriate EncryptionHandler for a specified Java Cryptographic encryption algorithm.
EncryptionManager() - Constructor for class org.forgerock.json.jose.jwe.EncryptionManager
 
encryptionMethod() - Static method in class org.forgerock.openig.util.JsonValues
Returns a function that transforms the JSON value to a EncryptionMethod object.
encryptionMethod(EncryptionMethod) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder
Specifies the JWE content encryption method to use when encrypting tokens produced by this token handler.
EncryptionMethod - Enum Class in org.forgerock.json.jose.jwe
An Enum of the possible encryption methods that can be used when encrypting a JWT.
encryptionPurpose(Purpose<? extends CryptoKey>) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder
Specifies the Purpose used to retrieve encryption keys from the secrets provider.
encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler
Deprecated.
Encrypts the plaintext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.
encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler
 
encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
 
encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.ECDHEncryptionHandler
 
encryptPlaintext(Key, byte[], byte[], byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler
Encrypts the plaintext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.
encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler
Encrypts the plaintext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.
ENDPOINT_REGISTRY_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the EndpointRegistry instance dedicated for the current Route's objects from the Heap.
endpointRegistry() - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns this object's EndpointRegistry, creating it lazily when requested for the first time.
EndpointRegistry - Class in org.forgerock.openig.http
Registry for Identity Gateway REST API endpoints.
EndpointRegistry(Router, String) - Constructor for class org.forgerock.openig.http.EndpointRegistry
Creates a registry around the given Router instance.
EndpointRegistry.Registration - Class in org.forgerock.openig.http
Handle for un-registering an endpoint.
enrich(JwtValidator.Builder) - Method in interface org.forgerock.openig.filter.jwt.JwtValidatorCustomizer
This method enriches a JwtValidator.Builder by adding claim checks.
enrich(JwtValidator.Builder) - Method in class org.forgerock.openig.filter.jwt.ScriptableJwtValidatorCustomizer
 
Entity - Class in org.forgerock.http.protocol
Message content.
EntityExtractFilter - Class in org.forgerock.openig.filter
Extracts regular expression patterns from a message entity.
EntityExtractFilter(MessageType, LeftValueExpression<?>) - Constructor for class org.forgerock.openig.filter.EntityExtractFilter
Builds an EntityExtractFilter that will act either on MessageType.REQUEST or MessageType.RESPONSE flow, extracting patterns into the given target Expression.
EntityExtractFilter(MessageType, LeftValueExpression<?>, Charset) - Constructor for class org.forgerock.openig.filter.EntityExtractFilter
Builds an EntityExtractFilter that will act either on MessageType.REQUEST or MessageType.RESPONSE flow, extracting patterns into the given target Expression.
EntityExtractFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an entity extract handler in a heap environment.
entries(List<?>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Sets the list of auth modules used in the authentication event and their state.
ENTRIES - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Defines the entries key.
ENTRY_CURRENT_KEY - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage
The current key used to calculate the HEADER_HMAC.
ENTRY_CURRENT_SIGNATURE - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage
The last signature inserted into the file.
ENTRY_INITIAL_KEY - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage
The initial key used to calculate the HEADER_HMAC.
ENTRY_SIGNATURE - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage
The alias to lookup the private/public signature key into the keystore.
entrySet() - Method in class org.forgerock.http.protocol.Headers
 
entrySet() - Method in class org.forgerock.http.protocol.RequestCookies
 
entrySet() - Method in class org.forgerock.util.LazyMap
Returns a Set view of the mappings contained in the map.
entrySet() - Method in class org.forgerock.util.MapDecorator
Returns a Set view of the mappings contained in the map.
enumConstant(Class<T>) - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as an enum constant of the specified enum type.
EnumUtil - Class in org.forgerock.openig.util
Utility class for accessing Java enum types.
EnumValueOfHelper<E extends Enum<E>> - Class in org.forgerock.util
Provides a EnumValueOfHelper.valueOf(String) method as a replacement for the implicitly declared enum function valueOf(String), which has the advantage of not throwing exceptions when the name argument is null or cannot be found in the enum's values.
EnumValueOfHelper(E[]) - Constructor for class org.forgerock.util.EnumValueOfHelper
Constructor with null default value.
EnumValueOfHelper(E[], E) - Constructor for class org.forgerock.util.EnumValueOfHelper
Constructor with an explicit default value.
Environment - Interface in org.forgerock.openig.config
Encapsulate logic to access configuration files and other directories of the IG base directory.
ENVIRONMENT_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve an Environment instance from the Heap.
EnvironmentHeap - Class in org.forgerock.openig.heap
The root Heap that includes access to the environment additional information.
EnvironmentHeap(Name, String, Environment, PropertyResolver, StartupMetrics) - Constructor for class org.forgerock.openig.heap.EnvironmentHeap
Builds a new EnvironmentHeap with the given name and environment.
EnvironmentHeap(Name, Environment, PropertyResolver) - Constructor for class org.forgerock.openig.heap.EnvironmentHeap
Builds a new EnvironmentHeap with the given name and environment.
EnvironmentVariablesPlugin - Class in org.forgerock.openig.el.plugins
An ELContext node plugin that provides read-only access to environment variables.
EnvironmentVariablesPlugin() - Constructor for class org.forgerock.openig.el.plugins.EnvironmentVariablesPlugin
 
epk(String) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Deprecated.
epk(JWK) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Sets the Ephemeral Public Key header parameter for this JWE.
EPK - Enum constant in enum class org.forgerock.json.jose.jwe.JweHeaderKey
Ephemeral Public Key header parameter.
epochSecondsInstant() - Static method in class org.forgerock.json.JsonValueFunctions
Returns a Instant by converting the JsonValue into a number and interpreting that as the number of seconds since the UTC epoch as per Instant.ofEpochSecond(long).
equals(Object) - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
 
equals(Object) - Method in class org.forgerock.http.header.Directive
 
equals(Object) - Method in class org.forgerock.http.header.ForwardedHeader
 
equals(Object) - Method in class org.forgerock.http.header.ForwardedHeader.Hop
 
equals(Object) - Method in class org.forgerock.http.header.TrailerHeader
 
equals(Object) - Method in class org.forgerock.http.header.Warning
 
equals(Object) - Method in class org.forgerock.http.header.WarningHeader
 
equals(Object) - Method in class org.forgerock.http.header.XForwardedForHeader
 
equals(Object) - Method in class org.forgerock.http.MutableUri
 
equals(Object) - Method in class org.forgerock.http.oauth2.OAuth2Error
 
equals(Object) - Method in class org.forgerock.http.protocol.Cookie
 
equals(Object) - Method in class org.forgerock.http.protocol.Header
 
equals(Object) - Method in class org.forgerock.http.routing.Version
 
equals(Object) - Method in class org.forgerock.http.util.SetDecorator
Compares the specified object with the set for equality.
equals(Object) - Method in class org.forgerock.json.jose.jwe.JweEncryption
 
equals(Object) - Method in class org.forgerock.json.jose.jwt.JWObject
 
equals(Object) - Method in class org.forgerock.json.jose.jwt.JwtType
 
equals(Object) - Method in class org.forgerock.json.JsonPointer
Compares the specified object with this pointer for equality.
equals(Object) - Method in class org.forgerock.json.resource.ResourcePath
Returns true if obj is a resource path having the exact same elements as this resource path.
equals(Object) - Method in interface org.forgerock.json.resource.ResourceResponse
Returns true if the provided object is a resource having the same resource ID and revision as this resource.
equals(Object) - Method in class org.forgerock.json.resource.SortKey
 
equals(Object) - Method in record class org.forgerock.openig.assertion.IdentityAssertionClaims
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.forgerock.openig.decoration.capture.KeyValueProcessor.Value
 
equals(Object) - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
 
equals(Object) - Method in class org.forgerock.openig.filter.throttling.ThrottlingRate
 
equals(Object) - Method in record class org.forgerock.openig.handler.assertion.IdentityAssertionClaims
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.forgerock.openig.heap.DefaultDeclarationProvider.Declaration
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.forgerock.openig.heap.Name
 
equals(Object) - Method in record class org.forgerock.openig.http.ContextAndRequest
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
 
equals(Object) - Method in record class org.forgerock.openig.text.Separator
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.forgerock.openig.tools.am.Version
 
equals(Object) - Method in record class org.forgerock.openig.tools.jwt.validation.Violation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.forgerock.openig.tools.notifications.Notification
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.forgerock.openig.tools.ServerTlsOptions.SniConfiguration
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.forgerock.secrets.credentials.PrincipalAndSecret
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpec
 
equals(Object) - Method in record class org.forgerock.secrets.propertyresolver.SecretResource
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.forgerock.secrets.Purpose
 
equals(Object) - Method in class org.forgerock.secrets.Secret
 
equals(Object) - Method in record class org.forgerock.secrets.SecretBuilder.SecretAndExpirer
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
 
equals(Object) - Method in class org.forgerock.services.routing.RouteMatcher
 
equals(Object) - Method in class org.forgerock.util.i18n.LocalizableString
The default equals operation.
equals(Object) - Method in class org.forgerock.util.LazyList
Compares the specified object with this list for equality.
equals(Object) - Method in class org.forgerock.util.LazyMap
Compares the specified object with the map for equality.
equals(Object) - Method in class org.forgerock.util.ListDecorator
Compares the specified object with this list for equality.
equals(Object) - Method in class org.forgerock.util.MapDecorator
Compares the specified object with the map for equality.
equals(Object) - Method in class org.forgerock.util.Pair
equals(Object) - Method in class org.forgerock.util.query.QueryFilter
 
equals(Object) - Method in class org.forgerock.util.time.Duration
 
EQUALS - Enum constant in enum class org.forgerock.http.routing.RoutingMode
The URI template must exactly match a request's resource name in order for the route to be selected.
EQUALS - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "equals" operator.
equalsAttributeUsingKey() - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints
Returns a JwtClaimConstraint that will succeed if the expected value is equal to the value looked up in the context attributes using the key, otherwise it will fail.
equalTo(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new equality filter using the provided field name and value assertion.
equalTo(Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies strict equality.
ERROR - Enum constant in enum class org.forgerock.audit.handlers.syslog.Severity
Error conditions.
ES256 - Enum constant in enum class org.forgerock.json.jose.jws.JwsAlgorithm
ECDSA using SHA-256 hash algorithm.
ES384 - Enum constant in enum class org.forgerock.json.jose.jws.JwsAlgorithm
ECDSA using SHA-384 hash algorithm.
ES512 - Enum constant in enum class org.forgerock.json.jose.jws.JwsAlgorithm
ECDSA using SHA-512 hash algorithm.
escape() - Method in record class org.forgerock.openig.text.Separator
Returns the value of the escape record component.
ESTIMATE - Enum constant in enum class org.forgerock.json.resource.CountPolicy
Estimated count may be used.
eval() - Method in class org.forgerock.openig.el.Expression
Convenient method to eval an Expression that does not need a scope.
eval(Bindings) - Method in class org.forgerock.openig.el.Expression
Evaluates the expression within the specified bindings and returns the resulting object if it matches the specified type, or null if it does not resolve or match.
evalAsync(Bindings) - Method in class org.forgerock.openig.el.Expression
Evaluates asynchronously the expression with the specified bindings and returns a promise of the resulting object if it matches the specified type, or a promise completed with null if it does not resolve or match.
evaluate(Context, R) - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
 
evaluate(Context, R) - Method in class org.forgerock.services.routing.RouteMatcher
Evaluates the request and determines whether it matches the route.
evaluateAsync(Object, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate an Object that may contain some expressions that needs to be evaluated.
evaluateAsync(List<Object>, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate a list that may contain some Expressions that needs to be evaluated.
evaluateAsync(Map<String, Object>, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate a map that may contain some expressions that needs to be evaluated.
evaluated() - Static method in class org.forgerock.openig.util.JsonValues
Returns a function that will evaluate all String nodes.
evaluated(Bindings) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function that will evaluate all String nodes.
evaluatedAsync(Bindings) - Static method in class org.forgerock.openig.util.JsonValues
Returns an async function that will evaluate all String nodes.
evaluatedWithHeapProperties() - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns a function that will evaluate the expression hold by a JsonValue using the properties defined in the heap of this Heaplet.
EVENT_NAME - Static variable in class org.forgerock.audit.events.AuditEventBuilder
Event name event payload field name.
EventBufferingConfiguration() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.EventBufferingConfiguration
 
EventBufferingConfiguration() - Constructor for class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration
 
EventBufferingConfiguration() - Constructor for class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration
 
EventBufferingConfiguration() - Constructor for class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration.EventBufferingConfiguration
 
EventBufferingConfiguration() - Constructor for class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration
 
EventHandlerConfiguration - Class in org.forgerock.audit.events.handlers
Base class for audit event handler configuration.
EventHandlerConfiguration() - Constructor for class org.forgerock.audit.events.handlers.EventHandlerConfiguration
 
eventName(String) - Method in class org.forgerock.audit.events.AuditEventBuilder
Sets the provided name for the event.
eventTopicsMetaData - Variable in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
The event topic meta data for the handler.
EventTopicsMetaData - Class in org.forgerock.audit.events
Encapsulates meta-data for event topics.
EventTopicsMetaData(Map<String, JsonValue>) - Constructor for class org.forgerock.audit.events.EventTopicsMetaData
Create a new EventTopicsMetaData.
EventTopicsMetaDataBuilder - Class in org.forgerock.audit.events
Builder for EventTopicsMetaData.
evict(K) - Method in class org.forgerock.util.PerItemEvictionStrategyCache
Evict a cached value from the cache.
EXACT - Enum constant in enum class org.forgerock.json.resource.CountPolicy
Exact count is required.
ExceptionHandler<E> - Interface in org.forgerock.util.promise
A completion handler for consuming exceptions which occur during the execution of asynchronous tasks.
excludeMethods(String...) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes a HTTP method from the CSRF filter.
excludePaths(String...) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes a path from the CSRF filter.
excludePaths(Collection<String>) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes the paths from the CSRF filter.
excludePathsStarting(String...) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes paths starting with the given prefixes from the CSRF filter.
excludePathsStarting(Collection<String>) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes paths starting with the given prefixes from the CSRF filter.
excludeRequests(Predicate<Request>) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes requests that match the given predicate from the CSRF filter.
excludeRequests(Predicate<Request>, String) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes requests that match the given predicate from the CSRF filter.
excludeSafeMethods() - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes HTTP safe methods that are usually not susceptible to CSRF attacks: GET, HEAD, and OPTIONS.
execute(Object, CsvContext) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler.ParseJsonValue
 
execute(Runnable) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.assertion.handler.IdentityAssertionHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.assertion.plugin.kerberos.KerberosIdentityAssertionPluginTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.assertion.plugin.kerberos.KeytabServiceLoginTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.assertion.plugin.kerberos.UsernamePasswordServiceLoginTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.decoration.DelegateTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.decoration.timer.TimerDecoratorTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.ChainHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.circuitbreaker.CircuitBreakerFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.DataPreservationFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.HeaderFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.oauth2.CacheAccessTokenResolverTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.oauth2.client.ResourceOwnerOAuth2ClientFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.oauth2.RequestFormResourceAccessTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.filter.oauth2.TokenIntrospectionAccessTokenResolverTypeDefinitionProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.ClientHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.DispatchHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.ReverseProxyHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.router.RouterHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.saml.SamlFederationFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.saml.SamlFederationHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.SequenceHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.handler.StaticResponseHandlerTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.openam.AmServiceTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.openam.session.AmSessionIdleTimeoutFilterTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.openam.SingleSignOnTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.proxy.CustomProxyOptionsTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.proxy.NoProxyOptionsTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.proxy.SystemProxyOptionsTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.script.AbstractScriptableTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.Base64EncodedSecretStoreTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.FileSystemSecretStoreTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.JwkPropertyFormatTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.KeyStoreSecretStoreTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.PemPropertyFormatTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.SecretKeyPropertyFormatTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.SecretsProviderTypeProvider
 
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.security.ClientTlsOptionsTypeProvider
 
executeAsync(Executor, Supplier<T, E>) - Static method in class org.forgerock.util.promise.Promises
Execute the provided supplier through the executor and returns immediately a Promise that will be completed once the supplier has been executed.
ExecutorFilter - Class in org.forgerock.openig.tools
This Filter executes all CREST operations in an executor, effectively running the rest of the chain in another thread.
ExecutorFilter(Executor) - Constructor for class org.forgerock.openig.tools.ExecutorFilter
Creates a new ExecutorFilter.
ExecutorServiceFactory - Class in org.forgerock.util.thread
Responsible for generating ExecutorService instances which are automatically wired up to shutdown when the ShutdownListener event triggers.
ExecutorServiceFactory(ShutdownManager) - Constructor for class org.forgerock.util.thread.ExecutorServiceFactory
Create an instance of the factory.
exp(Date) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets the expiration time of the JWT in the Claims Set.
EXP - Enum constant in enum class org.forgerock.json.jose.jwt.JwtClaimsSetKey
Expiration Time Claim.
expand(Map<String, Object>) - Static method in class org.forgerock.audit.util.JsonValueUtils
Expands a Json Object Map, where the keys of the map are the JsonPointers and the values are the value the JsonPointer resolves to.
expandKey(Key, String, byte[], int) - Static method in class org.forgerock.util.crypto.HKDFKeyGenerator
Expands a master key into a derived key for a specific purpose.
expandKey(Key, String, int) - Static method in class org.forgerock.util.crypto.HKDFKeyGenerator
Expands a master key into a derived key for a specific purpose.
expandKey(Key, String, String, int) - Static method in class org.forgerock.util.crypto.HKDFKeyGenerator
Expands a master key into a derived key for a specific purpose.
expect(Class<?>) - Method in class org.forgerock.json.JsonValue
Called to enforce that the JSON value is of a particular type.
EXPECTATION_FAILED - Static variable in class org.forgerock.http.protocol.Status
The 417 (Expectation Failed) status code indicates that the expectation given in the request's Expect header field (Section 5.1.1) could not be met by at least one of the inbound servers.
expectedType(Class<T>, Function<JsonValue, T, E>) - Static method in class org.forgerock.openig.util.JsonValues
Allows to use defaultTo in an heaplet configuration to retrieve an object.
expire() - Method in interface org.forgerock.secrets.SecretBuilder.Expirer
Force the expiry of a secret.
ExpiredTokenException - Exception in org.forgerock.tokenhandler
An exception generated by a TokenHandler on extraction when the token is expired.
ExpiredTokenException(String) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
Constructs a new exception with the specified detail message.
ExpiredTokenException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
Constructs a new exception with the specified detail message and cause.
ExpiredTokenException(Throwable) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
Constructs a new exception with the specified cause.
expirer() - Method in record class org.forgerock.secrets.SecretBuilder.SecretAndExpirer
Returns the value of the expirer record component.
expiresAt(Instant) - Method in class org.forgerock.secrets.SecretBuilder
Sets the secret to expire at the given time.
expireSecretsAfter(Duration, Clock) - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
Sets the amount of time that secrets produced by this store can be cached before they must be refreshed.
expiresIn(long, TemporalUnit, Clock) - Method in class org.forgerock.secrets.SecretBuilder
Sets the secret to expire in deadline units from now.
export(CryptoKey, Key) - Method in enum class org.forgerock.secrets.jwkset.JwkKeyFormat
 
export(CryptoKey, Key) - Method in interface org.forgerock.secrets.keys.KeyFormat
Exports the given crypto key and raw key material.
export(CryptoKey, Key) - Method in class org.forgerock.secrets.keys.KeyFormatPem
 
export(CryptoKey, Key) - Method in enum class org.forgerock.secrets.keys.KeyFormatRaw
 
export(KeyFormat<T>) - Method in class org.forgerock.secrets.keys.CryptoKey
Exports the key material in the given format.
exposedHeader(String) - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder
Adds an exposed header name to this configuration.
expression(Class<T>) - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns a function that will create an Expression from the string by the JsonValue using the bindings defined in the heap of this Heaplet as initial bindings.
expression(Class<T>) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function for transforming JsonValues to expressions.
expression(Class<T>, Bindings) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function for transforming JsonValues to expressions.
Expression<T> - Class in org.forgerock.openig.el
An Unified Expression Language expression.
Expression(String, Class<T>, Bindings) - Constructor for class org.forgerock.openig.el.Expression
Constructs an expression for later evaluation.
ExpressionException - Exception in org.forgerock.openig.el
An exception that is thrown during expression operations.
ExpressionException() - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with null as its detail message.
ExpressionException(String) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified detail message.
ExpressionException(String, Throwable) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified detail message and cause.
ExpressionException(Throwable) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified cause.
ExpressionInstant - Class in org.forgerock.openig.el
A wrapper of the Instant plus/minus functions for use in expressions.
ExpressionInstant(Instant) - Constructor for class org.forgerock.openig.el.ExpressionInstant
Create a new ExpressionInstant based on the passed Instant.
expressionOf(Class<T>) - Static method in class org.forgerock.openig.types.TypeDefinitions
Represents a runtime Expression of type T, which is a String with a specific Syntax.
ExpressionPlugin - Interface in org.forgerock.openig.el
A plugin that contributes a node to the Expression context tree.
ExpressionPropertyResolver - Class in org.forgerock.openig.heap
Resolves Bindings-based tokens using COMMONS Config PropertyResolver.
ExpressionRequestAsyncFunction<V> - Class in org.forgerock.openig.el
This is an implementation of the AsyncFunction based on the evaluation of an Expression.
ExpressionRequestAsyncFunction(Expression<V>) - Constructor for class org.forgerock.openig.el.ExpressionRequestAsyncFunction
Constructs an AsyncFunction that evaluates the provided Expression.
Expressions - Class in org.forgerock.openig.el
Utility class for evaluating expression in some collections.
expressionSyntaxOf(Class<T>) - Static method in class org.forgerock.openig.types.TypeDefinitions
Creates an expression Syntax that is bound to the given type.
extendedMatch(FF, String, Object) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new extended match filter using the provided field name, operator and value assertion.
extractMasterKey(byte[]) - Static method in class org.forgerock.util.crypto.HKDFKeyGenerator
The HKDF "extract" phase that generates a master key from some input key material.
extractMasterKey(byte[], byte[]) - Static method in class org.forgerock.util.crypto.HKDFKeyGenerator
The HKDF "extract" phase that generates a master key from some input key material.
extractValueAsString(JsonValue, String) - Static method in class org.forgerock.audit.util.JsonValueUtils
Extracts String representation of field identified by fieldName from json object.
extractValueAsString(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.util.JsonValueUtils
Extracts String representation of field identified by pointer from json object.

F

F_ERROR - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the error code.
F_ERROR - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
Error field name.
F_ERROR_DESCRIPTION - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the error description.
F_ERROR_DESCRIPTION - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
Error description field name.
F_ERROR_URI - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the error uri.
F_REALM - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the realm.
F_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the scope.
Facility - Enum Class in org.forgerock.audit.handlers.syslog
Defines the standard Syslog message facilities.
FACTORIES - Static variable in class org.forgerock.http.header.HeaderFactory
A map of header names to known HeaderFactory implementations.
factory - Variable in class org.forgerock.util.LazyList
Factory to create the instance of the list to expose.
factory - Variable in class org.forgerock.util.LazyMap
Factory to create the instance of the map to expose.
Factory<T> - Interface in org.forgerock.util
A factory interface.
Factory() - Constructor for class org.forgerock.http.header.AuthorizationHeader.Factory
 
FailableInputStream - Class in org.forgerock.http.io
Wraps an existing InputStream, supporting a failed state that is checked before and after each operation.
FailableInputStream(InputStream) - Constructor for class org.forgerock.http.io.FailableInputStream
Constructs a new FailableInputStream.
FAILED - Enum constant in enum class org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus
The access request was not successfully completed.
FAILED - Enum constant in enum class org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status
Authentication operation has completed unsuccessfully.
failedSubscription(String, String) - Static method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Builds a failure acknowledgement.
FailedToLoadJWKException - Exception in org.forgerock.json.jose.exceptions
Unable to load the JWK/x5u location points.
FailedToLoadJWKException() - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception.
FailedToLoadJWKException(String) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception with the given message.
FailedToLoadJWKException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception with the given message and cause.
FailedToLoadJWKException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception with the given cause.
failure(String) - Static method in class org.forgerock.openig.filter.oauth2.cnf.Result
Returns a Result representing validation failure.
failure(Violation) - Static method in class org.forgerock.openig.tools.jwt.validation.Result
Returns a Result representing validation failure.
FailureContext - Class in org.forgerock.openig.util
Context implementation to hold error information regarding failures.
FailureContext(Context, Exception) - Constructor for class org.forgerock.openig.util.FailureContext
Create a new FailureContext.
failureHandler(Handler) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Add a handler which will be responsible of creating a response in case of missing/wrong CSRF token.
FALSE - Static variable in class org.forgerock.util.query.QueryFilterOperators
a literal "false.
FapiInteractionIdFilter - Class in org.forgerock.openig.filter.finance
A FapiInteractionIdFilter is responsible to manage the FapiInteractionIdFilter.FAPI_INTERACTION_ID header value.
FapiInteractionIdFilter.Heaplet - Class in org.forgerock.openig.filter.finance
Creates and initializes a fapi interaction-id filter in a heap environment.
field(String, Object) - Static method in class org.forgerock.json.JsonValue
Returns a JSON field for inclusion in a JSON object using object.
FIELD_ACTION - Static variable in interface org.forgerock.json.resource.ActionRequest
The name of the field which contains the action ID in the JSON representation.
FIELD_ADDITIONAL_PARAMETERS - Static variable in interface org.forgerock.json.resource.Request
The name of the field which contains the additional query parameters in the JSON representation.
FIELD_CAUSE - Static variable in exception org.forgerock.json.resource.ResourceException
The name of the JSON field used for the cause message.
FIELD_CODE - Static variable in exception org.forgerock.json.resource.ResourceException
The name of the JSON field used for the code.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.ActionRequest
The name of the field which contains the action content in the JSON representation.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.CreateRequest
The name of the field which contains the resource content in the JSON representation.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.ResourceResponse
The name of the field which contains the resource content in the JSON representation.
FIELD_CONTENT - Static variable in interface org.forgerock.json.resource.UpdateRequest
The name of the field which contains the resource content in the JSON representation.
FIELD_CONTENT_ID - Static variable in interface org.forgerock.json.resource.ResourceResponse
The name of the field in the resource content which contains the resource ID.
FIELD_CONTENT_REVISION - Static variable in interface org.forgerock.json.resource.ResourceResponse
The name of the field in the resource content which contains the resource revision.
FIELD_COUNT_ONLY - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which specifies whether the query request is to return only the count of the results.
FIELD_DETAIL - Static variable in exception org.forgerock.json.resource.ResourceException
The name of the JSON field used for the detail.
FIELD_ERROR - Static variable in interface org.forgerock.json.resource.QueryResponse
The name of the field which contains the error in the JSON representation.
FIELD_FIELD - Static variable in class org.forgerock.json.resource.PatchOperation
The name of the field which contains the target field in the JSON representation.
FIELD_FIELDS - Static variable in interface org.forgerock.json.resource.Request
The name of the field which contains the fields in the JSON representation.
FIELD_FROM - Static variable in class org.forgerock.json.resource.PatchOperation
The name of the source field for copy and move operations.
FIELD_ID - Static variable in interface org.forgerock.json.resource.ResourceResponse
The name of the field which contains the resource ID in the JSON representation.
FIELD_MESSAGE - Static variable in exception org.forgerock.json.resource.ResourceException
The name of the JSON field used for the message.
FIELD_NAMES_FIELD - Static variable in class org.forgerock.audit.util.ElasticsearchUtil
JSON field-name of normalized field-names.
FIELD_NEW_RESOURCE_ID - Static variable in interface org.forgerock.json.resource.CreateRequest
The name of the field which contains the new resource ID in the JSON representation.
FIELD_OPERATION - Static variable in class org.forgerock.json.resource.PatchOperation
The name of the field which contains the type of patch operation in the JSON representation.
FIELD_PAGE_SIZE - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the page size in the JSON representation.
FIELD_PAGED_RESULTS_COOKIE - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the paged results cookie in the JSON representation.
FIELD_PAGED_RESULTS_COOKIE - Static variable in interface org.forgerock.json.resource.QueryResponse
The name of the field which contains the paged results cookie in the JSON representation.
FIELD_PAGED_RESULTS_OFFSET - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the paged results offset in the JSON representation.
FIELD_PATCH - Static variable in interface org.forgerock.json.resource.PatchRequest
The name of the field which contains the patch content in the JSON representation.
FIELD_PATCH_OPERATIONS - Static variable in interface org.forgerock.json.resource.PatchRequest
The name of the field which contains the patch operations in the JSON representation.
FIELD_QUERY_EXPRESSION - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the query expression in the JSON representation.
FIELD_QUERY_FILTER - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the query filter in the JSON representation.
FIELD_QUERY_ID - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the query ID in the JSON representation.
FIELD_REASON - Static variable in exception org.forgerock.json.resource.ResourceException
The name of the JSON field used for the reason.
FIELD_REMAINING_PAGED_RESULTS - Static variable in interface org.forgerock.json.resource.QueryResponse
The name of the field which contains the remaining paged results in the JSON representation.
FIELD_RESOURCE_PATH - Static variable in interface org.forgerock.json.resource.Request
The name of the field which contains the resource name in the JSON representation.
FIELD_RESULT - Static variable in interface org.forgerock.json.resource.QueryResponse
The name of the field which contains the array of matching resources in the JSON representation.
FIELD_RESULT_COUNT - Static variable in interface org.forgerock.json.resource.QueryResponse
The name of the field which contains the result count in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.DeleteRequest
The name of the field which contains the resource version in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.PatchRequest
The name of the field which contains the resource version in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.ResourceResponse
The name of the field which contains the resource version in the JSON representation.
FIELD_REVISION - Static variable in interface org.forgerock.json.resource.UpdateRequest
The name of the field which contains the resource version in the JSON representation.
FIELD_SORT_KEYS - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the sort keys in the JSON representation.
FIELD_TOTAL_PAGED_RESULTS - Static variable in interface org.forgerock.json.resource.QueryResponse
The name of the field which contains the total paged results in the JSON representation.
FIELD_TOTAL_PAGED_RESULTS_POLICY - Static variable in interface org.forgerock.json.resource.QueryRequest
The name of the field which contains the policy used for calculating the total number of paged results.
FIELD_TOTAL_PAGED_RESULTS_POLICY - Static variable in interface org.forgerock.json.resource.QueryResponse
The name of the field which contains the policy used for calculating the total number of paged results in the JSON representation.
FIELD_VALUE - Static variable in class org.forgerock.json.resource.PatchOperation
The name of the field which contains the operation value in the JSON representation.
FIELD_VALUE_ALL - Static variable in interface org.forgerock.json.resource.Request
The value of the fields request parameter to request all fields.
FIELD_VALUE_ALL_PTR - Static variable in class org.forgerock.json.resource.Resources
JsonPointer used in fields to denote "all fields", i.e., no filtering.
fieldIfNotNull(String, Object) - Static method in class org.forgerock.json.JsonValue
Returns a JSON field for inclusion in a JSON object using object only if its value is not null.
fieldIfSubfieldHasValue(String, String, String) - Static method in class org.forgerock.openig.util.JsonValues
Extension to JsonValue field... functions to support the case where we would like to add a field referencing an object, which itself contains a single sub-field, to which we would like to assign a given value if that value is not null.
file() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a File object.
FileAttributesFilter - Class in org.forgerock.openig.filter
Retrieves and exposes a record from a delimiter-separated file.
FileAttributesFilter(SeparatedValuesFile, String, Expression<String>, LeftValueExpression<Map>) - Constructor for class org.forgerock.openig.filter.FileAttributesFilter
Builds a new FileAttributesFilter extracting values from the given separated values file.
FileAttributesFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a separated values file attribute provider in a heap environment.
FileBasedEventHandlerConfiguration - Class in org.forgerock.audit.events.handlers
Configures time based or size based log file rotation.
FileBasedEventHandlerConfiguration() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
 
FileBasedEventHandlerConfiguration.FileRetention - Class in org.forgerock.audit.events.handlers
Groups the file retention config parameters.
FileBasedEventHandlerConfiguration.FileRotation - Class in org.forgerock.audit.events.handlers
Groups the file rotation config parameters.
FileBranchingStream - Class in org.forgerock.http.io
A BranchingInputStream for reading from files.
FileBranchingStream(File) - Constructor for class org.forgerock.http.io.FileBranchingStream
Creates a new stream for the specified file.
FilenameUtils - Class in org.forgerock.openig.util
Utility class for filename related methods.
FileNamingPolicy - Interface in org.forgerock.audit.retention
An interface to declare the names of audit log files.
FileResourceSet - Class in org.forgerock.openig.handler.resources
A FileResourceSet is able to give access to file-based content within the scope of the root directory.
FileResourceSet(File) - Constructor for class org.forgerock.openig.handler.resources.FileResourceSet
Constructs a file-based ResourceSet, using the given root as root directory.
FileRetention() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention
 
FileRotation() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
 
FileSystemSecretStore - Class in org.forgerock.secrets.propertyresolver
A SecretStore that reads secrets from a directory with the expectation that each file contains a separate secret.
FileSystemSecretStore.FileSystemSecretStoreBuilder - Class in org.forgerock.secrets.propertyresolver
A builder for more fluently creating a FileSystemSecretStore.
fileSystemSecretStoreBuilder(Path) - Static method in class org.forgerock.secrets.propertyresolver.FileSystemSecretStore
Creates a new FileSystemSecretStore builder.
FileSystemSecretStoreHeaplet - Class in org.forgerock.openig.secrets
This heaplet represents an instance of a PropertyResolverSecretStore resolving properties from files in a directory.
FileSystemSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.FileSystemSecretStoreHeaplet
 
FileSystemSecretStoreTypeProvider - Class in org.forgerock.openig.secrets
Provide the FileSystemSecretStoreHeaplet's TypeDefinition.
FileSystemSecretStoreTypeProvider() - Constructor for class org.forgerock.openig.secrets.FileSystemSecretStoreTypeProvider
 
fileToUrl(File) - Static method in class org.forgerock.openig.el.Functions
Returns the String representation of the URL denoting the given file.
filter(Set<String>) - Method in class org.forgerock.audit.events.EventTopicsMetaData
Returns a new instance of EventTopicsMetaData containing only the meta-data for topics held by this object that are named within provided topics parameter.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.cors.CorsFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.CsrfFilter
 
filter(Context, Request, Handler) - Method in interface org.forgerock.http.Filter
Filters the request and/or response of an exchange.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.OptionsFilter
Handles all OPTION requests to CREST resources, all other request methods are handled by the Handler.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.TransactionIdInboundFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.TransactionIdOutboundFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.oauth2.ClientSecretBasicAuthenticationFilter
Deprecated.
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.oauth2.ClientSecretPostAuthenticationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.oauth2.ResourceServerFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.routing.ResourceApiVersionRoutingFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.http.swagger.OpenApiRequestFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.allow.AllowOnlyFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.AssignmentFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.circuitbreaker.CircuitBreakerFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.ConditionalFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.ConditionEnforcementFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.CookieFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.DataPreservationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.DateHeaderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.EntityExtractFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.FileAttributesFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.finance.FapiInteractionIdFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.ForwardedRequestFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.FragmentFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.HeaderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.HttpAccessAuditFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.HttpBasicAuthFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.jwt.JwtValidationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.JwtBuilderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.LocationHeaderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.LogAttachedExceptionFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.MdcRouteIdFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.MetricsFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistrationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.oauth2.client.DiscoveryFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.oauth2.client.GrantSwapJwtAssertionOAuth2ClientFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.oauth2.cnf.CertificateThumbprintFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.RetryFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.ScriptableFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.SetCookieUpdateFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.SplitCookieFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.StaticRequestFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.SwitchFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.throttling.ThrottlingFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.UriPathRewriteFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.handler.router.NullResponseFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.AbstractConditionAdviceFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.CapturedUserPasswordFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.session.AmSessionIdleTimeoutFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.SessionInfoFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.SingleSignOnFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.TokenTransformationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.UserProfileFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.ping.protect.PingOneProtectEvaluationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.ping.protect.PingOneProtectFeedbackFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.ping.sideband.SidebandApiFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.sql.SqlAttributesFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.tools.ApiVersionProtocolHeaderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.tools.HeadlessAuthenticationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.tools.InsertSsoTokenHeaderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.tools.InvalidCallerTokenDetectionFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.uma.UmaResourceServerFilter
 
Filter - Interface in org.forgerock.audit.filter
Interface that represents an audit filter.
Filter - Interface in org.forgerock.http
Filters the request and/or response of an HTTP exchange.
Filter - Interface in org.forgerock.json.resource
An interface for implementing request handler filters.
filterAction(Context, ActionRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters an action request.
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter
 
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.openig.tools.CachePolicyDecisionFilter
 
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.openig.tools.ExecutorFilter
 
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
FilterBuilder - Class in org.forgerock.audit.filter
Builds a Filter for a given set of FilterPolicy.
FilterBuilder() - Constructor for class org.forgerock.audit.filter.FilterBuilder
 
FilterChain - Class in org.forgerock.json.resource
A chain of filters terminated by a target request handler.
FilterChain(RequestHandler) - Constructor for class org.forgerock.json.resource.FilterChain
Creates an empty filter chain.
FilterChain(RequestHandler, Collection<Filter>) - Constructor for class org.forgerock.json.resource.FilterChain
Creates a filter chain containing the provided list of filters.
FilterChain(RequestHandler, Filter...) - Constructor for class org.forgerock.json.resource.FilterChain
Creates a filter chain containing the provided list of filters.
FilterCondition - Interface in org.forgerock.json.resource
A condition which controls whether or not a filter will be invoked or not.
filterCreate(Context, CreateRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters a create request.
filterCreate(Context, CreateRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterCreate(Context, CreateRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter
 
filterCreate(Context, CreateRequest, RequestHandler) - Method in class org.forgerock.openig.tools.ExecutorFilter
 
filterCreate(Context, CreateRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
filterDelete(Context, DeleteRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters a delete request.
filterDelete(Context, DeleteRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterDelete(Context, DeleteRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter
 
filterDelete(Context, DeleteRequest, RequestHandler) - Method in class org.forgerock.openig.tools.ExecutorFilter
 
filterDelete(Context, DeleteRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
filtered(Handler, Filter) - Static method in class org.forgerock.http.handler.Handlers
Creates a "filtered handler" instance.
FILTERED_REQUEST - Enum constant in enum class org.forgerock.openig.decoration.capture.CapturePoint
Prints the filtered request (Filter only).
FILTERED_RESPONSE - Enum constant in enum class org.forgerock.openig.decoration.capture.CapturePoint
Prints the filtered response (Filter only).
filterPatch(Context, PatchRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters a patch request.
filterPatch(Context, PatchRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterPatch(Context, PatchRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter
 
filterPatch(Context, PatchRequest, RequestHandler) - Method in class org.forgerock.openig.tools.ExecutorFilter
 
filterPatch(Context, PatchRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
FilterPolicy - Class in org.forgerock.audit.filter
Represents a FilterPolicy which contains the includeIf and excludeIf values for the filter.
FilterPolicy() - Constructor for class org.forgerock.audit.filter.FilterPolicy
 
filterQuery(Context, QueryRequest, QueryResourceHandler, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters a query request.
filterQuery(Context, QueryRequest, QueryResourceHandler, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterQuery(Context, QueryRequest, QueryResourceHandler, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter
 
filterQuery(Context, QueryRequest, QueryResourceHandler, RequestHandler) - Method in class org.forgerock.openig.tools.ExecutorFilter
 
filterQuery(Context, QueryRequest, QueryResourceHandler, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
filterRead(Context, ReadRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters a read request.
filterRead(Context, ReadRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterRead(Context, ReadRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter
 
filterRead(Context, ReadRequest, RequestHandler) - Method in class org.forgerock.openig.tools.ExecutorFilter
 
filterRead(Context, ReadRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
filterResource(JsonValue, Collection<JsonPointer>) - Static method in class org.forgerock.json.resource.Resources
Returns a JSON object containing only the specified fields from the provided JSON value.
filterResource(ResourceResponse, Collection<JsonPointer>) - Static method in class org.forgerock.json.resource.Resources
Returns a JSON object containing only the specified fields from the provided resource.
filters(Options) - Method in class org.forgerock.openig.handler.ClientHandlerHeaplet
 
filters(Options) - Method in class org.forgerock.openig.handler.HttpClientHandlerHeaplet
Returns a list of Filter that will be executed on every request before the HttpClientHandler.
filters(Options) - Method in class org.forgerock.openig.handler.ReverseProxyHandlerHeaplet
 
Filters - Class in org.forgerock.http.filter
Utility methods for creating common types of filters.
Filters - Class in org.forgerock.json.resource
This class contains methods for creating various kinds of Filter and FilterConditions.
filterUpdate(Context, UpdateRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters an update request.
filterUpdate(Context, UpdateRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterUpdate(Context, UpdateRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter
 
filterUpdate(Context, UpdateRequest, RequestHandler) - Method in class org.forgerock.openig.tools.ExecutorFilter
 
filterUpdate(Context, UpdateRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
find() - Static method in class org.forgerock.openig.config.env.IgInstanceDirFinder
Find the directory that will be used as the base directory.
find(String) - Method in class org.forgerock.openig.handler.resources.FileResourceSet
 
find(String) - Method in interface org.forgerock.openig.handler.resources.ResourceSet
Finds a Resource matching the given path.
find(String) - Method in class org.forgerock.openig.ui.record.RecordService
Find a Record with the given id, returns null if not found.
find(String, String) - Static method in class org.forgerock.openig.el.Functions
Attempts to find the next subsequence of the input sequence that matches the regular expression.
find(Throwable, Class<T>) - Static method in class org.forgerock.openig.tools.notifications.ws.Throwables
Return the top-most Throwable in the exception's chain that matches the given type.
findApplicable(Context, String) - Method in interface org.forgerock.http.filter.cors.CorsPolicyProvider
Returns an optional CORS policy applicable in this context, for the given origin.
findByName(String) - Method in class org.forgerock.openig.filter.oauth2.client.