Index (IG Aggregated Javadoc 7.2.0 Documentation)

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 All Packages

A

A128CBC_HS256 - 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 - org.forgerock.json.jose.jwe.EncryptionMethod: AES encryption in Galois Counter Mode (GCM) with a 128 bit key length.
A128KW - org.forgerock.json.jose.jwe.JweAlgorithm: AES-128 KeyWrap.
A192CBC_HS384 - 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 - org.forgerock.json.jose.jwe.EncryptionMethod: AES encryption in Galois Counter Mode (GCM) with a 192 bit key length.
A192KW - org.forgerock.json.jose.jwe.JweAlgorithm: AES-192 KeyWrap.
A256CBC_HS512 - 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 - org.forgerock.json.jose.jwe.EncryptionMethod: AES encryption in Galois Counter Mode (GCM) with a 256 bit key length.
A256KW - 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.
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.
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.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 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 - 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...) - Method in class org.forgerock.openig.ldap.LdapConnection: Adds an entry to the Directory Server using the provided lines of LDIF.
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.
add(Entry) - Method in class org.forgerock.openig.ldap.LdapConnection: Adds the provided entry to the Directory Server.
add(AddRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Adds an entry to the Directory Server using the provided add request.
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 postconditions.
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
addConnectionEventListener(Consumer<ConnectionEvent>) - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionService
addCookie(Cookie) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
addDateHeader(String, long) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
addDefaultDeclaration(JsonValue) - Method in class org.forgerock.openig.heap.HeapImpl: Add a default JsonValue 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.
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.
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.
addSharedClientHandlerAttributes(ComponentTypeDefinition) - Method in class org.forgerock.openig.handler.ClientHandlerTypeProvider
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 - Class in org.forgerock.openig.http: Configuration class for the Identity Gateway Administration.
AdminHttpApplication(String, JsonValue, Environment, RunMode, PropertyResolver, MeterRegistry, HttpClientLoader, WebSocketClientProvider, Clock, IgTicker) - Constructor for class org.forgerock.openig.http.AdminHttpApplication: Construct a AdminHttpApplication.
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 - 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.
afterRollingOver() - Method in interface org.forgerock.audit.events.handlers.writers.RotatableWriter.RolloverLifecycleHook: This method is called after the rotation and retention checks are done.
AgentAuthenticationService - Class in org.forgerock.openig.tools.authentication.chf: An AgentAuthenticationService authenticate agent credentials (not subject credentials), forcing the login module to Application (restricted to agents).
AgentAuthenticationService(Handler, URI) - Constructor for class org.forgerock.openig.tools.authentication.chf.AgentAuthenticationService: Constructs a AgentAuthenticationService.
AGREE_KEY - org.forgerock.secrets.keys.KeyUsage: Key is intended for deriving a key via a key agreement protocol such as Diffie-Hellman.
ALERT - 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 - 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 specificiation.
ALL - 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 - 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.
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
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.
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 - 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 - 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 - 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: Deprecated.
Use Strings.asEnum(String, Class)
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(Purpose<T>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
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.openig.secrets.SecretsServiceProvider
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.
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.
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.
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.
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 - org.forgerock.json.jose.jwt.JwtClaimsSetKey: Audience Claim.
Audit - Annotation Type 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
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 - org.forgerock.audit.handlers.syslog.Facility: Security/authorization messages.
authenticate(HttpServletResponse) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
authenticate(Context, String, char[]) - Method in interface org.forgerock.openig.tools.authentication.AuthenticationService: Authenticates a subject (identified with the given username and password credentials), returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException on failures (I/O, invalid credentials, ...).
authenticate(Context, String, char[]) - Method in class org.forgerock.openig.tools.authentication.chf.DefaultAuthenticationService
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 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.
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 - org.forgerock.audit.handlers.syslog.Facility: Security/authorization messages.
AuthRedirectContext - Class in org.forgerock.openig.filter: Used by the FragmentFilter 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 - 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.
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.
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.
BASE_SYSTEM_PROPERTY - Static variable in class org.forgerock.openig.config.env.IgInstanceDirFinder: System property name that can be specified through command line.
Base64 - Class in org.forgerock.util.encode: Provides RFC 4648 / RFC 2045 compatible Base64 encoding and decoding.
BASE64 - 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 - 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: Deprecated.
Use Utils.decodeJwtComponent(String).
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: Deprecated.
Use Utils.encodeJwtComponent(String).
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.
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.
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, char[]) - Method in class org.forgerock.openig.ldap.LdapConnection: Authenticates to the Directory Server using simple authentication and the provided user name and password.
bind(String, Object) - Method in class org.forgerock.openig.el.Bindings: Binds a new value to the given name.
bind(BindRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Authenticates to the Directory Server using the provided bind request.
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.
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() - Method in class org.forgerock.openig.http.CookieBuilder: Create a Cookie based on the details held in this CookieBuilder.
build() - Method in class org.forgerock.openig.tools.am.AmService.Builder: Returns a new AmService instance.
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.services.context.ClientContext.Builder: Creates a ClientContext instance from the specified properties.
build(Class<T>) - Method in class org.forgerock.secrets.SecretBuilder: Deprecated.
Use SecretBuilder.build(Purpose) instead.
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: Creates a CaffeineCacheAccessTokenResolver.Builder to be passed when creating a new CaffeineCacheAccessTokenResolver.
builder(String) - Static method in class org.forgerock.json.jose.jwk.OctJWK: Get the Octet JWK builder.
builder(String) - Static method in class org.forgerock.openig.http.CookieBuilder: Create a CookieBuilder with just the cookie name set.
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
builder(SupportedEllipticCurve, String, String) - Static method in class org.forgerock.json.jose.jwk.EcJWK: Get the builder.
builder(JsonValue, String, String) - Static method in class org.forgerock.openig.http.CookieBuilder: Create a CookieBuilder based on the JSON structure of:
builder(JsonValue, Clock) - Static method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.

Returns a DefaultSecretsService's 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
Builder(Handler, Clock, String, String, AmVersion, UriService, AuthenticationService, AsyncRefreshableSupplier<SsoToken, AuthenticationException>) - Constructor for class org.forgerock.openig.tools.am.AmService.Builder
Builder(KeyType) - Constructor for class org.forgerock.json.jose.jwk.JWK.Builder: The builder constructor.
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.
for removal with EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionPurpose(Purpose). Will be removed in winter 2021 season.
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.

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, 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: Builder of CaffeineCacheAccessTokenResolver.
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
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 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 - 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.
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: Throws a NullPointerException if the object parameter is null, returns the object otherwise.
checkNotNull(T, String) - Static method in class org.forgerock.util.Reject: Throws a NullPointerException if the object parameter is null, returns the object otherwise.
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
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
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 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: 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 - org.forgerock.openig.tools.notifications.DisconnectionStrategy: Clear the cache when the notification service is disconnected.
CLEAR_ON_RECONNECT - 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 - 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 - 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_LOADER_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(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.
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
ClientRegistration - Class in org.forgerock.openig.filter.oauth2.client: A configuration for an OpenID Connect Provider.
ClientRegistration(String, String, List<String>, Issuer, Handler, Handler) - Constructor for class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Creates a Client Registration.
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.
since 26.2. See Filters.newUrlEncodedHttpBasicAuthFilter(String, SecretReference) for a replacement.
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: Creates an instance of this class.
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_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve a Clock instance from the Heap.
CLOCKD - 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.ldap.LdapConnection: Releases any resources associated with this connection.
close() - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject
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 class org.forgerock.openig.tools.notifications.ws.SubscriptionService: Close the SubscriptionService and unsubscribe from all topics.
close() - Method in class org.forgerock.openig.tools.notifications.ws.TopicManager
close() - Method in interface org.forgerock.openig.tools.notifications.ws.WebSocketAdapter
close() - Method in class org.forgerock.secrets.GenericSecret: Scrubs the secret value from memory on a best-effort basis.
close() - Method in class org.forgerock.secrets.keys.CryptoKey
close() - Method in class org.forgerock.secrets.Secret
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.
closeHandler(Consumer<Void>) - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Supply a close handler executed once the client websocket connection being closed.
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: Deprecated.
Use Closeables.closeSilently(Closeable...)
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: Deprecated.
Use Closeables.closeSilently(Iterable)
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 - 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 - 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.
COMPARATOR - Static variable in class org.forgerock.util.Pair: Comparator for Pairs made of Comparable elements.
compare(String, String, String) - Method in class org.forgerock.openig.ldap.LdapConnection: Compares the named entry in the Directory Server against the provided attribute value assertion.
compare(JsonValue, JsonValue) - Method in class org.forgerock.json.resource.SortKeyComparator
compare(CompareRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Compares an entry in the Directory Server using the provided compare request.
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: Deprecated.
Use Objects.compareValues(Object, Object)
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.
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.
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 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
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: Creates a new ConditionEnforcementFilter.
ConditionEnforcementFilter(Expression<Boolean>, Handler) - Constructor for class org.forgerock.openig.filter.ConditionEnforcementFilter: Creates a new 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_ASYNC_BEHAVIOR - Static variable in class org.forgerock.openig.handler.HttpClientHandlerHeaplet: Constant for the configuration asyncBehavior.
CONFIG_ENABLE_CONNECTION_STATE - Static variable in class org.forgerock.openig.handler.HttpClientHandlerHeaplet: Constant for the configuration stateTrackingEnabled.
CONFIG_HTTP2_PRIOR_KNOWLEDGE - Static variable in class org.forgerock.openig.handler.HttpClientHandlerHeaplet: Constant for the configuration http2PriorKnowledge.
CONFIG_NUMBER_OF_WORKERS - Static variable in class org.forgerock.openig.handler.HttpClientHandlerHeaplet: Constant for the configuration numberOfWorkers.
CONFIG_PROTOCOL_VERSION - Static variable in class org.forgerock.openig.handler.HttpClientHandlerHeaplet: Constant for the configuration protocolVersion.
CONFIG_SECRETS_PROVIDER - Static variable in class org.forgerock.openig.secrets.SecretsUtils: The common key to name secrets provider properties.
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.
configurationSupported(HttpClientLoader, JsonValue) - Method in class org.forgerock.openig.handler.HttpClientHandlerHeaplet: Is the provided configuration supported by the HttpClientLoader.
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: Deprecated.
Use JwksStoreService.configureJwksStore(String, Duration, Duration, URL, Clock) with an explicit clock.
configureJwksStore(String, Duration, Duration, URL, Clock) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService: Deprecated.
use JwksStoreService.configureJwksStoreAsync(String, Duration, Duration, URL, Clock) instead.
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.
connect(String, int) - Method in class org.forgerock.openig.ldap.LdapClient: Returns an LDAP connection for the specified LDAP server.
connect(String, int, Options) - Method in class org.forgerock.openig.ldap.LdapClient: Returns an LDAP connection for the specified LDAP server using the provided LDAP options.
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 - 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 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
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.
Replaced by ContentTypeHeader(String, Map)
ContentTypeHeader(String, String, String, Map<String, String>) - Constructor for class org.forgerock.http.header.ContentTypeHeader: Deprecated.
Replaced by ContentTypeHeader(String, Map)
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(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 - 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 class org.forgerock.openig.http.ContextAndRequest: Constructs a new ContextAndRequest.
contextDestroyed(ServletContextEvent) - Method in class org.forgerock.http.servlet.HttpFrameworkServletContextListener: No action performed.
contextInitialized(ServletContextEvent) - Method in class org.forgerock.http.servlet.HttpFrameworkServletContextListener: Registers the HttpApplication instances in the ServletContext attributes.
CONTINUE - 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 in org.forgerock.http.protocol: Indicates the SameSite value of the cookie.
CookieBuilder - Class in org.forgerock.openig.http: Class to collate all static cookie configuration data for building response cookies.
CookieFilter - Class in org.forgerock.openig.filter: Suppresses, relays and manages cookies.
CookieFilter() - Constructor for class org.forgerock.openig.filter.CookieFilter
CookieFilter.Action - Enum 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(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
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 in org.forgerock.json.resource: An enum of count policy types.
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.CryptoHeaderFilter.Heaplet: Deprecated.
create() - Method in class org.forgerock.openig.filter.CsrfFilterHeaplet
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.EncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet
create() - Method in class org.forgerock.openig.filter.oauth2.client.authentication.PrivateKeyJwtClientAuthenticationFilterHeaplet
create() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration.Heaplet
create() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer.Heaplet
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.OpenAmAccessTokenResolverHeaplet: Deprecated.
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.DesKeyGenHandler.Heaplet: Deprecated.
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.SamlFederationHandler.Heaplet
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.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.Base64EncodedSecretStore.Heaplet
create() - Method in class org.forgerock.openig.secrets.HsmSecretStoreHeaplet
create() - Method in class org.forgerock.openig.secrets.JwkSetSecretStoreHeaplet
create() - Method in class org.forgerock.openig.secrets.KeyStoreSecretStoreHeaplet
create() - Method in class org.forgerock.openig.secrets.PemPropertyFormatHeaplet
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
create() - Method in class org.forgerock.openig.security.KeyStoreHeaplet
create() - Method in class org.forgerock.openig.security.TrustAllManager.Heaplet
create() - Method in class org.forgerock.openig.security.TrustManagerHeaplet
create() - Method in class org.forgerock.openig.session.jwt.JwtSessionManagerHeaplet
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(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(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 - org.forgerock.json.resource.RequestType: A create request.
createActiveReference(Purpose<S>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
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.openig.secrets.SecretsServiceProvider
createActiveReference(Purpose<S>) - Method in class org.forgerock.secrets.SecretsProvider: Creates the secret reference from the given purpose.
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: Deprecated.
ExecutorServiceFactory.createCachedThreadPool(String) or ExecutorServiceFactory.createCachedThreadPool(ThreadFactory) should be used so that threads have meaningful names.
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.
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(String, SecretReference<GenericSecret>) - Method in class org.forgerock.openig.filter.oauth2.client.authentication.ClientSecretBasicAuthenticationFilterHeaplet
createFilter(String, SecretReference<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 class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
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.openig.secrets.SecretsServiceProvider
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.
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.
ExecutorServiceFactory.createThreadPool(int, int, long, TimeUnit, BlockingQueue, String) should be used so that threads have meaningful names.
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.
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 - org.forgerock.json.jose.jws.JwsHeaderKey: Critical header parameter.
CRITICAL - org.forgerock.audit.handlers.syslog.Severity: Critical conditions.
CRON - 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(AmService, String, String, CookieBuilder, Supplier<String>, JwsSignatureVerifier, Clock, Handler, Expression<Boolean>, String, String) - Constructor for class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter: Creates a new CrossDomainSingleSignOnFilter.
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.
CryptoHeaderFilter - Class in org.forgerock.openig.filter: Deprecated.
in 7.0, will be removed in future versions. See OPENIG-3704.
CryptoHeaderFilter() - Constructor for class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.
CryptoHeaderFilter.Heaplet - Class in org.forgerock.openig.filter: Deprecated.

Creates and initializes a header filter in a heap environment.
CryptoHeaderFilter.Operation - Enum in org.forgerock.openig.filter: Deprecated.

Should the filter encrypt or decrypt the given headers ?
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 - 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 - org.forgerock.json.jose.jwe.JweHeaderKey: Generic header key for a custom header parameter.
CUSTOM - org.forgerock.json.jose.jws.JwsHeaderKey: Generic header key for a custom header parameter.
CUSTOM - org.forgerock.json.jose.jwt.JwtClaimsSetKey: Custom (private) Claim.
CUSTOM - org.forgerock.json.jose.jwt.JwtHeaderKey: Generic header key for a custom header parameter.
CustomProxyOptions - Class in org.forgerock.openig.proxy: A ProxyOptions representing custom proxy settings.
CustomProxyOptions(URI) - Constructor for class org.forgerock.openig.proxy.CustomProxyOptions
CustomProxyOptions(URI, String, SecretReference<GenericSecret>) - Constructor for class org.forgerock.openig.proxy.CustomProxyOptions
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 - org.forgerock.audit.handlers.syslog.Facility: System daemons.
data - Variable in class org.forgerock.services.context.AbstractContext: The Context data.
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.
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.
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 - org.forgerock.audit.handlers.syslog.Severity: Debug-level messages.
decode(byte[]) - Static method in class org.forgerock.util.encode.Base64: Decodes a BASE64 encoded byte array.
decode(byte[], String) - Method in enum 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.openig.secrets.PlainPropertyFormat
decode(String) - Method in class org.forgerock.secrets.propertyresolver.PemPropertyFormat
decode(String) - Method in enum 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.
Use Base64.decode(byte[]) instead.
decodeFast(char[]) - Static method in class org.forgerock.util.encode.Base64: Deprecated.
Use Base64.decode(char[]) instead.
decodeFast(String) - Static method in class org.forgerock.util.encode.Base64: Deprecated.
Use Base64.decode(String) instead.
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.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.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.
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: Deprecated.
Prefer EncryptedJwt.decrypt(SecretsProvider, Purpose) instead.
decrypt(Key) - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt: Deprecated.
Prefer EncryptedThenSignedJwt.decrypt(SecretsProvider, Purpose) instead.
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 - org.forgerock.json.jose.jwk.KeyOperation: Use Key to decrypt content and validate decryption, if applicable.
DECRYPT - org.forgerock.openig.filter.CryptoHeaderFilter.Operation: Deprecated.

Perform a decryption of the selected headers.
DECRYPT - org.forgerock.secrets.keys.KeyUsage: Key is intended for decrypting data directly.
decryptAndVerify(Key, SigningHandler) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt: Deprecated.
Prefer SignedThenEncryptedJwt.decryptAndVerify(SecretsProvider, Purpose, Purpose) instead.
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.
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.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: Deprecated.
Use EncryptionHandler.decryptContentEncryptionKey(Key, byte[], JweHeader) instead.
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.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: Deprecated.
Prefer EncryptedJwt.decryptRawPayload(SecretsProvider, Purpose) instead.
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.
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 - 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 - 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_ALGORITHM - Static variable in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

Default cipher algorithm to be used when none is specified.
DEFAULT_AM_VERSION - Static variable in class org.forgerock.openig.tools.am.AmService: AM 6.0.0.
DEFAULT_BASEURI_DECORATOR - Static variable in class org.forgerock.openig.http.DefaultDeclarations: Default BaseUri decorator.
DEFAULT_CAPTURE_DECORATOR - Static variable in class org.forgerock.openig.http.DefaultDeclarations: Default Capture decorator.
DEFAULT_CASE_INSENSITIVE_FIELDS - Static variable in class org.forgerock.audit.AuditServiceConfiguration: Default value for AuditServiceConfiguration.getCaseInsensitiveFields().
DEFAULT_CLIENT_HANDLER - Static variable in class org.forgerock.openig.http.DefaultDeclarations: The client handler that deals with third-party services.
DEFAULT_COOKIE_NAME - Static variable in class org.forgerock.openig.tools.am.AmService: The default cookie header name for the OpenAM Server.
DEFAULT_PROTOCOL_VERSION - Static variable in class org.forgerock.json.resource.http.HttpUtils: The default version of the named protocol.
DEFAULT_PROXY_OPTIONS - Static variable in class org.forgerock.openig.http.DefaultDeclarations: Default ProxyOptions.
DEFAULT_REVERSE_PROXY_HANDLER - Static variable in class org.forgerock.openig.http.DefaultDeclarations: The proxy client handler that deals with the application traffic.
DEFAULT_ROTATION_FILE_SUFFIX - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: The default file rotation suffix format.
DEFAULT_SCHEDULED_THREAD_POOL - Static variable in class org.forgerock.openig.http.DefaultDeclarations: Default scheduler for configurations that require periodic execution of tasks such as cache eviction.
DEFAULT_SESSION_TIMEOUT - Static variable in class org.forgerock.openig.session.jwt.JwtSessionManagerHeaplet: Default sessionTimeout duration.
DEFAULT_TEMPORARY_STORAGE - Static variable in class org.forgerock.openig.http.DefaultDeclarations: Default temporary storage.
DEFAULT_TIMER_DECORATOR - Static variable in class org.forgerock.openig.http.DefaultDeclarations: Default Timer decorator.
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.
DefaultAuthenticationService - Class in org.forgerock.openig.tools.authentication.chf: Implements an HTTP-based authentication service.
DefaultAuthenticationService(Handler, URI) - Constructor for class org.forgerock.openig.tools.authentication.chf.DefaultAuthenticationService: Constructs a DefaultAuthenticationService.
DefaultDeclarations - Class in org.forgerock.openig.http: Configurations used as defaults in the 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.
defaultKey() - Method in class org.forgerock.openig.tools.ServerTlsOptions.SniConfiguration: Returns the default SigningKey to use when the server name is unknown.
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
defaultOptions() - Static method in class org.forgerock.util.Options: Returns a new set of options with default settings.
defaultOptions(Context) - Static method in class org.forgerock.openig.ldap.LdapClient: Setup the default options to create a LdapClient and adds the transactionId if any in the context's chain.
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
DefaultSecretsService - Class in org.forgerock.openig.secrets: Deprecated.
in 7.0, use SecretsProvider reference instead.
DefaultSecretsService(SecretsProvider) - Constructor for class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.

Constructs a new DefaultSecretsService with a given provider.
DefaultSecretsService.Builder - Class in org.forgerock.openig.secrets: Deprecated.

DefaultSecretsService's builder.
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 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
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) - Method in class org.forgerock.openig.ldap.LdapConnection: Deletes the named entry from the Directory Server.
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(DeleteRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Deletes an entry from the Directory Server using the provided delete request.
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 - 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.
deleteSubtree(String) - Method in class org.forgerock.openig.ldap.LdapConnection: Deletes the named entry and all of its subordinates from the Directory Server.
DeliveryModeConfig - Enum 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.
DeprecatedUserProfileFilter - Class in org.forgerock.openig.openam: Deprecated.
Since 6.5. Prefer to use the UserProfileFilter that does not require a SSO Token.
DeprecatedUserProfileFilter(AmService, Expression<String>, Set<String>) - Constructor for class org.forgerock.openig.openam.DeprecatedUserProfileFilter: Deprecated.

Creates a new Access Management profile attributes filter.
DERIVE_BITS - org.forgerock.json.jose.jwk.KeyOperation: Use Key to derive bits not to be used as a key.
DERIVE_KEY - 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.
DesKeyGenHandler - Class in org.forgerock.openig.handler: Deprecated.
Since 7.0.0 with no replacement
DesKeyGenHandler() - Constructor for class org.forgerock.openig.handler.DesKeyGenHandler: Deprecated.
DesKeyGenHandler.Heaplet - Class in org.forgerock.openig.handler: Deprecated.

Creates and initializes a DES key generator handler in a heap environment.
destroy() - Method in class org.forgerock.http.servlet.HttpFrameworkServlet
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.SamlFederationHandler.Heaplet
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.sql.JdbcDataSourceHeaplet
destroy() - Method in class org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet
destroy() - Method in class org.forgerock.secrets.GenericSecret
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 - 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 - org.forgerock.json.jose.jwe.JweAlgorithm: Direct encryption with a shared symmetric key.
DIRECT - org.forgerock.json.jose.jwe.JweAlgorithmType: Direct symmetric encryption.
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 - 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 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
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, Exception) - 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
dn(String, Object...) - Method in class org.forgerock.openig.ldap.LdapClient: Formats an LDAP distinguished name using the provided template and attribute values.
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.
domain(String) - Method in class org.forgerock.openig.http.CookieBuilder: Set the domain and return a new instance of this builder.
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>) - 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>) - 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 - 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.
Prefer the use of Duration.duration(long, TimeUnit).
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 - org.forgerock.json.jose.jwk.KeyType: Elliptical Curve Key.
ECDH_ES - org.forgerock.json.jose.jwe.JweAlgorithm: Elliptic Curve Diffie-Hellman (ECDH) key agreement, directly using the derived key for encryption.
ECDH_ES - org.forgerock.json.jose.jwe.JweAlgorithmType: Elliptic Curve Diffie-Hellman (ECDH) key agreement in Ephemeral-Static (ES) configuration.
ECDH_ES_A128KW - 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 - 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 - 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 - org.forgerock.json.jose.jws.JwsAlgorithmType: Elliptic Curve DSA signing algorithm.
ECDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers: Deprecated.
Use SecretECDSASigningHandler instead
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 - org.forgerock.json.jose.jws.SupportedEllipticCurve: The Ed25519 curve used for EdDSA signatures.
ED448 - org.forgerock.json.jose.jws.SupportedEllipticCurve: The Ed448 curve used for EdDSA signatures.
EDDSA - org.forgerock.json.jose.jws.JwsAlgorithm: Edwards Curve DSA (EdDSA), as defined in RFC 8037.
EDDSA - org.forgerock.json.jose.jws.JwsAlgorithmType: Edwards Curve DSA signing algorithm.
EdDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers: Deprecated.
Use SecretEdDSASigningHandler instead.
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.
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 - 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.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.
enableNotifications(boolean) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Enable or disable the notifications.
enc(EncryptionMethod) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder: Sets the Encryption Method header parameter for this JWE.
ENC - 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.
Prefer SignedJwtBuilderImpl.encrypt(EncryptionKey) instead.
encrypt(EncryptionKey<?>) - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl: Wraps the signed JWT in an outer encrypted JWE envelope.
ENCRYPT - org.forgerock.json.jose.jwk.KeyOperation: Use Key to encrypt content.
ENCRYPT - org.forgerock.openig.filter.CryptoHeaderFilter.Operation: Deprecated.

Performs an encryption of the selected headers.
ENCRYPT - 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: Deprecated.
Use JwtBuilderFactory.jwe(org.forgerock.secrets.keys.EncryptionKey) instead.
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
encryptedPrivateKeyJwtClientAuthenticationFilter() - Static method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter: Creates a new builder for 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 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.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) - 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.
Use JweHeaderBuilder.epk(JWK) instead.
epk(JWK) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder: Sets the Ephemeral Public Key header parameter for this JWE.
EPK - 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.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 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 class org.forgerock.openig.heap.Name
equals(Object) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
equals(Object) - Method in 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 class org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpec
equals(Object) - Method in class org.forgerock.secrets.Purpose
equals(Object) - Method in class org.forgerock.secrets.Secret
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 - 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.
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 - org.forgerock.audit.handlers.syslog.Severity: Error conditions.
ES256 - org.forgerock.json.jose.jws.JwsAlgorithm: ECDSA using SHA-256 hash algorithm.
ES384 - org.forgerock.json.jose.jws.JwsAlgorithm: ECDSA using SHA-384 hash algorithm.
ES512 - org.forgerock.json.jose.jws.JwsAlgorithm: ECDSA using SHA-512 hash algorithm.
ESTIMATE - 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 - org.forgerock.json.resource.CountPolicy: Exact count is required.
exceptionHandler(Consumer<Throwable>) - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Supply an exception handler capable of consuming websocket exceptions.
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.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.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.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.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.secrets.Base64EncodedSecretStoreTypeProvider
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.secrets.SecretsProviderTypeProvider
execute(TypeDefinitionRegistry) - Method in class org.forgerock.openig.security.ClientTlsOptionsTypeProvider
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 - 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 JsonPointer s 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.
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.
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 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 org.forgerock.secrets.keys.KeyFormatRaw
export(KeyFormat<T>) - Method in class org.forgerock.secrets.keys.CryptoKey: Exports the key material in the given format.
exportAsKey(CryptoKey) - Static method in class org.forgerock.openig.secrets.SecretsUtils: Exports the key material in the raw format.
exportAsKeyAndClose(CryptoKey) - Static method in class org.forgerock.openig.secrets.SecretsUtils: Exports the key material in the raw format and close the provided key material.
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.
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 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 - org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: The access request was not successfully completed.
FAILED - 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.
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.
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
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
fileToUrl(File) - Static method in class org.forgerock.openig.el.Functions: Returns the String representation of the URL denoting the given file.
filter(String, Object...) - Method in class org.forgerock.openig.ldap.LdapClient: Formats an LDAP filter using the provided template and assertion values.
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.CryptoHeaderFilter: Deprecated.
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.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.RuntimeExceptionFilter
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.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.DeprecatedUserProfileFilter: Deprecated.
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.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(Context, Request, Handler) - Method in class org.forgerock.openig.websocket.WebSocketHandshakeDetectorFilter
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 - org.forgerock.openig.decoration.capture.CapturePoint: Prints the filtered request (Filter only).
FILTERED_RESPONSE - 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(HttpClientLoader, Options) - Method in class org.forgerock.openig.handler.ClientHandlerHeaplet
filters(HttpClientLoader, 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(HttpClientLoader, 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.IssuerRepository: Find a registered Issuer whose name matches issuerName.
findBySupportedDomainNames(String) - Method in class org.forgerock.openig.filter.oauth2.client.IssuerRepository: Find a registered Issuer that supports the given {code domainName}.
findGroups(String, String) - Static method in class org.forgerock.openig.el.Functions: Returns an array containing the result of a find on a regular expression against a string, or null if no result is found.
findHeapletClass(Class<?>) - Static method in class org.forgerock.openig.heap.Heaplets: Finds the heaplet class associated to the given c type.
findJwk(String) - Method in class org.forgerock.json.jose.jwk.JWKSet: Search for a JWK that matches the kid.
findJwk(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Deprecated.
Use JwksStore.findJwkAsync(String) instead.
findJwk(Algorithm, String) - Method in class org.forgerock.json.jose.jwk.JWKSet: Search for a JWK that matches the algorithm and the key usage.
findJwk(Algorithm, String) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Deprecated.
Use JwksStore.findJwkAsync(String) instead.
findJwkAsync(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Search asynchronously for a JWK that matches the kid.
findJwkAsync(Algorithm, String) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Search asynchronously for a JWK that matches the algorithm and the key usage.
findOrCreateFromWellKnownUri(String, URI) - Method in class org.forgerock.openig.filter.oauth2.client.IssuerRepository: Try to find an already registered Issuer named issuerName.
findOrCreateFromWellKnownUri(String, URI, List<Pattern>, Handler) - Method in class org.forgerock.openig.filter.oauth2.client.IssuerRepository: Tries to find an already registered Issuer named issuerName.
findOrCreateSession() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext: Returns the managed session, or create a new one if none are managed at the time of this call.
findScriptFactory(String) - Method in class org.forgerock.openig.script.DefaultScriptFactoryManager
findScriptFactory(String) - Method in interface org.forgerock.openig.script.ScriptFactoryManager: Finds a factory for the given MIME type.
findSession() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext: Returns the managed session, or an empty Optional if none are managed at the time of this call.
findShare(Request) - Method in class org.forgerock.openig.uma.UmaSharingService: Find a Share.
firstOf(JsonValue, String...) - Static method in class org.forgerock.openig.util.JsonValues: Returns, if the given JSON value contains one of the names, the first defined JSON value, otherwise if the given JSON value does not match any of the names, then a JsonValue encapsulating null is returned.
FixedRateThrottlingPolicy - Class in org.forgerock.openig.filter.throttling: An implementation of the ThrottlingPolicy that always returns the same throtlling rate.
FixedRateThrottlingPolicy(ThrottlingRate) - Constructor for class org.forgerock.openig.filter.throttling.FixedRateThrottlingPolicy: Constructs a new throttling policy that always returns the same throttling rate.
FixedTimeRotationPolicy - Class in org.forgerock.audit.rotation: Rotates audit files at fixed times throughout the day.
FixedTimeRotationPolicy(List<Duration>) - Constructor for class org.forgerock.audit.rotation.FixedTimeRotationPolicy: Constructs a FixedTimeRotationPolicy given a list of milliseconds after midnight to rotateIfNeeded the files.
flatten(JsonValue) - Static method in class org.forgerock.audit.util.JsonValueUtils: Flattens a JsonValue to a Map, where the keys of the Map are JsonPointer s and the values are the value the JsonPointer s resolve to.
flatten(Context) - Static method in class org.forgerock.openig.el.Bindings: Flatten the current leaf Context into a Map keyed by context name.
FlowableDecoder - Interface in org.forgerock.http.decoder: Decodes an HTTP message entity flow.
flush() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter
flush() - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Flush the output stream which flushes the target output stream.
flush() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
flush() - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Flushes any buffered contents of the output stream.
flush() - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
flush() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
FLUSH_FILE_ACTION_NAME - Static variable in class org.forgerock.audit.handlers.json.JsonAuditEventHandler: Name of action to force flushing of file-buffer, which is not the same as flushing buffered audit events, and is primarily used for testing purposes.
flushBuffer() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
FORBIDDEN - Static variable in class org.forgerock.http.protocol.Status: The 403 (Forbidden) status code indicates that the server understood the request but refuses to authorize it.
FORBIDDEN - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource understood the request, but is refusing to fulfill it.
FORBIDDEN - Static variable in class org.forgerock.openig.handler.Handlers: A default Handler implementation that returns an empty (403 Forbidden) Response.
ForbiddenException - Exception in org.forgerock.json.resource: An exception that is thrown when access to a resource is forbidden during an operation on an resource.
ForbiddenException() - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with null as its detail message.
ForbiddenException(String) - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with the specified detail message.
ForbiddenException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with the specified detail message and cause.
ForbiddenException(Throwable) - Constructor for exception org.forgerock.json.resource.ForbiddenException: Constructs a new exception with the specified cause.
forbiddenHandler() - Static method in class org.forgerock.http.handler.Handlers: A common HTTP Framework Handler responding 403 Forbidden.
forceRotation() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Forces a rotation of the writer.
forCipherConstant(int) - Static method in enum org.forgerock.secrets.keys.KeyType: Converts an integer key type constant from the Cipher class into an equivalent KeyType enum value.
forContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets common fields from services contexts.
FORGEROCK_CLIENT_HANDLER - Static variable in class org.forgerock.openig.http.DefaultDeclarations: The client handler that deals with ForgeRock platform services (AM interactions mostly).
FORGEROCK_CLIENT_HANDLER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve ForgeRock ClientHandler instance from the Heap, which chains a TransactionIdOutboundFilter to a ClientHandler.
forHttpRequest(Context, Request) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets common fields from CREST contexts and request.
forKey(Key) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Determines the standard curve that matches the given (private or public) key.
forKey(Key, String) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Determines the standard curve that matches the given (private or public) key.
forKeyType(Class<? extends CryptoKey>) - Static method in enum org.forgerock.secrets.keys.KeyUsage: Returns the set of all key usages that are applicable to the given key type.
Form - Class in org.forgerock.http.protocol: Form fields, a case-sensitive multi-string-valued map.
Form() - Constructor for class org.forgerock.http.protocol.Form: Constructs a new, empty form object.
format(String, Object...) - Static method in class org.forgerock.json.resource.ResourcePath: Creates a new resource path using the provided path template and unencoded path elements.
formatDate(Date) - Static method in class org.forgerock.http.header.HeaderUtil: Formats a HTTP-date using RFC 1123 format as specified in RFC 2616.
forMaxAge(Duration) - Static method in class org.forgerock.json.resource.ResponseCacheControl: Returns a cache control that will allow caching until the given maximum age.
forMaxAgeSeconds(long) - Static method in class org.forgerock.json.resource.ResponseCacheControl: Returns a cache control that will allow caching until the given maximum age (in seconds).
formDecodeParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided form encoded parameter name or value as per application/x-www-form-urlencoded.
formEncodeParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: Form encodes the provided parameter name or value as per application/x-www-form-urlencoded.
forName(String) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Returns the curve parameters for the given standard curve name (crv claim in a JWK).
forPurpose(Purpose<GenericSecret>) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: Configures the purpose for which this access token store is to be used.
forSignature(byte[]) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Determines the supported curve parameters for the given ECDSA signature.
forSignature(byte[], JwsAlgorithmType) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Determines the supported curve parameters for the given signature.
forSigning(byte[]) - Static method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler: Deprecated.

Initialises a signing handler for signing.
forSigning(PrivateKey) - Static method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler: Deprecated.

Initialises a signing handler for signing.
forVerification(byte[]) - Static method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler: Deprecated.

Initialises a signing handler for verification.
forVerification(PublicKey) - Static method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler: Deprecated.

Initialises a signing handler for verification.
ForwardedHeader - Class in org.forgerock.http.header: A Header representation of the Forwarded HTTP header.
ForwardedHeader() - Constructor for class org.forgerock.http.header.ForwardedHeader
ForwardedHeader.Hop - Class in org.forgerock.http.header: This class represents a request's hop detail.
ForwardedRequestFilter - Class in org.forgerock.openig.filter: Rebase the UriRouterContext's Original URI with a computed scheme, host name and port.
ForwardedRequestFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes an ForwardedRequestFilter in a heap environment.
forWebCryptoName(String) - Static method in enum org.forgerock.secrets.keys.KeyUsage: Converts a Web Crypto/JWK key operation name into the equivalent key usage constant.
FOUND - Static variable in class org.forgerock.http.protocol.Status: The 302 (Found) status code indicates that the target resource resides temporarily under a different URI.
FragmentFilter - Class in org.forgerock.openig.filter: The FragmentFilter supports URIs that contain fragments, keeping track of the fragment part when a request triggers a login redirect.
FragmentFilter(String, String, FragmentFilter.ExtendedCookieBuilder) - Constructor for class org.forgerock.openig.filter.FragmentFilter: Creates a new FragmentFilter.
FragmentFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initialises a FragmentFilter in a heap environment.
FreeDiskSpaceRetentionPolicy - Class in org.forgerock.audit.retention: A RetentionPolicy that will retain/delete log files given a minimum amount of disk space the file system must contain.
FreeDiskSpaceRetentionPolicy(long) - Constructor for class org.forgerock.audit.retention.FreeDiskSpaceRetentionPolicy: Constructs a FreeDiskSpaceRetentionPolicy given a minimum amount of disk space the file system must contain.
from(Object) - Static method in class org.forgerock.openig.el.Expressions: Compile to expression an Object that may contain some String that needs to be evaluated.
from(String) - Static method in class org.forgerock.openig.el.Expressions: Convert a String to a compiled expression.
from(List<Object>) - Static method in class org.forgerock.openig.el.Expressions: Compile as expressions what can be compiled in a list.
from(Map<String, Object>) - Static method in class org.forgerock.openig.el.Expressions: Compile a map that may contain some values that needs to be transformed as expression.
FROM_PTR - Static variable in class org.forgerock.json.JsonPatch: Path to the "from" attribute of a patch entry.
fromCertificate(Certificate) - Static method in enum org.forgerock.secrets.keys.KeyUsage: Determines what usages are allowed for a public key based on the associated certificate.
fromCidrPattern(String) - Static method in class org.forgerock.openig.util.InetAddressMask: Build an address mask from a CIDR formatted string.
fromCidrPatterns(List<String>) - Static method in class org.forgerock.openig.util.InetAddressMask: Build a list of address masks from a list of CIDR pattern.
fromFormString(String) - Method in class org.forgerock.http.protocol.Form: Parses a form URL-encoded string containing form parameters and stores them in this object.
fromIntDate(long) - Static method in class org.forgerock.json.jose.utils.IntDate: Converts an IntDate into a Java Date object.
fromQueryString(String) - Method in class org.forgerock.http.protocol.Form: Parses a URL-encoded query string containing form parameters and stores them in this object.
fromRequestEntity(Request) - Method in class org.forgerock.http.protocol.Form: Deprecated.
Because Entity content should be read asynchronously. Instead retrieve the Form with Entity.getFormAsync().
fromRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form: Parses the query parameters of a request and stores them in this object.
fromString(String) - Method in class org.forgerock.http.protocol.Form: Deprecated.
use Form.fromFormString(String) instead.
fromX509KeyUsageBits(boolean[]) - Static method in enum org.forgerock.secrets.keys.KeyUsage: Converts an X.509 KeyUsage bit vector into a corresponding set of usage values.
FTP - org.forgerock.audit.handlers.syslog.Facility: FTP daemon.
Function<VIN,VOUT,E extends Exception> - Interface in org.forgerock.util: A synchronous function which returns a result immediately.
Functions - Class in org.forgerock.openig.el: Methods exposed for EL usage.
futureToPromise(CompletionStage<T>, Class<E>) - Static method in class org.forgerock.openig.tools.FutureUtils: Converts a CompletionStage to a Promise.
FutureUtils - Class in org.forgerock.openig.tools: Utility class for Futures and Promises.

G

GATEWAY_TIMEOUT - Static variable in class org.forgerock.http.protocol.Status: The 504 (Gateway Timeout) status code indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.
GatewayHttpApplication - Class in org.forgerock.openig.http: Configuration class for configuring the Identity Gateway.
GatewayHttpApplication(Environment, JsonValue, EndpointRegistry, RunMode, MeterRegistry, PropertyResolver, HttpClientLoader, WebSocketClientProvider, WebSocketProxyFilterProvider, Clock, IgTicker) - Constructor for class org.forgerock.openig.http.GatewayHttpApplication: Construct a GatewayHttpApplication.
gatherHttpContentsAsync(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser: Uses the Client to gather HTTP information.
generate() - Method in interface org.forgerock.util.generator.IdGenerator: Returns a new globally unique identifier.
generate() - Method in class org.forgerock.util.generator.IdGenerator.SequenceUuidIdGenerator
generate(JsonValue) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler: Deprecated.
generate(JsonValue) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler
generate(JsonValue) - Method in interface org.forgerock.tokenhandler.TokenHandler: Generates a new token using the state.
generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler
generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.ECDHEncryptionHandler
generateInitialisationVector() - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler: Generates a random JWE Initialisation Vector of the correct size for the encryption algorithm, if the EncryptionHandler JweAlgorithm does not required an initialisation vector then the initialisation vector will be an empty octet sequence.
generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler: Generates a random JWE Initialisation Vector of the correct size for the encryption algorithm.
generateJsonPointers(JsonValue) - Static method in class org.forgerock.audit.util.JsonSchemaUtils: Generates the Set of JsonPointers in a given JsonSchema.
generateJWEEncryptedKey(Key, Key) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler
generateJWEEncryptedKey(Key, Key) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
generateJWEEncryptedKey(Key, Key) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler: Deprecated.
Use EncryptionHandler.generateJWEEncryptedKey(Key, Key, JweHeader) instead.
generateJWEEncryptedKey(Key, Key) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler: Generates the JWE Encrypted Key by encrypting the Content Encryption Key (CEK) using the JweAlgorithm RSAES_PCKCS1_V1_5.
generateJWEEncryptedKey(Key, Key, JweHeader) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.ECDHEncryptionHandler
generateJWEEncryptedKey(Key, Key, JweHeader) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler: Generates the Content Encryption Key (CEK) following the appropriate steps defined by the EncryptionHandler JweAlgorithm.
generateKeyPair(SupportedEllipticCurve) - Static method in class org.forgerock.json.jose.jwk.OkpJWK: Generates a fresh OKP JWK with both public and private claims on the given curve.
GenericHeader - Class in org.forgerock.http.header: An undecoded HTTP message header.
GenericHeader(String, String) - Constructor for class org.forgerock.http.header.GenericHeader: Constructs a new header with the provided name and value.
GenericHeader(String, List<String>) - Constructor for class org.forgerock.http.header.GenericHeader: Constructs a new header with the provided name and values.
GenericHeaplet - Class in org.forgerock.openig.heap: A generic base class for heaplets with automatically injected fields.
GenericHeaplet() - Constructor for class org.forgerock.openig.heap.GenericHeaplet
GenericSecret - Class in org.forgerock.secrets: A generic secret represented as an opaque blob of bytes, such as a password or API key.
GenericSecret(SecretBuilder) - Constructor for class org.forgerock.secrets.GenericSecret: Constructs a generic secret with the given stable identifier and secret data.
get() - Method in class org.forgerock.openig.decoration.helper.LazyReference: Resolves the encapsulated reference.
get() - Method in class org.forgerock.secrets.SecretReference: Gets the current active secret object, refreshing it if necessary.
get() - Method in class org.forgerock.util.LazySupplier: Supplies a value and caches it, ensuring the same value is returned on subsequent calls.
get() - Method in interface org.forgerock.util.promise.Promise: Waits if necessary for this Promise to complete, and then returns the result if it completed successfully, or throws an ExecutionException containing the cause of the failure.
get() - Method in class org.forgerock.util.promise.PromiseImpl
get() - Method in interface org.forgerock.util.Supplier: Supply a value.
get(int) - Method in class org.forgerock.json.JsonPointer: Returns the reference token at the specified position.
get(int) - Method in class org.forgerock.json.JsonValue: Returns the specified child value.
get(int) - Method in class org.forgerock.json.resource.ResourcePath: Returns the path element at the specified position in this resource path.
get(int) - Method in class org.forgerock.util.LazyList: Returns the element at the specified position in this list.
get(int) - Method in class org.forgerock.util.ListDecorator: Returns the element at the specified position in this list.
get(int) - Method in class org.forgerock.util.promise.Promises.Results: Returns the result stored at the index i.
get(long, TimeUnit) - Method in interface org.forgerock.util.promise.Promise: Waits if necessary for at most the given time for this Promise to complete, and then returns the result if it completed successfully, or throws an ExecutionException containing the cause of the failure.
get(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
get(Class<H>) - Method in class org.forgerock.http.protocol.Headers: Returns the specified Header or {code null} if the header is not included in the message.
get(Object) - Method in class org.forgerock.http.protocol.Headers: Rich-type friendly get method.
get(Object) - Method in class org.forgerock.http.protocol.RequestCookies
get(Object) - Method in class org.forgerock.http.util.CaseInsensitiveMap
get(Object) - Method in class org.forgerock.util.LazyMap: Returns the value to which the specified key is mapped, or null if the map contains no mapping for the key.
get(Object) - Method in class org.forgerock.util.MapDecorator: Returns the value to which the specified key is mapped, or null if the map contains no mapping for the key.
get(Object, Object) - Method in class org.forgerock.openig.resolver.ArrayResolver
get(Object, Object) - Method in class org.forgerock.openig.resolver.BeanResolver
get(Object, Object) - Method in class org.forgerock.openig.resolver.HeadersResolver
get(Object, Object) - Method in class org.forgerock.openig.resolver.HeapResolver
get(Object, Object) - Method in class org.forgerock.openig.resolver.ListResolver
get(Object, Object) - Method in class org.forgerock.openig.resolver.MapResolver
get(Object, Object) - Method in class org.forgerock.openig.resolver.PrincipalResolver
get(Object, Object) - Method in interface org.forgerock.openig.resolver.Resolver: Attempts to resolve an element of an object.
get(Object, Object) - Static method in class org.forgerock.openig.resolver.Resolvers: Attempts to resolve an element of an object.
get(String) - Method in class org.forgerock.json.jose.jwt.JWObject: Returns the specified item value.
get(String) - Method in class org.forgerock.json.JsonValue: Returns the specified item value.
get(String) - Method in class org.forgerock.services.context.AbstractContext
get(String) - Method in interface org.forgerock.services.context.Context: Returns an Optional containing the first context in the chain whose context name matches the provided name, or an empty Optional if none is present.
get(String, Class<T>) - Method in interface org.forgerock.openig.heap.Heap: Returns an object from the heap with a specified name, or null if no such object exists.
get(String, Class<T>) - Method in class org.forgerock.openig.heap.HeapImpl
get(K, Function<K, V>) - Method in class org.forgerock.util.NonExpiringCache: Gets the object from the cache for the given key, or computes the value from calculation function and inserts the calculated value into the map.
get(JsonPointer) - Method in class org.forgerock.json.JsonValue: Returns the specified child value with a pointer, relative to this value as root.
get(Context) - Method in class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier: Computes (or re-computes) the value in a thread-safe manner, making sure that only 1 thread will compute the value, the other being blocked, waiting for the result to be computed.
get(Option<T>) - Method in class org.forgerock.util.Options: Returns the value associated with the provided option, or its default value if the option has not been configured.
getAcceptedIssuers() - Method in class org.forgerock.openig.security.TrustAllManager
getAcceptedIssuers() - Method in class org.forgerock.secrets.SecretsTrustManager
getAccessToken() - Method in class org.forgerock.http.oauth2.OAuth2Context: Returns the access token associated with this OAuth2 context.
getAccessToken(Context, String, String) - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Exchanges the authorization code for an access token and optional ID token, and then update the session state.
getAction() - Method in interface org.forgerock.json.resource.ActionRequest: Returns the ID of the action to be performed by this action request.
getAction() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionRequest: Returns this message's action.
getActionAsEnum(Class<T>) - Method in interface org.forgerock.json.resource.ActionRequest: Returns the ID of the action to be performed by this action request as a enum constant of the specified enum type.
getActions() - Method in class org.forgerock.openig.openam.PolicyDecisionContext: Returns the unmodifiable map of actions provided in the policy decision (can be empty, but never null).
getActive(Purpose<S>) - Method in class org.forgerock.openig.secrets.Base64EncodedSecretStore
getActive(Purpose<S>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
getActive(Purpose<S>) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore
getActive(Purpose<S>) - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
getActive(Purpose<S>) - Method in interface org.forgerock.secrets.SecretStore: Returns the active secret for the given purpose.
getActive(Purpose<S>) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
getActiveRequestCount() - Method in class org.forgerock.openig.filter.MetricsFilter: Get the active request count.
getActiveSecret(Purpose<S>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getActiveSecret(Purpose<S>) - Method in interface org.forgerock.openig.secrets.SecretsService: Gets the currently active secret for the given purpose.
getActiveSecret(Purpose<S>) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getActiveSecret(Purpose<S>) - Method in class org.forgerock.secrets.SecretsProvider: Gets the currently active secret for the given purpose.
getAddedHeaders() - Method in class org.forgerock.openig.filter.HeaderFilter: Returns the header fields to add to the message, represented as a MultiMap of String to a List of String, each listed value representing an expression that will be evaluated.
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.ActionRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.CreateRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.DeleteRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.PatchRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.QueryRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.ReadRequest
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.Request: Returns the additional parameter which should be used to control the behavior of this action request.
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.UpdateRequest
getAdditionalParameters() - Method in class org.forgerock.http.header.ContentTypeHeader: Deprecated.
Replaced by ContentTypeHeader.getDirectives()
getAdditionalParameters() - Method in interface org.forgerock.json.resource.ActionRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.CreateRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.DeleteRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.PatchRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.QueryRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.ReadRequest
getAdditionalParameters() - Method in interface org.forgerock.json.resource.Request: Returns the additional parameters which should be used to control the behavior of this action request.
getAdditionalParameters() - Method in interface org.forgerock.json.resource.UpdateRequest
getAdvices() - Method in class org.forgerock.json.resource.AdviceContext: Returns the advices contained within this context.
getAdvices() - Method in class org.forgerock.openig.openam.PolicyDecisionContext: Returns the unmodifiable map of advices provided in the policy decision (can be empty, but never null).
getAgent() - Method in class org.forgerock.http.header.Warning: Gets the warning's agent name.
getAgentId() - Method in class org.forgerock.openig.tools.am.AmService: Returns the agent's ID.
getAgreementPartyUInfo() - Method in class org.forgerock.json.jose.jwe.JweHeader: Gets the Agreement PartyUInfo header parameter for this JWE.
getAgreementPartyVInfo() - Method in class org.forgerock.json.jose.jwe.JweHeader: Gets the Agreement PartyVInfo header parameter for this JWE.
getAlgorithm() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm
getAlgorithm() - Method in class org.forgerock.json.jose.jwe.JweHeader: Gets the Algorithm set in the JWT header.
getAlgorithm() - Method in class org.forgerock.json.jose.jwk.JWK: Deprecated.
replaced by JWK.getJwaAlgorithm()
getAlgorithm() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
getAlgorithm() - Method in class org.forgerock.json.jose.jws.JwsHeader: Gets the Algorithm set in the JWT header.
getAlgorithm() - Method in interface org.forgerock.json.jose.jwt.Algorithm: Gets the actual name of the algorithm that is understood by Java cryptographic operations.
getAlgorithm() - Method in class org.forgerock.json.jose.jwt.JwtHeader: Gets the Algorithm set in the JWT header.
getAlgorithm() - Method in class org.forgerock.openig.tools.TlsOptions: Returns the SSL context algorithm name (never null).
getAlgorithm(String) - Static method in class org.forgerock.json.jose.jwk.JWK: Get the algorithm corresponding.
getAlgorithmString() - Method in class org.forgerock.json.jose.jwt.JwtHeader: Gets the string representation of the Algorithm set in the JWT header.
getAlgorithmType() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Gets the JweAlgorithmType of the JweAlgorithm.
getAlgorithmType() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Gets the JwsAlgorithmType of the JwsAlgorithm.
getAlias() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails: Get the alias that this key is stored using in the keystore.
getAll(Class<T>) - Method in interface org.forgerock.openig.heap.Heap: Deprecated.
marked in 6.5 with no functional equivalent
getAll(Class<T>) - Method in class org.forgerock.openig.heap.HeapImpl
getAll(String) - Method in class org.forgerock.http.protocol.Headers: Gets all the values of the header, or an empty list if the header doesn't exist.
getAllowedAlgorithms() - Method in class org.forgerock.secrets.SecretBuilder: Returns a predicate that can be used to test whether a given algorithm can be used with this key.
getAllowedKeyUsages() - Method in class org.forgerock.secrets.SecretBuilder: The allowed key usages of this key.
getApiId() - Method in interface org.forgerock.json.resource.CrestApplication: Get the API ID, that will be used in the ApiDescription.
getApiProducer() - Method in interface org.forgerock.http.DescribedHttpApplication: Provides the OpenAPI descriptor producer with which to produce the API.
getApiProducer() - Method in class org.forgerock.openig.http.AdminHttpApplication: Needed to enforce generation of CREST APIs.
getApiVersion() - Method in interface org.forgerock.json.resource.CrestApplication: Get the API Version, that will be used in the ApiDescription.
getAsync() - Method in class org.forgerock.secrets.SecretReference: Gets the current active secret object asynchronously, refreshing it if necessary.
getAsyncContext() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getAttribute(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getAttribute(String) - Method in class org.forgerock.openig.tools.jwt.validation.ValidatorConstraintContext: Get an attribute from the JwtValidationContext by key.
getAttributeNames() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getAttributes() - Method in class org.forgerock.openig.openam.PolicyDecisionContext: Returns the unmodifiable map of attributes provided in the policy decision (can be empty, but never null).
getAttributes() - Method in class org.forgerock.services.context.AttributesContext: Returns the attributes associated with the current request.
getAudience() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the intended audience for the JWT from the Claims Set.
getAuditEventHandlerConfigurationSchema(String, ClassLoader) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Gets the configuration schema for an audit event handler as json schema.
getAuditEventProperties(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets the Audit Event schema properties.
getAuditEventSchema(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets the Audit Event schema.
getAuthenticatedHandler() - Method in class org.forgerock.openig.tools.am.AmService: Returns a Handler that will perform automatic authentication with the provided agent credentials.
getAuthenticationId() - Method in class org.forgerock.services.context.SecurityContext: Returns the principal that the client used during authentication.
getAuthenticationService() - Method in class org.forgerock.openig.tools.am.AmService: Returns the service used to authenticate subjects to AM.
getAuthenticationTag() - Method in class org.forgerock.json.jose.jwe.JweEncryption: Gets the authentication tag from the result of the encryption.
getAuthority() - Method in class org.forgerock.http.MutableUri: Returns the authority compound element.
getAuthorization() - Method in class org.forgerock.services.context.SecurityContext: Returns an unmodifiable map containing additional principals associated with the client which MAY be used when performing authorization decisions.
getAuthorizeEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer: Returns the authorize end-point of this issuer.
getAuthType() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getAuthzToken() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration: Gets the Splunk authorization token required for making HTTP event collector calls.
getAutoCommit() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the auto commit value.
getAvailableAuditEventHandlers() - Method in class org.forgerock.audit.AuditServiceConfiguration: Returns a list of class names of available audit event handlers.
getBaseDirectory() - Method in interface org.forgerock.openig.config.Environment: Deprecated.
in 7.0, use Environment.getInstanceDirectory() as a replacement
getBaseUri() - Method in class org.forgerock.http.routing.UriRouterContext: Returns the portion of the request URI which has been routed so far.
getBaseUri() - Method in class org.forgerock.openig.tools.am.AmService: Return the base URI for this server.
getBaseUri() - Method in class org.forgerock.openig.tools.am.UriService: Return the base URI for this server.
getBatch() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Returns the configuration used to initialize the batch publisher.
getBearerAccessToken(String) - Static method in class org.forgerock.http.oauth2.OAuth2: Extracts the bearer token from the request's authorization header.
getBestApiRoute(Context, R) - Method in class org.forgerock.services.routing.AbstractRouter: Get the best route for an API request.
getBestRoute(Context, R) - Method in class org.forgerock.services.routing.AbstractRouter: Finds the best route that matches the given request based on the route matchers of the registered routes.
getBody() - Method in class org.forgerock.openig.tools.notifications.Notification: Returns the notification's payload.
getBoundary() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns the encapsulation boundary or null if none specified.
getBranch() - Static method in class org.forgerock.openig.util.ProductInfo: Returns the branch name.
getBufferFactory() - Method in interface org.forgerock.http.HttpApplication: Gets the Factory that will create temporary storage Buffers to handle the processing of requests.
getBufferFactory() - Method in class org.forgerock.openig.http.AdminHttpApplication
getBufferFactory() - Method in class org.forgerock.openig.http.GatewayHttpApplication
getBuffering() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Returns the configuration for events buffering.
getBuffering() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration: Gets configuration of event buffering.
getBuffering() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Returns the configuration for events buffering.
getBuffering() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration: Gets configuration of event buffering.
getBuffering() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration: Gets the configuration for buffering.
getBuffering() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Returns the configuration for events buffering.
getBufferSize() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getBundleInPreferredLocale(String, ClassLoader) - Method in class org.forgerock.util.i18n.PreferredLocales: Get a ResourceBundle using the preferred locale list and using the provided ClassLoader.
getByAsIp() - Method in class org.forgerock.http.header.ForwardedHeader.Hop: Get the proxy node IP if set as an IPv4/v6 address.
getBytes() - Method in class org.forgerock.http.protocol.Entity: Returns a byte array containing a copy of the decoded content of this entity.
getBytesAsync() - Method in class org.forgerock.http.protocol.Entity: Returns a promise of the decoded entity content as a byte array.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Retrieves the number of bytes written by this writer.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Returns the number of bytes written in this stream.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
getBytesWritten() - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Retrieves the number of bytes written by this writer.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
getBytesWritten() - Method in interface org.forgerock.audit.rotation.RotatableObject: Retrieves the number of bytes written to the file.
getCacheControl() - Method in interface org.forgerock.json.resource.Response: Indicates how the response should be cached by clients.
getCacheMissCacheTime() - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Get the cache time before reloading the cache in case of cache miss.
getCacheTimeout() - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Get the cache timeout.
getCapacity() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.BatchConfiguration: Returns the maximum capacity of the publishing queue.
getCaseInsensitiveFields() - Method in class org.forgerock.audit.AuditServiceConfiguration: Get the list of audit event fields to treat case-insensitively when filtering.
getCause() - Method in class org.forgerock.http.protocol.Response: Returns the (possibly null) cause of this error message (assuming it is a 4xx or a 5xx).
getCertificate() - Method in class org.forgerock.secrets.keys.CryptoKey: Returns any certificate associated with this key.
getCertificate() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails: Get the Certificate instance for the public component of this key.
getCertificate() - Method in class org.forgerock.secrets.SecretBuilder: Returns the certificate associated with this secret, or null if not available.
getCertificate(Class<T>) - Method in class org.forgerock.secrets.keys.CryptoKey: Returns the certificate of the given type if one is available.
getCertificateChain() - Method in class org.forgerock.secrets.keys.CryptoKey: Gets the certificate chain associated with this secret.
getCertificateChain() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails: Get the certificate chain for the public component of this key.
getCertificateChain() - Method in class org.forgerock.secrets.SecretBuilder: Returns the certificate chain associated with this secret, or an empty list if not available.
getCertificateChain(Class<T>) - Method in class org.forgerock.secrets.keys.CryptoKey: Gets the certificate chain associated with this secret as a list of the given certificate type.
getCertificateChain(String) - Method in class org.forgerock.secrets.SecretsKeyManager
getCertificates() - Method in class org.forgerock.services.context.ClientContext: Returns the collection (possibly empty) of certificate(s) provided by the client.
getChallenges() - Method in class org.forgerock.http.header.WwwAuthenticateHeader: Return an unmodifiable view of the authentication challenges represented by this header object.
getCharacter() - Method in class org.forgerock.openig.text.Separator: Returns the character used to separate values.
getCharacterEncoding() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getCharacterEncoding() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getCharset() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns the character set encoding used to encode the message, or null if no character set was specified.
getCipher() - Method in class org.forgerock.secrets.keys.KeyDecryptionKey
getCipher() - Method in class org.forgerock.secrets.keys.KeyEncryptionKey
getCipherSuitesArray() - Method in class org.forgerock.openig.tools.TlsOptions: Returns the array of cipher suites to be enabled (may be null for JVM default).
getCipherSuitesList() - Method in class org.forgerock.openig.tools.TlsOptions: Returns the list of cipher suites to be enabled (may be empty for JVM default).
getCiphertext() - Method in class org.forgerock.json.jose.jwe.JweEncryption: Gets the ciphertext from the result of the encryption.
getClaim(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets a claim value for the specified key.
getClaim(String, Class<T>) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets a claim value for the specified claim name and then casts it to the specified type.
getClaims() - Method in class org.forgerock.openig.filter.jwt.JwtValidationContext: Returns the claims copy as a JwtClaimsSet.
getClaimSetKey(String) - Static method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey: Gets the JwtClaimsSetKey constant that matches the given String (case-insensitive).
getClaimsSet() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
getClaimsSet() - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
getClaimsSet() - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt: Gets the claims set object for the nested Encrypted JWT that is the payload of this JWS.
getClaimsSet() - Method in class org.forgerock.json.jose.jws.SignedJwt: Gets the claims set object for the Jwt, which contains all of the claims (name value pairs) conveyed by the JWT.
getClaimsSet() - Method in interface org.forgerock.json.jose.jwt.Jwt: Gets the claims set object for the Jwt, which contains all of the claims (name value pairs) conveyed by the JWT.
getClaimsSet() - Method in class org.forgerock.openig.openam.CdSsoContext: Get a copy of the JWT claims set.
getClass(String) - Static method in class org.forgerock.util.Loader: Returns the Class object associated with the class or interface with the given name, or null if the class could not be returned for any reason.
getClassLoader() - Static method in class org.forgerock.util.Loader: Returns the class loader that should be used consistently throughout the application.
getClientAliases(String, Principal[]) - Method in class org.forgerock.secrets.SecretsKeyManager
getClientAuthentication() - Method in class org.forgerock.openig.tools.ServerTlsOptions: Return the configured ServerTlsOptions.ClientAuthentication required.
getClientId() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Returns the client ID of this client registration.
getClientId() - Method in class org.forgerock.secrets.oauth2.GrantTypeHandler: The client id of the client using this grant type.
getClientIpAddress() - Method in class org.forgerock.http.header.XForwardedForHeader: Get the IP address of the request's originating client.
getCloseHandler() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The close handler (guaranteed to be not null).
getCode() - Method in enum org.forgerock.audit.handlers.syslog.Facility: Get the syslog code for the facility.
getCode() - Method in enum org.forgerock.audit.handlers.syslog.Severity: Get the syslog code for the severity.
getCode() - Method in class org.forgerock.http.header.Warning: Gets the warning's three digit code.
getCode() - Method in class org.forgerock.http.protocol.Status: Returns the three-digit integer code giving the result of the attempt to understand and satisfy the request.
getCode() - Method in exception org.forgerock.json.resource.ResourceException: Returns the numeric code of the exception.
getCodings() - Method in class org.forgerock.http.header.ContentEncodingHeader: Returns the list of content codings.
getComment() - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
getCommentURL() - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
getCommonName() - Method in class org.forgerock.openig.openam.UserProfileContext: Get the user's common name (cn) or null if none.
getCommonName() - Method in class org.forgerock.openig.tools.userprofile.UserProfile: Get the common name (cn) or null if none.
getCompressionAlgorithm() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the Compression Algorithm header parameter for this JWE.
getCompressionHandler(CompressionAlgorithm) - Method in class org.forgerock.json.jose.jwe.CompressionManager: Gets the appropriate CompressionHandler that can perform the required compression using the given compression algorithm.
getConfig() - Method in interface org.forgerock.audit.AuditService: Gets the AuditService configuration.
getConfig() - Method in class org.forgerock.audit.AuditServiceProxy
getConfig() - Method in class org.forgerock.openig.audit.NoOpAuditService
getConfig() - Method in interface org.forgerock.openig.decoration.Context: Returns the heap object being decorated configuration.
getConfig() - Method in class org.forgerock.openig.heap.GenericHeaplet: Returns the config associated to that Heaplet.
getConfigDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
getConfigDirectory() - Method in interface org.forgerock.openig.config.Environment: Returns the directory that contains the configuration files.
getConfiguredAuditEventHandlers(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets the AuditEventHandlers that the audit event is configure to log to.
getConnection() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration: Gets configuration of connection to Elasticsearch.
getConnection() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration: Gets configuration of connection to Splunk.
getConnection() - Method in interface org.forgerock.json.resource.ConnectionFactory: Returns a connection to the JSON resource provider associated with this connection factory.
getConnectionAsync() - Method in interface org.forgerock.json.resource.ConnectionFactory: Asynchronously obtains a connection to the JSON resource provider associated with this connection factory.
getConnectionFactory() - Method in interface org.forgerock.audit.handlers.jms.JmsContextManager: Gets a JMS connection factory.
getConnectionFactory() - Method in interface org.forgerock.json.resource.CrestApplication: Get the connection factory for the application.
getConnectionFactoryName() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration: Returns the jndi lookup name for the JMS ConnectionFactory to which messages will be published.
getConnectionPool() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Gets the connection pool settings.
getConnectionTimeout() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the maximum amount of time to wait for a connection from the connection pool.
getConnectTimeout() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Returns the timeout after which attempts to connect to the Syslog daemon will be abandoned.
getConstraints() - Method in class org.forgerock.secrets.Purpose: Returns the set of constraints that should apply to any secrets that match this purpose.
getContent() - Method in interface org.forgerock.json.resource.ActionRequest: Returns the content of this action request.
getContent() - Method in interface org.forgerock.json.resource.CreateRequest: Returns the content of the JSON resource to be created.
getContent() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the JSON content of this resource.
getContent() - Method in interface org.forgerock.json.resource.UpdateRequest: Returns the content of the JSON resource to be replaced.
getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler
getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.ECDHEncryptionHandler
getContentEncryptionKey() - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler: Creates a Content Encryption Key (CEK) following the appropriate steps defined by the EncryptionHandler JweAlgorithm.
getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler: Creates a Content Encryption Key (CEK) by generating a random key value with a length equal to the EncryptionMethod A128CBC_HS256 key size.
getContentLength() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getContentType() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the content type header parameter for this JWS.
getContentType() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getContentType() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getContext() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState: Returns the context that triggered the event.
getContext() - Method in class org.forgerock.openig.http.ContextAndRequest: Returns the context.
getContext(String) - Method in class org.forgerock.services.context.AbstractContext
getContext(String) - Method in interface org.forgerock.services.context.Context: Returns the first context in the chain whose context name matches the provided name.
getContextName() - Method in class org.forgerock.services.context.AbstractContext
getContextName() - Method in interface org.forgerock.services.context.Context: Get this Context's name.
getContextPath() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getContextProperties() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration: Gets the Jndi InitialContext properties.
getCookieBuilder() - Method in class org.forgerock.openig.openam.CdSsoContext: Get the CDSSO authentication cookie builder.
getCookieJwt(Request, String) - Static method in class org.forgerock.openig.tools.JwtUtil: Get a JWT from a request, with a given cookie name.
getCookieName() - Method in class org.forgerock.openig.tools.am.AmService: Returns the cookie header name used by AM server.
getCookies() - Method in class org.forgerock.http.header.AbstractSetCookieHeader: Returns the list of Cookies from a SetCookieHeader or a SetCookie2Header.
getCookies() - Method in class org.forgerock.http.header.CookieHeader: Returns the cookies' request list.
getCookies() - Method in class org.forgerock.http.header.SetCookie2Header: Deprecated.

Returns the unmodifiable list of cookies.
getCookies() - Method in class org.forgerock.http.header.SetCookieHeader: Returns the cookies.
getCookies() - Method in class org.forgerock.http.protocol.Request: Returns the incoming request cookies.
getCookies() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getCredentials() - Method in class org.forgerock.http.header.AuthorizationHeader: Get the credentials component of the header value.
getCriticalHeaders() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the critical header parameters for this JWS.
getCRTCoefficient() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA First CRT Coefficient value.
getCRTCoefficient() - Method in class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo: Get the factor CRT Coefficient, noted as "t".
getCRTExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo: Get the factor CRT Exponent, noted as "d".
getCurrentDateTime() - Method in class org.forgerock.openig.tools.jwt.validation.ValidatorConstraintContext: Returns the current instant that was captured when the validation started.
getCurve() - Method in class org.forgerock.json.jose.jwk.EcJWK: Deprecated.
replaced by EcJWK.getEllipticCurve().
getD() - Method in class org.forgerock.json.jose.jwk.EcJWK: Gets the unsigned big-endian base64 url encoding of the d value for the elliptical curve private key.
getD() - Method in class org.forgerock.json.jose.jwk.OkpJWK: Returns the private key d value.
getDailyRotationTimes() - Method in class org.forgerock.audit.rotation.FixedTimeRotationPolicy: Get the list of times since midnight that rotation will occur at.
getDatabaseType() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Gets the type of the database.
getDataSourceClassName() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the datasource class name for the JDBC database.
getDate() - Method in class org.forgerock.http.header.Warning: Gets the warning's date.
getDateHeader(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getDecorated() - Method in class org.forgerock.openig.decoration.DecorationHandle: Returns the decorated object.
getDecryptionPurpose(String) - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Returns a Purpose that can be used to retrieve keys that are suitable for decryption with this JWE algorithm.
getDecryptionPurpose(String) - Method in enum org.forgerock.json.jose.jwe.JweAlgorithmType: Returns a Purpose that can be used to retrieve keys that are suitable for decryption with this type of JWE algorithm.
getDefaultValue() - Method in class org.forgerock.util.Option: Returns the default value of this Option, can be null.
getDefaultVersionBehaviour() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets the default version behaviour if the request does not contain a resource API version.
getDefaultVersionBehaviour() - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Gets the default routing behaviour to use when the request does not contain the Accept-API-Version header.
getDelimiterChar() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting: Gets the character to use to delimit the csv entries.
getDeliveryMode() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Returns the delivery mode configuration that should be used when publishing the JMS messages.
getDependency(Class<T>) - Method in interface org.forgerock.audit.DependencyProvider: Retrieve the dependency of type T.
getDependency(Class<T>) - Method in class org.forgerock.audit.DependencyProviderBase: Retrieve the dependency of type T.
getDependency(Class<T>, String) - Method in interface org.forgerock.audit.DependencyProvider: Retrieve the dependency of type T, with the given name.
getDescription() - Method in class org.forgerock.openig.filter.oauth2.cnf.Result: Returns the failure description (null if this is a success).
getDescription() - Method in class org.forgerock.openig.filter.oauth2.OAuth2FailureContext: Get a description of the failure that occurred, if known, for example as provided by AM.
getDescription() - Method in class org.forgerock.openig.openam.CdSsoFailureContext: Get a description of the CDSSO error that occurred.
getDescription() - Method in class org.forgerock.openig.tools.jwt.validation.Violation: Returns the description of this violation.
getDetail() - Method in exception org.forgerock.json.resource.ResourceException: Returns the additional detail which can be evaluated by applications.
getDirectives() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns all directives in the message, keyed off the directive name, or an empty map if none specified.
getDiscard() - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
getDispatcherType() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getDistinguishedName() - Method in class org.forgerock.openig.openam.UserProfileContext: Get the user's distinguished name (dn) or null if none.
getDistinguishedName() - Method in class org.forgerock.openig.tools.userprofile.UserProfile: Get the user's distinguished name (dn) or null if none.
getDocumentationUrl() - Static method in class org.forgerock.openig.util.ProductInfo: Returns the documentation URI (used in WelcomeHandler).
getDomain() - Method in class org.forgerock.http.protocol.Cookie: Returns the domain for which the cookie is valid.
getDriverClassName() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the class name of the driver to use for the jdbc connection.
getDuration() - Method in class org.forgerock.openig.filter.throttling.ThrottlingRate: Returns the duration of the sliding window.
getEllipticCurve() - Method in class org.forgerock.json.jose.jwk.EcJWK: Gets the elliptic curve.
getEllipticCurve() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk: The elliptic curve this JWK is on.
getEllipticCurve() - Method in class org.forgerock.json.jose.jwk.OkpJWK: The supported elliptic curve that this key is on.
getEllipticCurveName() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Return the standard name of the elliptic curve definition.
getEnabledProtocolsArray() - Method in class org.forgerock.openig.tools.TlsOptions: Returns the array of protocols to be enabled (may be null for JVM default).
getEnabledProtocolsList() - Method in class org.forgerock.openig.tools.TlsOptions: Returns the list of protocols to be enabled (may be empty for JVM default).
getEncryptedJwt() - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt: Gets the encrypted JWT.
getEncryptionAlgorithm() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Gets the Java Cryptographic algorithm name for the algorithm that will create the Content Encryption Key (CEK).
getEncryptionHandler(JweHeader) - Method in class org.forgerock.json.jose.jwe.EncryptionManager: Gets the appropriate EncryptionHandler that can perform the required encryption algorithm, as described by the JweAlgorithm and EncryptionMethod in the given JweHeader.
getEncryptionHandler(JweHeader, Key) - Method in class org.forgerock.json.jose.jwe.EncryptionManager: Gets the appropriate EncryptionHandler that can perform the required encryption algorithm, as described by the JweAlgorithm and EncryptionMethod in the given JweHeader.
getEncryptionMethod() - Method in class org.forgerock.json.jose.jwe.JweHeader: Gets the Encryption Method header parameter for this JWE.
getEncryptionPurpose(String) - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Returns a Purpose that can be used to retrieve keys that are suitable for encryption with this JWE algorithm.
getEncryptionPurpose(String) - Method in enum org.forgerock.json.jose.jwe.JweAlgorithmType: Returns a Purpose that can be used to retrieve keys that are suitable for encryption with this type of JWE algorithm.
getEndOfLineSymbols() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting: Gets the end of line symbol.
getEndpointHandlerConfig() - Method in class org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterHeaplet
getEndpointRegistry() - Method in class org.forgerock.openig.http.AdminHttpApplication: Returns the API endpoint registry.
getEntity() - Method in interface org.forgerock.http.protocol.Message: Returns the entity.
getEntity() - Method in class org.forgerock.http.protocol.MessageImpl
getEphemeralPublicKey() - Method in class org.forgerock.json.jose.jwe.JweHeader: Gets the Ephemeral Public Key header parameter for this JWE.
getError() - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns the error code specifying the cause of the failure.
getError() - Method in class org.forgerock.openig.filter.oauth2.OAuth2FailureContext: Get the error that occurred, if known, for example as provided by AM.
getError() - Method in class org.forgerock.openig.openam.CdSsoFailureContext: Get the CDSSO error that occurred.
getErrorDescription() - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns the human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.
getErrorsResponseCount() - Method in class org.forgerock.openig.filter.MetricsFilter: Get the errors response count.
getErrorUri() - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.
getEscape() - Method in class org.forgerock.openig.text.Separator: Returns the character used to escape character literals, or -1 if none.
getEvent() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState: Returns the event content.
getEvent() - Method in class org.forgerock.audit.handlers.jdbc.TableMapping: Gets the audit event the table mapping is for.
getException() - Method in class org.forgerock.openig.filter.oauth2.OAuth2FailureContext: Get any OAuth2ErrorException associated with the failure that occurred.
getException(int) - Static method in exception org.forgerock.json.resource.ResourceException: Deprecated.
in favor of ResourceException.newResourceException(int)
getException(int, String) - Static method in exception org.forgerock.json.resource.ResourceException: Deprecated.
in favor of ResourceException.newResourceException(int, String)
getException(int, String, Throwable) - Static method in exception org.forgerock.json.resource.ResourceException: Deprecated.
in favor of ResourceException.newResourceException(int, String, Throwable)
getExceptionHandler() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The exception handler (guaranteed to be not null).
getExcludeIf() - Method in class org.forgerock.audit.filter.FilterPolicy: Gets the excludeIf list.
getExpirationTime() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the expiration time of the JWT from the Claims Set.
getExpires() - Method in class org.forgerock.http.protocol.Cookie: Returns the lifetime of the cookie, expressed as the date and time of expiration.
getExpiresAt() - Method in class org.forgerock.http.oauth2.AccessTokenInfo: Returns the time (expressed as a timestamp in milliseconds since epoch) when this token will be expired.
getExpiry() - Method in class org.forgerock.secrets.SecretBuilder: Returns the expiry time for this secret.
getExpiryTime() - Method in class org.forgerock.secrets.Secret: The expiry time of this secret.
getFacility() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Returns the facility constant that should be applied to all Syslog messages.
getFamily() - Method in class org.forgerock.http.protocol.Status: Returns the class of response of this status code.
getField() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping: Returns the name of the event topic field to which this mapping applies.
getField() - Method in class org.forgerock.json.resource.PatchOperation: Returns the field targeted by the patch operation.
getField() - Method in class org.forgerock.json.resource.SortKey: Returns the sort key field.
getFields() - Method in interface org.forgerock.json.resource.ActionRequest
getFields() - Method in interface org.forgerock.json.resource.CreateRequest
getFields() - Method in interface org.forgerock.json.resource.DeleteRequest
getFields() - Method in interface org.forgerock.json.resource.PatchRequest
getFields() - Method in interface org.forgerock.json.resource.QueryRequest
getFields() - Method in interface org.forgerock.json.resource.ReadRequest
getFields() - Method in interface org.forgerock.json.resource.Request: Returns the list of fields which should be included with each JSON resource returned by this request.
getFields() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the list of fields which should be included in this JSON resource after field filtering has occurred.
getFields() - Method in interface org.forgerock.json.resource.UpdateRequest
getFields() - Method in class org.forgerock.openig.text.SeparatedValuesFile: Returns the explicit field keys in the order they appear in a record, overriding any existing field header, or empty to use field header.
getFieldToColumn() - Method in class org.forgerock.audit.handlers.jdbc.TableMapping: Sets the field to column mapping.
getFilename() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Gets the location of the keystore to be used.
getFileRetention() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Gets the FileBasedEventHandlerConfiguration.FileRetention.
getFileRotation() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Gets the FileBasedEventHandlerConfiguration.FileRotation.
getFilterPolicies() - Method in class org.forgerock.audit.AuditServiceConfiguration: Get the filter policy mappings.
getFilters() - Method in class org.forgerock.json.resource.FilterChain: Returns a modifiable list containing the list of filters in this filter chain.
getFirst() - Method in class org.forgerock.util.Pair: Returns the first element of this pair.
getFirst(Class<? extends Header>) - Method in class org.forgerock.http.protocol.Headers: Gets the first value of the header, or null if the header does not exist.
getFirst(String) - Method in class org.forgerock.http.protocol.Headers: Gets the first value of the header, or null if the header does not exist.
getFirst(K) - Method in class org.forgerock.http.util.MultiValueMap: Returns the first value in the list of values for the matching key, or null if no such value exists.
getFirstHop() - Method in class org.forgerock.http.header.ForwardedHeader: Get the first request's hop information (for, by, host and proto) as expressed in the header (ie: contents may not be well formatted).
getFirstValue() - Method in class org.forgerock.http.protocol.Header: Gets the first value of this header instance.
getForAsIp() - Method in class org.forgerock.http.header.ForwardedHeader.Hop: Get the client node IP if set as an IPv4/v6 address.
getForm() - Method in class org.forgerock.http.protocol.Entity: Returns a copy of the "application/x-www-form-urlencoded" entity decoded as a form.
getForm() - Method in class org.forgerock.http.protocol.Request: Deprecated.
Use Request.getQueryParams() or Entity.getForm()
getFormAsync() - Method in class org.forgerock.http.protocol.Entity: Returns a promise of a copy of the "application/x-www-form-urlencoded" entity decoded as a form.
getFormatting() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Returns the CSV formatting options.
getFormJwt(Request, String) - Static method in class org.forgerock.openig.tools.JwtUtil: Get the JWT from a request form parameter.
getFragment() - Method in class org.forgerock.http.MutableUri: Returns the fragment element.
getFrom() - Method in class org.forgerock.json.resource.PatchOperation: Returns the source field for move and copy operations.
getFullyQualifiedName() - Method in class org.forgerock.openig.heap.Name: Returns a String representation of this Name that includes the full Name hierarchy.
getGrantType() - Method in class org.forgerock.secrets.oauth2.GrantTypeHandler: The name of the grant type implemented by this handler.
getHandledTopics() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Gets the names of all audit event topics this handler is registered against.
getHandledTopics() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
getHandler() - Method in class org.forgerock.openig.heap.HeapImpl: Returns the Handler object referenced by the handler top-level attribute.
getHandler() - Method in class org.forgerock.openig.tools.am.AmService: Returns the handler to use with this configuration.
getHandlerForQueries() - Method in class org.forgerock.audit.AuditServiceConfiguration: Returns the name of the handler to use for querying the audit events.
getHeader() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
getHeader() - Method in class org.forgerock.json.jose.jws.SignedJwt: Gets the header object for the JWT, which contains properties which describe the cryptographic operations applied to the JWT, among other properties.
getHeader() - Method in interface org.forgerock.json.jose.jwt.Jwt: Gets the header object for the JWT, which contains properties which describe the cryptographic operations applied to the JWT, among other properties.
getHeader(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable list containing the values of the named HTTP request header.
getHeader(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getHeader(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getHeaderAsString(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns the first value of the named HTTP request header.
getHeaderClass() - Method in class org.forgerock.http.header.AuthorizationHeader.Factory
getHeaderClass() - Method in class org.forgerock.http.header.HeaderFactory: Get the associated header class.
getHeaderKey(String) - Static method in enum org.forgerock.json.jose.jwe.JweHeaderKey: Gets the JweHeaderKey constant that matches the given String.
getHeaderKey(String) - Static method in enum org.forgerock.json.jose.jws.JwsHeaderKey: Gets the JwsHeaderKey constant that matches the given String.
getHeaderKey(String) - Static method in enum org.forgerock.json.jose.jwt.JwtHeaderKey: Gets the JwtHeaderKey constant that matches the given String.
getHeaderName() - Method in class org.forgerock.http.header.AuthorizationHeader.Factory
getHeaderName() - Method in class org.forgerock.http.header.HeaderFactory: Get the associated header name.
getHeaderName() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The SSO header name.
getHeaderNames() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getHeaderNames() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getHeaders() - Method in interface org.forgerock.http.protocol.Message: Returns the headers.
getHeaders() - Method in class org.forgerock.http.protocol.MessageImpl
getHeaders() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder: Gets the header parameters for the JWT.
getHeaders() - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable map of the HTTP request headers.
getHeaders() - Method in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

Returns the headers whose values should be processed for encryption or decryption.
getHeaders(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getHeaders(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getHeap() - Method in interface org.forgerock.openig.decoration.Context: Returns the heap that spawned the decorated heap object.
getHeap() - Method in class org.forgerock.openig.heap.GenericHeaplet: Returns the heap associated to that Heaplet.
getHeap() - Method in class org.forgerock.openig.http.AdminHttpApplication: Returns the heap based on the contents of the admin configuration.
getHeaplet(Class<?>) - Static method in class org.forgerock.openig.heap.Heaplets: Returns the heaplet that creates an instance of the specified class, or null if no such heaplet could be found.
getHeartbeatExecutorService() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The executor service to use to schedule heartbeat tasks.
getHeartbeatInterval() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The interval between heartbeats.
getHierarchicalLeaf() - Method in class org.forgerock.openig.heap.Name: Returns a String representation of this leaf's Name that is compliant with the hierarchical naming, i.e.
getHierarchicalName() - Method in class org.forgerock.openig.heap.Name: Returns a String representation of this Name that includes the full Name hierarchy, with each segment name being 'slugged'.
getHops() - Method in class org.forgerock.http.header.ForwardedHeader: Get the list of request's hops details.
getHost() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Gets the host for the connection (default localhost).
getHost() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration: Gets the host for the connection (default localhost).
getHost() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Returns the hostname of the Syslog daemon to which messages should be published.
getHost() - Method in class org.forgerock.http.MutableUri: Returns the host element.
getHostnameVerifier() - Method in class org.forgerock.openig.tools.ClientTlsOptions: Returns the HttpClientHandler.HostnameVerifier to apply.
getHttpApplications() - Method in class org.forgerock.http.servlet.HttpFrameworkServletContextListener: Gets a Map of HttpApplication instances keyed by a String application key.
getHttpServletContextFactory() - Static method in class org.forgerock.json.resource.http.SecurityContextFactory: Deprecated.

Returns the singleton security context factory which can be used for obtaining context information from a HTTP request.
getId() - Method in class org.forgerock.json.resource.IdentifierQueryResourceHandler: Gets the identifier being queried for.
getId() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the ID of this resource, if applicable.
getId() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck: Returns the request message id.
getId() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionRequest: Returns this message's correlation id.
getId() - Method in class org.forgerock.services.context.AbstractContext
getId() - Method in interface org.forgerock.services.context.Context: Returns the unique ID identifying this context, usually a UUID.
getIdleTimeout() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the maximum time a connection is allowed to be idle.
getIn() - Method in class org.forgerock.http.io.PipeBufferedStream: Returns the output stream which writes to the pipe.
getIncludeIf() - Method in class org.forgerock.audit.filter.FilterPolicy: Gets the includeIf list.
getIncludeIfFilters(String) - Method in class org.forgerock.audit.events.EventTopicsMetaData: Returns JSON Pointers to fields which should be automatically whitelisted for a given topic's schema.
getIndexMapping() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration: Sets configuration of index mapping.
getIndexName() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration: Gets primary index name (default is audit).
getInfo() - Method in class org.forgerock.http.oauth2.AccessTokenInfo: Returns the raw JSON as a map.
getInfo() - Method in class org.forgerock.openig.filter.jwt.JwtValidationContext: Returns the claims copy as a Map.
getInfo() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the information of the SessionInfo object.
getInfo() - Method in class org.forgerock.openig.openam.SsoTokenContext: Returns the session info associated with this context.
getInfo() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the session info as Map for the given SSO Token if any, or null if none.
getInitialConnectionAttempts() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The number of retries allowed for the first connection.
getInitialFile() - Method in class org.forgerock.audit.rotation.RotationContext: Get the initial file.
getInitialName() - Method in interface org.forgerock.audit.retention.FileNamingPolicy: Initializes the policy and returns the current name to use.
getInitialName() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy: Gets the initial file.
getInputStream() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getInstance() - Static method in class org.forgerock.openig.ldap.LdapClient: Returns the unique instance of an LdapClient.
getInstance() - Static method in class org.forgerock.util.SignatureUtil: Gets the SignatureUtil instance.
getInstance(EncryptionHandler, JweAlgorithm, EncryptionMethod) - Static method in class org.forgerock.json.jose.jwe.handlers.encryption.ECDHEncryptionHandler: Get an instance of the ECDH-ES encryption handler for the given parameters.
getInstanceDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
getInstanceDirectory() - Method in interface org.forgerock.openig.config.Environment: Returns the instance directory of the IG file system.
getIntHeader(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getIntrospectionEndpoint() - Method in class org.forgerock.openig.uma.UmaSharingService: Returns the OAuth 2.0 Introspection endpoint Uri.
getIntValue() - Method in enum org.forgerock.util.thread.listener.ShutdownPriority: Returns the priority.
getIpAddresses() - Method in class org.forgerock.http.header.XForwardedForHeader: Get the IP addresses list.
getIssuedAtTime() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the time the JWT was issued at, from the Claims Set.
getIssuedToken() - Method in class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeContext: Returns the exchange token issued by the authorization service.
getIssuedToken() - Method in class org.forgerock.openig.openam.StsContext: Returns the token issued by the AM STS.
getIssuedTokenType() - Method in class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeContext: Returns the issued exchange token type URN.
getIssuer() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the issuer this JWT was issued by.
getIssuer() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Returns the Issuer for this client registration.
getIssuerUri() - Method in class org.forgerock.openig.uma.UmaSharingService: Returns the issuer's URI.
getJdbcUrl() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the JDBC database url.
getJndi() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Gets the JmsAuditEventHandlerConfiguration.JndiConfiguration.
getJson() - Method in class org.forgerock.http.protocol.Entity: Returns the content of this entity decoded as a JSON object.
getJson(InputStream) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Returns a JSON value from the provided input stream.
getJsonActions() - Method in class org.forgerock.openig.openam.PolicyDecisionContext: Returns the unmodifiable actions entry in the policy decision (never null).
getJsonAdvices() - Method in class org.forgerock.openig.openam.PolicyDecisionContext: Returns the unmodifiable advices entry in the policy decision (never null).
getJsonAsync() - Method in class org.forgerock.http.protocol.Entity: Returns a promise of the content of this entity decoded as a JSON object.
getJsonAttributes() - Method in class org.forgerock.openig.openam.PolicyDecisionContext: Returns the unmodifiable attributes entry in the policy decision (never null).
getJsonContent() - Method in interface org.forgerock.json.resource.ActionResponse: Gets the JsonValue content contained in the Response.
getJsonValue() - Method in exception org.forgerock.json.JsonValueException: Returns the JSON value for which the exception was thrown.
getJsonWebKey() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the JSON Web Key header parameter for this JWS.
getJwaAlgorithm() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the alg parameter of the JWK.
getJwaAlgorithmName() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm
getJwaAlgorithmName() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
getJwaAlgorithmName() - Method in interface org.forgerock.json.jose.jwt.Algorithm: Gets the name of the algorithm as defined in the JWA standard.
getJweHeader() - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt: Get the header of the encapsulated EncryptedJwt.
getJweStandardName() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Returns the JWE standard encryption method name for this encryption method.
getJWKsAsJsonValue() - Method in class org.forgerock.json.jose.jwk.JWKSet: Get the JWKs in the set.
getJWKsAsList() - Method in class org.forgerock.json.jose.jwk.JWKSet: Get the JWKs in the set.
getJwkSetUrl() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the JWK Set URL header parameter for this JWS.
getJwksStore(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService: Returns the appropriate JWKs store.
getJwkThumbprint(String) - Method in class org.forgerock.json.jose.jwk.JWK: Calculates the JWK Thumbprint of this JWK.
getJwkType() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Returns the type of JWK that is used for this elliptic curve.
getJwkUrl() - Method in class org.forgerock.json.jose.jwk.store.JwksStore: The JWKs URI.
getJwsAlgorithm() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Returns the JwsAlgorithm that corresponds to this elliptic curve.
getJwsAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Deprecated.
Replaced by JwsAlgorithm.parseCryptographicAlgorithm(String)
getJwt() - Method in class org.forgerock.openig.filter.jwt.JwtValidationContext: Returns a copy of the Jwt.
getJwt() - Method in class org.forgerock.openig.filter.jwt.JwtValidationErrorContext: Returns the JWT.
getJwt() - Method in class org.forgerock.openig.tools.jwt.validation.ValidatorConstraintContext: Return the JWT the constraints must be applied on.
getJwtId() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the unique ID of the JWT.
getKey() - Method in interface org.forgerock.http.decoder.Decoder: Returns the coding that the decoder supports, as it would appear in the Content-Encoding header.
getKey() - Method in interface org.forgerock.http.decoder.FlowableDecoder: Returns the coding that the decoder supports, as it would appear in the Content-Encoding header.
getKey() - Method in class org.forgerock.json.jose.jwk.OctJWK: Gets the symmetric key.
getKey() - Method in class org.forgerock.openig.el.plugins.EnvironmentVariablesPlugin
getKey() - Method in class org.forgerock.openig.el.plugins.SystemPropertiesPlugin
getKey() - Method in class org.forgerock.openig.resolver.ArrayResolver: Returns null, as arrays are not resolved through type discovery.
getKey() - Method in class org.forgerock.openig.resolver.BeanResolver: Do not forget to override this method in sub-classes.
getKey() - Method in class org.forgerock.openig.resolver.HeadersResolver
getKey() - Method in class org.forgerock.openig.resolver.HeapResolver
getKey() - Method in class org.forgerock.openig.resolver.ListResolver
getKey() - Method in class org.forgerock.openig.resolver.MapResolver
getKey() - Method in class org.forgerock.openig.resolver.PrincipalResolver
getKey() - Method in class org.forgerock.openig.resolver.RequestResolver
getKey() - Method in interface org.forgerock.openig.resolver.Resolver: Returns the type of object that the resolver supports.
getKey() - Method in interface org.forgerock.util.Indexed: Returns the unique key to index the object by.
getKey(KeyStore, String, String) - Static method in class org.forgerock.openig.util.KeyStoreUtil: Retrieves a PrivateKey or a SecretKey from a KeyStore.
getKeyAgreement() - Method in class org.forgerock.secrets.keys.KeyAgreementKey: Obtains a key agreement protocol object for this key.
getKeyAgreement(String) - Method in class org.forgerock.secrets.keys.KeyAgreementKey: Obtains a key agreement protocol object initialized with this key.
getKeyAgreement(String, AlgorithmParameterSpec) - Method in class org.forgerock.secrets.keys.KeyAgreementKey: Obtains a key agreement protocol object initialized with this key.
getKeyAgreementAlgorithm() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Determines the Java KeyAgreement algorithm to use for this curve.
getKeyAlgorithm() - Method in class org.forgerock.secrets.keys.CryptoKey: Returns the algorithm used by the underlying key, for instance "RSA" or "EC".
getKeyGenerationAlgorithm() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Determines the Java KeyPairGenerator algorithm to use for this curve.
getKeyId() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the keyId parameter of the JWK.
getKeyId() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the Key ID header parameter for this JWS.
getKeyManager(Purpose<? extends CryptoKey>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getKeyManager(Purpose<? extends CryptoKey>) - Method in interface org.forgerock.openig.secrets.SecretsService: Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
getKeyManager(Purpose<? extends CryptoKey>) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getKeyManager(Purpose<? extends CryptoKey>) - Method in class org.forgerock.secrets.SecretsProvider: Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
getKeyManager(Purpose<? extends CryptoKey>, Options) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getKeyManager(Purpose<? extends CryptoKey>, Options) - Method in interface org.forgerock.openig.secrets.SecretsService: Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
getKeyManager(Purpose<? extends CryptoKey>, Options) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getKeyManager(Purpose<? extends CryptoKey>, Options) - Method in class org.forgerock.secrets.SecretsProvider: Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
getKeyManagers() - Method in class org.forgerock.openig.tools.TlsOptions: Returns the array of KeyManager to use (may be null).
getKeyOffset() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Gets the number of octets in each of the CEK and MAC key.
getKeyOperations() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the key operations parameter of the JWK.
getKeyOperations(String) - Static method in enum org.forgerock.json.jose.jwk.KeyOperation: Get the KeyOperation.
getKeySize() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Gets the bit length of the Content Encryption Key (CEK).
getKeystoreHandler(String) - Method in class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider
getKeystoreHandler(String) - Method in interface org.forgerock.audit.providers.KeyStoreHandlerProvider: Returns the keystore handler corresponding to the given name.
getKeyStoreHandlerName() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Get the key store handler name.
getKeyType() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the kty parameter of the JWK.
getKeyType() - Method in class org.forgerock.secrets.keys.CryptoKey: Returns an indication of the type of key this is.
getKeyType() - Method in enum org.forgerock.secrets.keys.KeyUsage: The key type corresponding to this key usage.
getKeyType(String) - Static method in enum org.forgerock.json.jose.jwk.KeyType: Get the KeyType given a string.
getKeyUsages() - Method in class org.forgerock.secrets.keys.CryptoKey: Returns the key usages that the key can be used for.
getKeyWrappingAlgorithm() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm: For ECDH-ES key agreement modes, this indicates the key wrapping mode that should be applied to the resulting derived key.
getKnownTopics() - Method in interface org.forgerock.audit.AuditService: Returns the set of event topics (schemas) that the AuditService understands.
getKnownTopics() - Method in class org.forgerock.audit.AuditServiceProxy
getKnownTopics() - Method in class org.forgerock.openig.audit.NoOpAuditService
getLabel() - Method in class org.forgerock.secrets.Purpose: Returns a symbolic label for this purpose that can be used in routing requests for secrets.
getLastHop() - Method in class org.forgerock.http.header.ForwardedHeader: Get the last request's hop information (for, by, host and proto) as expressed in the header (ie: contents may not be well formatted).
getLastHopClientIp() - Method in class org.forgerock.http.header.ForwardedHeader: Get the last request's hop IP address.
getLastHopIpAddress() - Method in class org.forgerock.http.header.XForwardedForHeader: Get the IP address of the request's last hop.
getLastLoadedJwkSet() - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Returns the last successfully loaded JWK Set together with the time at which it was last fetched.
getLastModified() - Method in interface org.forgerock.openig.handler.resources.Resource: Returns the timestamp when the resource has been last modified (expressed in TimeUnit.MILLISECONDS).
getLastRotationTime() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
getLastRotationTime() - Method in interface org.forgerock.audit.rotation.RotatableObject: Retrieves the last time the file was rotated.
getLatestAccessTime() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the latest access time as an Instant.
getLatestAccessTime() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the latest access time as an Instant.
getLatestJwkSet() - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Returns the latest non expired successfully loaded JWK Set.
getLeaf() - Method in class org.forgerock.openig.heap.Name: Returns the leaf name (cannot be null).
getLength() - Method in class org.forgerock.http.header.ContentLengthHeader: Returns the content length, or -1 if no content length has been set.
getLocalAddr() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getLocalAddress() - Method in class org.forgerock.services.context.ClientContext: Returns the IP address of the interface that received the request.
getLocale() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getLocale() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getLocales() - Method in class org.forgerock.http.header.AcceptLanguageHeader: Returns the PreferredLocales instance that represents this header.
getLocales() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getLocales() - Method in class org.forgerock.util.i18n.PreferredLocales: The ordered list of preferred locales.
getLocalHostName() - Method in class org.forgerock.audit.providers.DefaultLocalHostNameProvider
getLocalHostName() - Method in interface org.forgerock.audit.providers.LocalHostNameProvider: Establish the local hostname of the current server.
getLocalName() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getLocalPort() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getLocalPort() - Method in class org.forgerock.services.context.ClientContext: Returns the port of the interface that received the request.
getLocation() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getLocation() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Returns the path to the keystore.
getLocation() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getLocationUri() - Method in class org.forgerock.http.header.LocationHeader: Returns the location URI or null if empty.
getLogDirectory() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Returns the directory where CSV file is located.
getLogDirectory() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration: Gets the directory where the JSON file is located.
getLogger(Context) - Method in class org.forgerock.openig.decoration.helper.AbstractDecorator: Builds a logger based on the pattern <decoratorClassname>.<decoratorName>.<decoratedObjectName>.
getLoginEndpoint() - Method in class org.forgerock.openig.openam.SsoTokenContext: The login endpoint URI evaluated from SingleSignOnFilter configuration.
getMacAlgorithm() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Gets the Java Cryptographic algorithm name for the algorithm that will generate the MAC key.
getMajor() - Method in class org.forgerock.http.routing.Version: Returns the major version number.
getManaged() - Method in class org.forgerock.openig.filter.CookieFilter: Returns the set of cookie names that will be managed.
getMatchedUri() - Method in class org.forgerock.http.routing.UriRouterContext: Returns the portion of the request URI which matched the URI template.
getMatchRequests() - Method in class org.forgerock.openig.filter.EntityExtractFilter: Returns the regular expression patterns set.
getMaxAge() - Method in class org.forgerock.http.protocol.Cookie: Returns the lifetime of the cookie, expressed in seconds.
getMaxAgeSeconds() - Method in class org.forgerock.json.resource.ResponseCacheControl: The maximum age (in seconds) that the response should be cached.
getMaxBatchedEvents() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the maximum number of events to read from the buffer on each interval.
getMaxBatchedEvents() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the maximum number of events that can be batched into a PreparedStatement.
getMaxBatchedEvents() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.BatchConfiguration: Returns the maximum count of events that will be expected to be delivered in a single publish call.
getMaxBatchedEvents() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration: Gets the maximum number of events to read from the buffer on each interval.
getMaxDiskSpaceToUse() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Gets the maximum disk space the audit logs can occupy.
getMaxFileSize() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the maximum file size of an audit log file in bytes.
getMaxFileSizeInBytes() - Method in class org.forgerock.audit.rotation.SizeBasedRotationPolicy: Gets the maximum size (in bytes) a file may grow to before being rotated.
getMaxIdleExpirationTime() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the max idle expiration time as an Instant.
getMaxIdleExpirationTime() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the max idle expiration time as an Instant.
getMaxLifetime() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the maximum lifetime of a connection in the connection pool.
getMaxNumberOfHistoryFiles() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Gets the maximum number of historical log files to retain.
getMaxPoolSize() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the maximum size of the connection pool.
getMaxSessionExpirationTime() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the max session expiration time as an Instant.
getMaxSessionExpirationTime() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the max session expiration time as an Instant.
getMaxSize() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxSize() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Returns the maximum size of the queue.
getMaxSize() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxSize() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration: Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxSize() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxTimeout() - Method in class org.forgerock.util.PerItemEvictionStrategyCache: Gets the maximum timeout (can be null).
getMdAlgorithm() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Returns the Java-friendly name of the message digest algorithm implementation.
getMessage() - Method in exception org.forgerock.json.JsonValueException: Returns the detail message string of this exception.
getMessage() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck: Returns acknowledgement message.
getMessageHandler() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The message handler (guaranteed to be not null).
getMethod() - Method in class org.forgerock.http.protocol.Request: Returns the method to be performed on the resource.
getMethod() - Method in class org.forgerock.json.resource.http.HttpContext: Returns the effective HTTP method, taking into account presence of the X-HTTP-Method-Override header.
getMethod() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getMinFreeSpaceRequired() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Gets the minimum free space the system must contain.
getMinIdle() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the minimum number of idle connections in the connection pool.
getMinor() - Method in class org.forgerock.http.routing.Version: Returns the minor version number.
getMode() - Method in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig: Returns the DeliveryMode value for this configuration.
getMode() - Method in enum org.forgerock.audit.handlers.jms.SessionModeConfig: Returns the session mode setting for this configuration.
getModulus() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA modulus value.
getName() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Gets the name of this audit event handler.
getName() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
getName() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Returns the name of this handler.
getName() - Method in class org.forgerock.http.header.AcceptApiVersionHeader
getName() - Method in class org.forgerock.http.header.AcceptLanguageHeader
getName() - Method in class org.forgerock.http.header.AuthorizationHeader
getName() - Method in class org.forgerock.http.header.ConnectionHeader
getName() - Method in class org.forgerock.http.header.ContentApiVersionHeader
getName() - Method in class org.forgerock.http.header.ContentEncodingHeader
getName() - Method in class org.forgerock.http.header.ContentLengthHeader
getName() - Method in class org.forgerock.http.header.ContentTypeHeader
getName() - Method in class org.forgerock.http.header.CookieHeader
getName() - Method in class org.forgerock.http.header.Directive: Represents the directive name.
getName() - Method in class org.forgerock.http.header.ForwardedHeader
getName() - Method in class org.forgerock.http.header.GenericHeader
getName() - Method in class org.forgerock.http.header.LocationHeader
getName() - Method in class org.forgerock.http.header.ReferrerHeader
getName() - Method in class org.forgerock.http.header.SetCookie2Header: Deprecated.
getName() - Method in class org.forgerock.http.header.SetCookieHeader
getName() - Method in class org.forgerock.http.header.TrailerHeader
getName() - Method in class org.forgerock.http.header.TransactionIdHeader
getName() - Method in class org.forgerock.http.header.WarningHeader
getName() - Method in class org.forgerock.http.header.WwwAuthenticateHeader
getName() - Method in class org.forgerock.http.header.XForwardedForHeader
getName() - Method in class org.forgerock.http.protocol.Cookie: Returns name of the cookie.
getName() - Method in class org.forgerock.http.protocol.Header: Returns the name of the header, as it would canonically appear within an HTTP message.
getName() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Gets the full name of the encryption method.
getName() - Method in enum org.forgerock.json.jose.jwk.KeyOperation: Get the Value of the KeyOperation.
getName() - Method in interface org.forgerock.openig.decoration.Context: Returns the name of the heap object being decorated.
getName() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Returns the name of this client registration.
getName() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer: Returns the name of this issuer.
getName() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
getName() - Method in interface org.forgerock.openig.heap.Heap: Returns the name of this heap.
getName() - Method in class org.forgerock.openig.heap.HeapImpl
getName() - Method in class org.forgerock.openig.http.CookieBuilder: The name of the cookie that will be built from this CookieBuilder.
getName() - Method in class org.forgerock.openig.tools.am.Realm: Returns the fully qualified realm's name: '/finances/employees' The returned name always starts with /, and never ends with /.
getName() - Static method in class org.forgerock.openig.util.ProductInfo: Returns the product name.
getName(String) - Static method in class org.forgerock.openig.util.FilenameUtils: Gets the name minus the path from a full fileName
getNamed(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.Base64EncodedSecretStore
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.jwkset.JwkSetSecretStore
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
getNamed(Purpose<S>, String) - Method in interface org.forgerock.secrets.SecretStore: Returns the named secret from this store.
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
getNamedOrValidSecrets(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getNamedOrValidSecrets(Purpose<S>, String) - Method in interface org.forgerock.openig.secrets.SecretsService: If the given id is not null, then this returns the single named secret that corresponds to that stable id (or a stream of valid secrets for the given purpose if no such secret exists), otherwise it returns all valid secrets for the given purpose.
getNamedOrValidSecrets(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getNamedOrValidSecrets(Purpose<S>, String) - Method in class org.forgerock.secrets.SecretsProvider: If the given id is not null, then this returns the single named secret that corresponds to that stable id (or a stream of valid secrets for the given purpose if no such secret exists), otherwise it returns all valid secrets for the given purpose.
getNamedSecret(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getNamedSecret(Purpose<S>, String) - Method in interface org.forgerock.openig.secrets.SecretsService: Gets the secret for the given purpose with the given stable secret id.
getNamedSecret(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getNamedSecret(Purpose<S>, String) - Method in class org.forgerock.secrets.SecretsProvider: Gets the secret for the given purpose with the given stable secret id.
getNewResourceId() - Method in interface org.forgerock.json.resource.CreateRequest: Returns the client provided ID of the resource to be created.
getNextFile() - Method in class org.forgerock.audit.rotation.RotationContext: Get the next file.
getNextName() - Method in interface org.forgerock.audit.retention.FileNamingPolicy: Gets the next name to use.
getNextName() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy: Gets the next name for this FileNamingPolicy.
getNonEmptyPath(MutableUri) - Static method in class org.forgerock.openig.websocket.UriUtils: Returns / when the given uri has no path component, returns the uri path otherwise.
getNotBeforeTime() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the time the JWT is not allowed to be processed before, from the Claims Set.
getNotificationService() - Method in class org.forgerock.openig.tools.am.AmService: Returns the AM notification service.
getNotPresent(String, String) - Static method in class org.forgerock.json.resource.AdviceWarning: Convenience method to quickly generate frequently-used error type: 100.
getNullResponseCount() - Method in class org.forgerock.openig.filter.MetricsFilter: Get the null response count.
getNumberOfRequests() - Method in class org.forgerock.openig.filter.throttling.ThrottlingRate: Returns the maximum of requests that can be filtered out during the duration.
getOAuth2Error() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader: Returns the OAuth 2.0 error represented by this header.
getOAuth2Error() - Method in exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException: Returns the OAuth 2.0 error represented by this exception.
getObject() - Method in class org.forgerock.json.JsonValue: Returns the raw Java object representing this JSON value.
getObject() - Method in interface org.forgerock.openig.el.ExpressionPlugin: Returns, and if necessary, creates, the context object.
getObject() - Method in class org.forgerock.openig.el.plugins.EnvironmentVariablesPlugin
getObject() - Method in class org.forgerock.openig.el.plugins.SystemPropertiesPlugin
getOpenHandler() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The open handler (guaranteed to be not null).
getOpenIGRouter() - Method in class org.forgerock.openig.http.AdminHttpApplication: Returns the router that represents the /openig namespace (or whatever path/prefix value that was configured).
getOperation() - Method in class org.forgerock.json.resource.PatchOperation: Returns the type of patch operation to be performed.
getOrDefaultEndpointHandler() - Method in class org.forgerock.openig.filter.oauth2.client.ClientCredentialsOAuth2ClientFilterHeaplet
getOriginalUri() - Method in class org.forgerock.http.routing.UriRouterContext: Get the original URI.
getOriginalValue() - Method in class org.forgerock.http.header.Directive: Represents the original directive value and in quotes if it was originally quoted.
getOriginatingClientIp() - Method in class org.forgerock.http.header.ForwardedHeader: Get the first request's hop IP address.
getOrThrow() - Method in interface org.forgerock.util.promise.Promise: Waits if necessary for this Promise to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure.
getOrThrow() - Method in class org.forgerock.util.promise.PromiseImpl
getOrThrow(long, TimeUnit) - Method in interface org.forgerock.util.promise.Promise: Waits if necessary for at most the given time for this Promise to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure.
getOrThrow(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
getOrThrowIfInterrupted() - Method in interface org.forgerock.util.promise.Promise: Waits if necessary for this Promise to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure.
getOrThrowUninterruptibly() - Method in interface org.forgerock.util.promise.Promise: Deprecated.
Since 25.0.0. Prefer using Promise.getOrThrow() and handle properly the InterruptedException in the calling code, or use Promise.getOrThrowIfInterrupted().
getOrThrowUninterruptibly() - Method in class org.forgerock.util.promise.PromiseImpl: Deprecated.
getOrThrowUninterruptibly(long, TimeUnit) - Method in interface org.forgerock.util.promise.Promise: Deprecated.
Since 25.0.0. Prefer using Promise.get(long, TimeUnit) and handle properly the InterruptedException in the calling code, or use Promise.getOrThrowIfInterrupted().
getOrThrowUninterruptibly(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl: Deprecated.
getOtherPrimesInfo() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA other factors value.
getOut() - Method in class org.forgerock.http.io.PipeBufferedStream: Returns the input stream which reads from the pipe.
getOutputStream() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getPagedResultsCookie() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the opaque cookie which is used by the resource provider to track its position in the set of query results.
getPagedResultsCookie() - Method in interface org.forgerock.json.resource.QueryResponse: Returns the opaque cookie which can be used for the next cookie-based paged request.
getPagedResultsOffset() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the zero-based index of the first resource which should be included in the query results.
getPageSize() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the requested page results page size or 0 if paged results are not required.
getPairComparator() - Static method in class org.forgerock.util.Pair: Returns a comparator for Pairs of comparable objects.
getParameter(String) - Method in class org.forgerock.json.jose.jwe.JweHeader
getParameter(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets a header parameter for the specified key.
getParameter(String) - Method in class org.forgerock.json.jose.jwt.JwtHeader: Gets a header parameter for the specified key.
getParameter(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable list containing the values of the named HTTP request parameter.
getParameter(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getParameter(String, Class<T>) - Method in class org.forgerock.json.jose.jwt.JwtHeader: Gets a header parameter for the specified key and then casts it to the specified type.
getParameterAsString(String) - Method in class org.forgerock.json.resource.http.HttpContext: Returns the first value of the named HTTP request parameter.
getParameterMap() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getParameterNames() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getParameters() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Returns the parameters for the given elliptic curve.
getParameters() - Method in class org.forgerock.json.jose.jwt.JwtHeader: Returns this JwtHeader's parameters.
getParameters() - Method in class org.forgerock.json.resource.http.HttpContext: Returns an unmodifiable map of the HTTP request parameters.
getParameters() - Method in class org.forgerock.openig.sql.SqlAttributesFilter: Returns the list of parameters to evaluate and include in the execution of the prepared statement.
getParameterSpec() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Gets any parameter spec associated with this algorithm.
getParameterValues(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getParent() - Method in class org.forgerock.openig.heap.Name: Returns the parent Name (can be null).
getParent() - Method in class org.forgerock.services.context.AbstractContext
getParent() - Method in interface org.forgerock.services.context.Context: Returns the parent of this context.
getPart(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getParts() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getPassword() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Gets the password of the keystore.
getPassword() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Gets Elasticsearch password for HTTP basic authentication.
getPassword() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the password to use to connect to the JDBC database.
getPassword() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getPassword() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Returns the password.
getPassword() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getPassword() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
getPassword() - Method in interface org.forgerock.audit.secure.SecureStorage: Returns the password used to access the storage.
getPassword() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo: Returns the password to use when authenticating to the proxy.
getPassword() - Method in class org.forgerock.http.header.authorization.BasicCredentials: Get the password.
getPasswordSecretIdOrPasswordAsByte(SecretsProvider, JsonValue, JsonValue, Logger) - Static method in class org.forgerock.openig.secrets.SecretsUtils: Retrieve a required shared secret value (as byte[]) from the given secretIdNode and deprecatedNode nodes.
getPatchOperations() - Method in interface org.forgerock.json.resource.PatchRequest: Returns the list of patch operations which should be performed against the targeted resource.
getPath() - Method in class org.forgerock.http.MutableUri: Returns the path element.
getPath() - Method in class org.forgerock.http.protocol.Cookie: Returns the subset of URLs on the origin server to which this cookie applies.
getPath() - Method in class org.forgerock.json.resource.http.HttpContext: Returns the HTTP request path.
getPath() - Method in class org.forgerock.openig.http.EndpointRegistry: Returns this registry's base path.
getPath() - Method in class org.forgerock.openig.http.EndpointRegistry.Registration: Returns this endpoint's path.
getPathElements() - Method in class org.forgerock.http.MutableUri: Return the URI path elements as an immutable List.
getPathElements(String) - Static method in class org.forgerock.http.util.Paths: Converts a path into a list of URL-decoded path elements.
getPathInfo() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getPaths() - Method in class org.forgerock.http.swagger.SwaggerExtended
getPathTranslated() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getPayload() - Method in class org.forgerock.json.jose.jws.SignedJwt: Gets the payload for the JWS, which will either be a JWT Claims Set, SignedJwt.getClaimsSet(), or a nested EncryptedJwt, EncryptedJwt.
getPermissionEndpoint() - Method in class org.forgerock.openig.uma.UmaSharingService: Returns the UMA Permission Request endpoint Uri.
getPointer() - Method in class org.forgerock.json.JsonValue: Returns the pointer of the JSON value in its JSON structure.
getPoolName() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the name of the connection pool.
getPort() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Gets the port for the connection (default 9200).
getPort() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration: Gets the port for the connection (default 8088).
getPort() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Returns the port of the Syslog daemon to which messages should be published.
getPort() - Method in class org.forgerock.http.MutableUri: Returns the port element.
getPort() - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
getPort(String, int) - Static method in class org.forgerock.openig.websocket.UriUtils: Returns the default's protocol port if not set in the given URI scheme, the URI port otherwise.
getPreferredLocale() - Method in class org.forgerock.util.i18n.PreferredLocales: The preferred locale, i.e.
getPreferredLocales() - Method in interface org.forgerock.json.resource.ActionRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.CreateRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.DeleteRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.PatchRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.QueryRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.ReadRequest
getPreferredLocales() - Method in interface org.forgerock.json.resource.Request: Get the locale preference for the request.
getPreferredLocales() - Method in interface org.forgerock.json.resource.UpdateRequest
getPrimeFactor() - Method in class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo: Get the prime factor, noted as "r".
getPrimeP() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA First Prime Factor value.
getPrimePExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA First Factor CRT Exponent value.
getPrimeQ() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA Second Prime Factor value.
getPrimeQExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA Second factor CRT Exponent value.
getPriorities() - Static method in enum org.forgerock.util.thread.listener.ShutdownPriority: Returns list of all the priorities (ordered from the highest to the lowest priority) defined in the system.
getPrivateExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA Private Exponent value.
getPrivateKey(String) - Method in class org.forgerock.secrets.SecretsKeyManager
getProductName() - Method in interface org.forgerock.audit.providers.ProductInfoProvider: Returns the name of the application hosting the AuditService.
getProperties() - Method in class org.forgerock.openig.heap.EnvironmentHeap
getProperties() - Method in interface org.forgerock.openig.heap.Heap: Returns the properties from this heap and its parents if any.
getProperties() - Method in class org.forgerock.openig.heap.HeapImpl
getProperties() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the unmodifiable map of properties bound to the session (can be empty, but never null).
getProperties() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the unmodifiable map of properties bound to the session (can be empty, but never null).
getProperty(String, boolean) - Method in class org.forgerock.openig.heap.ExpressionPropertyResolver
getPropertyType(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets a AuditEvent property type.
getProtectionParameter() - Method in class org.forgerock.secrets.SecretsLoadStoreParameter
getProtocol() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Returns the protocol over which messages transmitted to the Syslog daemon.
getProtocol() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getProtocolVersion() - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Gets the acceptable protocol version.
getProtocolVersion() - Method in class org.forgerock.http.header.ContentApiVersionHeader: Gets the protocol version of the content of the returned content.
getProtocolVersion() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets the protocol API version of the framework used to handle the request.
getProvider() - Method in class org.forgerock.secrets.SecretBuilder: Returns the security provider associated with this secret, or null if not specified.
getProxyUri() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo: Returns the URI of the proxy.
getPublicExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Get the RSA Public Exponent.
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.EcJWK
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.JWK: Return a builder with all the values set for representing the public components of the JWK.
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.OctJWK
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.OkpJWK
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.RsaJWK
getPublicKey() - Method in class org.forgerock.secrets.keys.CryptoKey: Returns the public key associated with this secret, if one is available.
getPublicKey() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails: Get the PublicKey component of this key.
getPublicKey() - Method in class org.forgerock.secrets.SecretBuilder: Returns the public key associated with this secret, or null if not available.
getPublicKey(Class<T>) - Method in class org.forgerock.secrets.keys.CryptoKey: Returns the public key associated with this secret, if one is available.
getPublicKey(KeyStore, String, String) - Static method in class org.forgerock.openig.util.KeyStoreUtil: Retrieve the public key from the keystore: it could be a certificate or a symmetric key.
getPublisher(InetSocketAddress, SyslogAuditEventHandlerConfiguration) - Method in enum org.forgerock.audit.handlers.syslog.TransportProtocol: Get the publisher for the given configuration.
getPurpose() - Method in exception org.forgerock.secrets.NoSuchSecretException: Returns the purpose for which no secret was found.
getQuery() - Method in class org.forgerock.http.MutableUri: Returns the path element.
getQueryExpression() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the native query expression which will be used for processing the query request.
getQueryFilter() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the query filter which will be used for selecting which JSON resources will be returned.
getQueryId() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the query identifier for pre-defined queries.
getQueryParams() - Method in class org.forgerock.http.protocol.Request: Returns a copy of the query parameters decoded as a form.
getQueryString() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getQuote() - Method in class org.forgerock.openig.text.Separator: Returns the character used to quote string literals, or -1 if none.
getQuoteChar() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting: Gets the character to use to quote the csv entries.
getRaw() - Method in class org.forgerock.openig.openam.CapturedUserPasswordContext: The bytes of the decrypted password.
getRawAuthority() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) authority compound element.
getRawContentFlowable() - Method in class org.forgerock.http.protocol.Entity: Returns a publisher of bytes representing the raw content of this entity.
getRawContentInputStream() - Method in class org.forgerock.http.protocol.Entity: Returns an input stream representing the raw content of this entity.
getRawContentInputStreamAsync() - Method in class org.forgerock.http.protocol.Entity: Returns a promise of an input stream representing the raw content of this entity.
getRawData() - Method in class org.forgerock.secrets.SecretBuilder: Returns the raw secret data, or null if the raw data is not available.
getRawFragment() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) fragment element.
getRawInfo() - Method in class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeContext: Returns the raw exchange token info as issued by the authorization server.
getRawInfo() - Method in class org.forgerock.openig.openam.UserProfileContext: Returns the unmodifiable Map of the user profile info, not null.
getRawInfo() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the session info for the given SSO Token as JsonValue if any, or null if none.
getRawPath() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) path element.
getRawQuery() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) query element.
getRawUserInfo() - Method in class org.forgerock.http.MutableUri: Returns the raw (encoded) user info element.
getRawValue() - Method in class org.forgerock.http.header.AuthorizationHeader: Get the raw value of the header.
getReader() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRealm() - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns the scope of protection required to access the protected resource.
getRealm() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the realm as specified by Access Management.
getRealm() - Method in class org.forgerock.openig.openam.UserProfileContext: Get the user's realm or null if none.
getRealm() - Method in class org.forgerock.openig.tools.am.AmService: Returns the realm to use with this configuration.
getRealm() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the realm as specified by Access Management.
getRealm() - Method in class org.forgerock.openig.tools.userprofile.UserProfile: Get the user's realm or null if none.
getRealPath(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter: Deprecated.
As of Version 2.1 of the Java Servlet API, use ServletContext.getRealPath(java.lang.String) instead.
getReason() - Method in exception org.forgerock.json.resource.ResourceException: Returns the short reason phrase of the exception.
getReasonPhrase() - Method in class org.forgerock.http.protocol.Status: Returns the reason phrase associated with the status code.
getReconnectDelay() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The delay after which a reconnect will be attempted.
getRecord(String, String) - Method in class org.forgerock.openig.text.SeparatedValuesFile: Returns a record from the file where the specified key is equal to the specified value.
getRedirectEndpoint() - Method in class org.forgerock.openig.openam.CdSsoContext: Configured redirect endpoint URI used in AM communication.
getRegisteredHandler(String) - Method in interface org.forgerock.audit.AuditService: Returns the registered handler corresponding to provided name.
getRegisteredHandler(String) - Method in class org.forgerock.audit.AuditServiceProxy
getRegisteredHandler(String) - Method in class org.forgerock.openig.audit.NoOpAuditService
getRegisteredHandlers() - Method in interface org.forgerock.audit.AuditService: Returns the registered handlers.
getRegisteredHandlers() - Method in class org.forgerock.audit.AuditServiceProxy
getRegisteredHandlers() - Method in class org.forgerock.openig.audit.NoOpAuditService
getRegistrationEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer: Returns the registration end-point of this issuer.
getRelayed() - Method in class org.forgerock.openig.filter.CookieFilter: Returns the set of cookie names that will be relayed (Cookie transmitted from the client to the next handler in the context of a request, and Set-Cookie2 transmitted from the next handler to the client in the context of a response).
getRemainingPagedResults() - Method in interface org.forgerock.json.resource.QueryResponse: Returns an estimate of the total number of remaining results to be returned in subsequent paged results query requests.
getRemainingUri() - Method in class org.forgerock.http.routing.UriRouterContext: Returns the portion of the request URI which is remaining to be matched be the next router.
getRemoteAddr() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRemoteAddress() - Method in class org.forgerock.services.context.ClientContext: Returns the IP address of the client (or last proxy) that sent the request or an empty string if the client is internal.
getRemoteHost() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRemotePort() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRemotePort() - Method in class org.forgerock.services.context.ClientContext: Returns the source port of the client (or last proxy) that sent the request or -1 if the client is internal.
getRemoteUser() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRemoteUser() - Method in class org.forgerock.services.context.ClientContext: Returns the login of the user making this request or an empty string if not known.
getRemovedHeaders() - Method in class org.forgerock.openig.filter.HeaderFilter: Returns the names of header fields to remove from the message.
getRequest() - Method in class org.forgerock.openig.http.ContextAndRequest: Returns the request.
getRequestDispatcher(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRequestedSessionId() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRequestReceivedTime() - Method in class org.forgerock.services.context.RequestAuditContext: Get the time in milliseconds since the epoch that the request was received.
getRequestType() - Method in interface org.forgerock.json.resource.ActionRequest
getRequestType() - Method in interface org.forgerock.json.resource.CreateRequest
getRequestType() - Method in interface org.forgerock.json.resource.DeleteRequest
getRequestType() - Method in interface org.forgerock.json.resource.PatchRequest
getRequestType() - Method in interface org.forgerock.json.resource.QueryRequest
getRequestType() - Method in interface org.forgerock.json.resource.ReadRequest
getRequestType() - Method in interface org.forgerock.json.resource.Request: Returns the type of this request.
getRequestType() - Method in interface org.forgerock.json.resource.UpdateRequest
getRequestURI() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRequestURL() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getRequiredFields() - Method in enum org.forgerock.json.jose.jwk.KeyType: The minimum set of fields that are required for a JWK of this type.
getRequiredScopes(Context, Request) - Method in interface org.forgerock.http.oauth2.ResourceAccess: Returns the scopes required to access the resource.
getRequiredScopes(Context, Request) - Method in class org.forgerock.openig.filter.oauth2.ScriptableResourceAccess
getResource() - Method in class org.forgerock.openig.openam.PolicyDecisionContext: Returns the resource entry in the policy decision (never null).
getResource(String) - Static method in class org.forgerock.util.Loader: Finds the resource with the given name.
getResourceApiVersion() - Method in exception org.forgerock.json.resource.ResourceException
getResourceApiVersion() - Method in interface org.forgerock.json.resource.Response: Gets the API version of the resource that the request was routed to.
getResourcePath() - Method in interface org.forgerock.json.resource.ActionRequest
getResourcePath() - Method in interface org.forgerock.json.resource.CreateRequest: Returns the path of the JSON resource container beneath which the new resource should be created.
getResourcePath() - Method in interface org.forgerock.json.resource.DeleteRequest
getResourcePath() - Method in interface org.forgerock.json.resource.PatchRequest
getResourcePath() - Method in interface org.forgerock.json.resource.QueryRequest
getResourcePath() - Method in interface org.forgerock.json.resource.ReadRequest
getResourcePath() - Method in interface org.forgerock.json.resource.Request: Returns the non-null path of the JSON resource to which this request should be targeted.
getResourcePath() - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersion: Get the ResourcePath to match.
getResourcePath() - Method in interface org.forgerock.json.resource.UpdateRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.ActionRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.CreateRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.DeleteRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.PatchRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.QueryRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.ReadRequest
getResourcePathObject() - Method in interface org.forgerock.json.resource.Request: Returns the non-null path of the JSON resource to which this request should be targeted.
getResourcePathObject() - Method in interface org.forgerock.json.resource.UpdateRequest
getResourceResponse() - Method in class org.forgerock.json.resource.IdentifierQueryResourceHandler: Gets the ResourceResponse query result.
getResourceVersion() - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Gets the acceptable resource version.
getResourceVersion() - Method in class org.forgerock.http.header.ContentApiVersionHeader: Gets the resource version of the returned content.
getResourceVersion() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets the API version of the resource that the request was routed to.
getResourceVersion() - Method in interface org.forgerock.json.resource.ActionRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.CreateRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.DeleteRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.PatchRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.QueryRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.ReadRequest
getResourceVersion() - Method in interface org.forgerock.json.resource.Request: Gets the requested API version of the resource.
getResourceVersion() - Method in interface org.forgerock.json.resource.UpdateRequest
getResponse() - Method in exception org.forgerock.http.protocol.ResponseException: Returns the response associated to this exception.
getResponseTime() - Method in class org.forgerock.openig.filter.MetricsFilter: Get the response time.
getRevision() - Method in interface org.forgerock.json.resource.DeleteRequest: Returns the expected version information associated with the JSON resource to be deleted.
getRevision() - Method in interface org.forgerock.json.resource.PatchRequest: Returns the expected version information associated with the JSON resource to be patched.
getRevision() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the revision of this resource, if known.
getRevision() - Method in interface org.forgerock.json.resource.UpdateRequest: Returns the expected version information associated with the JSON resource to be updated.
getRevision() - Static method in class org.forgerock.openig.util.ProductInfo: Returns the revision.
getRootId() - Method in class org.forgerock.services.context.AbstractContext
getRootId() - Method in interface org.forgerock.services.context.Context: Returns the unique ID of the root context, usually a UUID.
getRotationFilePrefix() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the prefix to add to a log file on rotation.
getRotationFileSuffix() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the suffix to add to a log file on rotation.
getRotationInterval() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the interval to trigger a file rotation.
getRotationInterval() - Method in class org.forgerock.audit.rotation.TimeLimitRotationPolicy: Gets the rotation duration interval.
getRotationRetentionCheckInterval() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Gets the interval to check time-based file rotation policies.
getRotationTimes() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets a list of times at which file rotation should be triggered; times should be provided as Strings that can be parsed by Duration that each specify an offset from midnight.
getRoutes() - Method in class org.forgerock.services.routing.AbstractRouter: Gets all registered routes on this router.
getSafeDocumentBuilder(boolean) - Static method in class org.forgerock.util.xml.XMLUtils: Provides a secure DocumentBuilder implementation, which is protected against different types of entity expansion attacks and makes sure that only locally available DTDs can be referenced within the XML document.
getSafeSAXParser(boolean) - Static method in class org.forgerock.util.xml.XMLUtils: Provides a secure SAXParser instance, which is protected against different types of entity expension, DoS attacks and makes sure that only locally available DTDs can be referenced within the XML document.
getSalt() - Method in class org.forgerock.util.crypto.HKDFKeyGenerator.HKDFMasterKey: Returns the non-secret salt for the master key.
getSameSite() - Method in class org.forgerock.http.protocol.Cookie: Returns the value of the SameSite attribute.
getSchema(String) - Method in class org.forgerock.audit.events.EventTopicsMetaData: Returns the JSON schema for the requested topic if this object has meta-data for that topic.
getScheme() - Method in class org.forgerock.http.MutableUri: Returns the scheme name.
getScheme() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getScope() - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns the required scope of the access token for accessing the requested resource.
getScope() - Method in class org.forgerock.openig.ldap.LdapClient: Returns the SearchScope available.
getScopedName() - Method in class org.forgerock.openig.heap.Name: Returns a String representation of this Name that includes only the first parent and the leaf name.
getScopes() - Method in class org.forgerock.http.oauth2.AccessTokenInfo: Returns the scopes associated to this token.
getScopes() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Returns the list of scopes of this client registration.
getScopes() - Method in class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeContext: Returns the set of scopes applicable to the exchange token.
getScriptDirectory(String) - Method in class org.forgerock.openig.config.env.DefaultEnvironment
getScriptDirectory(String) - Method in interface org.forgerock.openig.config.Environment: Returns the directory that contains the files of the given type.
getSecond() - Method in class org.forgerock.util.Pair: Returns the second element of this pair.
getSecretId() - Method in exception org.forgerock.secrets.NoSuchSecretException: Returns the stable id of the secret that was not found, or null if not specified.
getSecretKey() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails: Get the Key instance for the secret component of this key.
getSecretKey() - Method in class org.forgerock.secrets.SecretBuilder: Returns the secret (or private) key associated with this secret, or null if not specified.
getSecretService() - Method in class org.forgerock.openig.heap.GenericHeaplet: Returns the SecretsService from the heap.
getSecretsProviderOrSecretsService(Logger, JsonValue, Heap) - Static method in class org.forgerock.openig.secrets.SecretsUtils: Returns a SecretsProvider as specified with the SecretsUtils.CONFIG_SECRETS_PROVIDER attribute or falling back to a new SecretsProvider wrapping the SecretsService found in the heap.
getSecretType() - Method in class org.forgerock.secrets.Purpose: Returns the type of secrets that this purpose requires.
getSecureStorage(String) - Method in class org.forgerock.audit.providers.DefaultSecureStorageProvider
getSecureStorage(String) - Method in interface org.forgerock.audit.providers.SecureStorageProvider: Returns the secure storage corresponding to the given name.
getSecurity() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Returns the CSV tamper evident options.
getSegments() - Method in class org.forgerock.openig.tools.am.Realm: Returns the unmodifiable list of the segments composing the realm.
getSelfApiHandler() - Method in class org.forgerock.http.routing.Router
getSelfApiHandler() - Method in class org.forgerock.json.resource.Router
getSelfApiHandler() - Method in class org.forgerock.services.routing.AbstractRouter: Return a Describable handler that returns this AbstractRouter's internal api description from the Describable.handleApiRequest(Context, Object) method.
getSeparator() - Method in enum org.forgerock.openig.text.Separators: Returns the Separator specification that the enum constant represents.
getServerAliases(String, Principal[]) - Method in class org.forgerock.secrets.SecretsKeyManager
getServerName() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getServerPort() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getServletContext() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getServletPath() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getSession() - Method in class org.forgerock.http.session.SessionContext: Returns the Session associated with the remote client.
getSession() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getSession(boolean) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getSessionHandle() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the session handle, which may be used to logout of the session.
getSessionHandle() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the session handle, which may be used to logout of the session.
getSessionInfo(Context, String) - Method in class org.forgerock.openig.tools.session.CacheSessionService
getSessionInfo(Context, String) - Method in class org.forgerock.openig.tools.session.CrestSessionService
getSessionInfo(Context, String) - Method in interface org.forgerock.openig.tools.session.SessionService: Returns a promise that will be completed with an optional SessionInfo or with an SessionException in case of errors.
getSessionMode() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Returns the mode that the JMS session should use when publishing the JMS messages.
getSessionService() - Method in class org.forgerock.openig.tools.am.AmService: Returns the SessionService for this server.
getSessionUid() - Method in class org.forgerock.openig.openam.CdSsoContext: Get the ForgeRock session uid.
getSeverityFieldMappings() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Returns the configurations for mapping audit event field values to Syslog severity values.
getShare(String) - Method in class org.forgerock.openig.uma.UmaSharingService: Returns the Share with the given id.
getShortName() - Static method in class org.forgerock.openig.util.ProductInfo: Returns the product short name.
getSignature() - Method in class org.forgerock.secrets.keys.CertificateVerificationKey: Returns a signature object initialised for verification using a default algorithm for this key type.
getSignature() - Method in class org.forgerock.secrets.keys.SigningKey: Returns an initialised signature object for a default signature algorithm for this key type.
getSignature() - Method in class org.forgerock.secrets.keys.VerificationKey: Returns a signature object initialised for verification using a default algorithm for this key type.
getSignature(String) - Method in class org.forgerock.secrets.keys.CertificateVerificationKey: Returns a signature object initialised for verification.
getSignature(String) - Method in class org.forgerock.secrets.keys.SigningKey: Returns a signature object initialised for signing.
getSignature(String) - Method in class org.forgerock.secrets.keys.VerificationKey: Returns a signature object initialised for verification.
getSignatureInterval() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Gets the signature's interval.
getSignatureIntervalDuration() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Get's CsvAuditEventHandlerConfiguration.CsvSecurity.getSignatureInterval() value as a Duration.
getSignatureSize() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Returns the size of the signature produced by this curve in octets.
getSignedJwt() - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt: Get the signed JWT.
getSkewAllowance() - Method in class org.forgerock.openig.tools.jwt.validation.ValidatorConstraintContext: Returns the skew allowance that can be tolerated when validating temporal fields.
getSortKeys() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the sort keys which should be used for ordering the JSON resources returned by this query request.
getSsoToken() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the SSO Token of this SessionInfo.
getStableId() - Method in class org.forgerock.secrets.Secret: A stable identifier for this particular secret that can be used to lookup the same secret in future.
getStableId() - Method in class org.forgerock.secrets.SecretBuilder: Returns the stable id for this secret..
getStandardName() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Return the name of the curve as used for the "crv" claim in a JWK.
getStatus() - Method in class org.forgerock.http.protocol.Response: Returns the response status.
getStatus() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getStatusResponseCount(Status.Family) - Method in class org.forgerock.openig.filter.MetricsFilter: Get the response count by status family.
getStore() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getStore() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Get the keystore.
getStore() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getStoredType() - Method in class org.forgerock.openig.secrets.Base64EncodedSecretStore
getStoredType() - Method in class org.forgerock.secrets.jwkset.JwkSetSecretStore
getStoredType() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
getStoredType() - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore
getStoredType() - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
getStoredType() - Method in interface org.forgerock.secrets.SecretStore: The top-level class that this store is capable of storing.
getStoredType() - Method in class org.forgerock.secrets.ThreadPoolSecretStore
getString() - Method in class org.forgerock.http.protocol.Entity: Returns the content of this entity decoded as a string.
getStringAsync() - Method in class org.forgerock.http.protocol.Entity: Returns a promise of the content of this entity decoded as a string.
getSubject() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the subject this JWT is issued to.
getSubProtocols() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The subProtocols list to support (guaranteed to be not null).
getSuppressed() - Method in class org.forgerock.openig.filter.CookieFilter: Returns the set of cookie names that will be suppressed from the request and from the response.
getTable() - Method in class org.forgerock.audit.handlers.jdbc.TableMapping: Gets the table name for the mapping.
getTableMappings() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Gets the table mappings for the audit events.
getTarget() - Method in class org.forgerock.json.resource.FilterChain: Returns the target request handler which will be invoked once processing has reached the end of the filter chain.
getTempDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
getTempDirectory() - Method in interface org.forgerock.openig.config.Environment: Returns the temporary directory of IG (where we have read+write permissions).
getText() - Method in class org.forgerock.http.header.Warning: Gets the warning's text description.
getThis() - Method in class org.forgerock.http.routing.Router
getThis() - Method in class org.forgerock.json.resource.Router
getThis() - Method in class org.forgerock.services.routing.AbstractRouter: Returns this AbstractRouter instance, typed correctly.
getThrowable() - Method in class org.forgerock.openig.openam.CdSsoFailureContext: Get the Throwable associated with the CDSSO error that occurred.
getTimestamp() - Method in class org.forgerock.openig.tools.notifications.Notification: Returns the instant when the event happened on the AM server.
getTimeStamp() - Static method in class org.forgerock.openig.util.ProductInfo: Returns the timestamp.
getToken() - Method in class org.forgerock.http.header.authorization.BearerToken: Get the token.
getToken() - Method in class org.forgerock.http.oauth2.AccessTokenInfo: Returns the access token identifier issued from the authorization server.
getToken() - Method in class org.forgerock.openig.openam.CdSsoContext: Get the encoded JWT.
getTokenEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer: Returns the token end-point of this issuer.
getTokenProvider() - Method in class org.forgerock.openig.tools.am.AmService: Returns the AsyncRefreshableSupplier being used as a SsoToken provider for this server.
getTokenProvider() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The SSO token value provider.
getTokens() - Method in class org.forgerock.http.header.ConnectionHeader: Returns the list of connection tokens.
getTopic() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState: Returns the topic of the event.
getTopic() - Method in interface org.forgerock.audit.handlers.jms.JmsContextManager: Gets a JMS topic.
getTopic() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping: Returns the name of the event topic to which this mapping applies.
getTopic() - Method in class org.forgerock.openig.tools.notifications.Notification: Returns the notification's topic.
getTopic() - Method in interface org.forgerock.openig.tools.notifications.Subscription: Returns the name of the subscribed topic.
getTopic() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck: Returns the name of the topic, subject of the (un-)subscription request (is null for failure).
getTopic() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionRequest: Returns the topic name.
getTopicName() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration: Returns the jndi lookup name for the JMS Topic to which messages will be published.
getTopics() - Method in class org.forgerock.audit.events.EventTopicsMetaData: Returns the names of the set of topics for which this object has meta-data.
getTopics() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Returns the names of the topics accepted by this handler.
getTotalPagedResults() - Method in interface org.forgerock.json.resource.QueryResponse: Returns the total number of paged results in adherence with the QueryRequest.getTotalPagedResultsPolicy() in the request or QueryResponse.NO_COUNT if paged results were not requested, the count policy is NONE, or the total number of paged results is unknown.
getTotalPagedResultsPolicy() - Method in interface org.forgerock.json.resource.QueryRequest: Returns the CountPolicy used to calculate QueryResponse.getTotalPagedResults().
getTotalPagedResultsPolicy() - Method in interface org.forgerock.json.resource.QueryResponse: Returns the policy that was used to calculate the totalPagedResults.
getTotalRequestCount() - Method in class org.forgerock.openig.filter.MetricsFilter: Get the total request count.
getTotalResponseCount() - Method in class org.forgerock.openig.filter.MetricsFilter: Get the total response count.
getTrackingIds() - Method in class org.forgerock.services.context.RequestAuditContext: Get all tracking IDs stored in this context.
getTrailers() - Method in class org.forgerock.http.protocol.Response: Returns the trailers, aka trailing headers.
getTransactionId() - Method in class org.forgerock.http.header.TransactionIdHeader: Returns the transaction id.
getTransactionId() - Method in class org.forgerock.services.context.TransactionIdContext: Returns the transaction id.
getTransformation() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Gets the Java Cryptographic algorithm name for the algorithm that will eb used to encrypt the plaintext.
getTransformedValue(JsonValue, JsonValue) - Method in interface org.forgerock.json.JsonPatchValueTransformer: Return the value to be used for a given patch operation.
getTrustManager(Purpose<? extends CryptoKey>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getTrustManager(Purpose<? extends CryptoKey>) - Method in interface org.forgerock.openig.secrets.SecretsService: Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.
getTrustManager(Purpose<? extends CryptoKey>) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getTrustManager(Purpose<? extends CryptoKey>) - Method in class org.forgerock.secrets.SecretsProvider: Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.
getTrustManager(Purpose<? extends CryptoKey>, Options) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getTrustManager(Purpose<? extends CryptoKey>, Options) - Method in interface org.forgerock.openig.secrets.SecretsService: Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.
getTrustManager(Purpose<? extends CryptoKey>, Options) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getTrustManager(Purpose<? extends CryptoKey>, Options) - Method in class org.forgerock.secrets.SecretsProvider: Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.
getTrustManagers() - Method in class org.forgerock.openig.tools.TlsOptions: Returns the array of TrustManager to use (may be null).
getType() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getType() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Returns the type of the keystore.
getType() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getType() - Method in class org.forgerock.http.header.AuthorizationHeader: Get the type of the authorization being presented, e.g.
getType() - Method in class org.forgerock.http.header.ContentTypeHeader: Returns the media type of the underlying data or null if none specified.
getType() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the type of the contents of the Claims Set.
getType() - Method in class org.forgerock.json.jose.jwt.JwtHeader: Gets the type of JWT this header represents.
getType() - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet: Returns the type of the IG object.
getType() - Method in class org.forgerock.openig.decoration.timer.TimerDecorator.Heaplet
getType() - Method in class org.forgerock.openig.handler.ClientHandlerHeaplet
getType() - Method in interface org.forgerock.openig.handler.resources.Resource: Returns the media type of this resource.
getType() - Method in class org.forgerock.openig.handler.ReverseProxyHandlerHeaplet
getType() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
getType() - Method in class org.forgerock.openig.heap.GenericHeaplet: Returns the type of the IG object.
getUnit() - Method in class org.forgerock.util.time.Duration: Returns the TimeUnit this duration is expressed in.
getUniversalId() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the universal id.
getUniversalId() - Method in class org.forgerock.openig.openam.SsoTokenContext: Returns the universalId of the user associated with this session.
getUniversalId() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the universal id.
getUnrecognizedCriticalHeaders() - Method in exception org.forgerock.json.jose.exceptions.UnrecognizedCriticalHeaderException: The unrecognized critical headers that caused processing to fail.
getUri() - Method in class org.forgerock.http.header.ReferrerHeader: Get the URI value of the Referrer header.
getUri() - Method in class org.forgerock.http.protocol.Request: Returns the fully-qualified URI of the resource being accessed.
getUri() - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: The Websocket remote endpoint URI (guaranteed to be not null).
getUriTemplateVariables() - Method in class org.forgerock.http.routing.UriRouterContext: Returns an unmodifiable Map containing the parsed URI template variables, keyed on the URI template variable name.
getUse() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the use parameter of the JWK.
getUserAgent() - Method in class org.forgerock.services.context.ClientContext: Returns the value of the User-Agent HTTP Header (if any, returns an empty string otherwise).
getUserId() - Method in class org.forgerock.services.context.RequestAuditContext: Get the user ID stored in this context.
getUserInfo() - Method in class org.forgerock.http.MutableUri: Returns the user info element.
getUserInfo(Context, OAuth2Session) - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Returns a Promise completed either with the json value of the user info obtained from the authorization server if the response from the authorization server has a status code of 200, or with an exception, meaning the access token may have expired.
getUserInfoEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer: Returns the user end-point of this issuer.
getUsername() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Gets Elasticsearch username for HTTP basic authentication.
getUsername() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Gets the username to use to connect to the JDBC database.
getUsername() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo: Returns the username to use when authenticating to the proxy.
getUsername() - Method in class org.forgerock.http.header.authorization.BasicCredentials: Get the username.
getUsername() - Method in class org.forgerock.openig.openam.SessionInfoContext: Returns the user-friendly version of the username.
getUsername() - Method in class org.forgerock.openig.openam.SsoTokenContext: Returns the username of the user associated with this session.
getUsername() - Method in class org.forgerock.openig.openam.UserProfileContext: Get the user's username or null if none.
getUsername() - Method in class org.forgerock.openig.tools.session.SessionInfo: Returns the user-friendly version of the username.
getUsername() - Method in class org.forgerock.openig.tools.userprofile.UserProfile: Get the user's username.
getUserPrincipal() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
getUserProfile(Context, String) - Method in class org.forgerock.openig.tools.userprofile.CacheUserProfileService
getUserProfile(Context, String) - Method in class org.forgerock.openig.tools.userprofile.CrestUserProfileService
getUserProfile(Context, String) - Method in interface org.forgerock.openig.tools.userprofile.UserProfileService: Returns a promise that will be completed with an UserProfile or with an UserProfileException in case of errors.
getValid(Purpose<S>) - Method in class org.forgerock.openig.secrets.Base64EncodedSecretStore
getValid(Purpose<S>) - Method in class org.forgerock.secrets.jwkset.JwkSetSecretStore
getValid(Purpose<S>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
getValid(Purpose<S>) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore
getValid(Purpose<S>) - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore: Returns a stream of the active secret for the given purpose.
getValid(Purpose<S>) - Method in interface org.forgerock.secrets.SecretStore: Returns all valid secrets for the given purpose from this store.
getValid(Purpose<S>) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
getValidSecrets(Purpose<S>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
getValidSecrets(Purpose<S>) - Method in interface org.forgerock.openig.secrets.SecretsService: Returns all secrets for the given purpose which have not yet expired.
getValidSecrets(Purpose<S>) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
getValidSecrets(Purpose<S>) - Method in class org.forgerock.secrets.SecretsProvider: Returns all secrets for the given purpose which have not yet expired.
getValue() - Method in class org.forgerock.audit.events.AuditEvent: Returns the Json value of this event.
getValue() - Method in class org.forgerock.http.header.Directive: Represents directive value, won't be quoted even if the original was.
getValue() - Method in class org.forgerock.http.protocol.Cookie: Returns the value of the cookie.
getValue() - Method in class org.forgerock.json.JsonPointer: Returns the JSON pointer string value.
getValue() - Method in class org.forgerock.json.resource.PatchOperation: Returns the value for the patch operation.
getValue() - Method in class org.forgerock.openig.decoration.capture.KeyValueProcessor.Value: Get the actual value.
getValue() - Method in class org.forgerock.openig.filter.jwt.JwtValidationContext: Returns the JWT.
getValue() - Method in class org.forgerock.openig.filter.JwtBuilderContext: Returns the JWT as a String.
getValue() - Method in class org.forgerock.openig.openam.CapturedUserPasswordContext: Returns the decrypted password as an UTF-8 String.
getValue() - Method in class org.forgerock.openig.openam.SsoTokenContext: Returns the token associated with this SsoTokenContext context.
getValue() - Method in class org.forgerock.openig.tools.authentication.SsoToken: Returns the string value of this token.
getValue() - Method in class org.forgerock.openig.tools.InternalSsoTokenContext: Returns the token associated with this InternalSsoTokenContext context.
getValue() - Method in class org.forgerock.services.TransactionId: Returns the value of this TransactionId.
getValue() - Method in class org.forgerock.util.time.Duration: Returns the number of TimeUnit this duration represents.
getValue(Charset) - Method in class org.forgerock.openig.openam.CapturedUserPasswordContext: Returns a new String by decoding the password using the specified charset.
getValue(K, Callable<V>) - Method in class org.forgerock.util.PerItemEvictionStrategyCache: Borrow (and create before hand if absent) a cache entry.
getValue(K, Callable<V>, AsyncFunction<V, Duration, E>) - Method in class org.forgerock.util.PerItemEvictionStrategyCache: Borrow (and create before hand if absent) a cache entry.
getValue(JwtClaimsSet, JsonPointer) - Static method in class org.forgerock.openig.tools.JwtUtil: Return a value from it's well-known location on the OAuth2 authorization JWT.
getValueMappings() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping: Returns the mapping of audit event values to Syslog severity values.
getValues() - Method in class org.forgerock.http.header.AcceptApiVersionHeader
getValues() - Method in class org.forgerock.http.header.AcceptLanguageHeader
getValues() - Method in class org.forgerock.http.header.AuthorizationHeader
getValues() - Method in class org.forgerock.http.header.ConnectionHeader
getValues() - Method in class org.forgerock.http.header.ContentApiVersionHeader
getValues() - Method in class org.forgerock.http.header.ContentEncodingHeader
getValues() - Method in class org.forgerock.http.header.ContentLengthHeader
getValues() - Method in class org.forgerock.http.header.ContentTypeHeader
getValues() - Method in class org.forgerock.http.header.CookieHeader
getValues() - Method in class org.forgerock.http.header.ForwardedHeader
getValues() - Method in class org.forgerock.http.header.GenericHeader: Returns the header as a list of strings.
getValues() - Method in class org.forgerock.http.header.LocationHeader
getValues() - Method in class org.forgerock.http.header.ReferrerHeader
getValues() - Method in class org.forgerock.http.header.SetCookie2Header: Deprecated.
getValues() - Method in class org.forgerock.http.header.SetCookieHeader
getValues() - Method in class org.forgerock.http.header.TrailerHeader
getValues() - Method in class org.forgerock.http.header.TransactionIdHeader
getValues() - Method in class org.forgerock.http.header.WarningHeader
getValues() - Method in class org.forgerock.http.header.WwwAuthenticateHeader
getValues() - Method in class org.forgerock.http.header.XForwardedForHeader
getValues() - Method in class org.forgerock.http.protocol.Header: Returns the header as a list of strings.
getValues() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
getVersion() - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
getVersion() - Method in interface org.forgerock.http.protocol.Message: Returns the protocol version.
getVersion() - Method in class org.forgerock.http.protocol.MessageImpl
getVersion() - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersion: Get the Version corresponding to the resourcePath.
getVersion() - Method in class org.forgerock.openig.tools.am.AmService: Return the version of the configured OpenAM Server.
getVersion() - Static method in class org.forgerock.openig.util.ProductInfo: Returns the product version.
getViolation() - Method in class org.forgerock.openig.tools.jwt.validation.Result: Return the Violation if it is present, null otherwise.
getViolations() - Method in class org.forgerock.openig.filter.jwt.JwtValidationErrorContext: Returns the unmodifiable list of Violations.
getViolations() - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidatorResult: Returns the list of the Violation if this JWT is invalid.
getWarnings() - Method in class org.forgerock.http.header.WarningHeader: Gets all Warnings.
getWebCryptoName() - Method in enum org.forgerock.secrets.keys.KeyUsage: The standard WebCrypto KeyUsage name for this usage.
getWellKnownEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer: Returns the well-known end-point of this issuer.
getWithDeprecation(JsonValue, Logger, String, String...) - Static method in class org.forgerock.openig.util.JsonValues: Returns the named property from the provided JSON object, falling back to zero or more deprecated property names.
getWithoutRefresh() - Method in class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier: Computes the value in a thread-safe manner, making sure that only 1 thread will compute the value, the other being blocked, waiting for the result to be computed.
getWrappedWriter() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Retrieves the wrapped writer.
getWriteInterval() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the interval for reading events from the buffer to transmit to Elasticsearch.
getWriteInterval() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the interval to write the queued buffered events.
getWriteInterval() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.BatchConfiguration: Gets the interval for reading events from the buffer to transmit via jms.
getWriteInterval() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets delay after which the file-writer thread is scheduled to run after encountering an empty event buffer (units of 'ms' are recommended).
getWriteInterval() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration: Gets the interval for reading events from the buffer to transmit to splunk.
getWriter() - Method in class org.forgerock.audit.rotation.RotationContext: Get the writer.
getWriter() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
getWriterThreads() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Gets the number of writer threads to use to write buffered events.
getX() - Method in class org.forgerock.json.jose.jwk.EcJWK: Gets the unsigned big-endian base64 url encoding of the elliptical curve point x coordinate.
getX() - Method in class org.forgerock.json.jose.jwk.OkpJWK: Returns the x-coordinate that forms the public key.
getX509BitPosition() - Method in enum org.forgerock.secrets.keys.KeyUsage: The bit position of this usage in the X.509 KeyUsage extension.
getX509CertificateChain() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the X.509 Certificate Chain header parameter for this JWS.
getX509CertificateThumbprint() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the X.509 Certificate Thumbprint header parameter for this JWS.
getX509Chain() - Method in class org.forgerock.json.jose.jwk.JWK: Gets a List of X509 chain certs.
getX509StandardName() - Method in enum org.forgerock.secrets.keys.KeyUsage: The standard name of this key usage in the X.509 standard.
getX509Thumbnail() - Method in class org.forgerock.json.jose.jwk.JWK: Deprecated.
Use JWK.getX509Thumbprint() instead.
getX509Thumbprint() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the X509 thumbprint.
getX509ThumbprintS256() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the X.509 SHA-256 thumbprint.
getX509Url() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Gets the X.509 URL header parameter for this JWS.
getX509URL() - Method in class org.forgerock.json.jose.jwk.JWK: Gets the X509 URL.
getY() - Method in class org.forgerock.json.jose.jwk.EcJWK: Gets the unsigned big-endian base64 url encoding of the elliptical curve point y coordinate.
GLOBAL_DECORATOR_HEAP_KEY - Static variable in class org.forgerock.openig.decoration.global.GlobalDecorator: Heap Key for the global decorator(s).
GLOBAL_METER_REGISTRY_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the global MeterRegistry from the Heap.
GlobalDecorator - Class in org.forgerock.openig.decoration.global: A GlobalDecorator stores decorators configuration in order to re-apply them when requested to decorate a given heap object instance.
GlobalDecorator(Decorator, JsonValue, Heap, String...) - Constructor for class org.forgerock.openig.decoration.global.GlobalDecorator: Builds a new GlobalDecorator using given decorators JSON object element.
GONE - Static variable in class org.forgerock.http.protocol.Status: The 410 (Gone) status code indicates that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent.
GRANT_TYPE - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set grant_type key - not available in JwtClaimsSetKey.
GrantTypeHandler - Class in org.forgerock.secrets.oauth2: Abstract base class for OAuth 2 grant type handlers for calling the token endpoint.
GrantTypeHandler(String, String) - Constructor for class org.forgerock.secrets.oauth2.GrantTypeHandler: Initialises the grant type handler with the given grant type name and client id.
GrantTypeHandler(String, String, Collection<String>) - Constructor for class org.forgerock.secrets.oauth2.GrantTypeHandler: Initialises the grant type handler with the given grant type name and client id.
GREATER_EQUAL - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "greater-than-or-equal" operator.
GREATER_THAN - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "greater-than" operator.
greaterThan(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new greater than filter using the provided field name and value assertion.
greaterThan(Version) - Static method in class org.forgerock.openig.tools.am.Version: Returns a predicate that verifies if this version is strictly greater than the given version.
greaterThanOrEqualTo(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new greater than or equal to filter using the provided field name and value assertion.
greaterThanOrEqualTo(Version) - Static method in class org.forgerock.openig.tools.am.Version: Returns a predicate that verifies if this version is greater or equal to the given version.
GROOVY_MIME_TYPE - Static variable in class org.forgerock.openig.script.GroovyScriptFactory: The mime-type for Groovy scripts.
GroovyScriptFactory - Class in org.forgerock.openig.script: Provide support for scripts written in the Groovy language.
GroovyScriptFactory(File, File) - Constructor for class org.forgerock.openig.script.GroovyScriptFactory: Constructs a new factory given two runtime directories: basedir (the root directory where file scripts are stored) and cacheDir (where inlined scripts would be stored prior to execution).
GroovyScriptFactory(Environment) - Constructor for class org.forgerock.openig.script.GroovyScriptFactory: Constructs a new factory based on the given runtime Environment.

H

H_BEARER - Static variable in class org.forgerock.http.oauth2.OAuth2Error: The WWW-Authenticate header prefix, 'Bearer'.
H2 - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: The name used for an H2 database.
handle(Context, Request) - Method in interface org.forgerock.http.Handler: Returns a Promise representing the asynchronous Response of the given request.
handle(Context, Request) - Method in class org.forgerock.http.handler.HttpClientHandler: Sends an HTTP request to a remote server and returns a Promise representing the asynchronous response.
handle(Context, Request) - Method in class org.forgerock.http.routing.Router
handle(Context, Request) - Method in class org.forgerock.openig.handler.DesKeyGenHandler: Deprecated.
handle(Context, Request) - Method in class org.forgerock.openig.handler.DispatchHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.JwkSetHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.resources.ResourceHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.router.RouterHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.saml.SamlFederationHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.ScriptableHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.SequenceHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.StaticResponseHandler
handle(Context, Request) - Method in class org.forgerock.openig.handler.WelcomeHandler
handle(Context, ResourcePath) - Method in interface org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.NoApiVersionHandler: Handler called when a request has no resource API version.
handleAction(Context, String, ActionRequest) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Performs an action.
handleAction(Context, String, ActionRequest) - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
handleAction(Context, String, ActionRequest) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler
handleAction(Context, String, ActionRequest) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandler
handleAction(Context, ActionRequest) - Method in interface org.forgerock.audit.AuditService: Audit service may support actions on the service itself or on handlers.
handleAction(Context, ActionRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleAction(Context, ActionRequest) - Method in class org.forgerock.json.resource.FilterChain
handleAction(Context, ActionRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Handles performing an action on a resource, and optionally returns an associated result.
handleAction(Context, ActionRequest) - Method in class org.forgerock.json.resource.Router
handleAction(Context, ActionRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Handles performing an action on a resource, and optionally returns an associated result.
handleAction(Context, ActionRequest) - Method in class org.forgerock.openig.audit.NoOpAuditService
handleActual(Response, String) - Method in class org.forgerock.http.filter.cors.CorsPolicy: Handles the response of an actual CORS request.
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.FilterChain
handleApiRequest(Context, Request) - Method in class org.forgerock.json.resource.Router
handleApiRequest(Context, R) - Method in interface org.forgerock.services.descriptor.Describable: Handle a request for the API Descriptor.
handleApiRequest(Context, R) - Method in class org.forgerock.services.routing.AbstractRouter
handleCreate(Context, CreateRequest) - Method in interface org.forgerock.audit.AuditService: Propagates the audit event to the AuditEventHandler objects that have been registered for the audit event topic.
handleCreate(Context, CreateRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleCreate(Context, CreateRequest) - Method in class org.forgerock.json.resource.FilterChain
handleCreate(Context, CreateRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Adds a new JSON resource, returning a Promise that will be completed when the resource has been added.
handleCreate(Context, CreateRequest) - Method in class org.forgerock.json.resource.Router
handleCreate(Context, CreateRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Adds a new JSON resource.
handleCreate(Context, CreateRequest) - Method in class org.forgerock.openig.audit.NoOpAuditService
handleDelete(Context, DeleteRequest) - Method in interface org.forgerock.audit.AuditService: Audit service does not support changing audit entries.
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.FilterChain
handleDelete(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Deletes a JSON resource, returning a Promise that will be completed when the resource has been deleted.
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.json.resource.Router
handleDelete(Context, DeleteRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Deletes a JSON resource.
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.openig.audit.NoOpAuditService
handleException(E) - Method in interface org.forgerock.util.promise.ExceptionHandler: Invoked when the asynchronous task has failed.
handleException(E) - Method in class org.forgerock.util.promise.PromiseImpl: Signals that the asynchronous task represented by this promise has failed.
handleNoApiVersionSupplied(Context, ResourcePath) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification: Support handling when no resource API version is supplied on the request.
handleNoApiVersionSupplied(Context, ResourcePath) - Method in interface org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.VersionSpecification: Support custom handling when no resource API version is supplied on the request.
handlePatch(Context, PatchRequest) - Method in interface org.forgerock.audit.AuditService: Audit service does not support changing audit entries.
handlePatch(Context, PatchRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handlePatch(Context, PatchRequest) - Method in class org.forgerock.json.resource.FilterChain
handlePatch(Context, PatchRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Updates a JSON resource by applying a set of changes to its existing content, returning a Promise that will be completed when the resource has been updated.
handlePatch(Context, PatchRequest) - Method in class org.forgerock.json.resource.Router
handlePatch(Context, PatchRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Updates a JSON resource by applying a set of changes to its existing content.
handlePatch(Context, PatchRequest) - Method in class org.forgerock.openig.audit.NoOpAuditService
handlePreflight(Request, String) - Method in class org.forgerock.http.filter.cors.CorsPolicy: Produces the response for a CORS preflight request.
handleQuery(Context, QueryRequest, Collection<ResourceResponse>) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Searches for all JSON resources matching a user specified set of criteria.
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.audit.AuditService: Performs the query on the specified object and returns the associated results.
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.AuditServiceProxy
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.FilterChain
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.RequestHandler: Searches for all JSON resources matching a user specified set of criteria, returning a Promise that will be completed when the search has completed.
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.Router
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.openig.audit.NoOpAuditService
handler() - Method in class org.forgerock.openig.types.importer.RouteInstance: Returns the component instance of the main handler of this route.
handler(ComponentInstance) - Method in class org.forgerock.openig.types.importer.RouteInstance: Sets the component instance supporting the main handler of this route.
Handler - Interface in org.forgerock.http: Asynchronously handles an HTTP Request by producing an associated Response.
handleRead(Context, ReadRequest) - Method in interface org.forgerock.audit.AuditService: Gets an object from the audit logs by identifier.
handleRead(Context, ReadRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.FilterChain
handleRead(Context, ReadRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Reads a JSON resource, returning a Promise that will be completed when the resource has been read.
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.Router
handleRead(Context, ReadRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Reads a JSON resource.
handleRead(Context, ReadRequest) - Method in class org.forgerock.openig.audit.NoOpAuditService
handleResource(ResourceResponse) - Method in class org.forgerock.json.resource.IdentifierQueryResourceHandler
handleResource(ResourceResponse) - Method in interface org.forgerock.json.resource.QueryResourceHandler: Invoked each time a matching JSON resource is returned from a query request.
handleResult(V) - Method in class org.forgerock.util.promise.PromiseImpl: Signals that the asynchronous task represented by this promise has succeeded.
handleResult(V) - Method in interface org.forgerock.util.promise.ResultHandler: Invoked when the asynchronous task has completed successfully.
Handlers - Class in org.forgerock.http.handler: Utility methods for creating common types of handlers.
Handlers - Class in org.forgerock.openig.handler: Provides commonly used handler implementations.
handleRuntimeException(RuntimeException) - Method in class org.forgerock.util.promise.PromiseImpl
handleRuntimeException(RuntimeException) - Method in interface org.forgerock.util.promise.RuntimeExceptionHandler: Invoked when the asynchronous task has failed with a runtime exception.
handleUpdate(Context, UpdateRequest) - Method in interface org.forgerock.audit.AuditService: Audit service does not support changing audit entries.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.json.resource.FilterChain
handleUpdate(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.RequestHandler: Updates a JSON resource by replacing its existing content with new content, returning a Promise that will be completed when the resource has been updated.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.json.resource.Router
handleUpdate(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler: Updates a JSON resource by replacing its existing content with new content.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.openig.audit.NoOpAuditService
hasChangedSince(long) - Method in interface org.forgerock.openig.handler.resources.Resource: Returns true if the resource has changed since the given timestamp (expressed in ms).
hasClaims() - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns empty if the JWT does contain claims.
hasCredentials() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo: Returns true if there is a set of username/password credentials defined.
hasFields() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns true if any fields have been added, indicating that the list of fields in this response should be included in this JSON resource after field filtering has occurred, otherwise returns false indicating that the original list of fields in the request should be used for filtering the response.
HASH_BYTES_LEN - Static variable in class org.forgerock.util.crypto.HKDFKeyGenerator: The HMAC output length in bytes.
hashCode() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
hashCode() - Method in class org.forgerock.http.header.Directive
hashCode() - Method in class org.forgerock.http.header.ForwardedHeader
hashCode() - Method in class org.forgerock.http.header.ForwardedHeader.Hop
hashCode() - Method in class org.forgerock.http.header.TrailerHeader
hashCode() - Method in class org.forgerock.http.header.Warning
hashCode() - Method in class org.forgerock.http.header.WarningHeader
hashCode() - Method in class org.forgerock.http.header.XForwardedForHeader
hashCode() - Method in class org.forgerock.http.MutableUri
hashCode() - Method in class org.forgerock.http.oauth2.OAuth2Error
hashCode() - Method in class org.forgerock.http.protocol.Cookie
hashCode() - Method in class org.forgerock.http.protocol.Header
hashCode() - Method in class org.forgerock.http.routing.Version
hashCode() - Method in class org.forgerock.http.util.SetDecorator
hashCode() - Method in class org.forgerock.json.jose.jwe.JweEncryption
hashCode() - Method in class org.forgerock.json.jose.jwt.JWObject
hashCode() - Method in class org.forgerock.json.JsonPointer: Returns the hash code value for this pointer.
hashCode() - Method in class org.forgerock.json.resource.ResourcePath: Returns a hash code for this resource path.
hashCode() - Method in interface org.forgerock.json.resource.ResourceResponse: Returns the hash code for this resource.
hashCode() - Method in class org.forgerock.json.resource.SortKey
hashCode() - Method in class org.forgerock.openig.decoration.capture.KeyValueProcessor.Value
hashCode() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
hashCode() - Method in class org.forgerock.openig.filter.throttling.ThrottlingRate
hashCode() - Method in class org.forgerock.openig.heap.Name
hashCode() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
hashCode() - Method in class org.forgerock.openig.text.Separator
hashCode() - Method in class org.forgerock.openig.tools.am.Version
hashCode() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpec
hashCode() - Method in class org.forgerock.secrets.Purpose
hashCode() - Method in class org.forgerock.secrets.Secret
hashCode() - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
hashCode() - Method in class org.forgerock.services.routing.RouteMatcher
hashCode() - Method in class org.forgerock.util.i18n.LocalizableString: Default hashcode implementation.
hashCode() - Method in class org.forgerock.util.LazyList: Returns the hash code value for this list.
hashCode() - Method in class org.forgerock.util.LazyMap: Returns the hash code value for the map.
hashCode() - Method in class org.forgerock.util.ListDecorator: Returns the hash code value for this list.
hashCode() - Method in class org.forgerock.util.MapDecorator: Returns the hash code value for the map.
hashCode() - Method in class org.forgerock.util.Pair
hashCode() - Method in class org.forgerock.util.query.QueryFilter
hashCode() - Method in class org.forgerock.util.time.Duration
hasName() - Method in class org.forgerock.http.header.Directive: Return true if the directive name is not null or empty.
hasNext() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyIterator
hasStreamingContent() - Method in class org.forgerock.http.protocol.Response: Indicates that the response's content has to be considered as a streaming and thus some special treatments may apply on it.
hasUserInfoEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer: Returns true if this issuer has a user info end-point.
hasValidSignature(JwsSignatureVerifier) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Validates the signature of this SignedJwt.
hasValidSignatureAndEncryption(JwtConstraint, JwtConstraint) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Provides a JwtConstraint configured with the supplied JwtConstraints verifying both signature and encryption.
head(int) - Method in class org.forgerock.json.JsonPointer: Returns a pointer which is a subsequence of the path elements contained in this pointer beginning with the first element (0) and ending with the element at position endIndex-1.
head(int) - Method in class org.forgerock.json.resource.ResourcePath: Returns a resource path which is a subsequence of the path elements contained in this resource path beginning with the first element (0) and ending with the element at position endIndex-1.
header(String, Object) - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder: Adds a custom header parameter to the JWT header.
Header - Class in org.forgerock.http.protocol: An HTTP message header.
Header() - Constructor for class org.forgerock.http.protocol.Header
HEADER_NAMES - Static variable in class org.forgerock.http.header.HeaderFactory: A map of Header types to the names of the headers they implement.
HeaderFactory<H extends Header> - Class in org.forgerock.http.header: Creates instances of Header classes from String representation.
HeaderFactory() - Constructor for class org.forgerock.http.header.HeaderFactory
HeaderFilter - Class in org.forgerock.openig.filter: Removes headers from and adds headers to a message.
HeaderFilter(MessageType) - Constructor for class org.forgerock.openig.filter.HeaderFilter: Builds a HeaderFilter processing either the incoming or outgoing message.
HeaderFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes a header filter in a heap environment.
HeaderFilterTypeProvider - Class in org.forgerock.openig.filter: Provide HeaderFilter's TypeDefinition.
HeaderFilterTypeProvider() - Constructor for class org.forgerock.openig.filter.HeaderFilterTypeProvider
headerIfNotNull(String, Object) - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder: Adds a customer header parameter to the JWT header if the value is not null.
headers() - Method in class org.forgerock.json.jose.builders.AbstractJwtBuilder: Gets the JwtHeaderBuilder that this JwtBuilder will use to build the JWT's header parameters.
headers() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder: Gets the JweHeaderBuilder that this JwtBuilder will use to build the JWE's header parameters.
headers() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder
headers() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl: Gets the JwsHeaderBuilder that this JwtBuilder will use to build the JWS' header parameters.
headers() - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder
Headers - Class in org.forgerock.http.protocol: Message headers, a case-insensitive multiple-value map.
Headers() - Constructor for class org.forgerock.http.protocol.Headers: Constructs a Headers object that is case-insensitive for header names.
HEADERS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The headers event payload field name.
HeadersResolver - Class in org.forgerock.openig.resolver: Resolves Headers objects.
HeadersResolver() - Constructor for class org.forgerock.openig.resolver.HeadersResolver
HeaderUtil - Class in org.forgerock.http.header: Utility class for processing values in HTTP header fields.
HeadlessAuthenticationFilter - Class in org.forgerock.openig.tools: Provides an OpenAM SSO Token in the given header name for downstream components.
HeadlessAuthenticationFilter(String, AsyncRefreshableSupplier<SsoToken, AuthenticationException>) - Constructor for class org.forgerock.openig.tools.HeadlessAuthenticationFilter: Creates a HeadlessAuthenticationFilter which will provide an AM SSO Token in the given header name for downstream components.
heap - Variable in class org.forgerock.openig.decoration.helper.DecoratorHeaplet: Where objects should be put and where object dependencies should be retrieved.
heap - Variable in class org.forgerock.openig.heap.GenericHeaplet: Where objects should be put and where object dependencies should be retrieved.
Heap - Interface in org.forgerock.openig.heap: Manages a collection of associated objects created and initialized by Heaplet objects.
HEAP_METER_REGISTRY_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the local MeterRegistry from the Heap.
HeapException - Exception in org.forgerock.openig.heap: An exception that is thrown during heap operations.
HeapException() - Constructor for exception org.forgerock.openig.heap.HeapException: Constructs a new exception with null as its detail message.
HeapException(String) - Constructor for exception org.forgerock.openig.heap.HeapException: Constructs a new exception with the specified detail message.
HeapException(String, Throwable) - Constructor for exception org.forgerock.openig.heap.HeapException: Constructs a new exception with the specified detail message and cause.
HeapException(Throwable) - Constructor for exception org.forgerock.openig.heap.HeapException: Constructs a new exception with the specified cause.
HeapImpl - Class in org.forgerock.openig.heap: The concrete implementation of a heap.
HeapImpl(HeapImpl, Name) - Constructor for class org.forgerock.openig.heap.HeapImpl: Builds a new heap that is a child of the given heap.
HeapImpl(HeapImpl, Name, PropertyResolver) - Constructor for class org.forgerock.openig.heap.HeapImpl: Builds a new heap that is a child of the given heap.
HeapImpl(Name) - Constructor for class org.forgerock.openig.heap.HeapImpl: Builds a root heap (will be referenced by children but has no parent itself).
Heaplet - Interface in org.forgerock.openig.heap: Creates and initializes an object that is stored in a Heap.
Heaplet() - Constructor for class org.forgerock.openig.audit.NoOpAuditService.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.decoration.baseuri.BaseUriDecorator.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.decoration.capture.CaptureDecorator.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.decoration.timer.TimerDecorator.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.allow.AllowOnlyFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.AssignmentFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.circuitbreaker.CircuitBreakerFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.ConditionEnforcementFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.CookieFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.CryptoHeaderFilter.Heaplet: Deprecated.
Heaplet() - Constructor for class org.forgerock.openig.filter.DateHeaderFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.EntityExtractFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.FileAttributesFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.finance.FapiInteractionIdFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.ForwardedRequestFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.FragmentFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.HeaderFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.HttpBasicAuthFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.jwt.JwtValidationFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.jwt.ScriptableJwtValidatorCustomizer.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.JwtBuilderFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.LocationHeaderFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.ClientRegistration.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.Issuer.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.IssuerRepository.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.cnf.CertificateThumbprintFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.cnf.ConfirmationKeyVerifierAccessTokenResolver.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.ScriptableAccessTokenResolver.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.ScriptableResourceAccess.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.StatelessAccessTokenResolver.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.ScriptableFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.SetCookieUpdateFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.StaticRequestFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.SwitchFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.filter.UriPathRewriteFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.DesKeyGenHandler.Heaplet: Deprecated.
Heaplet() - Constructor for class org.forgerock.openig.handler.DispatchHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.JwkSetHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.resources.ResourceHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.router.RouterHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.saml.SamlFederationHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.ScriptableHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.SequenceHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.StaticResponseHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.handler.WelcomeHandler.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.CapturedUserPasswordFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.PolicyEnforcementFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.RequestResourceUriProvider.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.ScriptableResourceUriProvider.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.session.AmSessionIdleTimeoutFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.SessionInfoFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.SingleSignOnFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.openam.TokenTransformationFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.proxy.CustomProxyOptions.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.proxy.NoProxyOptions.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.proxy.SystemProxyOptions.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.secrets.Base64EncodedSecretStore.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.security.TrustAllManager.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.sql.SqlAttributesFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.uma.UmaResourceServerFilter.Heaplet
Heaplet() - Constructor for class org.forgerock.openig.uma.UmaSharingService.Heaplet
HeapletFactory - Interface in org.forgerock.openig.heap: Builds Heaplet instances.
Heaplets - Class in org.forgerock.openig.heap: Loads Heaplet classes based on the class of object they create.
heapObjectNameOrPointer() - Static method in class org.forgerock.openig.util.JsonValues: Returns a function that will look for the name of the object.
HeapResolver - Class in org.forgerock.openig.resolver: Resolves Heap objects.
HeapResolver() - Constructor for class org.forgerock.openig.resolver.HeapResolver
heartbeat(Duration, ScheduledExecutorService) - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Supply The heartbeat setup to keep the websocket session busy.
HEURISTIC_EXPIRATION - Static variable in class org.forgerock.http.header.WarningHeader: 113 Heuristic expiration MUST be included if the cache heuristically chose a freshness lifetime greater than 24 hours and the response's age is greater than 24 hours.
HEURISTIC_EXPIRATION - Static variable in class org.forgerock.json.resource.AdviceWarning: 113 Heuristic expiration MUST be included if the cache heuristically chose a freshness lifetime greater than 24 hours and the response's age is greater than 24 hours.
Hex - Class in org.forgerock.util.encode: Routines for encoding and decoding binary data in hexadecimal format.
HideKeyValueProcessor - Class in org.forgerock.openig.decoration.capture: For every key that starts with the keyToHide, return an empty value.
HIGHEST - org.forgerock.util.thread.listener.ShutdownPriority: HIGHEST is the priority pre-defined in the system.
HKDFKeyGenerator - Class in org.forgerock.util.crypto: Implements the HKDF key deriviation function to allow a single input key to be expanded into multiple component keys.
HKDFKeyGenerator.HKDFMasterKey - Class in org.forgerock.util.crypto: A secret key designed to be used as the master key for HKDF key generation.
HMAC - org.forgerock.json.jose.jws.JwsAlgorithmType: HMAC signing algorithm.
HMAC_ALGORITHM - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The HMAC algorithm to use.
HMAC_ALGORITHM - Static variable in class org.forgerock.util.crypto.HKDFKeyGenerator: The HMAC algorithm.
HmacSigningHandler - Class in org.forgerock.json.jose.jws.handlers: Deprecated.
Use SecretHmacSigningHandler instead
HmacSigningHandler(byte[]) - Constructor for class org.forgerock.json.jose.jws.handlers.HmacSigningHandler: Deprecated.

Constructs a new HmacSigningHandler.
HmacSigningHandler(SecretKey) - Constructor for class org.forgerock.json.jose.jws.handlers.HmacSigningHandler: Deprecated.

Constructs a new HmacSigningHandler.
Hop(String) - Constructor for class org.forgerock.http.header.ForwardedHeader.Hop: Construct a ForwardedHeader.Hop.
Hop(String, String, String, String) - Constructor for class org.forgerock.http.header.ForwardedHeader.Hop: Construct a ForwardedHeader.Hop.
HS256 - org.forgerock.json.jose.jws.JwsAlgorithm: HMAC using SHA-256 hash algorithm.
HS384 - org.forgerock.json.jose.jws.JwsAlgorithm: HMAC using SHA-384 hash algorithm.
HS512 - org.forgerock.json.jose.jws.JwsAlgorithm: HMAC using SHA-512 hash algorithm.
HsmKeyStoreLoader - Class in org.forgerock.secrets.keystore: A loader for the KeyStoreSecretStore that knows how to load standard PKCS#11 Hardware Security Module (HSM) providers on our supported platforms.
HsmKeyStoreLoader(String) - Constructor for class org.forgerock.secrets.keystore.HsmKeyStoreLoader: Initializes the HSM loader with a supported PKCS#11 provider for the current platform and the given PKCS#11 configuration file.
HsmKeyStoreLoader(Provider) - Constructor for class org.forgerock.secrets.keystore.HsmKeyStoreLoader: Initializes the HSM loader with the given PKCS#11 provider.
HsmSecretStoreHeaplet - Class in org.forgerock.openig.secrets: This heaplet represents an instance of a HsmSecretStoreHeaplet.
HsmSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.HsmSecretStoreHeaplet
HTTP - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The http event payload field name.
HTTP_VERSION_NOT_SUPPORTED - Static variable in class org.forgerock.http.protocol.Status: The 505 (HTTP Version Not Supported) status code indicates that the server does not support, or refuses to support, the major version of HTTP that was used in the request message.
HttpAccessAuditFilter - Class in org.forgerock.openig.filter: This filter aims to send some access audit events to the AuditService managed as a CREST handler.
HttpAccessAuditFilter(RequestHandler, Clock) - Constructor for class org.forgerock.openig.filter.HttpAccessAuditFilter: Constructs a new HttpAccessAuditFilter.
HttpApplication - Interface in org.forgerock.http: Configuration class to configure the HttpApplication instance.
HttpApplicationException - Exception in org.forgerock.http: An exception that is thrown during a Http Application start up when the start up of the application fails.
HttpApplicationException(String) - Constructor for exception org.forgerock.http.HttpApplicationException: Constructs a new exception with the specified detail message.
HttpApplicationException(String, Throwable) - Constructor for exception org.forgerock.http.HttpApplicationException: Constructs a new exception with the specified detail message and cause.
HttpApplicationException(Throwable) - Constructor for exception org.forgerock.http.HttpApplicationException: Constructs a new exception with the specified cause.
HttpBasicAuthenticationClientFilterHeaplet - Class in org.forgerock.openig.filter: Creates and initializes a Filter supporting the injection of a Basic Authorization header in the request for the configured credentials.
HttpBasicAuthenticationClientFilterHeaplet() - Constructor for class org.forgerock.openig.filter.HttpBasicAuthenticationClientFilterHeaplet
HttpBasicAuthFilter - Class in org.forgerock.openig.filter: Performs authentication through the HTTP Basic authentication scheme.
HttpBasicAuthFilter(Expression<String>, Expression<String>, Handler) - Constructor for class org.forgerock.openig.filter.HttpBasicAuthFilter: Builds a HttpBasicAuthFilter with required expressions and error handler.
HttpBasicAuthFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes an HTTP basic authentication filter in a heap environment.
HttpClient - Interface in org.forgerock.http.spi: An SPI interface for HTTP Client implementations.
HttpClientHandler - Class in org.forgerock.http.handler: An HTTP client for sending requests to remote servers.
HttpClientHandler() - Constructor for class org.forgerock.http.handler.HttpClientHandler: Creates a new HTTP client using default client options.
HttpClientHandler(Options) - Constructor for class org.forgerock.http.handler.HttpClientHandler: Creates a new HTTP client using the provided client options.
HttpClientHandler.HostnameVerifier - Enum in org.forgerock.http.handler: SSL host name verification policies.
HttpClientHandler.ProxyInfo - Class in org.forgerock.http.handler: Encapsulates the details of the proxy if one is required when making outgoing requests.
HttpClientHandlerHeaplet - Class in org.forgerock.openig.handler: Abstract Heaplet to create HTTP clients with different behaviors.
HttpClientHandlerHeaplet() - Constructor for class org.forgerock.openig.handler.HttpClientHandlerHeaplet
HttpClientProvider - Interface in org.forgerock.http.spi: A provider interface for obtaining HttpClient instances.
HttpContext - Class in org.forgerock.json.resource.http: A Context containing information relating to the originating HTTP request.
HttpContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.json.resource.http.HttpContext: Restore from JSON representation.
HttpContextFactory - Interface in org.forgerock.json.resource.http: A factory which is responsible for creating new request Contexts for each JSON request.
HttpFrameworkServlet - Class in org.forgerock.http.servlet: An HTTP servlet implementation which provides integration between the Servlet API and the common HTTP Framework.
HttpFrameworkServlet() - Constructor for class org.forgerock.http.servlet.HttpFrameworkServlet: Default constructor for use via web.xml declaration.
HttpFrameworkServlet(HttpApplication) - Constructor for class org.forgerock.http.servlet.HttpFrameworkServlet: Deprecated.
Replaced by HttpFrameworkServlet(HttpApplication, boolean, Clock), which explicitly sets the trustTransactionIdHeader field and the Clock to use.
HttpFrameworkServlet(HttpApplication, boolean) - Constructor for class org.forgerock.http.servlet.HttpFrameworkServlet: Deprecated.
Replaced by HttpFrameworkServlet(HttpApplication, boolean, Clock) which does not rely on the system Clock anymore.
HttpFrameworkServlet(HttpApplication, boolean, Clock) - Constructor for class org.forgerock.http.servlet.HttpFrameworkServlet: Creates a new HttpFrameworkServlet programmatically using the specified HttpApplication.
HttpFrameworkServletContextListener - Class in org.forgerock.http.servlet: A ServletContextListener that sets String keyed HttpApplication instances as attributes on the ServletContext.
HttpFrameworkServletContextListener() - Constructor for class org.forgerock.http.servlet.HttpFrameworkServletContextListener
httpFromContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets HTTP method, path, queryString and headers from HttpContext, if the provided Context contains a HttpContext.
httpOnly(boolean) - Method in class org.forgerock.openig.http.CookieBuilder: Set the httpOnly flag and return a new instance of this builder.
httpRequest(boolean, String, String, Map<String, List<String>>, Map<String, List<String>>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided HTTP request fields for the event.
httpRequest(boolean, String, String, Map<String, List<String>>, Map<String, List<String>>, Map<String, String>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided HTTP request fields for the event.
httpResponse(Map<String, List<String>>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided HTTP fields for the event.
HttpUtils - Class in org.forgerock.json.resource.http: HTTP utility methods and constants.
HttpWebSocketClient - Interface in org.forgerock.openig.tools.notifications.ws: HTTP WebSocket client interface.

I

iat(Date) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the time the JWT was issued at, in the Claims Set.
IAT - org.forgerock.json.jose.jwt.JwtClaimsSetKey: Issued At Claim.
IdentifierQueryResourceHandler - Class in org.forgerock.json.resource: QueryResourceHandler that searches for a specific identifier value.
IdentifierQueryResourceHandler(String) - Constructor for class org.forgerock.json.resource.IdentifierQueryResourceHandler: Creates a new QueryResourceHandler for the given identifier.
identity() - Static method in class org.forgerock.json.JsonValueFunctions: Returns an identity function that will copy the input JsonValue.
idFragment() - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
idFragment() - Method in class org.forgerock.services.routing.RouteMatcher: The fragment of an API ID that this matcher provides.
IdGenerator - Interface in org.forgerock.util.generator: Defines the contract to generate global unique identifiers.
IdGenerator.SequenceUuidIdGenerator - Class in org.forgerock.util.generator: Default implementation of the IdGenerator that will output some ids based on the following pattern : <uuid> + '-' + an incrementing sequence.
IdTokenValidationFilterHeaplet - Class in org.forgerock.openig.filter.oauth2.client: An IdTokenValidationFilterHeaplet creates a filter that can be used to validate the given idToken according to the provided configuration by leveraging the JwtValidationFilter.
IdTokenValidationFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.IdTokenValidationFilterHeaplet
ifBlank(String) - Static method in class org.forgerock.util.Reject: Alias for Reject.checkNotBlank(String) to be used in fluent Reject.ifBlank syntax.
ifBlank(String, String) - Static method in class org.forgerock.util.Reject: Alias for Reject.checkNotBlank(String, String) to be used in fluent Reject.ifBlank syntax.
ifFalse(boolean) - Static method in class org.forgerock.util.Reject: Deprecated.
Experience has shown that Reject.ifFalse can be hard to read. Prefer to use Reject.unless(boolean) (which works identically) or rewrite to use Reject.ifTrue(boolean) instead.
ifFalse(boolean, String) - Static method in class org.forgerock.util.Reject: Deprecated.
Experience has shown that Reject.ifFalse can be hard to read. Prefer to use Reject.unless(boolean, String) (which works identically) or rewrite to use Reject.ifTrue(boolean, String) instead.
ifNull(Object) - Static method in class org.forgerock.util.Reject: Alias for checkNotNull to be used in fluent Reject.ifNull syntax.
ifNull(Object, String) - Static method in class org.forgerock.util.Reject: Alias for checkNotNull to be used in fluent Reject.ifNull syntax.
ifNull(T...) - Static method in class org.forgerock.util.Reject: Throws a NullPointerException if any of the provided arguments are null.
ifTrue(boolean) - Static method in class org.forgerock.util.Reject: Throws an IllegalArgumentException if the condition parameter is true.
ifTrue(boolean, String) - Static method in class org.forgerock.util.Reject: Throws an IllegalArgumentException with a custom message if the condition parameter is true.
IgInstanceDirFinder - Class in org.forgerock.openig.config.env: This class is responsible for locating the IG instance directory.
IgTicker - Class in org.forgerock.openig.util: A time source; returns a time value representing the number of nanoseconds elapsed since some fixed but arbitrary point in time.
IgTicker() - Constructor for class org.forgerock.openig.util.IgTicker
immutable(List<T>, Supplier<List<T>>) - Static method in class org.forgerock.openig.tools.Utils: Returns an immutable List.
immutableMap(Map<K, V>, Supplier<Map<K, V>>) - Static method in class org.forgerock.openig.tools.Utils: Creates an immutable Map.
includeCauseInJsonValue() - Method in exception org.forgerock.json.resource.ResourceException: Returns this ResourceException with the includeCause flag set to true so that toJsonValue() method will include the cause if there is one supplied.
IncomparableRouteMatchException - Exception in org.forgerock.services.routing: An exception which is thrown when two incompatible RouteMatch instances are attempted to be compared.
IncomparableRouteMatchException(RouteMatch, RouteMatch) - Constructor for exception org.forgerock.services.routing.IncomparableRouteMatchException: Constructs a IncomparableRouteMatchException with the two RouteMatch instance that caused the exception.
increment(String, Number) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "increment" patch operation which will increment the value(s) of the specified field by the amount provided.
increment(JsonPointer, Number) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "increment" patch operation which will increment the value(s) of the specified field by the amount provided.
Indexed<T> - Interface in org.forgerock.util: Interface of an object that can be indexed with a unique key.
IndexMappingConfiguration() - Constructor for class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration
indexOf(Object) - Method in class org.forgerock.util.LazyList: Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
indexOf(Object) - Method in class org.forgerock.util.ListDecorator: Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
indexOf(String, String) - Static method in class org.forgerock.openig.el.Functions: Returns the index within a string of the first occurrence of a specified substring.
InetAddressMask - Class in org.forgerock.openig.util: Matches IPs (v4 or v6) with a CIDR pattern RFC4632.
INFORMATIONAL - org.forgerock.audit.handlers.syslog.Severity: Informational messages.
INFORMATIONAL - org.forgerock.http.protocol.Status.Family: The 1xx (Informational) class of status code indicates an interim response for communicating connection status or request progress prior to completing the requested action and sending a final response.
init() - Method in class org.forgerock.http.servlet.HttpFrameworkServlet
init(String) - Static method in class org.forgerock.openig.util.ProductInfo: Initialise the product info.
init(JsonValue, String...) - Method in class org.forgerock.openig.heap.HeapImpl: Initializes the heap using the given configuration.
injectIn(HeapImpl) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder: Deprecated.

Builds and configures a new DefaultSecretsService instance, and finally inject the reference in the given destination HeapImpl.
InsertSsoTokenHeaderFilter - Class in org.forgerock.openig.tools: This filter is responsible to check that an @InternalSsoTokenContext was defined in the context's chain and to propagate the SSO token (potentially not valid) into the request as a header.
InsertSsoTokenHeaderFilter(String) - Constructor for class org.forgerock.openig.tools.InsertSsoTokenHeaderFilter: Creates a filter which is responsible to check that an @InternalSsoTokenContext was defined in the context's chain and to propagate the SSO token (potentially not valid) into the request as a header.
INSTANCE - org.forgerock.secrets.keys.KeyFormatRaw: The singleton instance of this formatter.
INSTANCE - Static variable in class org.forgerock.openig.proxy.NoProxyOptions: The only instance of NoProxyOptions.
INSTANCE - Static variable in class org.forgerock.openig.proxy.SystemProxyOptions: The only instance of SystemProxyOptions.
INSTANCE_SYSTEM_PROPERTY - Static variable in class org.forgerock.openig.config.env.IgInstanceDirFinder: System property name that can be specified through command line.
instant() - Static method in class org.forgerock.json.JsonValueFunctions: Returns a Function to transform a JsonValue representing a UTC format datetime to an Instant.
instant() - Static method in class org.forgerock.openig.util.JsonValues: Returns a Function to transform a JsonValue representing a timestamp (in seconds) to an Instant.
IntDate - Class in org.forgerock.json.jose.utils: This class provides utility methods for converting Java Date objects into and from IntDates.
integer() - Static method in class org.forgerock.json.JsonValueFunctions: Returns an Integer by converting the JsonValue using JsonValue.asInteger(), or by parsing the JsonValue string using Integer.parseInt(String).
integer(String) - Static method in class org.forgerock.openig.el.Functions: Transforms a String to an Integer.
INTEGER_TAG - Static variable in class org.forgerock.json.jose.utils.DerUtils: DER tag for integer values.
integerWithRadix(String, int) - Static method in class org.forgerock.openig.el.Functions: Transforms a String to an Integer.
INTERFACE_TYPE_DEFINITION - Static variable in class org.forgerock.openig.openam.AmServiceTypeProvider: The name of the interface type used to reference this type.
INTERFACE_TYPE_DEFINITION - Static variable in class org.forgerock.openig.secrets.SecretsProviderTypeProvider: The name of the interface type used to reference this type.
INTERFACE_TYPE_DEFINITION - Static variable in class org.forgerock.openig.security.ClientTlsOptionsTypeProvider: The name of the interface type used to reference this type.
INTERNAL_ERROR - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that a resource encountered an unexpected condition which prevented it from fulfilling the request.
INTERNAL_SERVER_ERROR - Static variable in class org.forgerock.http.protocol.Status: The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
INTERNAL_SERVER_ERROR - Static variable in class org.forgerock.openig.handler.Handlers: A default Handler implementation that returns an empty (500 Internal Server Error) Response.
internalServerError() - Static method in class org.forgerock.http.protocol.Responses: Utility method returning an async function that creates a Response with status Status.INTERNAL_SERVER_ERROR and the exception set as the cause.
InternalServerErrorException - Exception in org.forgerock.json.resource: An exception that is thrown during an operation on a resource when the server encountered an unexpected condition which prevented it from fulfilling the request.
InternalServerErrorException() - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with null as its detail message.
InternalServerErrorException(String) - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with the specified detail message.
InternalServerErrorException(String, Throwable) - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with the specified detail message and cause.
InternalServerErrorException(Throwable) - Constructor for exception org.forgerock.json.resource.InternalServerErrorException: Constructs a new exception with the specified cause.
internalServerErrorHandler(Exception) - Static method in class org.forgerock.http.handler.Handlers: A common HTTP Framework Handler responding 500 Internal Server Error.
InternalSsoTokenContext - Class in org.forgerock.openig.tools: An InternalSsoTokenContext used to store an SSO token.
InternalSsoTokenContext(Context, String) - Constructor for class org.forgerock.openig.tools.InternalSsoTokenContext: Creates a new InternalSsoTokenContext context with the provided token.
invalidate() - Method in class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier: Flag the current token as being invalid to force a refresh on next get().
invalidateEagerly(AsyncCache<K, V>, Promise<V, E>, K) - Static method in class org.forgerock.openig.tools.CaffeineUtils: Preemptively invalidates the cache entry on failure.
InvalidCallerTokenDetectionFilter - Class in org.forgerock.openig.tools: An InvalidCallerTokenDetectionFilter provides a mechanism that allows IG to detect an incorrect response and trigger a token refresh before making the request again with the updated token.
InvalidJwtException - Exception in org.forgerock.json.jose.exceptions: Represents an exception that occurs when a JWT is determined as invalid.
InvalidJwtException(String) - Constructor for exception org.forgerock.json.jose.exceptions.InvalidJwtException: Constructs a new JwtReconstructionException with the provided exception message.
InvalidJwtException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.InvalidJwtException: Constructs a new JwtReconstructionException with the provided exception message and underlying throwable.
InvalidJwtException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.InvalidJwtException: Constructs a new JwtReconstructionException with the provided underlying throwable.
InvalidTokenException - Exception in org.forgerock.tokenhandler: An exception generated by a TokenHandler on validation or extraction when the token is invalid.
InvalidTokenException(String) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException: Constructs a new exception with the specified detail message.
InvalidTokenException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException: Constructs a new exception with the specified detail message and cause.
InvalidTokenException(Throwable) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException: Constructs a new exception with the specified cause.
invokeAll(Collection<? extends Callable<T>>) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
invokeAny(Collection<? extends Callable<T>>) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
IO - Class in org.forgerock.http.io: Utility class that can stream to and from streams.
IP - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The IP event payload field name.
ipMatch(String, String) - Static method in class org.forgerock.openig.el.Functions: Matches an IP (either v4 or v6) with a IP range using the Classless inter-domain routing (CIDR) formalism.
is(String) - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns true if this error includes an error code and it matches the provided error code.
is(Predicate<Version>) - Method in class org.forgerock.openig.tools.am.Version: Returns true if this version satisfy the given predicate.
isAdd() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "add" patch operation.
isAlpnEnabled() - Method in class org.forgerock.openig.tools.TlsOptions: Is ALPN (Application Layer Protocol Negotiation, a TLS extension) enabled or not ?
isAscendingOrder() - Method in class org.forgerock.json.resource.SortKey: Returns true if this sort key is in ascending order, or false if it is in descending order.
isAsyncStarted() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
isAsyncSupported() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
isAuditing(String) - Method in interface org.forgerock.audit.AuditService: Returns whether or not events of the specified topic will be handled.
isAuditing(String) - Method in class org.forgerock.audit.AuditServiceProxy
isAuditing(String) - Method in class org.forgerock.openig.audit.NoOpAuditService
isAuthenticated() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Indicates whether the encryption algorithm ensures authenticity of data origin as well as confidentiality and integrity.
isAuthenticated() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithmType: Indicates whether the algorithm type provides assurance of the originator of an encrypted JWT (sender authentication).
isAutoFlush() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.EventBufferingConfiguration: Indicates if events are automatically flushed after being written.
isAutoFlush() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Indicates if events are automatically flushed after being written.
isBetterMatchThan(RouteMatch) - Method in interface org.forgerock.services.routing.RouteMatch: Determines whether this route match is better than the given rout match.
isBlank(CharSequence) - Static method in class org.forgerock.util.Strings: Check to see if a character sequence is null or blank.
isBlank(CharSequence) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Strings.isBlank(CharSequence)
isBoolean() - Method in class org.forgerock.json.JsonValue: Returns true if the JSON value is a Boolean.
isCacheable() - Method in class org.forgerock.json.resource.ResponseCacheControl: Indicates whether the response should ever be cached.
isCancelled() - Method in interface org.forgerock.util.promise.Promise: Returns true if this Promise was cancelled before it completed normally.
isCancelled() - Method in class org.forgerock.util.promise.PromiseImpl
isClientError() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.CLIENT_ERROR one ?
isClosed() - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Indicates whether or not this connection has been explicitly closed by calling close.
isClosed() - Method in interface org.forgerock.json.resource.Connection: Indicates whether or not this connection has been explicitly closed by calling close.
isClosed() - Method in class org.forgerock.secrets.GenericSecret
isClosed() - Method in class org.forgerock.secrets.keys.CryptoKey
isClosed() - Method in class org.forgerock.secrets.Secret: Indicates whether this secret has been closed by calling the Secret.close() method.
isCollection() - Method in class org.forgerock.json.JsonValue: Returns true if the JSON value is a Collection.
isCommitted() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
isCompatible(Object, Object) - Static method in class org.forgerock.util.Objects: Returns whether the two objects are type-compatible.
isCompatible(Object, Object) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Objects.isCompatible(Object, Object)
isCompatibleWith(Version) - Method in class org.forgerock.http.routing.Version: Returns false if: the MAJOR version numbers are not the same.
isCopy() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is a "copy" patch operation.
isCountOnly() - Method in interface org.forgerock.json.resource.QueryRequest: Return if the request should only return resource count.
isDecodedContentEmpty() - Method in class org.forgerock.http.protocol.Entity: Returns true if this entity's decoded content is empty.
isDefined(String) - Method in class org.forgerock.json.jose.jwt.JWObject: Returns true if this JWObject contains the specified item.
isDefined(String) - Method in class org.forgerock.json.JsonValue: Returns true if this JSON value contains the specified item.
isDestroyed() - Method in class org.forgerock.secrets.GenericSecret
isDone() - Method in interface org.forgerock.util.promise.Promise: Returns true if this Promise has completed.
isDone() - Method in class org.forgerock.util.promise.PromiseImpl
isElasticsearchCompatible() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration: Determines if JSON format should be transformed to be compatible with ElasticSearch format restrictions.
isEmpty() - Method in class org.forgerock.http.protocol.Headers
isEmpty() - Method in class org.forgerock.http.protocol.RequestCookies
isEmpty() - Method in class org.forgerock.http.util.SetDecorator
isEmpty() - Method in class org.forgerock.json.JsonPointer: Returns true if this pointer identifies the root value of a JSON structure.
isEmpty() - Method in class org.forgerock.json.resource.ResourcePath: Returns true if this resource path contains no path elements.
isEmpty() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
isEmpty() - Method in class org.forgerock.util.LazyList: Returns true if this list contains no elements.
isEmpty() - Method in class org.forgerock.util.LazyMap: Returns true if the map contains no key-value mappings.
isEmpty() - Method in class org.forgerock.util.ListDecorator: Returns true if this list contains no elements.
isEmpty() - Method in class org.forgerock.util.MapDecorator: Returns true if the map contains no key-value mappings.
isEmpty() - Method in class org.forgerock.util.PerItemEvictionStrategyCache: Returns whether this cache is empty or not.
isEmpty() - Method in class org.forgerock.util.RangeSet: Returns true if this set contains no elements.
isEnabled() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Checks if the audit event handler is enabled.
isEnabled() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
isEnabled() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Checks if the audit event handler is enabled.
isEnabled() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Gets tamper evident logging enabled status.
isEnabled() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.EventBufferingConfiguration: Indicates if event buffering is enabled.
isEnabled() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Indicates if event buffering is enabled.
isEnabled() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Indicates if event buffering is enabled.
isEnabled() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration: Indicates if event buffering is enabled.
isEqual(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch: Compares two JSON values, and returns whether the two objects are identical.
isEqualTo(JsonValue) - Method in class org.forgerock.json.JsonValue: Performs a deep comparison of this JSON value with another JSON value, and returns whether the two objects are identical.
isEqualTo(T) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns empty if the value is equal to the one expected and fulfill the Violation with the custom error message.
isError() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck: Returns true if this acknowledgment message is a failure, false otherwise.
isExpired(Clock) - Method in class org.forgerock.secrets.Secret: Indicates whether the secret has expired according to the given clock.
isExternal() - Method in class org.forgerock.services.context.ClientContext: Returns true if this client is external.
isExtractable() - Method in class org.forgerock.secrets.keys.CryptoKey: Indicates whether the raw key material can be extracted for this key.
isFailure() - Method in class org.forgerock.openig.filter.oauth2.cnf.Result: Returns true if this Result is a failure, false otherwise.
isFailure() - Method in class org.forgerock.openig.tools.jwt.validation.Result: Returns true if this Result is a failure, false otherwise.
isGreaterOrEqualTo(Function<ValidatorConstraintContext, T>) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns a JwtClaimConstraint that will succeed if the value is greater than or equal to the given value, otherwise it will fail.
isGreaterOrEqualTo(T) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: A shorter version of isGreaterOrEqualTo(constant(limit)).
isGreaterThan(Function<ValidatorConstraintContext, T>) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns a JwtClaimConstraint that will succeed if the value is greater than the given value, otherwise it will fail.
isGreaterThan(T) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: A shorter version of isGreaterThan(constant(limit)).
isHttpOnly() - Method in class org.forgerock.http.protocol.Cookie: Returns true if the user agent should make the cookie inaccessible to client side script.
isImpendingIgRedirectNotified() - Method in class org.forgerock.openig.filter.AuthRedirectContext: Returns whether an impending IG redirect has been performed or not.
isIncrement() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "increment" patch operation.
isInformational() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.INFORMATIONAL one ?
isInTheFuture() - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns a JwtClaimConstraint that will succeed if the timestamp is after the given date, otherwise it will fail.
isInThePast() - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns a JwtClaimConstraint that will succeed if the timestamp is before the given date, otherwise it will fail.
isLessOrEqualTo(Function<ValidatorConstraintContext, T>) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns a JwtClaimConstraint that will succeed if the value is less than or equal to the given value, otherwise it will fail.
isLessOrEqualTo(T) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: A shorter version of isLessOrEqualTo(constant(limit)).
isLessThan(Function<ValidatorConstraintContext, T>) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns a JwtClaimConstraint that will succeed if the value is less than the given value, otherwise it will fail.
isLessThan(T) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: A shorter version of isLessThan(constant(limit)).
isList() - Method in class org.forgerock.json.JsonValue: Returns true if the JSON value is a List.
isMap() - Method in class org.forgerock.json.JsonValue: Returns true if the JSON value is a Map.
isMove() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is a "move" patch operation.
isNotNull() - Method in class org.forgerock.json.JsonValue: Returns true if the value is not null.
isNotNull() - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Returns empty if the value is present.
isNull() - Method in class org.forgerock.json.JsonValue: Returns true if the value is null.
isNullOrEmpty(String) - Static method in class org.forgerock.util.Strings: Check to see if the provided String is null or empty.
isNullOrEmpty(String) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Strings.isNullOrEmpty(String)
isNumber() - Method in class org.forgerock.json.JsonValue: Returns true if the JSON value is a Number.
ISO_OFFSET_DATE_TIME_FORMAT - Static variable in class org.forgerock.audit.events.AuditEventBuilder: ISO 8601 date-time formatter '2011-12-03T10:15:30.000Z' specifically for UTC/GMT time zone.
isOpen() - Method in interface org.forgerock.openig.tools.notifications.ws.HttpWebSocketClient: Returns true if this client is open, otherwise false.
isPrefixOf(JsonPointer) - Method in class org.forgerock.json.JsonPointer: Checks whether candidate is an extension of this JSON Pointer.
isPrivate() - Method in class org.forgerock.json.jose.jwk.EcJWK
isPrivate() - Method in class org.forgerock.json.jose.jwk.JWK: Indicates if any private key attributes are present in the JWK.
isPrivate() - Method in class org.forgerock.json.jose.jwk.OctJWK
isPrivate() - Method in class org.forgerock.json.jose.jwk.OkpJWK
isPrivate() - Method in class org.forgerock.json.jose.jwk.RsaJWK
isPropertyRequired(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets whether a AuditEvent property is required.
isPublicKeyValid() - Method in class org.forgerock.json.jose.jwk.EcJWK: Checks for validity of the public key portion of this JWK as per EcJWK.isPublicKeyValid(ECPublicKey, SupportedEllipticCurve).
isPublicKeyValid() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk: Determines whether the public key is a valid point on the underlying elliptic curve.
isPublicKeyValid() - Method in class org.forgerock.json.jose.jwk.OkpJWK: Determines whether the public key is valid.
isPublicKeyValid(ECPublicKey, SupportedEllipticCurve) - Static method in class org.forgerock.json.jose.jwk.EcJWK: Checks whether the public key actually lies on the curve it claims to be on.
isQuoted() - Method in class org.forgerock.http.header.Directive: Return true if the original directive value was enclosed in quotes.
isRawContentEmpty() - Method in class org.forgerock.http.protocol.Entity: Returns true if this entity's raw content is empty.
isRedirection() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.REDIRECTION one ?
isRemove() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "remove" patch operation.
isReplace() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is an "replace" patch operation.
isRequestedSessionIdFromCookie() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
isRequestedSessionIdFromUrl() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter: Deprecated.
As of Version 2.1 of the Java Servlet API, use ChfHttpServletRequestAdapter.isRequestedSessionIdFromURL() instead.
isRequestedSessionIdFromURL() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
isRequestedSessionIdValid() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
isResult() - Method in interface org.forgerock.util.promise.Promise: Returns true if this Promise has completed and contains a value.
isResult() - Method in class org.forgerock.util.promise.PromiseImpl
isReverseDnsLookupEnabled() - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Whether the client.host should be looked up from client.ip.
isRootContext() - Method in class org.forgerock.services.context.AbstractContext
isRootContext() - Method in interface org.forgerock.services.context.Context: Returns true if this context is a root context.
isRotationEnabled() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets log rotation enabled state.
isRunning() - Method in interface org.forgerock.audit.AuditService: Returns true if this object is running.
isRunning() - Method in class org.forgerock.audit.AuditServiceProxy
isRunning() - Method in class org.forgerock.openig.audit.NoOpAuditService
iss(String) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the issuer this JWT was issued by.
iss(URI) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the issuer this JWT was issued by.
ISS - org.forgerock.json.jose.jwt.JwtClaimsSetKey: Issuer Claim.
isSatisfiedBy(T) - Method in class org.forgerock.secrets.Purpose: Determines whether all of the constraints for this purpose are satisfied by the given secret.
isSatisfiedBy(T) - Method in interface org.forgerock.secrets.SecretConstraint: Determines whether this constraint is satisfied by the given secret.
isSecure() - Method in class org.forgerock.http.protocol.Cookie: Returns true if the user agent should use only secure means to send back this cookie.
isSecure() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
isSecure() - Method in class org.forgerock.services.context.ClientContext: Returns true if this client connection is secure.
isSecure(String) - Static method in class org.forgerock.openig.websocket.UriUtils: Returns true if the given URI scheme is for a secure (TLS) connection.
isServerError() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.SERVER_ERROR one ?
isServerError() - Method in exception org.forgerock.json.resource.ResourceException: Returns true if the HTTP error code is in the 500 range.
isShutdown() - Method in interface org.forgerock.util.thread.listener.ShutdownManager: Find out whether the shutdown has been triggered.
isShutdown() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
isString() - Method in class org.forgerock.json.JsonValue: Returns true if the JSON value is a String.
isSuccess() - Method in class org.forgerock.openig.filter.oauth2.cnf.Result: Returns true if this Result is a success, false otherwise.
isSuccess() - Method in class org.forgerock.openig.tools.jwt.validation.Result: Returns true if this Result is a success, false otherwise.
isSuccess() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck: Returns true if this acknowledgment message is a success, false otherwise.
isSuccessful() - Method in class org.forgerock.http.protocol.Status: Is the family of this status a Status.Family.SUCCESSFUL one ?
Issuer - Class in org.forgerock.openig.filter.oauth2.client: A configuration for an OpenID Connect Issuer.
Issuer(String, JsonValue) - Constructor for class org.forgerock.openig.filter.oauth2.client.Issuer: Creates an issuer with the specified name and configuration.
ISSUER_KEY - Static variable in class org.forgerock.openig.filter.oauth2.client.Issuer: The key used to store this issuer in the context.
Issuer.Heaplet - Class in org.forgerock.openig.filter.oauth2.client: Creates and initializes an Issuer object in a heap environment.
IssuerRepository - Class in org.forgerock.openig.filter.oauth2.client: A repository to store and create all the OAuth2 issuers.
IssuerRepository(Handler) - Constructor for class org.forgerock.openig.filter.oauth2.client.IssuerRepository: Creates an IssuerRepository.
IssuerRepository.Heaplet - Class in org.forgerock.openig.filter.oauth2.client: Creates and initializes an IssuerRepository in a heap environment.
isSymmetric() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Indicates whether the algorithm uses the same key for both encryption and decryption operations (symmetric encryption).
isSymmetric() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithmType: Indicates whether the algorithm type uses the same key for both encryption and decryption operations (symmetric encryption).
isSymmetric() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Indicates whether the algorithm is a symmetric (secret key) algorithm like HMAC or a public key algorithm.
isSymmetric() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithmType: Indicates whether the algorithm type is a symmetric (secret key) algorithm like HMAC or a public key algorithm.
isSymmetric() - Method in interface org.forgerock.json.jose.jwt.Algorithm: Indicates whether the algorithm uses the same key for all operations.
isTerminated() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
isTransform() - Method in class org.forgerock.json.resource.PatchOperation: Returns true if this is a "transform" patch operation.
isUnlimited() - Method in class org.forgerock.util.time.Duration: Returns true if this Duration represents an unlimited (or indefinite) duration.
isUsableForQueries() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: States if an AuditEventHandler can be used for queries.
isUsableForQueries() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
isUsableForQueries() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration
isUsableForQueries() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration
isUsableForQueries() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
isUsableForQueries() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration
isUsableForQueries() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration
isUsableForQueries() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration
isUserInRole(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
isUseSSL() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Indicates if the connection uses SSL.
isUseSSL() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration: Indicates if the connection uses SSL.
isValid() - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Returns true if this connection has not been closed and no fatal errors have been detected.
isValid() - Method in interface org.forgerock.json.resource.Connection: Returns true if this connection has not been closed and no fatal errors have been detected.
isValid() - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidatorResult: Returns true if the JWT is valid, false otherwise.
isValueOfType(Object, Class<?>) - Method in class org.forgerock.json.jose.jwt.JWObject: Checks to see if the given value is of an assignable type from the required class.
isWarningEnabled() - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Gets whether a warning should be issued to the calling client if the request does not contain a resource API version.
isWarningEnabled() - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Returns true if warning headers should be set on the response if no Accept-API-Version header is present on the request.
isWebSocketHandshake(Request) - Static method in class org.forgerock.openig.websocket.WebSocketUtils: Returns true if this request represents a WebSocket handshake.
isXDHCurve() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Determines whether this curve is intended for use with X-Diffie-Hellman (XDH) key agreement (X25519 or X448).
isXecKey(Key) - Static method in class org.forgerock.json.jose.utils.XECUtils: Determines whether the given key is a XECKey.
isZero() - Method in class org.forgerock.util.time.Duration: Returns true if this Duration represents a zero-length duration.
iterator() - Method in class org.forgerock.http.util.SetDecorator
iterator() - Method in class org.forgerock.json.JsonPointer: Returns an iterator over the pointer's reference tokens.
iterator() - Method in class org.forgerock.json.JsonValue: Returns an iterator over the child values that this JSON value contains.
iterator() - Method in class org.forgerock.json.resource.ResourcePath: Returns an iterator over the path elements in this resource path.
iterator() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
iterator() - Method in class org.forgerock.openig.session.jwt.dirty.DirtySet
iterator() - Method in class org.forgerock.util.LazyList: Returns an iterator over the elements in this list in proper sequence.
iterator() - Method in class org.forgerock.util.ListDecorator: Returns an iterator over the elements in this list in proper sequence.
iterator() - Method in class org.forgerock.util.RangeSet: Returns an iterator over the elements in this set.

J

javaDuration() - Static method in class org.forgerock.openig.util.JsonValues: Returns a Duration object from a JsonValue.
JcaKeyStoreHandler - Class in org.forgerock.audit.secure: Default implementation of a Keystore handler.
JcaKeyStoreHandler(String, String, String) - Constructor for class org.forgerock.audit.secure.JcaKeyStoreHandler: Creates a new keystore handler.
JCEKS_KEYSTORE_TYPE - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The name of the Java Cryptography Extension KeyStore (JCEKS) type.
JdbcAuditEventHandler - Class in org.forgerock.audit.handlers.jdbc: Implements a AuditEventHandler to write AuditEvents to a JDBC repository.
JdbcAuditEventHandler(JdbcAuditEventHandlerConfiguration, EventTopicsMetaData, DataSource) - Constructor for class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: Create a new JdbcAuditEventHandler instance.
JdbcAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.jdbc: Configures the JDBC mapping and connection pool.
JdbcAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration
JdbcAuditEventHandlerConfiguration.ConnectionPool - Class in org.forgerock.audit.handlers.jdbc: Configuration for a connection pool.
JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration - Class in org.forgerock.audit.handlers.jdbc: Configuration of event buffering.
JdbcDataSourceHeaplet - Class in org.forgerock.openig.sql: Creates and initializes a JDBC data source in a heap environment.
JdbcDataSourceHeaplet() - Constructor for class org.forgerock.openig.sql.JdbcDataSourceHeaplet
jku(URL) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Sets the JWK Set URL header parameter for this JWS.
JKU - org.forgerock.json.jose.jws.JwsHeaderKey: JWK Set URL header parameter.
JmsAuditEventHandler - Class in org.forgerock.audit.handlers.jms: Publishes Audit events on a JMS Topic.
JmsAuditEventHandler(JmsContextManager, BatchPublisherFactory, JmsAuditEventHandlerConfiguration, EventTopicsMetaData) - Constructor for class org.forgerock.audit.handlers.jms.JmsAuditEventHandler: Creates a new AuditEventHandler instance that publishes JMS messages on a JMS Topic for each Audit event.
JmsAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.jms: Configuration object for the JmsAuditEventHandler.
JmsAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
JmsAuditEventHandlerConfiguration.BatchConfiguration - Class in org.forgerock.audit.handlers.jms: This class holds the configuration properties that are used by the {#link BatchPublisher} to control the batch queue and worker threads that process the items in the queue.
JmsAuditEventHandlerConfiguration.JndiConfiguration - Class in org.forgerock.audit.handlers.jms: Stores the JNDI context properties and lookup names.
JmsContextManager - Interface in org.forgerock.audit.handlers.jms: Interface for retrieving a JMS topic and a JMS connection factory.
JndiConfiguration() - Constructor for class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
join(Object, String) - Static method in class org.forgerock.openig.el.Functions: Joins an array or Iterable values into a single string value, using the toString() result from each value and separated by the specified separator.
join(String, Iterable<?>) - Static method in class org.forgerock.openig.util.StringUtil: Joins a collection of elements into a single string value, with a specified separator.
join(String, Object...) - Static method in class org.forgerock.openig.util.StringUtil: Joins an array of strings into a single string value, with a specified separator.
join(Collection<String>, char) - Static method in class org.forgerock.http.header.HeaderUtil: Joins a collection of header values into a single header value, with a specified specified separator.
join(List<Promise<?, ? extends Exception>>) - Static method in class org.forgerock.util.promise.Promises: Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
join(Promise<?, ? extends Exception>...) - Static method in class org.forgerock.util.promise.Promises: Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
joinAsString(StringBuilder, String, Iterable<?>) - Static method in class org.forgerock.util.Strings: Appends into the provided StringBuilder the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
joinAsString(StringBuilder, String, Iterable<?>) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Strings.joinAsString(StringBuilder, String, Iterable)
joinAsString(StringBuilder, String, Object...) - Static method in class org.forgerock.util.Strings: Appends into the provided StringBuilder the string representation of the provided objects concatenated together using the provided separator.
joinAsString(StringBuilder, String, Object...) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Strings.joinAsString(StringBuilder, String, Object...)
joinAsString(String, Iterable<?>) - Static method in class org.forgerock.util.Strings: Returns a string whose content is the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
joinAsString(String, Iterable<?>) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Strings.joinAsString(String, Iterable)
joinAsString(String, Object...) - Static method in class org.forgerock.util.Strings: Returns a string whose content is the string representation of the provided objects concatenated together using the provided separator.
joinAsString(String, Object...) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Strings.joinAsString(String, Object...)
joinPath(List<String>) - Static method in class org.forgerock.http.util.Paths: Joins a list of URL-decoded path elements into a url-encoded path.
JoseSecretConstraints - Class in org.forgerock.json.jose.utils: Set of SecretConstraints for filtering Secrets.
json() - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /json namespace.
json() - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /json namespace.
json(Object) - Static method in class org.forgerock.json.JsonValue: Returns a JSON value whose content is the provided object.
json(String) - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /json namespace.
json(String) - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /json namespace.
Json - Class in org.forgerock.http.util: Provides read and write JSON capabilities.
JSON_KEY_ALG - Static variable in class org.forgerock.json.jose.jwk.JWK: The Algorithm key.
JSON_KEY_KID - Static variable in class org.forgerock.json.jose.jwk.JWK: The KeyID key.
JSON_KEY_KTY - Static variable in class org.forgerock.json.jose.jwk.JWK: The KeyType key.
JSON_KEY_OPERATIONS - Static variable in class org.forgerock.json.jose.jwk.JWK: The KeyOperations key.
JSON_KEY_USE - Static variable in class org.forgerock.json.jose.jwk.JWK: The KeyUse key.
JSON_KEY_X5C - Static variable in class org.forgerock.json.jose.jwk.JWK: The X509 chain key.
JSON_KEY_X5T - Static variable in class org.forgerock.json.jose.jwk.JWK: The X509 thumbprint.
JSON_KEY_X5T_S256 - Static variable in class org.forgerock.json.jose.jwk.JWK: The X509 SHA-256 thumbprint.
JSON_KEY_X5U - Static variable in class org.forgerock.json.jose.jwk.JWK: The X509 URL key.
Json.JsonValueModule - Class in org.forgerock.http.util: Jackson Module that uses a mixin to make sure that a JsonValue instance is serialized using its #getObject() value only.
Json.LocalizableStringModule - Class in org.forgerock.http.util: Jackson Module that adds a serializer for LocalizableString.
JsonAuditEventHandler - Class in org.forgerock.audit.handlers.json: AuditEventHandler for persisting raw JSON events to a file.
JsonAuditEventHandler(JsonAuditEventHandlerConfiguration, EventTopicsMetaData) - Constructor for class org.forgerock.audit.handlers.json.JsonAuditEventHandler: Creates a JsonAuditEventHandler instances.
JsonAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.json: Configuration for JsonAuditEventHandler.
JsonAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration
JsonAuditEventHandlerConfiguration.EventBufferingConfiguration - Class in org.forgerock.audit.handlers.json: Configuration of event buffering.
JsonException - Exception in org.forgerock.json: An exception that is thrown during JSON operations.
JsonException() - Constructor for exception org.forgerock.json.JsonException: Constructs a new exception with null as its detail message.
JsonException(String) - Constructor for exception org.forgerock.json.JsonException: Constructs a new exception with the specified detail message.
JsonException(String, Throwable) - Constructor for exception org.forgerock.json.JsonException: Constructs a new exception with the specified detail message and cause.
JsonException(Throwable) - Constructor for exception org.forgerock.json.JsonException: Constructs a new exception with the specified cause.
JsonPatch - Class in org.forgerock.json: Processes partial modifications to JSON values.
JsonPatchValueTransformer - Interface in org.forgerock.json: RFC6902 expects the patch value to be a predetermined, static value to be used in the patch operation's execution.
JsonPointer - Class in org.forgerock.json: Identifies a specific value within a JSON structure.
JsonPointer() - Constructor for class org.forgerock.json.JsonPointer: Deprecated.
Use JsonPointer.rootPtr() instead.
JsonPointer(Iterable<String>) - Constructor for class org.forgerock.json.JsonPointer: Constructs a JSON pointer from an iterable collection of reference tokens.
JsonPointer(String) - Constructor for class org.forgerock.json.JsonPointer: Constructs a JSON pointer, identifying the specified pointer value.
JsonPointer(String...) - Constructor for class org.forgerock.json.JsonPointer: Constructs a JSON pointer from an array of reference tokens.
jsonPointerToDotNotation(String) - Static method in class org.forgerock.audit.events.AuditEventHelper: Converts JsonPointer field identifier to dotted-path form.
JsonSchemaUtils - Class in org.forgerock.audit.util: Contains Utility methods for dealing with JsonSchema data.
jsonUri() - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /json namespace.
jsonUri() - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /json namespace.
jsonUri(String) - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /json namespace.
jsonUri(String) - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /json namespace.
jsonValue - Variable in class org.forgerock.audit.events.AuditEventBuilder: Represents the event as a JSON value.
JsonValue - Class in org.forgerock.json: Represents a value in a JSON object model structure.
JsonValue(Object) - Constructor for class org.forgerock.json.JsonValue: Constructs a JSON value object with a given object.
JsonValue(Object, JsonPointer) - Constructor for class org.forgerock.json.JsonValue: Constructs a JSON value object with a given object and pointer.
JsonValueException - Exception in org.forgerock.json: An exception that is thrown during JSON value operations.
JsonValueException(JsonValue) - Constructor for exception org.forgerock.json.JsonValueException: Constructs a new exception with the specified JSON value and null as its detail message.
JsonValueException(JsonValue, String) - Constructor for exception org.forgerock.json.JsonValueException: Constructs a new exception with the specified JSON value and detail message.
JsonValueException(JsonValue, String, Throwable) - Constructor for exception org.forgerock.json.JsonValueException: Constructs a new exception with the specified JSON value, detail message and cause.
JsonValueException(JsonValue, Throwable) - Constructor for exception org.forgerock.json.JsonValueException: Constructs a new exception with the specified JSON value and cause.
jsonValueFilterVisitor() - Static method in class org.forgerock.util.query.JsonValueFilterVisitor: Returns a QueryFilterVisitor that can assess if a JsonValue resource matches a set of criteria defined by a QueryFilter.
JsonValueFilterVisitor - Class in org.forgerock.util.query: A QueryFilterVisitor that returns true if the provide JsonValue meets the criteria of the QueryFilter assertions and false if it does not.
JsonValueFunctions - Class in org.forgerock.json: This class contains the utility functions to convert a JsonValue to another type.
JsonValueFunctions - Class in org.forgerock.json.resource: This class contains the utility functions to convert a JsonValue to CREST (json-resource) types.
JsonValueModule() - Constructor for class org.forgerock.http.util.Json.JsonValueModule
JsonValues - Class in org.forgerock.openig.util: Provides additional functionality to JsonValue.
JsonValueTraverseFunction - Class in org.forgerock.json: An implementation of Function that recursively traverses the JsonValue and applies some transformation if needed.
JsonValueTraverseFunction(Function<JsonValue, ?, JsonValueException>) - Constructor for class org.forgerock.json.JsonValueTraverseFunction: Construct the traversal function with a transformation function to apply to each array element nested object attribute value element, or primitive element.
JsonValueUtils - Class in org.forgerock.audit.util: Contains some JsonValue Utility methods.
jti(String) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the unique ID of the JWT.
JTI - org.forgerock.json.jose.jwt.JwtClaimsSetKey: JWT ID Claim.
jwe(Key) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory: Deprecated.
Prefer JwtBuilderFactory.jwe(EncryptionKey) instead.
jwe(EncryptionKey<?>) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory: Creates a builder for building an encrypted JWT using the given encryption key.
JWE - org.forgerock.json.jose.jwt.JwtType: Used when encrypting a nested JWT.
jweAlgorithm(JweAlgorithm) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder: Specifies the JWE key management algorithm to use when encrypting tokens produced by this token handler.
JweAlgorithm - Enum in org.forgerock.json.jose.jwe: An Enum of the possible encryption algorithms that can be used to encrypt a JWT.
JweAlgorithmType - Enum in org.forgerock.json.jose.jwe: An Enum of the possible types of JWE algorithms that can be used to encrypt a JWT.
JweCompressionException - Exception in org.forgerock.json.jose.exceptions: Represents an exception for when compression/decompression of the plaintext fails.
JweCompressionException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JweCompressionException: Constructs a new JweCompressionException with the provided exception message.
JweCompressionException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweCompressionException: Constructs a new JweCompressionException with the provided exception message and underlying throwable.
JweCompressionException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweCompressionException: Constructs a new JweCompressionException with the provided underlying throwable.
JweDecryptionCheckedException - Exception in org.forgerock.json.jose.exceptions: This exception entirely duplicates JweDecryptionException except that it is a checked exception so that it can be used with a Promise.
JweDecryptionCheckedException() - Constructor for exception org.forgerock.json.jose.exceptions.JweDecryptionCheckedException: Constructs the exception with a basic message indicating that decryption failed.
JweDecryptionConstraint - Class in org.forgerock.openig.tools.jwt.validation: Class supporting EncryptedJwt encryption verification with a verification Purpose and a SecretsProvider responsible for getting the decryption key.
JweDecryptionConstraint(SecretsProvider, Purpose<DataDecryptionKey>) - Constructor for class org.forgerock.openig.tools.jwt.validation.JweDecryptionConstraint: Construct a JweDecryptionConstraint.
JweDecryptionException - Exception in org.forgerock.json.jose.exceptions: Represents an exception for when decryption of the JWE fails.
JweDecryptionException() - Constructor for exception org.forgerock.json.jose.exceptions.JweDecryptionException: Constructs a new JweDecryptionException.
JweEncryption - Class in org.forgerock.json.jose.jwe: This class represents the result from the encryption process of the JWT plaintext.
JweEncryption(byte[], byte[]) - Constructor for class org.forgerock.json.jose.jwe.JweEncryption: Constructs a new JweEncryption object with the given ciphertext and authentication tag.
JweEncryptionException - Exception in org.forgerock.json.jose.exceptions: Represents an exception for when encryption of the JWE fails.
JweEncryptionException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JweEncryptionException: Constructs a new JweEncryptionException with the provided exception message.
JweEncryptionException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweEncryptionException: Constructs a new JweEncryptionException with the provided exception message and underlying throwable.
JweEncryptionException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweEncryptionException: Constructs a new JweEncryptionException with the provided underlying throwable.
JweException - Exception in org.forgerock.json.jose.exceptions: Represents a generic exception for JWE operations.
JweException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JweException: Constructs a new JweException with the provided exception message.
JweException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweException: Constructs a new JweException with the provided exception message and underlying throwable.
JweException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweException: Constructs a new JweException with the provided underlying throwable.
JweHeader - Class in org.forgerock.json.jose.jwe: An implementation for the JWE Header parameters.
JweHeader() - Constructor for class org.forgerock.json.jose.jwe.JweHeader: Constructs an new, empty JweHeader.
JweHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwe.JweHeader: Constructs a new JweHeader with its parameters set to the contents of the given Map.
JweHeaderBuilder<B extends EncryptedJwtBuilder> - Class in org.forgerock.json.jose.builders: An implementation of a JWE Header builder that provides a fluent builder pattern to create JWE headers.
JweHeaderBuilder(B) - Constructor for class org.forgerock.json.jose.builders.JweHeaderBuilder: Constructs a new JweHeaderBuilder, parented by the given JwtBuilder.
JweHeaderKey - Enum in org.forgerock.json.jose.jwe: An Enum for the additional JWE Header parameter names.
jwk(JWK) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Sets the JSON Web Key header parameter for this JWS.
JWK - Class in org.forgerock.json.jose.jwk: The abstract base class for the 3 implementations of JWK.
JWK - org.forgerock.json.jose.jws.JwsHeaderKey: JSON Web Key header parameter.
JWK(KeyType, String, String, String) - Constructor for class org.forgerock.json.jose.jwk.JWK: Deprecated.
Use the builder instead.
JWK(KeyType, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.JWK: Deprecated.
Use the builder instead.
JWK(KeyType, String, Set<KeyOperation>, Algorithm, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.JWK: Creates a JWK given the basic parameters.
JWK.Builder<B extends JWK.Builder> - Class in org.forgerock.json.jose.jwk: JWK builder.
JwkKeyFormat - Enum in org.forgerock.secrets.jwkset: Exports keys in JSON Web Key (JWK) format.
JWKLookup - Class in org.forgerock.json.jose.jwk: Helper class to look up and return the keys from specific JWK implementation algorithm types.
JWKLookup() - Constructor for class org.forgerock.json.jose.jwk.JWKLookup
JWKS_STORE_DEFAULT_CACHE_MISS_CACHE_TIME_MS - Static variable in class org.forgerock.json.jose.jwk.store.JwksStoreService: The default cache time before reload the cache in case of cache miss ms.
JWKS_STORE_DEFAULT_CACHE_TIMEOUT_MS - Static variable in class org.forgerock.json.jose.jwk.store.JwksStoreService: The default cache timeout in ms.
jwkSet(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser: Deprecated.
Use JWKSetParser.jwkSetAsync(URL) instead.
JWKSet - Class in org.forgerock.json.jose.jwk: Holds a Set of JWKs.
JWKSet() - Constructor for class org.forgerock.json.jose.jwk.JWKSet: Constructs an empty JWKSet.
JWKSet(List<JWK>) - Constructor for class org.forgerock.json.jose.jwk.JWKSet: Construct a JWKSet from a List of JWKs.
JWKSet(JWK) - Constructor for class org.forgerock.json.jose.jwk.JWKSet: Construct a JWKSet from a single JWK.
JWKSet(JsonValue) - Constructor for class org.forgerock.json.jose.jwk.JWKSet: Construct a JWKSet from a single JWK.
jwkSetAsync(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser: Provides a JWK set as indicated by the JWKSet's URL.
JwkSetHandler - Class in org.forgerock.openig.handler: Creates a JwkSetHandler to store the cryptographic keys.
JwkSetHandler.Heaplet - Class in org.forgerock.openig.handler: Creates and initializes a JwkSetHandler in a heap environment.
JWKSetParser - Class in org.forgerock.json.jose.jwk: Provides methods to gather a JWKSet from a URL and return a map of key ids to keys as dictated by that JWKS.
JWKSetParser(Client) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser: Alternative constructor allowing the calling class to pass in an already-configured Client.
JWKSetParser(Client, JWKLookup) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser: Alternative constructor allowing the calling class to pass in an already-configured Client.
JwkSetSecretStore - Class in org.forgerock.secrets.jwkset: A secret store that loads cryptographic keys from a local or remote JWKSet.
JwkSetSecretStore(JWKSet, Options) - Constructor for class org.forgerock.secrets.jwkset.JwkSetSecretStore: Creates a secret store directly from the given JWK Set.
JwkSetSecretStore(JwksStore) - Constructor for class org.forgerock.secrets.jwkset.JwkSetSecretStore: Creates a secret store from a JwksStore.
JwkSetSecretStore(JwksStore, Options) - Constructor for class org.forgerock.secrets.jwkset.JwkSetSecretStore: Creates a secret store from a JwksStore.
JwkSetSecretStoreHeaplet - Class in org.forgerock.openig.secrets: This heaplet represents an instance of a JwkSetSecretStore resolving secrets from an URL of a JSON Web Key Set(JWKSet).
JwkSetSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.JwkSetSecretStoreHeaplet
jwkSetToMap(JWKSet) - Method in class org.forgerock.json.jose.jwk.JWKSetParser: Converts a supplied JWKSet into a map of key:values, where the keys are the keyIds and the values are verification keys.
JwksStore - Class in org.forgerock.json.jose.jwk.store: Store JWKs into a jwkSet from a JWKs_URI and refresh the jwkSet when necessary.
JwksStore(Duration, Duration, URL, JWKSetParser, Clock) - Constructor for class org.forgerock.json.jose.jwk.store.JwksStore: Deprecated.
It is recommended to use JwksStore.newJwksStore(Duration, Duration, URL, JWKSetParser, Clock).
JwksStoreService - Class in org.forgerock.json.jose.jwk.store: Manage the jwks store, to avoid having more than one jwks store for the same JWKs_URI unnecessary.
JwksStoreService() - Constructor for class org.forgerock.json.jose.jwk.store.JwksStoreService: Deprecated.
Prefer using the constructor JwksStoreService(Client client) in which you provide your own instance of Client. This one does instantiate a specific instance of AsyncHttpClient but does not allow any custom filter processing, nor does it close it properly.
JwksStoreService(int, int) - Constructor for class org.forgerock.json.jose.jwk.store.JwksStoreService: Deprecated.
Prefer using the constructor JwksStoreService(Client client) where timeouts are in control of the client application
JwksStoreService(Client) - Constructor for class org.forgerock.json.jose.jwk.store.JwksStoreService: Constructor with a HTTP client, that will be used to connect to the JWKS_URI.
JWObject - Class in org.forgerock.json.jose.jwt: A base implementation class for a JSON Web object.
JWObject() - Constructor for class org.forgerock.json.jose.jwt.JWObject: Constructs a new, empty JWObject.
jws(SigningHandler) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory: Creates a builder for building a signed JWT into a base64url UTF-8 encoded JWT string.
JWS - org.forgerock.json.jose.jwt.JwtType: Used when signing a nested JWT.
jwsAlgorithm(JwsAlgorithm) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder: Specifies the JWS signature algorithm to use to sign tokens produced by this token handler.
JwsAlgorithm - Enum in org.forgerock.json.jose.jws: An Enum of the possible signing algorithms that can be used to sign a JWT.
JwsAlgorithmType - Enum in org.forgerock.json.jose.jws: An Enum of the possible types of JWS algorithms that can be used to sign a JWT.
JwsException - Exception in org.forgerock.json.jose.exceptions: Represents a generic exception for JWS operations.
JwsException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwsException: Constructs a new JwsException with the provided exception message.
JwsException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsException: Constructs a new JwsException with the provided exception message and underlying throwable.
JwsException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsException: Constructs a new JwsException with the provided underlying throwable.
JwsHeader - Class in org.forgerock.json.jose.jws: An implementation for the JWS Header parameters.
JwsHeader() - Constructor for class org.forgerock.json.jose.jws.JwsHeader: Constructs a new, empty JwsHeader.
JwsHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jws.JwsHeader: Constructs a new JwsHeader, with its parameters set to the contents of the given Map.
JwsHeaderBuilder - Class in org.forgerock.json.jose.builders: An implementation of a JWS Header builder that provides a fluent builder pattern to create JWS headers.
JwsHeaderBuilder(SignedJwtBuilderImpl) - Constructor for class org.forgerock.json.jose.builders.JwsHeaderBuilder: Constructs a new JwsHeaderBuilder, parented by the given JwtBuilder.
JwsHeaderKey - Enum in org.forgerock.json.jose.jws: An Enum for the JWS Header parameter names.
JwsSignatureVerifier - Class in org.forgerock.openig.tools.jwt.validation: Class supporting Jwt signature verification with a verification Purpose and a SigningManager responsible for the verification.
JwsSignatureVerifier(SigningManager, Purpose<VerificationKey>) - Constructor for class org.forgerock.openig.tools.jwt.validation.JwsSignatureVerifier: Constructor taking a SigningManager and verification Purpose.
JwsSigningException - Exception in org.forgerock.json.jose.exceptions: Represents an exception for when signing of the JWS fails.
JwsSigningException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwsSigningException: Constructs a new JwsSigningException with the provided exception message.
JwsSigningException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsSigningException: Constructs a new JwsSigningException with the provided exception message and underlying throwable.
JwsSigningException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsSigningException: Constructs a new JwsSigningException with the provided underlying throwable.
JwsVerifyingException - Exception in org.forgerock.json.jose.exceptions: Represents an exception for when verification of the JWS signature fails.
JwsVerifyingException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwsVerifyingException: Constructs a new JwsVerifyingException with the provided exception message.
JwsVerifyingException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsVerifyingException: Constructs a new JwsVerifyingException with the provided exception message and underlying throwable.
JwsVerifyingException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsVerifyingException: Constructs a new JwsVerifyingException with the provided underlying throwable.
jwt() - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory: Deprecated.
This method provides no security at all and shouldn't be used.
jwt(JwtConstraint) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder: Adds a JwtConstraint on the JWT.
Jwt - Interface in org.forgerock.json.jose.jwt: The interface for all types of JSON Web Tokens (JWTs).
JWT - org.forgerock.json.jose.jwt.JwtType: Used for plaintext, non-nested signed or non-nested encrypted JWTs.
JwtBearerGrantTypeHandler - Class in org.forgerock.secrets.oauth2: Implements the JWT bearer assertion grant type.
JwtBearerGrantTypeHandler(SecretReference<GenericSecret>) - Constructor for class org.forgerock.secrets.oauth2.JwtBearerGrantTypeHandler: Constructs the handler with the given source of JWTs.
JwtBearerGrantTypeHandler(SecretReference<GenericSecret>, String, Collection<String>) - Constructor for class org.forgerock.secrets.oauth2.JwtBearerGrantTypeHandler: Constructs the handler with the given source of JWTs, for the given client and scope.
JwtBearerGrantTypeHandler(SecretReference<GenericSecret>, Collection<String>) - Constructor for class org.forgerock.secrets.oauth2.JwtBearerGrantTypeHandler: Constructs the handler with the given source of JWTs, for the given scope.
jwtBuilder() - Method in class org.forgerock.openig.tools.jwt.factory.EncryptedJwtFactory
jwtBuilder() - Method in class org.forgerock.openig.tools.jwt.factory.SignedJwtFactory
jwtBuilder() - Method in class org.forgerock.openig.tools.jwt.factory.SignedThenEncryptedJwtFactory
jwtBuilder() - Method in class org.forgerock.openig.tools.jwt.factory.UnsignedJwtFactory: Deprecated.
JwtBuilder - Interface in org.forgerock.json.jose.builders: The base interface for all JwtBuilders for each type of JWT (plaintext, signed or encrypted).
JwtBuilderContext - Class in org.forgerock.openig.filter: Used by the JwtBuilderFilter to make the JWT available in the context.
JwtBuilderException - Exception in org.forgerock.json.jose.exceptions: Represents an exception that occurs when creating/rebuilding JWTs.
JwtBuilderException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException: Constructs a new JwtBuilderException with the provided exception message.
JwtBuilderException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException: Constructs a new JwtBuilderException with the provided exception message and underlying throwable.
JwtBuilderException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException: Constructs a new JwtBuilderException with the provided underlying throwable.
JwtBuilderFactory - Class in org.forgerock.json.jose.builders: A factory for getting builders for plaintext, signed and encrypted JWTs and reconstructing JWT strings back into their relevant JWT objects.
JwtBuilderFactory() - Constructor for class org.forgerock.json.jose.builders.JwtBuilderFactory
JwtBuilderFilter - Class in org.forgerock.openig.filter: The JwtBuilderFilter collects data from template and puts the name-value pairs into a JWT structure.
JwtBuilderFilter(JsonValue, JwtFactory) - Constructor for class org.forgerock.openig.filter.JwtBuilderFilter: Creates a new JwtBuilderFilter which will create a JWT based on the given JSON template and place it into the context JwtBuilderContext.
JwtBuilderFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes an JwtBuilderFilter in a heap environment.
JwtClaimConstraint<T> - Interface in org.forgerock.openig.tools.jwt.validation: A JwtClaimConstraint represents an individual check that can applied to test a claim from a JWT.
JwtClaimsSet - Class in org.forgerock.json.jose.jwt: An implementation that holds a JWT's Claims Set.
JwtClaimsSet() - Constructor for class org.forgerock.json.jose.jwt.JwtClaimsSet: Constructs a new, empty JwtClaimsSet.
JwtClaimsSet(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwt.JwtClaimsSet: Constructs a new JwtClaimsSet, with its claims set to the contents of the given Map.
JwtClaimsSetBuilder - Class in org.forgerock.json.jose.builders: An implementation of a JWT Claims Set builder that provides a fluent builder pattern to creating JWT Claims Sets.
JwtClaimsSetBuilder() - Constructor for class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
JwtClaimsSetKey - Enum in org.forgerock.json.jose.jwt: An Enum for the JWT Claims Set names.
JwtConstraint - Interface in org.forgerock.openig.tools.jwt.validation: A JwtConstraint represents an individual check that can applied to test a JWT.
jwtExpression() - Method in class org.forgerock.openig.filter.jwt.JwtValidationFilter.Heaplet: Returns the expression to be used to obtain the JWT token value.
jwtExpression() - Method in class org.forgerock.openig.filter.oauth2.client.IdTokenValidationFilterHeaplet
JwtFactory - Interface in org.forgerock.openig.tools.jwt.factory: A JwtFactory encapsulates JWT production strategy into a re-usable and testable design.
JwtHeader - Class in org.forgerock.json.jose.jwt: A base implementation class for JWT Headers.
JwtHeader() - Constructor for class org.forgerock.json.jose.jwt.JwtHeader: Constructs a new JwtHeader, with the "typ" parameter set to "JWT".
JwtHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwt.JwtHeader: Constructs a new JwtHeader, with its parameters set to the contents of the given Map.
JwtHeaderBuilder<T extends JwtBuilder,B extends JwtHeaderBuilder<T,B>> - Class in org.forgerock.json.jose.builders: A base implementation of a JWT header builder that provides a fluent builder pattern to creating JWT headers.
JwtHeaderBuilder(T) - Constructor for class org.forgerock.json.jose.builders.JwtHeaderBuilder: Constructs a new JwtHeaderBuilder, parented by the given JwtBuilder.
JwtHeaderKey - Enum in org.forgerock.json.jose.jwt: An Enum for the JWT Header parameter names.
JwtReconstruction - Class in org.forgerock.json.jose.common: A service that provides a method for reconstruct a JWT string back into its relevant JWT object, (SignedJwt, EncryptedJwt, SignedThenEncryptedJwt, EncryptedThenSignedJwt).
JwtReconstruction() - Constructor for class org.forgerock.json.jose.common.JwtReconstruction: Default constructor.
JwtReconstructionException - Exception in org.forgerock.json.jose.exceptions: Represents an exception that occurs when reconstructing JWTs.
JwtReconstructionException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwtReconstructionException: Constructs a new JwtReconstructionException with the provided exception message.
JwtReconstructionException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtReconstructionException: Constructs a new JwtReconstructionException with the provided exception message and underlying throwable.
JwtReconstructionException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtReconstructionException: Constructs a new JwtReconstructionException with the provided underlying throwable.
JwtRuntimeException - Exception in org.forgerock.json.jose.exceptions: Represents a generic exception for JWT operations.
JwtRuntimeException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwtRuntimeException: Constructs a new JwtRuntimeException with the provided exception message.
JwtRuntimeException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtRuntimeException: Constructs a new JwtRuntimeException with the provided exception message and underlying throwable.
JwtRuntimeException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtRuntimeException: Constructs a new JwtRuntimeException with the provided underlying throwable.
JwtSecureHeader - Class in org.forgerock.json.jose.jws: A base implementation for the common security header parameters shared by the JWS and JWE headers.
JwtSecureHeader() - Constructor for class org.forgerock.json.jose.jws.JwtSecureHeader: Constructs a new, empty JwtSecureHeader.
JwtSecureHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jws.JwtSecureHeader: Constructs a new JwtSecureHeader, with its parameters set to the contents of the given Map.
JwtSecureHeaderBuilder<T extends JwtBuilder,B extends JwtSecureHeaderBuilder<T,B>> - Class in org.forgerock.json.jose.builders: A base implementation of a JWT header builder, for the common security header parameters shared by the JWS and JWE headers, that provides a fluent builder pattern to creating JWT headers.
JwtSecureHeaderBuilder(T) - Constructor for class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Constructs a new JwtSecureHeaderBuilder, parented by the given JwtBuilder.
JwtSessionManagerHeaplet - Class in org.forgerock.openig.session.jwt: A JwtSessionManagerHeaplet is responsible for configuring and creating a JwtSession.
JwtSessionManagerHeaplet() - Constructor for class org.forgerock.openig.session.jwt.JwtSessionManagerHeaplet
JwtTokenHandler - Class in org.forgerock.json.jose.tokenhandler: Deprecated.
Prefer SecretsJwtTokenHandler instead.
JwtTokenHandler(JweAlgorithm, EncryptionMethod, KeyPair, JwsAlgorithm, SigningHandler) - Constructor for class org.forgerock.json.jose.tokenhandler.JwtTokenHandler: Deprecated.

Constructs a new JWT token handler that never expires.
JwtTokenHandler(JweAlgorithm, EncryptionMethod, KeyPair, JwsAlgorithm, SigningHandler, Optional<Long>, int) - Constructor for class org.forgerock.json.jose.tokenhandler.JwtTokenHandler: Deprecated.

Constructs a new JWT token handler.
jwtType(String) - Static method in enum org.forgerock.json.jose.jwt.JwtType: Finds the value of the String representation of the given JWT type.
JwtType - Enum in org.forgerock.json.jose.jwt: An Enum for the possible types of JWTs.
JwtUtil - Class in org.forgerock.openig.tools: Utility methods supporting JWTs.
JwtValidationContext - Class in org.forgerock.openig.filter.jwt: A JwtValidationContext used to store the JWT and claims.
JwtValidationErrorContext - Class in org.forgerock.openig.filter.jwt: A JwtValidationErrorContext used to store the JWT and the list of violations for this JWT.
JwtValidationFilter - Class in org.forgerock.openig.filter.jwt: A JwtValidationFilter validates the given JWT according to the provided configuration.
JwtValidationFilter(Expression<String>, JwtValidator, Handler) - Constructor for class org.forgerock.openig.filter.jwt.JwtValidationFilter: Constructs a JwtValidationFilter.
JwtValidationFilter.Heaplet - Class in org.forgerock.openig.filter.jwt: Creates and initializes a JwtValidationFilter in a heap environment.
JwtValidator - Class in org.forgerock.openig.tools.jwt.validation: The JwtValidator is responsible for the JWT validation.
JwtValidator.Builder - Class in org.forgerock.openig.tools.jwt.validation: Builder for the JwtValidator.
jwtValidatorCustomizer() - Method in class org.forgerock.openig.filter.jwt.JwtValidationFilter.Heaplet: Returns an instance of a JwtValidatorCustomizer if one has been defined.
jwtValidatorCustomizer() - Method in class org.forgerock.openig.filter.oauth2.client.IdTokenValidationFilterHeaplet
JwtValidatorCustomizer - Interface in org.forgerock.openig.filter.jwt: This interface provides a generic way to enrich a JwtValidator.Builder.
JwtValidatorResult - Class in org.forgerock.openig.tools.jwt.validation: A class that handles the results for the JWT validation.

K

KERN - org.forgerock.audit.handlers.syslog.Facility: Kernel messages.
KEY_AGREEMENT - Static variable in class org.forgerock.secrets.Purpose: Indicates a key intended for an interactive key agreement protocol, such as Diffie-Hellman (DH) or the elliptic curve equivalent (ECDH).
KEY_DECRYPTION - Static variable in class org.forgerock.secrets.Purpose: Indicates a key intended for decrypting ("unwrapping") other keys.
KEY_ENCRYPTION - Static variable in class org.forgerock.secrets.Purpose: Indicates a key intended for encrypting ("wrapping") other keys.
KEY_MANAGER_ALGORITHM - Static variable in class org.forgerock.secrets.SecretsKeyManager: The algorithm of the underlying X509ExtendedKeyManager implementation to use.
KeyAgreementKey - Class in org.forgerock.secrets.keys: A key that is used in a key-agreement protocol (such as Diffie-Hellman) to agree another key.
KeyAgreementKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.KeyAgreementKey: Initialises the key with the given secret data.
keyAlgorithm(String) - Static method in interface org.forgerock.secrets.SecretConstraint: Enforces a particular key algorithm (case insensitive).
KeyDecryptionKey - Class in org.forgerock.secrets.keys: A key that is used to decrypt (or "unwrap") other keys that have been encrypted with a KeyEncryptionKey.
KeyDecryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.KeyDecryptionKey: Initialises the key with the given secret data.
KeyEncryptionKey - Class in org.forgerock.secrets.keys: A key that is used to encrypt ("wrap") other keys.
KeyEncryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.KeyEncryptionKey: Initialises the key with the given secret data.
KeyFormat<T> - Interface in org.forgerock.secrets.keys: A format that can be used for exporting key material.
KeyFormatPem - Class in org.forgerock.secrets.keys: Exports a key in the PEM (Privacy Enhanced Mail) format.
KeyFormatPem(boolean) - Constructor for class org.forgerock.secrets.keys.KeyFormatPem: Constructs a new PEM key format that does not encrypt private keys.
KeyFormatRaw - Enum in org.forgerock.secrets.keys: Exports the raw key.
keyId - Variable in class org.forgerock.json.jose.jwk.JWK.Builder: The key ID, optional.
keyId(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Sets the keyId parameter of the JWK.
KeyManagerHeaplet - Class in org.forgerock.openig.security: This heaplet creates and initializes instances of an SSL Java KeyManager.
KeyManagerHeaplet() - Constructor for class org.forgerock.openig.security.KeyManagerHeaplet
keyMatch(Object, String) - Static method in class org.forgerock.openig.el.Functions: Returns the first key found in a map that matches the specified regular expression pattern, or null if no such match is found.
KeyOperation - Enum in org.forgerock.json.jose.jwk: Represents the Possible key operations values.
keyOperations - Variable in class org.forgerock.json.jose.jwk.JWK.Builder: The key operations, optional.
keyOperations(Set<KeyOperation>) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Set the key operations parameter of the JWK.
keyPair(KeyPair) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder: Sets the public and private values from the given key pair.
keys() - Method in class org.forgerock.json.jose.jwt.JWObject: Returns the set of keys for this JWObject's values.
keys() - Method in class org.forgerock.json.JsonValue: Returns the set of keys for this JSON value's child values.
Keys - Class in org.forgerock.openig.heap: Define here the constants that can be used as Heap's keys.
keySet() - Method in class org.forgerock.http.protocol.Headers
keySet() - Method in class org.forgerock.http.protocol.RequestCookies
keySet() - Method in class org.forgerock.util.LazyMap: Returns a Set view of the keys contained in the map.
keySet() - Method in class org.forgerock.util.MapDecorator: Returns a Set view of the keys contained in the map.
KeyStoreHandler - Interface in org.forgerock.audit.secure: Handles the access to a KeyStore.
KeyStoreHandlerDecorator - Class in org.forgerock.audit.secure: Decorate a KeyStoreHandler in order to add some commons utility methods to read or write keystore's entries.
KeyStoreHandlerDecorator(KeyStoreHandler) - Constructor for class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Constructs a new KeyStoreHandlerDecorator.
KeyStoreHandlerProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining a keystore handler.
KeyStoreHeaplet - Class in org.forgerock.openig.security: This heaplet creates and initializes instances of Java KeyStore.
KeyStoreHeaplet() - Constructor for class org.forgerock.openig.security.KeyStoreHeaplet
KeyStoreSecretStore - Class in org.forgerock.secrets.keystore: A secret store for cryptographic keys based on a standard Java KeyStore.
KeyStoreSecretStore(Function<char[], KeyStore, KeyStoreException>, SecretReference<GenericSecret>) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore: Initialises the keystore using the same password for the keystore and all keys and default configuration options.
KeyStoreSecretStore(Function<char[], KeyStore, KeyStoreException>, SecretReference<GenericSecret>, SecretReference<GenericSecret>, Options, KeyStoreSecretStore.StableIdProvider) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore: Initialises the key store.
KeyStoreSecretStore(Function<char[], KeyStore, KeyStoreException>, SecretReference<GenericSecret>, Options) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore: Initialises the keystore using the same password for the keystore and all keys.
KeyStoreSecretStore.AliasSpec - Class in org.forgerock.secrets.keystore: Specifies an alias with its validity for use in the store.
KeyStoreSecretStore.KeyDetails - Class in org.forgerock.secrets.keystore: Details of a key that comes from the keystore.
KeyStoreSecretStore.StableIdProvider - Interface in org.forgerock.secrets.keystore: An interface to allow the consuming application to provide the stable ID for the secret.
KeyStoreSecretStoreHeaplet - Class in org.forgerock.openig.secrets: This heaplet represents an instance of a KeyStoreSecretStore.
KeyStoreSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.KeyStoreSecretStoreHeaplet
KeyStoreSecureStorage - Class in org.forgerock.audit.secure: Implementation of a secure storage using a keystore.
KeyStoreSecureStorage(KeyStoreHandler, PrivateKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage: Creates the storage with a keystore handler, initialized to verify only.
KeyStoreSecureStorage(KeyStoreHandler, PublicKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage: Creates the storage with a keystore handler, initialized to verify only.
KeyStoreSecureStorage(KeyStoreHandler, PublicKey, PrivateKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage: Creates the storage with a keystore handler, initialized to verify only.
KeyStoreUtil - Class in org.forgerock.openig.util: Utility class to retrieve private keys from KeyStore.
keyType - Variable in class org.forgerock.json.jose.jwk.JWK.Builder: The key type, required.
KeyType - Enum in org.forgerock.json.jose.jwk: Enum representing the possible KeyTypes.
KeyType - Enum in org.forgerock.secrets.keys: Indicates the type of key.
KeyUsage - Enum in org.forgerock.secrets.keys: Indicates the allowed usages for a particular key.
keyUsages(Set<KeyUsage>) - Method in class org.forgerock.secrets.SecretBuilder: Sets the allowed key usages for this key.
keyUse(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Set the key use parameter of the JWK.
KeyUseConstants - Class in org.forgerock.json.jose.jwk: Represents the supported KeyUse values.
KeyValueProcessor - Interface in org.forgerock.openig.decoration.capture: For a given key/value pair, return the processed value as an Optional.
KeyValueProcessor.Value - Class in org.forgerock.openig.decoration.capture: Class representing a value to be processed.
kid(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Sets the Key ID header parameter for this JWS.
KID - org.forgerock.json.jose.jws.JwsHeaderKey: Key ID header parameter.

L

LABEL_PATTERN - Static variable in class org.forgerock.secrets.Purpose: The regular expression to use when validating purpose labels.
LambdaExceptionUtils - Class in org.forgerock.util: Utility methods for interacting with lambdas that throw exceptions.
lastIndexOf(Object) - Method in class org.forgerock.util.LazyList: Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
lastIndexOf(Object) - Method in class org.forgerock.util.ListDecorator: Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
LATEST - org.forgerock.http.routing.DefaultVersionBehaviour: Will route to the latest version of the resource.
LAX - org.forgerock.http.protocol.Cookie.SameSite: In "lax" mode the cookie will be sent on "safe" top-level navigation methods (GET, HEAD, TRACE or OPTIONS).
lazy(Supplier<T, E>) - Static method in class org.forgerock.util.LazySupplier: Constructs a supplier that will lazily compute and cache a value from the given supplier.
lazyCopy() - Method in class org.forgerock.http.protocol.Request: Returns a Supplier that will lazily copy the request object the first time it is accessed.
LazyList<E> - Class in org.forgerock.util: A list with lazy initialization.
LazyList() - Constructor for class org.forgerock.util.LazyList: Constructs a new lazy list.
LazyList(Factory<List<E>>) - Constructor for class org.forgerock.util.LazyList: Constructs a new lazy list.
LazyMap<K,V> - Class in org.forgerock.util: A map with lazy initialization.
LazyMap() - Constructor for class org.forgerock.util.LazyMap: Constructs a new lazy map.
LazyMap(Factory<Map<K, V>>) - Constructor for class org.forgerock.util.LazyMap: Constructs a new lazy map.
LazyReference<T> - Class in org.forgerock.openig.decoration.helper: Lazily resolve a JsonValue reference node against a provided Heap instance.
LazySupplier<T,E extends Exception> - Class in org.forgerock.util: A Supplier that lazily computes a value the first time it is accessed and then caches the result to return on subsequent requests.
LdapClient - Class in org.forgerock.openig.ldap: This class acts as a simplified access point into the OpenDJ LDAP SDK.
LdapConnection - Class in org.forgerock.openig.ldap: Provides an adapted view of an OpenDJ LDAP connection exposing only the synchronous methods and protecting against future evolution of the Connection interface (e.g.
leaf() - Method in class org.forgerock.json.JsonPointer: Returns the last (leaf) reference token of the JSON pointer, or null if the pointer contains no reference tokens (i.e.
leaf() - Method in class org.forgerock.json.resource.ResourcePath: Returns the last path element in this resource path.
LEASE_EXPIRY_DURATION - Static variable in interface org.forgerock.secrets.SecretStore: Option used to specify how long secrets from a store should be used before being refreshed.
leftValueExpression(Class<T>) - Static method in class org.forgerock.openig.util.JsonValues: Returns a function for transforming JsonValues to left-value expressions.
LeftValueExpression<T> - Class in org.forgerock.openig.el: A LeftValueExpression is a specialized Expression to which we can assign a value.
length() - Method in interface org.forgerock.http.io.Buffer: Returns the current length of the buffer.
length(Object) - Static method in class org.forgerock.openig.el.Functions: Returns the number of items in a collection, or the number of characters in a string.
LENGTH_REQUIRED - Static variable in class org.forgerock.http.protocol.Status: The 411 (Length Required) status code indicates that the server refuses to accept the request without a defined Content-Length (Section 3.3.2 of [RFC7230]).
LESS_EQUAL - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "less-than-or-equal" operator.
LESS_THAN - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "less-than" operator.
lessThan(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new less than filter using the provided field name and value assertion.
lessThanOrEqualTo(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new less than or equal to filter using the provided field name and value assertion.
LifeCycle - Interface in org.forgerock.openig.tools: Manages Lifecycle on an object.
list - Variable in class org.forgerock.util.ListDecorator: The list wrapped by this decorator.
listAll() - Method in class org.forgerock.openig.ui.record.RecordService: List all persisted records from the file system.
ListDecorator<E> - Class in org.forgerock.util: Wraps another map.
ListDecorator(List<E>) - Constructor for class org.forgerock.util.ListDecorator: Constructs a new list decorator, wrapping the specified list.
listFiles() - Method in interface org.forgerock.audit.retention.FileNamingPolicy: Lists all the archived files, from oldest to newest.
listFiles() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy: List the files in the initial file directory that match the prefix, name and suffix format.
listIterator() - Method in class org.forgerock.util.LazyList: Returns a list iterator over the elements in this list (in proper sequence).
listIterator() - Method in class org.forgerock.util.ListDecorator: Returns a list iterator over the elements in this list (in proper sequence).
listIterator(int) - Method in class org.forgerock.util.LazyList: Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
listIterator(int) - Method in class org.forgerock.util.ListDecorator: Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
listOf(Function<JsonValue, T, E>) - Static method in class org.forgerock.openig.util.JsonValues: Returns a function that transform a JSON node value into a list of adapted instances.
listOf(Function<JsonValue, V, E>) - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON value as a List containing objects whose type (and value) is specified by a transformation function.
ListResolver - Class in org.forgerock.openig.resolver: Resolves List objects.
ListResolver() - Constructor for class org.forgerock.openig.resolver.ListResolver
Lists - Class in org.forgerock.http.util: Provides helper methods for List.
listShares() - Method in class org.forgerock.openig.uma.UmaSharingService: Returns a copy of the list of currently managed shares.
load(Class<S>, Options) - Method in interface org.forgerock.http.spi.Loader: Loads a service of the specified type.
load(Request) - Method in interface org.forgerock.http.session.SessionManager: Deprecated.

Loads a new Session for the given Request.
loadAsync(Request) - Method in interface org.forgerock.http.session.AsyncSessionManager: Loads a new Session for the given Request.
loadBouncyCastle() - Static method in class org.forgerock.json.jose.utils.Utils: Attempts to load the BouncyCastle JCE provider and register it.
Loader - Class in org.forgerock.util: Provides methods for dynamically loading classes.
Loader - Interface in org.forgerock.http.spi: An SPI interface for implementing alternative service loading strategies.
loadJWKFromJson(JWK.Builder, JsonValue) - Static method in class org.forgerock.json.jose.jwk.JWK: Load the generic JWK attributes from the json, by side effect.
loadList(Class<E>) - Static method in class org.forgerock.util.Loader: Loads services of a particular type into a list.
loadList(Class<E>, ClassLoader) - Static method in class org.forgerock.util.Loader: Loads services of a particular type into a list.
loadMap(Class<V>) - Static method in class org.forgerock.util.Loader: Loads services of a particular type into a map.
loadMap(Class<V>, ClassLoader) - Static method in class org.forgerock.util.Loader: Loads services of a particular type into a map.
LOCAL0 - org.forgerock.audit.handlers.syslog.Facility: Local use 0 (local0).
LOCAL1 - org.forgerock.audit.handlers.syslog.Facility: Local use 1 (local1).
LOCAL2 - org.forgerock.audit.handlers.syslog.Facility: Local use 2 (local2).
LOCAL3 - org.forgerock.audit.handlers.syslog.Facility: Local use 3 (local3).
LOCAL4 - org.forgerock.audit.handlers.syslog.Facility: Local use 4 (local4).
LOCAL5 - org.forgerock.audit.handlers.syslog.Facility: Local use 5 (local5).
LOCAL6 - org.forgerock.audit.handlers.syslog.Facility: Local use 6 (local6).
LOCAL7 - org.forgerock.audit.handlers.syslog.Facility: Local use 7 (local7).
localAddress(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the local server's address.
LocalHostNameProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining the server's local hostname.
LocalizableString - Class in org.forgerock.util.i18n: Represents a String which could be localizable.
LocalizableString(String) - Constructor for class org.forgerock.util.i18n.LocalizableString: String only constructor for non-localizable String values.
LocalizableString(String, Class<?>) - Constructor for class org.forgerock.util.i18n.LocalizableString: Constructor for potentially localizable String.
LocalizableString(String, ClassLoader) - Constructor for class org.forgerock.util.i18n.LocalizableString: Constructor for potentially localizable String.
LocalizableString(String, ClassLoader, LocalizableString) - Constructor for class org.forgerock.util.i18n.LocalizableString: Constructor for potentially localizable String.
LocalizableStringModule() - Constructor for class org.forgerock.http.util.Json.LocalizableStringModule: Default constructor.
localPort(int) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the local server's port.
LocationHeader - Class in org.forgerock.http.header: Processes the Location message header.
LocationHeader() - Constructor for class org.forgerock.http.header.LocationHeader: Constructs a new empty header whose location is null.
LocationHeader(String) - Constructor for class org.forgerock.http.header.LocationHeader: Constructs a new header with the provided location URI.
LocationHeaderFilter - Class in org.forgerock.openig.filter: Rewrites Location headers on responses that generate a redirect that would take the user directly to the application being proxied rather than taking the user through the Identity Gateway.
LocationHeaderFilter() - Constructor for class org.forgerock.openig.filter.LocationHeaderFilter
LocationHeaderFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes a LocationHeaderFilter in a heap environment.
LOGALERT - org.forgerock.audit.handlers.syslog.Facility: Log alert.
LogAttachedExceptionFilter - Class in org.forgerock.openig.filter: A LogAttachedExceptionFilter prints attached exceptions to filtered responses.
LogAttachedExceptionFilter() - Constructor for class org.forgerock.openig.filter.LogAttachedExceptionFilter
LOGAUDIT - org.forgerock.audit.handlers.syslog.Facility: Log audit.
login(String, String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
logout() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
logout(Context, String) - Method in class org.forgerock.openig.tools.session.CacheSessionService
logout(Context, String) - Method in class org.forgerock.openig.tools.session.CrestSessionService
logout(Context, String) - Method in interface org.forgerock.openig.tools.session.SessionService: Returns a promise that will be completed with a Void or with an SessionException in case of errors.
lookup() - Method in class org.forgerock.openig.audit.AbstractAuditEvents
lookup() - Method in interface org.forgerock.openig.audit.AuditEvents: Lookup audit events from resources.
lookup(String, KeyType) - Method in class org.forgerock.json.jose.jwk.JWKLookup: Lookup returns the key from the given json, under the assumption it's of the correct keyType.
lookup(Context, Request) - Method in class org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicy
lookup(Context, Request) - Method in class org.forgerock.openig.filter.throttling.FixedRateThrottlingPolicy
lookup(Context, Request) - Method in class org.forgerock.openig.filter.throttling.MappedThrottlingPolicy
lookup(Context, Request) - Method in class org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy
lookup(Context, Request) - Method in interface org.forgerock.openig.filter.throttling.ThrottlingPolicy: Returns the ThrottlingRate that should be used for the provided request.
lookupOrCreateHeapObject(Heap, Class<T>) - Static method in class org.forgerock.openig.util.JsonValues: Returns a Function that will lookup into the provided heap and its parents for an object named by the provided JsonValue declaration.
lowerThan(Version) - Static method in class org.forgerock.openig.tools.am.Version: Returns a predicate that verifies if this version is strictly lower than the given version.
lowerThanOrEqualTo(Version) - Static method in class org.forgerock.openig.tools.am.Version: Returns a predicate that verifies if this version is lower or equal to the given version.
LOWEST - org.forgerock.util.thread.listener.ShutdownPriority: LOWEST is the priority pre-defined in the system.
LPR - org.forgerock.audit.handlers.syslog.Facility: Line printer subsystem.

M

MAIL - org.forgerock.audit.handlers.syslog.Facility: Mail system.
main(String[]) - Static method in class org.forgerock.audit.handlers.csv.CsvSecureArchiveVerifierCli: Entry point for CLI.
major() - Method in class org.forgerock.openig.tools.am.Version: Returns major component of the version.
makeLocalizingObjectWriter(ObjectMapper, Request) - Static method in class org.forgerock.http.util.Json: Make an object writer that contains the locales from the request for serialization of LocalizableString instances.
makeLocalizingObjectWriter(ObjectMapper, PreferredLocales) - Static method in class org.forgerock.http.util.Json: Make an object writer that contains the provided locales for serialization of LocalizableString instances.
MalformedHeaderException - Exception in org.forgerock.http.header: Thrown when a header string cannot be parsed to a rich Header implementation.
MalformedHeaderException(Exception) - Constructor for exception org.forgerock.http.header.MalformedHeaderException: Constructs a new exception with the given cause.
MalformedHeaderException(String) - Constructor for exception org.forgerock.http.header.MalformedHeaderException: Constructs a new exception with the given message.
MalformedHeaderException(String, Exception) - Constructor for exception org.forgerock.http.header.MalformedHeaderException: Constructs a new exception with the given message and cause.
MANAGE - org.forgerock.openig.filter.CookieFilter.Action: Intercept and manage the cookie within the proxy.
map - Variable in class org.forgerock.util.MapDecorator: The map wrapped by this decorator.
MapDecorator<K,V> - Class in org.forgerock.util: Wraps another map.
MapDecorator(Map<K, V>) - Constructor for class org.forgerock.util.MapDecorator: Constructs a new map decorator, wrapping the specified map.
MapFilterVisitor<F> - Class in org.forgerock.util.query: A QueryFilterVisitor that produces a Map representation of the filter tree.
MapFilterVisitor() - Constructor for class org.forgerock.util.query.MapFilterVisitor
MappedThrottlingPolicy - Class in org.forgerock.openig.filter.throttling: Implementation of ThrottlingPolicy backed by a Map.
MappedThrottlingPolicy(AsyncFunction<ContextAndRequest, String, Exception>, Map<String, ThrottlingRate>, ThrottlingRate) - Constructor for class org.forgerock.openig.filter.throttling.MappedThrottlingPolicy: Constructs a new MappedThrottlingPolicy.
MappedThrottlingPolicyHeaplet - Class in org.forgerock.openig.filter.throttling: Creates and initializes a MappedThrottlingPolicy in a heap environment.
MappedThrottlingPolicyHeaplet() - Constructor for class org.forgerock.openig.filter.throttling.MappedThrottlingPolicyHeaplet
MapResolver - Class in org.forgerock.openig.resolver: Resolves Map objects.
MapResolver() - Constructor for class org.forgerock.openig.resolver.MapResolver
matchedUri(String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the matchedUri value.
matches(String, String) - Static method in class org.forgerock.openig.el.Functions: Deprecated, for removal: This API element is subject to removal in a future version.
since 7.2.0, with OPENIG-5793. Use Functions.find(String, String) or Functions.matchesWithRegex(String, String) instead.
matches(Locale, Locale, List<Locale>) - Static method in class org.forgerock.util.i18n.PreferredLocales: Checks if the candidate locale the best match for the requested locale? Exclude Locale.ROOT, as it should be the fallback only when all locales are tried.
matches(Pattern) - Static method in class org.forgerock.openig.tools.jwt.validation.Constraints: Build and returns a new `Constraint` that checks if the claim's value is matched (as per Matcher.matches()) by the given regex.
matches(Context, Request) - Method in interface org.forgerock.json.resource.FilterCondition: Returns true if the conditional filter should be invoked, or false if processing should continue directly to the next filter in the filter chain.
matchesWithRegex(String, String) - Static method in class org.forgerock.openig.el.Functions: Returns true if the string matches the specified regular expression pattern.
matchingGroups(String, String) - Static method in class org.forgerock.openig.el.Functions: Deprecated, for removal: This API element is subject to removal in a future version.
since 7.2.0, with OPENIG-5957. Use Functions.findGroups(String, String) instead.
matchRequestType(Set<RequestType>) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose type is contained in types.
matchRequestType(RequestType...) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose type is contained in types.
matchResourcePath(String) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose resource path matches the provided regular expression.
matchResourcePath(Pattern) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will only match requests whose resource path matches the provided regular expression.
matchVersion(Request) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification
matchVersion(Request) - Method in interface org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.VersionSpecification: Test the request to try to find a match based on version configuration.
maxAge(Duration) - Method in class org.forgerock.http.filter.cors.CorsPolicy.Builder: Sets a maximum age for user-agent to cache for valid pre-flight responses.
maxBatchEvents(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: Sets the maximum number of events in a given batch.
mdcAwareAction(Action) - Static method in class org.forgerock.http.protocol.MdcAwareAction: Wraps the delegate Action with another Action instance that will capture the current MDC context, and will use it when delegating the calls to the delegated Action.
mdcAwareAction(Map<String, String>, Action) - Static method in class org.forgerock.http.protocol.MdcAwareAction: Wraps the delegate Action with another Action instance that will use the provided MDC context when delegating the calls to the delegated Action.
MdcAwareAction - Class in org.forgerock.http.protocol: An implementation of Action that will preserve the SLF4J MDC.
mdcAwareConsumer(Consumer<T>) - Static method in class org.forgerock.http.protocol.MdcAwareConsumer: Wraps the delegate Consumer with another Consumer instance that will capture the current MDC context, and will use it when delegating the calls to the delegated Consumer.
mdcAwareConsumer(Map<String, String>, Consumer<T>) - Static method in class org.forgerock.http.protocol.MdcAwareConsumer: Wraps the delegate Consumer with another Consumer instance that will use the provided MDC context when delegating the calls to the delegated Consumer.
MdcAwareConsumer<T> - Class in org.forgerock.http.protocol: An implementation of Consumer that will preserve the SLF4J MDC.
mdcAwareSingleObserver(SingleObserver<T>) - Static method in class org.forgerock.openig.reactive.MdcAwareSingleObserver: Wraps the delegate SingleObserver with another SingleObserver instance that will capture the current MDC context, and will use it when delegating the calls to the delegated SingleObserver.
MdcAwareSingleObserver<T> - Class in org.forgerock.openig.reactive: A SingleObserver wrapper that manages the MDC.
mdcAwareSubscriber(Map<String, String>, Subscriber<T>) - Static method in class org.forgerock.http.protocol.MdcAwareSubscriber: Wraps the delegate Subscriber with another Subscriber instance that will use the provided MDC context when delegating the calls to the delegated Subscriber.
mdcAwareSubscriber(Subscriber<T>) - Static method in class org.forgerock.http.protocol.MdcAwareSubscriber: Wraps the delegate Subscriber with another Subscriber instance that will capture the current MDC context, and will use it when delegating the calls to the delegated Subscriber.
MdcAwareSubscriber<T> - Class in org.forgerock.http.protocol: An implementation of Subscriber that will preserve the SLF4J MDC.
MdcExecutorServiceDelegate - Class in org.forgerock.util.thread: Store SLF4J Mapped Diagnosed Context (aka MDC) when tasks are submitted, and re-inject it when tasks are executed.
MdcExecutorServiceDelegate(ExecutorService) - Constructor for class org.forgerock.util.thread.MdcExecutorServiceDelegate: Constructs an instance of ExecutorService that will forward the SLF4J Mapped Diagnosed Context to submitted tasks, and will execute these on the provided delegate.
MdcRouteIdFilter - Class in org.forgerock.openig.filter: A MdcRouteIdFilter aims to prepare the current thread with SLF4J MDC information about the current route.
MdcRouteIdFilter(String) - Constructor for class org.forgerock.openig.filter.MdcRouteIdFilter: Constructs a filter for preparing MDC for the given routeId.
MdcScheduledExecutorServiceDelegate - Class in org.forgerock.util.thread: Store SLF4J Mapped Diagnosed Context (aka MDC) when tasks are submitted, and re-inject it when tasks are executed.
MdcScheduledExecutorServiceDelegate(ScheduledExecutorService) - Constructor for class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate: Constructs an instance of ScheduledExecutorService that will forward the SLF4J Mapped Diagnosed Context to submitted tasks, and will execute these on the provided delegate.
MEDIA_TYPE - Static variable in class org.forgerock.json.JsonPatch: Internet media type for the JSON Patch format.
MemoryBackend - Class in org.forgerock.json.resource: A simple in-memory collection resource provider which uses a Map to store resources.
MemoryBackend() - Constructor for class org.forgerock.json.resource.MemoryBackend: Creates a new in-memory collection containing no resources.
merge(List<D>) - Method in interface org.forgerock.http.ApiProducer: Merge the provided descriptors into a single descriptor.
merge(List<Swagger>) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
merge(JsonValue) - Method in class org.forgerock.json.JsonValue: Creates a new JSON value which combines the contents this JSON value with another.
merge(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch: Creates a new JSON value which combines the contents two JSON values.
Message<M extends Message<M>> - Interface in org.forgerock.http.protocol: Elements common to requests and responses.
messageHandler(Consumer<JsonValue>) - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Supply a message handler capable of consuming server requests.
MessageImpl<T extends MessageImpl<T>> - Class in org.forgerock.http.protocol: Abstract message base class.
MessageType - Enum in org.forgerock.openig.util: Indicates a type of HTTP message.
MeteredStream - Class in org.forgerock.audit.events.handlers.writers: A metered stream is a subclass of OutputStream that (a) forwards all its output to a target stream (b) keeps track of how many bytes have been written.
MeteredStream(OutputStream, long) - Constructor for class org.forgerock.audit.events.handlers.writers.MeteredStream: Create the stream wrapped around the specified output stream.
meterRegistryHolder() - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet: Returns this object's MeterRegistry, creating it lazily when requested for the first time.
meterRegistryHolder() - Method in class org.forgerock.openig.heap.GenericHeaplet: Returns this object's MeterRegistry, creating it lazily when requested for the first time.
METHOD - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The method event payload field name.
METHOD_DELETE - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP DELETE method.
METHOD_GET - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP GET method.
METHOD_HEAD - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP HEAD method.
METHOD_NOT_ALLOWED - Static variable in class org.forgerock.http.protocol.Status: The 405 (Method Not Allowed) status code indicates that the method received in the request-line is known by the origin server but not supported by the target resource.
METHOD_OPTIONS - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP OPTIONS method.
METHOD_PATCH - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP PATCH method.
METHOD_POST - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP POST method.
METHOD_PUT - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP PUT method.
METHOD_TRACE - Static variable in class org.forgerock.http.filter.OptionsFilter: The HTTP TRACE method.
METRICS_PROTECTION_FILTER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve a Filter instance from the Heap of config.json to protect the metrics endpoint.
MetricsFilter - Class in org.forgerock.openig.filter: Collect request processing metrics.
MetricsFilter(MeterRegistry) - Constructor for class org.forgerock.openig.filter.MetricsFilter: Construct a MetricsFilter with meters registered with the supplied MeterRegistry.
micro() - Method in class org.forgerock.openig.tools.am.Version: Returns micro component of the version.
minor() - Method in class org.forgerock.openig.tools.am.Version: Returns minor component of the version.
MISCELLANEOUS_PERSISTENT_WARNING - Static variable in class org.forgerock.http.header.WarningHeader: 299 Miscellaneous persistent warning The warning text MAY include arbitrary information to be presented to a human user, or logged.
MISCELLANEOUS_PERSISTENT_WARNING - Static variable in class org.forgerock.json.resource.AdviceWarning: 299 Miscellaneous persistent warning The warning text MAY include arbitrary information to be presented to a human user, or logged.
MISCELLANEOUS_WARNING - Static variable in class org.forgerock.http.header.WarningHeader: 199 Miscellaneous warning The warning text MAY include arbitrary information to be presented to a human user, or logged.
MISCELLANEOUS_WARNING - Static variable in class org.forgerock.json.resource.AdviceWarning: 199 Miscellaneous warning The warning text MAY include arbitrary information to be presented to a human user, or logged.
model() - Method in class org.forgerock.openig.types.importer.RouteInstance: Returns the underlying route's model.
modify(String...) - Method in class org.forgerock.openig.ldap.LdapConnection: Modifies an entry in the Directory Server using the provided lines of LDIF.
modify(ModifyRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Modifies an entry in the Directory Server using the provided modify request.
modifyDN(String, String) - Method in class org.forgerock.openig.ldap.LdapConnection: Renames the named entry in the Directory Server using the provided new RDN.
modifyDN(ModifyDnRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Renames an entry in the Directory Server using the provided modify DN request.
modifyHeaders(Consumer<Headers>) - Method in interface org.forgerock.http.protocol.Message: Interact with the Headers object from the Message.getHeaders() in a fluent way.
modifyHeaders(Consumer<Headers>) - Method in class org.forgerock.http.protocol.MessageImpl
move(String, String) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "move" patch operation which will move the value found at `from` to `path`.
move(JsonPointer, JsonPointer) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "move" patch operation which will move the value found at `from` to `path`.
MOVED_PERMANENTLY - Static variable in class org.forgerock.http.protocol.Status: The 301 (Moved Permanently) status code indicates that the target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs.
multipartCrestApplication(ConnectionFactory, String, String) - Static method in class org.forgerock.json.resource.Applications: Create a simple CrestApplication that allows multipart/form-data requests using the provided factory, id and version.
MULTIPLE_CHOICES - Static variable in class org.forgerock.http.protocol.Status: The 300 (Multiple Choices) status code indicates that the target resource has more than one representation, each with its own more specific identifier, and information about the alternatives is being provided so that the user (or user agent) can select a preferred representation by redirecting its request to one or more of those identifiers.
MultiValueMap<K,V> - Class in org.forgerock.http.util: Wraps a map for which the values are lists, providing a set of convenience methods for handling list values.
MultiValueMap(Map<K, List<V>>) - Constructor for class org.forgerock.http.util.MultiValueMap: Creates a new multi-value map, wrapping an existing map with list values.
MutableUri - Class in org.forgerock.http: A MutableUri is a modifiable URI substitute.
MutableUri(String) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri using the given URL encoded String URI.
MutableUri(String, String, String, int, String, String, String) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri using the given fields values (decoded values).
MutableUri(URI) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri using the given URI.
MutableUri(MutableUri) - Constructor for class org.forgerock.http.MutableUri: Builds a new MutableUri with deep copy.
MYSQL - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: The name used for a MySQL database.

N

name - Variable in class org.forgerock.openig.decoration.helper.DecoratorHeaplet: The fully qualified name of the object to be created.
name - Variable in class org.forgerock.openig.heap.GenericHeaplet: The name of the object to be created and stored in the heap by this heaplet.
name() - Method in class org.forgerock.openig.types.importer.RouteInstance: Returns the name of this route.
name(String) - Method in class org.forgerock.openig.types.importer.RouteInstance: Sets the name of this route.
Name - Class in org.forgerock.openig.heap: A Name uniquely identify an object within a hierarchy.
NAME - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.AcceptLanguageHeader: The name of the header.
NAME - Static variable in class org.forgerock.http.header.authorization.BasicCredentials: The name of the Basic challenge scheme.
NAME - Static variable in class org.forgerock.http.header.authorization.BearerToken: The name of the Bearer challenge scheme.
NAME - Static variable in class org.forgerock.http.header.AuthorizationHeader: A constant for the name of the Authorization header.
NAME - Static variable in class org.forgerock.http.header.ConnectionHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentApiVersionHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentEncodingHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentLengthHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentTypeHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.CookieHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ForwardedHeader: The name of the header in the HTTP message.
NAME - Static variable in class org.forgerock.http.header.LocationHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.ReferrerHeader: The name of the header in the HTTP message.
NAME - Static variable in class org.forgerock.http.header.SetCookie2Header: Deprecated.

The name of this header.
NAME - Static variable in class org.forgerock.http.header.SetCookieHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.TrailerHeader: The name of the header in the HTTP message.
NAME - Static variable in class org.forgerock.http.header.TransactionIdHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.WarningHeader: The name of this header.
NAME - Static variable in class org.forgerock.http.header.WwwAuthenticateHeader: A constant for the name of the WWW-Authenticate header.
NAME - Static variable in class org.forgerock.http.header.XForwardedForHeader: The name of this header.
NAME - Static variable in class org.forgerock.openig.filter.AuthRedirectContext: Context's name.
NAME - Static variable in class org.forgerock.openig.filter.DateHeaderFilter: The name of this header.
NAME - Static variable in class org.forgerock.openig.filter.jwt.JwtValidationContext: Context's name.
NAME - Static variable in class org.forgerock.openig.filter.jwt.JwtValidationErrorContext: Context's name.
NAME - Static variable in class org.forgerock.openig.filter.JwtBuilderContext: Context's name.
NAME - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader: The name of the header that this object represents.
NAME - Static variable in class org.forgerock.openig.filter.oauth2.OAuth2FailureContext: The OAuth2FailureContext's name.
NAME - Static variable in class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeContext: The OAuth2TokenExchangeContext's name.
NAME - Static variable in class org.forgerock.openig.openam.CapturedUserPasswordContext: Context's name.
NAME - Static variable in class org.forgerock.openig.openam.CdSsoContext: Context name.
NAME - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext: Context name.
NAME - Static variable in class org.forgerock.openig.openam.PolicyDecisionContext: Context's name.
NAME - Static variable in class org.forgerock.openig.openam.SessionInfoContext: The @{code SessionInfoContext}'s name.
NAME - Static variable in class org.forgerock.openig.openam.StsContext: Context's name.
NAME - Static variable in class org.forgerock.openig.openam.UserProfileContext: Context's name.
NAME - Static variable in class org.forgerock.openig.websocket.WebSocketHandshakeContext: Context's name.
named(SecretsProvider, Purpose<T>, String, Clock) - Static method in class org.forgerock.secrets.SecretReference: Creates a reference to a named secret using the given secrets provider.
namedCurveParams(Key) - Static method in class org.forgerock.json.jose.utils.XECUtils: Returns the NamedCurveParameters for this key.
names(Class<T>) - Static method in class org.forgerock.openig.util.EnumUtil: Returns a set of the names of the enum constants of the specified enum type.
nbf(Date) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the time the JWT is not allowed to be processed before, in the Claims Set.
NBF - org.forgerock.json.jose.jwt.JwtClaimsSetKey: Not Before Claim.
NEVER_CLEAR - org.forgerock.openig.tools.notifications.DisconnectionStrategy: Do not touch the cache when the notification service gets disconnected or reconnected.
NEVER_EXPIRES - Static variable in class org.forgerock.http.oauth2.AccessTokenInfo: Marker for never ending tokens.
neverThrown() - Static method in exception org.forgerock.util.promise.NeverThrowsException: Utility method returning an empty function, whose goal is to ease the transformation of a Promise type.
neverThrownAsync() - Static method in exception org.forgerock.util.promise.NeverThrowsException: Utility method returning an empty function, whose goal is to ease the transformation of a Promise type.
NeverThrowsException - Exception in org.forgerock.util.promise: The NeverThrowsException class is an uninstantiable placeholder exception which should be used for indicating that a Function or AsyncFunction never throws an exception (i.e.
newActionRequest(String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource path and action ID.
newActionRequest(String, String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource container path, resource ID, and action ID.
newActionRequest(ResourcePath, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource path and action ID.
newActionRequest(ResourcePath, String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new action request with the provided resource container path, resource ID, and action ID.
newActionResponse(JsonValue) - Static method in class org.forgerock.json.resource.Responses: Returns a new JsonValue response with the provided JSON content.
newAdviceWarning(String, String, Object...) - Static method in class org.forgerock.json.resource.AdviceWarning: Generate a warning using the builder provided.
newAnnotatedRequestHandler(Object) - Static method in class org.forgerock.json.resource.Resources: Deprecated.
Use Resources.newHandler(Object) instead.
newApiRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new API request with the provided path.
newAsyncSessionFilter(AsyncSessionManager) - Static method in class org.forgerock.http.filter.Filters: Creates a session Filter that will use the provided AsyncSessionManager to manage the users session.
newAuditService() - Static method in class org.forgerock.audit.AuditServiceBuilder: Factory method for new instances of this builder.
newAuthorizationServerError(String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error: Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.
newAuthorizationServerError(String, String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error: Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.
newBase64SysEnvSecretStore() - Static method in class org.forgerock.openig.secrets.SystemAndEnvSecretStoreHeaplet: Returns a new instance of a SecretStore that reads base64-encoded secrets (passwords or symmetric keys) from system properties and environment variables.
newBearerTokenAuthFilter(SecretReference<GenericSecret>) - Static method in class org.forgerock.http.filter.Filters: Creates an authentication Filter that puts a Bearer Authorization header in the request.
newBearerTokenAuthFilterWithoutRetry(SecretReference<GenericSecret>) - Static method in class org.forgerock.http.filter.Filters: Creates an authentication Filter that puts a Bearer Authorization header in the request.
newBranchingInputStream(byte[]) - Static method in class org.forgerock.http.io.IO: Creates a new branching input stream that wraps a byte array.
newBranchingInputStream(InputStream, Factory<Buffer>) - Static method in class org.forgerock.http.io.IO: Creates a new branching input stream to wrap another input stream.
newBufferedPublisher(BatchConsumer) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisherFactory: Provides a new instance of a buffered batch publisher.
newBufferedPublisher(BatchConsumer) - Method in class org.forgerock.audit.events.handlers.buffering.BatchPublisherFactoryImpl
newBuilder(BatchConsumer) - Static method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Provides a new builder.
newChildProducer(String) - Method in interface org.forgerock.http.ApiProducer: Create a child producer with the same type, but with the extra ID fragment.
newChildProducer(String) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
newClient(ClientTlsOptions, ProxyOptions) - Method in interface org.forgerock.openig.tools.notifications.ws.WebSocketClientProvider: Creates a new WebSocket client.
newCollection(Object) - Static method in class org.forgerock.json.resource.Resources: Deprecated.
Use Resources.newHandler(Object) instead.
newConnectionFactory(Handler, URI) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new ConnectionFactory that map back and forth JSON resource objects to CHF objects.
newCreateRequest(String, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, new resource ID, and JSON content.
newCreateRequest(String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, and JSON content.
newCreateRequest(ResourcePath, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, new resource ID, and JSON content.
newCreateRequest(ResourcePath, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new create request with the provided resource path, and JSON content.
newCrestApplication(RequestHandler, String) - Static method in class org.forgerock.openig.util.CrestUtil: Creates a new CrestApplication.
newCsrfFilter(String) - Static method in class org.forgerock.http.filter.Filters: Creates a filter that protects against cross-site request forgery (CSRF) attacks when using cookies for authentication.
newDecodedContentInputStream() - Method in class org.forgerock.http.protocol.Entity: Returns a branched input stream representing the decoded content of this entity.
newDecodedContentReader(Charset) - Method in class org.forgerock.http.protocol.Entity: Returns a branched reader representing the decoded content of this entity.
newDecompressedContentFlowable() - Method in class org.forgerock.http.protocol.Entity: Returns a publisher of bytes representing the decompressed content of this entity, according to the Content-Encoding header.
newDefaultCsrfFilter(String) - Static method in class org.forgerock.http.filter.Filters: Creates a filter that protects against cross-site request forgery (CSRF) attacks when using cookies for authentication.
newDeleteRequest(String) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource path.
newDeleteRequest(String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource container path, and resource ID.
newDeleteRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource path.
newDeleteRequest(ResourcePath, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new delete request with the provided resource container path, and resource ID.
newEcdsaSigningHandler(ECPrivateKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
use SigningManager.newEcdsaSigningHandler(SigningKey)} instead
newEcdsaSigningHandler(PrivateKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
use SigningManager.newEcdsaSigningHandler(SigningKey)} instead
newEcdsaSigningHandler(SigningKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new handler for signing ES256 signatures.
newEcdsaVerificationHandler(ECPublicKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
use SigningManager.newEcdsaVerificationHandler(VerificationKey) instead
newEcdsaVerificationHandler(VerificationKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new handler for verifying ES256 signatures.
newEdDsaSigningHandler(byte[]) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
Use SigningManager.newEdDsaSigningHandler(SigningKey) instead
newEdDsaSigningHandler(SigningKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new handler for signing EdDSA signatures.
newEdDsaVerificationHandler(byte[]) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
Use SigningManager.newEdDsaVerificationHandler(VerificationKey) instead.
newEdDsaVerificationHandler(VerificationKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new handler for verifying EdDSA signatures.
newExceptionPromise(E) - Static method in class org.forgerock.util.promise.Promises: Returns a Promise representing an asynchronous task which has already failed with the provided exception.
newFileBuffer(File, int) - Static method in class org.forgerock.http.io.IO: Creates a new file buffer that uses a local file for data storage.
newForbidden() - Static method in class org.forgerock.http.protocol.Responses: Generates an empty Forbidden response (403).
newHandler(Object) - Static method in class org.forgerock.json.resource.Resources: Creates a new RequestHandler backed by the supplied provider.
newHmacSigningHandler(byte[]) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
use SigningManager.newHmacSigningHandler(SigningKey) instead
newHmacSigningHandler(SecretKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
use SigningManager.newHmacSigningHandler(SigningKey) instead
newHmacSigningHandler(SigningKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new SecretHmacSigningHandler configured for signature validation.
newHmacVerificationHandler(VerificationKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new SecretHmacSigningHandler configured for signature validation.
newHttpBasicAuthenticationFilter(String, SecretReference<GenericSecret>) - Static method in class org.forgerock.http.filter.Filters: Creates an authentication Filter that put a Basic Authorization header in the request.
newHttpBasicAuthenticationFilter(String, SecretReference<GenericSecret>, Charset) - Static method in class org.forgerock.http.filter.Filters: Creates an authentication Filter that put a Basic Authorization header in the request.
newHttpClient(Options) - Method in interface org.forgerock.http.spi.HttpClientProvider: Returns a new HttpClient configured using the provided set of options.
newHttpHandler(ConnectionFactory) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newHttpHandler(ConnectionFactory, HttpContextFactory) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newHttpHandler(ConnectionFactory, Context) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newHttpHandler(CrestApplication) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Since 25.0.0. Prefer to use CrestHttp.newHttpHandler(CrestApplication, Factory) and provide your own factory instead of the default one.
newHttpHandler(CrestApplication, HttpContextFactory) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Since 25.0.0. Prefer to use CrestHttp.newHttpHandler(CrestApplication, HttpContextFactory, Factory) and provide your own factory instead of the default one.
newHttpHandler(CrestApplication, HttpContextFactory, Factory<Buffer>) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new JSON resource HTTP handler with the provided CREST request handler.
newHttpHandler(CrestApplication, Context) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Since 25.0.0. Prefer to use CrestHttp.newHttpHandler(CrestApplication, Context, Factory) and provide your own factory instead of the default one.
newHttpHandler(CrestApplication, Context, Factory<Buffer>) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new JSON resource HTTP handler with the provided CREST request handler.
newHttpHandler(CrestApplication, Factory<Buffer>) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new JSON resource HTTP handler with the provided CREST request handler.
newHttpHandler(RequestHandler) - Static method in class org.forgerock.json.resource.http.CrestHttp: Deprecated.
Use CrestHttp.newHttpHandler(CrestApplication) instead.
newInstance() - Method in interface org.forgerock.util.Factory: Creates and returns a new object instance.
newInstance(Class<?>) - Method in interface org.forgerock.openig.heap.HeapletFactory: Returns a new Heaplet instance that know how to build the given type.
newInstance(String) - Static method in class org.forgerock.util.Loader: Creates a new instance of a named class.
newInstance(String, Class<T>) - Static method in class org.forgerock.util.Loader: Creates a new instance of a named class.
newInstance(JsonValue, Heap) - Static method in class org.forgerock.openig.filter.circuitbreaker.CircuitBreakerFilter.Heaplet: Create a new instance of a CircuitBreakerFilter.
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.jwt.ScriptableJwtValidatorCustomizer.Heaplet
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.oauth2.ScriptableAccessTokenResolver.Heaplet
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.oauth2.ScriptableResourceAccess.Heaplet
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.ScriptableFilter.Heaplet
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy.Heaplet
newInstance(Script, Heap) - Method in class org.forgerock.openig.handler.ScriptableHandler.Heaplet
newInstance(Script, Heap) - Method in class org.forgerock.openig.openam.ScriptableResourceUriProvider.Heaplet
newInstance(Script, Heap) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet: Creates the new heap object instance using the provided script.
newInternalClientContext(Context) - Static method in class org.forgerock.services.context.ClientContext: Creates an internal ClientContext instance.
newInternalConnection(RequestHandler) - Static method in class org.forgerock.json.resource.Resources: Creates a new connection to a RequestHandler.
newInternalConnectionFactory(RequestHandler) - Static method in class org.forgerock.json.resource.Resources: Creates a new connection factory which binds internal client connections to RequestHandlers.
newInternalServerError() - Static method in class org.forgerock.http.protocol.Responses: Generates an empty Internal Server Error response (500).
newInternalServerError(Exception) - Static method in class org.forgerock.http.protocol.Responses: Generates an Internal Server Error response (500) containing the cause of the error response.
newJwksStore(Duration, Duration, URL, JWKSetParser, Clock) - Static method in class org.forgerock.json.jose.jwk.store.JwksStore: Create a new JWKs store asynchronously.
newMemoryBuffer(int, int) - Static method in class org.forgerock.http.io.IO: Creates a new buffer that uses a byte array for data storage.
newNopSigningHandler() - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
This method is inherently insecure and shouldn't be used.
newNotFound() - Static method in class org.forgerock.http.protocol.Responses: Generates an empty Not Found response (404).
newOptionsFilter(String...) - Static method in class org.forgerock.http.filter.Filters: Creates a Filter which handles HTTP OPTIONS method requests.
newPatchRequest(String, String, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource container path, resource ID, and JSON patch operations.
newPatchRequest(String, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource path and JSON patch operations.
newPatchRequest(ResourcePath, String, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource container path, resource ID, and JSON patch operations.
newPatchRequest(ResourcePath, PatchOperation...) - Static method in class org.forgerock.json.resource.Requests: Returns a new patch request with the provided resource path and JSON patch operations.
newPromise(Supplier<V, E>) - Static method in class org.forgerock.util.promise.Promises: Execute a task and return the result as a Promise.
newQueryRequest(String) - Static method in class org.forgerock.json.resource.Requests: Returns a new query request with the provided resource container path.
newQueryRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new query request with the provided resource container path.
newQueryResponse() - Static method in class org.forgerock.json.resource.Responses: Creates a new query result with a null paged results cookie and no count of the total number of remaining results.
newQueryResponse(String) - Static method in class org.forgerock.json.resource.Responses: Creates a new query result with the provided paged results cookie and no count.
newQueryResponse(String, CountPolicy, int) - Static method in class org.forgerock.json.resource.Responses: Creates a new query result with the provided paged results cookie and a count of the total number of remaining results according to totalPagedResultsPolicy.
newReadRequest(String) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource path.
newReadRequest(String, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource container path, and resource ID.
newReadRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource path.
newReadRequest(ResourcePath, String) - Static method in class org.forgerock.json.resource.Requests: Returns a new read request with the provided resource container path, and resource ID.
newReference(Heap, JsonValue, Class<R>, boolean) - Static method in class org.forgerock.openig.decoration.helper.LazyReference: Builds a LazyReference dedicated to resolve the given (optional or not) reference of type type from the given heap.
newRemainingResultsResponse(String, int) - Static method in class org.forgerock.json.resource.Responses: Deprecated.
Use Responses.newQueryResponse(String, CountPolicy, int) instead.
newRequestHandler(Handler, URI) - Static method in class org.forgerock.json.resource.http.CrestHttp: Creates a new RequestHandler that map back and forth JSON resource objects to CHF objects.
newResourceApiVersionBehaviourManager() - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a new ResourceApiVersionBehaviourManager which is responsibly for managing whether warning headers are returned and the default version behaviour when the Accept-API-Version header is not present on the request.
newResourceApiVersionBehaviourManager() - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a new ResourceApiVersionBehaviourManager which is responsibly for managing whether warning headers are returned and the default version behaviour when the Accept-API-Version header is not present on the request.
newResourceException(int) - Static method in exception org.forgerock.json.resource.ResourceException: Returns an exception with the specified HTTP error code, but no detail message or cause, and a default reason phrase.
newResourceException(int, String) - Static method in exception org.forgerock.json.resource.ResourceException: Returns an exception with the specified HTTP error code and detail message, but no cause, and a default reason phrase.
newResourceException(int, String, Throwable) - Static method in exception org.forgerock.json.resource.ResourceException: Returns an exception with the specified HTTP error code, detail message, and cause, and a default reason phrase.
newResourceResponse(String, String, JsonValue) - Static method in class org.forgerock.json.resource.Responses: Returns a new Resource response with the provided Resource as content.
newResourceServerError(String, List<String>, String, String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error: Returns an OAuth 2.0 error suitable for inclusion in resource server WWW-Authenticate response headers.
newResponsePromise(Response) - Static method in class org.forgerock.http.protocol.Response: Returns a Promise representing the Response for an asynchronous Request which has already completed.
newResponsePromiseImpl() - Static method in class org.forgerock.http.protocol.Response: Creates a new pending Promise implementation representing the Response for an asynchronous Request.
newResultPromise(V) - Static method in class org.forgerock.util.promise.Promises: Returns a Promise representing an asynchronous task which has already succeeded with the provided result.
newRsaSigningHandler(Key) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
use SigningManager.newRsaVerificationHandler(VerificationKey) instead
newRsaSigningHandler(SigningKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new SecretRSASigningHandler configured for signature validation.
newRsaVerificationHandler(VerificationKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new SecretRSASigningHandler configured for signature validation.
newRuntimeExceptionPromise(RuntimeException) - Static method in class org.forgerock.util.promise.Promises: Returns a Promise representing an asynchronous task which has already failed with the provided runtime exception.
NEWS - org.forgerock.audit.handlers.syslog.Facility: Network news subsystem.
newSessionFilter(SessionManager) - Static method in class org.forgerock.http.filter.Filters: Deprecated.
newSigningHandler(Key) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
Use SigningManager.newSigningHandler(SigningKey) instead
newSigningHandler(JWK) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns a signing handler from the given JSON Web Key (JWK) which will be used to sign a JWT.
newSigningHandler(JWK, Purpose<SigningKey>) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns a signing handler from the given JSON Web Key (JWK) which will be used to sign a JWT.
newSigningHandler(JWK, Purpose<SigningKey>, Instant) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns a signing handler from the given JSON Web Key (JWK) which will be used to sign a JWT.
newSigningHandler(SigningKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns the signing handler from the given SigningKey which will be used to sign the JWT.
newSigningHandler(Purpose<SigningKey>) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new SigningHandler configured for signing with the provided secret purpose.
newSigningHandler(SecretReference<SigningKey>) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new SigningHandler configured for signing with the provided secret reference.
newSingleton(Object) - Static method in class org.forgerock.json.resource.Resources: Deprecated.
Use Resources.newHandler(Object) instead.
newTemporaryBuffer(int, int, int, File) - Static method in class org.forgerock.http.io.IO: Creates a new temporary buffer that first uses memory, then a temporary file for data storage.
newTemporaryStorage() - Static method in class org.forgerock.http.io.IO: Creates a new storage using the system dependent default temporary directory and default sizes.
newTemporaryStorage(File) - Static method in class org.forgerock.http.io.IO: Builds a storage using the given directory (may be null) and default sizes.
newTemporaryStorage(File, int, int, int) - Static method in class org.forgerock.http.io.IO: Builds a storage using the given directory (may be null) and provided sizes.
newThreadFactory(ThreadGroup, String, boolean) - Static method in class org.forgerock.util.Threads: Creates a new thread factory which will create threads using the specified thread group, naming template, and daemon status.
newThreadFactory(ThreadGroup, String, boolean) - Static method in class org.forgerock.util.Utils: Deprecated.
Use Threads.newThreadFactory(ThreadGroup, String, boolean)
newUpdateRequest(String, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource container path, resource ID, and new JSON content.
newUpdateRequest(String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource path and new JSON content.
newUpdateRequest(CreateRequest) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request built based on the provided create request.
newUpdateRequest(ResourcePath, String, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource container path, resource ID, and new JSON content.
newUpdateRequest(ResourcePath, JsonValue) - Static method in class org.forgerock.json.resource.Requests: Returns a new update request with the provided resource path and new JSON content.
newUrlEncodedHttpBasicAuthFilter(String, SecretReference<GenericSecret>) - Static method in class org.forgerock.http.filter.Filters: Creates an authentication Filter that put a Basic Authorization header in the request.
newVerificationHandler(Key) - Method in class org.forgerock.json.jose.jws.SigningManager: Deprecated.
Use SigningManager.newVerificationHandler(VerificationKey) instead
newVerificationHandler(JWK) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns the signing handler from the given JSON Web Key (JWK) which will be used to verify the JWT.
newVerificationHandler(JWK, Purpose<VerificationKey>) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns a signing handler from the given JSON Web Key (JWK) which will be used to verify a JWT.
newVerificationHandler(JWK, Purpose<VerificationKey>, Instant) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns a signing handler from the given JSON Web Key (JWK) which will be used to verify a JWT.
newVerificationHandler(VerificationKey) - Method in class org.forgerock.json.jose.jws.SigningManager: Returns the signing handler from the given VerificationKey which will be used to verify the JWT.
newVerificationHandler(Purpose<VerificationKey>, String) - Method in class org.forgerock.json.jose.jws.SigningManager: Constructs a new SigningHandler configured for verifying with the provided secret purpose.
newVoidResultPromise() - Static method in class org.forgerock.util.promise.Promises: Returns a Promise representing an asynchronous task which has already succeeded without result.
newWarning(String, String, Object...) - Static method in class org.forgerock.http.header.WarningHeader: Constructs a new warning header with the frequently-used error type: 100.
newWebSocket(WebSocketAdapterConfiguration) - Method in interface org.forgerock.openig.tools.notifications.ws.HttpWebSocketClient: Request the client to create a new WebSocket on the given configuration.
newWebSocketProxyFilter(Options) - Method in interface org.forgerock.openig.websocket.WebSocketProxyFilterProvider: Create a new Filter to manage WebSocket upgrade requests, and manage subsequent communication.
next() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyIterator
next() - Method in class org.forgerock.openig.text.SeparatedValuesReader: Reads the next record from the character input stream.
NO_CONTENT - Static variable in class org.forgerock.http.protocol.Status: The 204 (No Content) status code indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
NO_CONTENT - Static variable in class org.forgerock.openig.handler.Handlers: A default Handler implementation that returns an empty (204 No Content) Response.
NO_COUNT - Static variable in interface org.forgerock.json.resource.QueryResponse: The value provided when no count is known or can reasonably be supplied.
NO_MAX_FILE_SIZE - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: The file size value to use when no maximum is set.
NON_AUTHORITATIVE_INFO - Static variable in class org.forgerock.http.protocol.Status: The 203 (Non-Authoritative Information) status code indicates that the request was successful but the enclosed payload has been modified from that of the origin server's 200 (OK) response by a transforming proxy (Section 5.7.2 of [RFC7230]).
NON_PERSISTENT - org.forgerock.audit.handlers.jms.DeliveryModeConfig: A non-persistent delivery mode.
NONCE - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set nonce key - not available in JwtClaimsSetKey.
none() - Static method in class org.forgerock.http.filter.cors.CorsPolicy.Builder: Rejects any input value.
NONE - org.forgerock.http.protocol.Cookie.SameSite: Some browsers are moving to marking all cookies as SameSite=lax by default and allowing SameSite=none as an option to turn that off.
NONE - org.forgerock.http.routing.DefaultVersionBehaviour: Will not attempt to route to any version of the resource, instead will return an error to the client.
NONE - org.forgerock.json.jose.jwe.CompressionAlgorithm: When no compression is applied.
NONE - org.forgerock.json.jose.jws.JwsAlgorithm: Deprecated.
This algorithm is inherently insecure and should not be used.
NONE - org.forgerock.json.jose.jws.JwsAlgorithmType: Deprecated.
This algorithm is inherently insecure and shouldn't be used.
NONE - org.forgerock.json.resource.CountPolicy: There should be no count returned.
NONE - org.forgerock.openig.decoration.capture.CapturePoint: Disable the capture.
NONE - org.forgerock.openig.tools.ServerTlsOptions.ClientAuthentication: Client authentication not required.
NonExpiringCache<K,V> - Class in org.forgerock.util: Allows the Caching of an object.
NonExpiringCache() - Constructor for class org.forgerock.util.NonExpiringCache
NOOP_ROLLOVER_LIFECYCLE_HOOK - Static variable in class org.forgerock.audit.events.handlers.writers.RotatableWriter: A RolloverLifecycleHook that does nothing.
NoOpAuditEventHandler - Class in org.forgerock.audit.events.handlers: An event handler that does nothing.
NoOpAuditEventHandler() - Constructor for class org.forgerock.audit.events.handlers.NoOpAuditEventHandler: Default constructor.
NoOpAuditService - Class in org.forgerock.openig.audit: Used as a no-op placeholder for an AuditService which can be overridden via config.
NoOpAuditService() - Constructor for class org.forgerock.openig.audit.NoOpAuditService
NoOpAuditService.Heaplet - Class in org.forgerock.openig.audit: Creates a NoOpAuditService in a heap environment.
noopExceptionAsyncFunction() - Static method in class org.forgerock.http.protocol.Responses: Utility method returning an empty async function, whose goal is to ease the transformation of a Promise type.
noopExceptionFunction() - Static method in class org.forgerock.http.protocol.Responses: Utility method returning an empty function, whose goal is to ease the transformation of a Promise type.
NoOpRotatationHooks() - Constructor for class org.forgerock.audit.rotation.RotationHooks.NoOpRotatationHooks
NOPCompressionHandler - Class in org.forgerock.json.jose.jwe.handlers.compression: A NOP implementation of the Compression Handler, which will be used when no compression is to be applied.
NOPCompressionHandler() - Constructor for class org.forgerock.json.jose.jwe.handlers.compression.NOPCompressionHandler
NoProxyOptions - Class in org.forgerock.openig.proxy: A ProxyOptions to use when no proxy must be used.
NoProxyOptions.Heaplet - Class in org.forgerock.openig.proxy: Creates and initializes a NoProxyOptions in a heap environment.
NoProxyOptionsTypeProvider - Class in org.forgerock.openig.proxy: Provide the NoProxyOptions's TypeDefinition.
NoProxyOptionsTypeProvider() - Constructor for class org.forgerock.openig.proxy.NoProxyOptionsTypeProvider
NOPSigningHandler - Class in org.forgerock.json.jose.jws.handlers: Deprecated.
This algorithm is inherently insecure and shouldn't be used.
NOPSigningHandler() - Constructor for class org.forgerock.json.jose.jws.handlers.NOPSigningHandler: Deprecated.
NORMALIZED_FIELD - Static variable in class org.forgerock.audit.util.ElasticsearchUtil: JSON field-name of metadata to assist in de-normalization.
normalizeJson(JsonValue) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Normalizes JSON to conform to Elasticsearch data-format restrictions.
normalizeJsonPointer(JsonPointer) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Replaces periods in JsonPointer keys with underscore.
NoSuchSecretException - Exception in org.forgerock.secrets: Indicates that no secret was configured for the given purpose, or the named secret is not available.
NoSuchSecretException(String) - Constructor for exception org.forgerock.secrets.NoSuchSecretException: Constructs the exception for the given purpose and secret stable id.
NoSuchSecretException(Purpose<?>) - Constructor for exception org.forgerock.secrets.NoSuchSecretException: Constructs the exception for the given purpose.
NoSuchSecretException(Purpose<?>, String) - Constructor for exception org.forgerock.secrets.NoSuchSecretException: Constructs the exception for the given purpose and secret stable id.
not(FilterCondition) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will match requests which do not match the provided condition.
not(QueryFilter<FF>) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new not filter using the provided sub-filter.
NOT - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "or" operator.
NOT_ACCEPTABLE - Static variable in class org.forgerock.http.protocol.Status: The 406 (Not Acceptable) status code indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request (Section 5.3), and the server is unwilling to supply a default representation.
NOT_FOUND - Static variable in class org.forgerock.http.protocol.Status: The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
NOT_FOUND - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource could not be found.
NOT_IMPLEMENTED - Static variable in class org.forgerock.http.protocol.Status: The 501 (Not Implemented) status code indicates that the server does not support the functionality required to fulfill the request.
NOT_PRESENT - Static variable in class org.forgerock.http.header.WarningHeader: 100 Indicates that there is data missing from the request.
NOT_PRESENT - Static variable in class org.forgerock.json.resource.AdviceWarning: 100 Indicates that there is data missing from the request.
NOT_SUPPORTED - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource does not implement/support the feature to fulfill the request HTTP status: 501 Not Implemented.
NotFoundException - Exception in org.forgerock.json.resource: An exception that is thrown when a specified resource cannot be found.
NotFoundException() - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with null as its detail message.
NotFoundException(String) - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with the specified detail message.
NotFoundException(String, Throwable) - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with the specified detail message and cause.
NotFoundException(Throwable) - Constructor for exception org.forgerock.json.resource.NotFoundException: Constructs a new exception with the specified cause.
NOTICE - org.forgerock.audit.handlers.syslog.Severity: Normal but significant condition.
Notification - Class in org.forgerock.openig.tools.notifications: A Notification is a special message that AM send to its "agents" to notify the occurrence of an event.
Notification(Instant, String, JsonValue) - Constructor for class org.forgerock.openig.tools.notifications.Notification: Creates a notification that happened at timestamp, on the given topic with the given body.
notificationClientProvider(WebSocketClientProvider) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Specifies the WebSocketClientProvider to use to manage notifications.
NotificationListener - Interface in org.forgerock.openig.tools.notifications: Listen to topic notification.
NotificationsConstants - Class in org.forgerock.openig.tools.notifications.ws: Class providing constants used in AM notifications support.
notificationService(NotificationService) - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver.Builder: Bind a NotificationService instance to this builder.
notificationService(NotificationService) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Bind a NotificationService instance to this builder.
NotificationService - Interface in org.forgerock.openig.tools.notifications: Represents a source of notifications.
NotificationService.Registration - Interface in org.forgerock.openig.tools.notifications: Represents the connection event listener registration.
notificationServiceConnectionAttempts(Integer) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Specifies the number of Websocket connection attempts to try before failing the AmService creation.
notificationServiceHeartbeat(Duration, ScheduledExecutorService) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Set up heartbeats sent to AM to keep the connection busy.
NotificationServiceImpl - Class in org.forgerock.openig.tools.notifications.ws: NotificationService implementation.
NotificationServiceImpl(HttpWebSocketClient, URI, IdGenerator, String, AsyncRefreshableSupplier<SsoToken, AuthenticationException>, Duration, int, Duration, ScheduledExecutorService) - Constructor for class org.forgerock.openig.tools.notifications.ws.NotificationServiceImpl: Constructs a NotificationService implementation.
notificationServiceProxyOptions(ProxyOptions) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Specifies the ProxyOptions to use for the websocket connection.
notificationServiceReconnectDelay(Duration) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Specifies the delay to wait between connection re-establishments when web-socket connection is lost (or cannot be acquired at startup).
notificationServiceTls(ClientTlsOptions) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Specifies the TLS options to use for establishing a connection to the Web-socket endpoint.
notifyDescriptorChange() - Method in interface org.forgerock.services.descriptor.Describable.Listener: Implement this method to handle changes to API Descriptors.
notifyDescriptorChange() - Method in class org.forgerock.services.routing.AbstractRouter
notifyImpendingIgRedirect() - Method in class org.forgerock.openig.filter.AuthRedirectContext: Warn that an impending IG redirection has been attempted.
notSupported(Request) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil: Creates a NotSupportedException.
NotSupportedException - Exception in org.forgerock.json.resource: An exception that is thrown during an operation on a resource when the resource does not implement/support the feature to fulfill the request.
NotSupportedException() - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with null as its detail message.
NotSupportedException(String) - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with the specified detail message.
NotSupportedException(String, Throwable) - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with the specified detail message and cause.
NotSupportedException(Throwable) - Constructor for exception org.forgerock.json.resource.NotSupportedException: Constructs a new exception with the specified cause.
NotSupportedFilter - Class in org.forgerock.openig.tools: A convenient implementation of a CREST Filter that just returns a NotSupportedException for all the methods implementations.
NotSupportedFilter() - Constructor for class org.forgerock.openig.tools.NotSupportedFilter
notSupportedOnCollection(Request) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil: Creates a NotSupportedException.
notSupportedOnInstance(Request) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil: Creates a NotSupportedException.
NTP - org.forgerock.audit.handlers.syslog.Facility: NTP subsystem.
NULL_FIRST - org.forgerock.json.resource.SortKeyComparator.NullPosition: A JsonValue that wraps a null object is considered less than one that is not.
NULL_LAST - org.forgerock.json.resource.SortKeyComparator.NullPosition: A JsonValue that wraps a null object is considered more than one that is not.
nullInputStream() - Static method in class org.forgerock.http.io.IO: Returns an input stream that holds no data.
nullOutputStream() - Static method in class org.forgerock.http.io.IO: Returns an output stream that discards all data written to it.
NullResponseFilter - Class in org.forgerock.openig.handler.router: This class is used to filter null responses.
NullResponseFilter() - Constructor for class org.forgerock.openig.handler.router.NullResponseFilter
NullRetentionHooks() - Constructor for class org.forgerock.audit.retention.RetentionHooks.NullRetentionHooks
NUMBER_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json number value type.

O

oauth2(String) - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /oauth2 namespace.
oauth2(String) - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /oauth2 namespace.
OAuth2 - Class in org.forgerock.http.oauth2: OAuth2 utility class.
OAuth2BearerWWWAuthenticateHeader - Class in org.forgerock.openig.filter.oauth2.client: Processes the OAuth 2.0 Bearer WWW-Authenticate message header.
OAuth2BearerWWWAuthenticateHeader() - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader: Constructs a new empty header.
OAuth2BearerWWWAuthenticateHeader(OAuth2Error) - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader: Constructs a new header with the provided error.
OAuth2ClassAliasResolver - Class in org.forgerock.openig.filter.oauth2: Register all the aliases supported by the openig-oauth2 module.
OAuth2ClassAliasResolver() - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
OAuth2ClientFilter - Class in org.forgerock.openig.filter.oauth2.client: A filter which is responsible for authenticating the end-user using OAuth 2.0 delegated authorization.
OAuth2ClientFilter(ClientRegistrationRepository, PerItemEvictionStrategyCache<String, Promise<Map<String, Object>, OAuth2ErrorException>>, UriValidationService, Clock, Handler, Expression<String>) - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Constructs an OAuth2ClientFilter.
OAuth2ClientFilter.Heaplet - Class in org.forgerock.openig.filter.oauth2.client: Creates and initializes the filter in a heap environment.
OAuth2Context - Class in org.forgerock.http.oauth2: An OAuth2Context could be used to store and retrieve an AccessTokenInfo.
OAuth2Context(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.oauth2.OAuth2Context: Creates a new context from the JSON representation of a previously persisted context.
OAuth2Context(Context, AccessTokenInfo) - Constructor for class org.forgerock.http.oauth2.OAuth2Context: Creates a new OAuth2 context with the provided AccessTokenInfo.
OAuth2Error - Class in org.forgerock.http.oauth2: Describes an error which occurred during an OAuth 2.0 authorization request or when performing an authorized request.
OAuth2ErrorException - Exception in org.forgerock.openig.filter.oauth2.client: An exception that is thrown when OAuth 2.0 request fails.
OAuth2ErrorException(String, String) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException: Creates a new exception with the provided OAuth 2.0 error code and optional description.
OAuth2ErrorException(String, String, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException: Creates a new exception with the provided OAuth 2.0 error code, optional description, and cause.
OAuth2ErrorException(OAuth2Error) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException: Creates a new exception with the provided OAuth 2.0 error.
OAuth2ErrorException(OAuth2Error, String) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException: Creates a new exception with the provided OAuth 2.0 error.
OAuth2ErrorException(OAuth2Error, String, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException: Creates a new exception with the provided OAuth 2.0 error.
OAuth2ErrorException(OAuth2Error, Throwable) - Constructor for exception org.forgerock.openig.filter.oauth2.client.OAuth2ErrorException: Creates a new exception with the provided OAuth 2.0 error.
OAuth2FailureContext - Class in org.forgerock.openig.filter.oauth2: Context implementation to hold OAuth2 error details, should a failure occur during OAuth2 scenarios.
OAuth2ResourceServerFilterHeaplet - Class in org.forgerock.openig.filter.oauth2: Validates a Request that contains an OAuth 2.0 access token.
OAuth2ResourceServerFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet
OAuth2ResourceServerFilterTypeProvider - Class in org.forgerock.openig.filter.oauth2: Provide a TypeDefinitionProvider for OAuth2ResourceServer.
OAuth2ResourceServerFilterTypeProvider() - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterTypeProvider
OAuth2SessionContext - Class in org.forgerock.openig.filter.oauth2.client: This context helps to manage the OAuth2Session when used with OAuth2ClientFilter.
OAuth2TokenExchangeContext - Class in org.forgerock.openig.filter.oauth2: Context supporting OAuth2 token exchange scenarios, this manages the resulting exchange token.
OAuth2TokenExchangeFilter - Class in org.forgerock.openig.filter.oauth2: Filter supporting OAuth2 token exchange scenarios.
OAuth2TokenExchangeFilter(URI, Handler, Expression<String>, String, String, ResourceAccess, URI, String, Handler) - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2TokenExchangeFilter: Construct a new OAuth2TokenExchangeFilter.
OAuth2TokenExchangeFilter.Heaplet - Class in org.forgerock.openig.filter.oauth2: Creates and initialises an OAuth2TokenExchangeFilter in a heap environment.
oauth2Uri(String) - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /oauth2 namespace.
oauth2Uri(String) - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /oauth2 namespace.
object - Variable in class org.forgerock.openig.decoration.helper.DecoratorHeaplet: The object created by the heaplet's DecoratorHeaplet.create() method.
object - Variable in class org.forgerock.openig.heap.GenericHeaplet: The object created by the heaplet's GenericHeaplet.create() method.
object(int) - Static method in class org.forgerock.json.JsonValue: Produces an empty JSON object pre-allocated for size fields.
object(Map.Entry<String, Object>...) - Static method in class org.forgerock.json.JsonValue: Returns a JSON object comprised of the provided JSON fields.
OBJECT_MAPPER - Static variable in class org.forgerock.audit.util.ElasticsearchUtil: Jackson ObjectMapper for working with JSON.
OBJECT_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json Object value type.
ObjectMapperKeyValueProcessor - Class in org.forgerock.openig.decoration.capture: Attempt to deserialize the Object into its String representation.
ObjectMapperKeyValueProcessor() - Constructor for class org.forgerock.openig.decoration.capture.ObjectMapperKeyValueProcessor
Objects - Class in org.forgerock.util: Common utility methods for Objects.
obtainReadLock() - Method in class org.forgerock.audit.AuditServiceProxy: Obtain the read lock or block until it becomes available.
obtainWriteLock() - Method in class org.forgerock.audit.AuditServiceProxy: Obtain the write lock or block until it becomes available.
OCT - org.forgerock.json.jose.jwk.KeyType: Octet Key.
OctJWK - Class in org.forgerock.json.jose.jwk: Creates an Octet JWK.
OctJWK(String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.OctJWK: Deprecated.
Use the builder instead.
OctJWK.Builder - Class in org.forgerock.json.jose.jwk: The Octet JWK builder.
of(F, S) - Static method in class org.forgerock.util.Pair: Creates a new Pair.
of(Class<?>) - Static method in class org.forgerock.openig.heap.Name: Builds a new Name for the given type.
of(Class<T>, T) - Static method in class org.forgerock.util.Option: Defines an option with the provided type and default value.
of(String) - Static method in class org.forgerock.openig.tools.am.Version: Parse an input string, decomposing it in its base elements (major, minor, micro).
of(String...) - Static method in class org.forgerock.openig.heap.Name: Builds a new Name using the given name parts.
offer(String, JsonValue) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisher: Offers up an event to be added to a batch.
offer(String, JsonValue) - Method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returning true upon success and false if this queue is full.
ofKey(Key) - Static method in enum org.forgerock.secrets.keys.KeyType: Returns the type of the given key, or null if the input is null or not recognised.
OK - Static variable in class org.forgerock.http.protocol.Status: The 200 (OK) status code indicates that the request has succeeded.
OKP - org.forgerock.json.jose.jwk.KeyType: Octet key-pair.
OkpJWK - Class in org.forgerock.json.jose.jwk: An Octet Key-Pair (OKP) JWK as defined in RFC 8037.
OkpJWK.Builder - Class in org.forgerock.json.jose.jwk: Builder object for Octet Key-Pair (OKP) JWKs.
OLDEST - org.forgerock.http.routing.DefaultVersionBehaviour: Will route to the oldest version of the resource.
onChange(BiConsumer<Path, WatchEvent.Kind<Path>>) - Method in class org.forgerock.util.DirectoryWatcher.ChangeListener: Registers a listener to be notified of change events for this directory.
onChanges(FileChangeSet) - Method in class org.forgerock.openig.handler.router.RouterHandler
onClose() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionService: Means of notifying the SubscriptionService that a notification provider has closed.
onComplete() - Method in class org.forgerock.http.protocol.MdcAwareSubscriber
onElementsRemoved() - Method in interface org.forgerock.openig.session.jwt.dirty.DirtyListener: Called when one or more element from the underlying Map are removed.
onError(Throwable) - Method in class org.forgerock.http.protocol.MdcAwareSubscriber
onError(Throwable) - Method in class org.forgerock.openig.reactive.MdcAwareSingleObserver
onExceptionInternalServerError() - Static method in class org.forgerock.http.protocol.Responses: Utility function that returns a Response whose status is Status.INTERNAL_SERVER_ERROR and the exception attached to the response as the cause.
onMessage(JsonValue) - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionService: Means of supplying the SubscriptionService with subscription and notification messages.
onNext(T) - Method in class org.forgerock.http.protocol.MdcAwareSubscriber
onNotification(Notification) - Method in interface org.forgerock.openig.tools.notifications.NotificationListener: Receive the notifications as soon as they arrive.
onOpen(WebSocketAdapter) - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionService: Means of notifying the SubscriptionService that a notification provider available.
onOverflow(Runnable) - Method in class org.forgerock.util.DirectoryWatcher.ChangeListener: Registers a callback to be notified when the underlying watch service lost some change events due to overflow.
onSubscribe(Disposable) - Method in class org.forgerock.openig.reactive.MdcAwareSingleObserver
onSubscribe(Subscription) - Method in class org.forgerock.http.protocol.MdcAwareSubscriber
onSuccess(T) - Method in class org.forgerock.openig.reactive.MdcAwareSingleObserver
OP_PTR - Static variable in class org.forgerock.json.JsonPatch: Path to the "op" attribute of a patch entry.
open() - Method in interface org.forgerock.openig.handler.resources.Resource: Returns a new InputStream used to read resource's content.
OpenAmAccessTokenResolver - Class in org.forgerock.http.oauth2.resolver: Deprecated.
The “/oauth2/tokeninfo” endpoint was deprecated in AM 6.5. OpenAmAccessTokenResolver is deprecated and should not be used.
OpenAmAccessTokenResolver(Handler, Clock, String) - Constructor for class org.forgerock.http.oauth2.resolver.OpenAmAccessTokenResolver: Deprecated.

Creates a new OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo OpenAm endpoint.
OpenAmAccessTokenResolverHeaplet - Class in org.forgerock.openig.filter.oauth2: Deprecated.
in 7.0. The "/oauth2/tokeninfo" endpoint was deprecated in AM 6.5.
OpenAmAccessTokenResolverHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.OpenAmAccessTokenResolverHeaplet: Deprecated.
OpenAMClassAliasResolver - Class in org.forgerock.openig.openam: Register all the aliases supported by the openig-openam module.
OpenAMClassAliasResolver() - Constructor for class org.forgerock.openig.openam.OpenAMClassAliasResolver
OpenApiRequestFilter - Class in org.forgerock.http.swagger: This filter looks for the query parameter {code _api} : if present then it returns the API description of the downstream handlers, otherwise the request is processed as expected.
OpenApiRequestFilter() - Constructor for class org.forgerock.http.swagger.OpenApiRequestFilter
openHandler(Consumer<WebSocketAdapter>) - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Supply an open handler executed once the websocket connection is established and completed.
operation(String, String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new patch operation having the specified operation type, field, and value(s).
operation(String, JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new patch operation having the specified operation type, field, and value(s).
OPERATION - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The operation event payload field name.
OPERATION_ADD - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "add" operations.
OPERATION_COPY - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "copy" operations.
OPERATION_INCREMENT - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "increment" operations.
OPERATION_MOVE - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "move" operations.
OPERATION_REMOVE - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "remove" operations.
OPERATION_REPLACE - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "replace" operations.
OPERATION_TRANSFORM - Static variable in class org.forgerock.json.resource.PatchOperation: The identifier used for "transform" operations.
Option<T> - Class in org.forgerock.util: A configuration option whose value can be stored in a set of Options.
OPTION_CONNECT_TIMEOUT - Static variable in class org.forgerock.http.handler.HttpClientHandler: The TCP connect timeout for new HTTP connections.
OPTION_DISABLE_CONNECTION_STATE - Static variable in class org.forgerock.http.handler.HttpClientHandler: This option is only taken into account when OPTION_REUSE_CONNECTIONS is also set to true.
OPTION_HOSTNAME_VERIFIER - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the SSL host name verification policy.
OPTION_KEY_MANAGER_FACTORY - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the key manager factory that should be used when configuring SSL/TLS connections.
OPTION_KEY_MANAGERS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the list of key managers that should be used when configuring SSL/TLS connections.
OPTION_LOADER - Static variable in class org.forgerock.http.handler.HttpClientHandler: The strategy which should be used for loading the HttpClientProvider.
OPTION_MAX_CONNECTIONS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the maximum number of connections that should be pooled by the HTTP client.
OPTION_NON_PROXY_HOSTS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the list of hosts for which requests should not be proxied.
OPTION_POOLED_CONNECTION_TTL - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the time to live (expiry time) in milliseconds of connections from the pool.
OPTION_PROXY - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies a proxy to use for requests by the HTTP Client.
OPTION_PROXY_SYSTEM - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies that the system defined proxy should be used for requests by the HTTP Client.
OPTION_RETRY_REQUESTS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies whether requests should be retried if a failure is detected.
OPTION_REUSE_CONNECTIONS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies whether HTTP connections should be kept alive and reused for additional requests.
OPTION_SO_TIMEOUT - Static variable in class org.forgerock.http.handler.HttpClientHandler: The TCP socket timeout when waiting for HTTP responses.
OPTION_SSL_CIPHER_SUITES - Static variable in class org.forgerock.http.handler.HttpClientHandler: List of JSSE ciphers to be enabled on the HttpClient.
OPTION_SSL_ENABLED_PROTOCOLS - Static variable in class org.forgerock.http.handler.HttpClientHandler: List of SSL protocols to be enabled on the HttpClient.
OPTION_SSLCONTEXT_ALGORITHM - Static variable in class org.forgerock.http.handler.HttpClientHandler: SSLContext algorithm to be used when making SSL/TLS connections.
OPTION_TEMPORARY_STORAGE - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the temporary storage that should be used for storing HTTP responses.
OPTION_TRUST_MANAGER_FACTORY - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the trust manager factory that should be used when configuring SSL/TLS connections.
OPTION_TRUST_MANAGERS - Static variable in class org.forgerock.http.handler.HttpClientHandler: Specifies the list of trust managers that should be used when configuring SSL/TLS connections.
optional() - Static method in class org.forgerock.openig.util.JsonValues: Returns a function returning an Optional JsonValue if the value is null or undefined.
optionalHeapObject(Heap, Class<T>) - Static method in class org.forgerock.openig.util.JsonValues: Returns a Function to transform a list of String-based JsonValues into a list of optional heap objects.
optionalOf(Function<JsonValue, T, JsonValueException>) - Static method in class org.forgerock.openig.util.JsonValues: Returns a wrapping function returning an Optional result of the given delegate function.
Options - Class in org.forgerock.util: A set of options which can be used for customizing the behavior of HTTP clients and servers.
OptionsFilter - Class in org.forgerock.http.filter: Filter which handles OPTION HTTP requests to CREST resources.
or(Collection<FilterCondition>) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will match requests which match any of the provided conditions.
or(Collection<QueryFilter<FF>>) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new or filter using the provided list of sub-filters.
or(FilterCondition...) - Static method in class org.forgerock.json.resource.Filters: Returns a FilterCondition which will match requests which match any of the provided conditions.
or(QueryFilter<FF>...) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new or filter using the provided list of sub-filters.
OR - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "not" operator.
ORACLE - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: The name used for an Oracle database.
org.forgerock.audit - package org.forgerock.audit: Package contains the AuditService.
org.forgerock.audit.batch - package org.forgerock.audit.batch: Package contains common audit batch configuration files.
org.forgerock.audit.events - package org.forgerock.audit.events: Package contains audit events.
org.forgerock.audit.events.handlers - package org.forgerock.audit.events.handlers: This package contains the default AuditEventHandlers.
org.forgerock.audit.events.handlers.buffering - package org.forgerock.audit.events.handlers.buffering: This package contains the batch publisher and its various implementations.
org.forgerock.audit.events.handlers.writers - package org.forgerock.audit.events.handlers.writers: Utility classes for writing streams of characters.
org.forgerock.audit.filter - package org.forgerock.audit.filter: Contains the classes for filtering audit events.
org.forgerock.audit.handlers.csv - package org.forgerock.audit.handlers.csv: This package contains the default AuditEventHandler implementations.
org.forgerock.audit.handlers.elasticsearch - package org.forgerock.audit.handlers.elasticsearch: This package contains the Elasticsearch AuditEventHandler implementation.
org.forgerock.audit.handlers.jdbc - package org.forgerock.audit.handlers.jdbc: This package contains a JDBC AuditEventHandler implementation.
org.forgerock.audit.handlers.jms - package org.forgerock.audit.handlers.jms: This package contains a JMS AuditEventHandler implementation.
org.forgerock.audit.handlers.json - package org.forgerock.audit.handlers.json: This package contains the JSON-file AuditEventHandler implementation.
org.forgerock.audit.handlers.splunk - package org.forgerock.audit.handlers.splunk: This package contains the audit handler implementation for Splunk.
org.forgerock.audit.handlers.syslog - package org.forgerock.audit.handlers.syslog: This package contains a Syslog AuditEventHandler implementation.
org.forgerock.audit.json - package org.forgerock.audit.json: This package contains utilities to build and configure audit service and handlers from JSON configuration.
org.forgerock.audit.providers - package org.forgerock.audit.providers: Dependencies that can be made available to the AuditService via a DependencyProvider.
org.forgerock.audit.retention - package org.forgerock.audit.retention: File retention classes.
org.forgerock.audit.rotation - package org.forgerock.audit.rotation: Audit log file rotation classes.
org.forgerock.audit.secure - package org.forgerock.audit.secure: Classes for handling secure audit logging.
org.forgerock.audit.util - package org.forgerock.audit.util: This package contains utility classes used in the audit service.
org.forgerock.http - package org.forgerock.http: Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.decoder - package org.forgerock.http.decoder: Decodes HTTP entities that are compressed or encoded.
org.forgerock.http.filter - package org.forgerock.http.filter: Core Filter implementations.
org.forgerock.http.filter.cors - package org.forgerock.http.filter.cors: Support for CORS.
org.forgerock.http.handler - package org.forgerock.http.handler: Core Handler implementations.
org.forgerock.http.header - package org.forgerock.http.header: Processes HTTP message header fields.
org.forgerock.http.header.authorization - package org.forgerock.http.header.authorization: Credentials classes for use with the AuthorizationHeader.
org.forgerock.http.io - package org.forgerock.http.io: Provides stream buffering, branching, and storage functions.
org.forgerock.http.oauth2 - package org.forgerock.http.oauth2: This package provides APIs for OAuth 2.0 services implementations.
org.forgerock.http.oauth2.resolver - package org.forgerock.http.oauth2.resolver: This package defines OpenAM specific logic needed to retrieve an AccessTokenInfo.
org.forgerock.http.protocol - package org.forgerock.http.protocol: Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.routing - package org.forgerock.http.routing: Provides routing functionality for HTTP requests.
org.forgerock.http.servlet - package org.forgerock.http.servlet: Integrates with the Java Enterprise Edition Servlet API.
org.forgerock.http.session - package org.forgerock.http.session: Provides interfaces for managing and interacting with HTTP Sessions.
org.forgerock.http.spi - package org.forgerock.http.spi: HTTP service provider API.
org.forgerock.http.swagger - package org.forgerock.http.swagger: Classes to support OpenAPI API Descriptions using Swagger.
org.forgerock.http.util - package org.forgerock.http.util: Miscellaneous utility classes.
org.forgerock.json - package org.forgerock.json: Provides an API for the traversal and manipulation of JSON object model structures in Java.
org.forgerock.json.jose.builders - package org.forgerock.json.jose.builders: Classes and interfaces for builder to build JWTs using a fluent API.
org.forgerock.json.jose.common - package org.forgerock.json.jose.common: Common classes and interfaces for all types of JWTs.
org.forgerock.json.jose.exceptions - package org.forgerock.json.jose.exceptions: Exceptions for all possible JWT exception scenarios.
org.forgerock.json.jose.jwe - package org.forgerock.json.jose.jwe: Classes and interfaces for JWT encryption and JWEs.
org.forgerock.json.jose.jwe.handlers.compression - package org.forgerock.json.jose.jwe.handlers.compression: Compression Handler classes for each possible compression algorithm.
org.forgerock.json.jose.jwe.handlers.encryption - package org.forgerock.json.jose.jwe.handlers.encryption: Encryption Handler classes for each possible encryption algorithm.
org.forgerock.json.jose.jwk - package org.forgerock.json.jose.jwk: Classes and interfaces for creating and manipulating JWKs.
org.forgerock.json.jose.jwk.store - package org.forgerock.json.jose.jwk.store: This package contains classes to manage a JWKs URI.
org.forgerock.json.jose.jws - package org.forgerock.json.jose.jws: Classes and interfaces for JWT signing and JWS'.
org.forgerock.json.jose.jws.handlers - package org.forgerock.json.jose.jws.handlers: Signing Handler classes for each possible signing algorithm.
org.forgerock.json.jose.jwt - package org.forgerock.json.jose.jwt: Classes and interfaces for JWTs.
org.forgerock.json.jose.tokenhandler - package org.forgerock.json.jose.tokenhandler: JWT implementation(s) of TokenHandler.
org.forgerock.json.jose.utils - package org.forgerock.json.jose.utils: Utility classes for JWT creation and manipulation.
org.forgerock.json.resource - package org.forgerock.json.resource: Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.json.resource.http - package org.forgerock.json.resource.http: JSON resource Commons HTTP Framework integration.
org.forgerock.openig.alias - package org.forgerock.openig.alias: Service Provider interface for registering type aliases.
org.forgerock.openig.audit - package org.forgerock.openig.audit: Service Provider interface for registering audit events.
org.forgerock.openig.config - package org.forgerock.openig.config: Performs dynamic configuration bootstrap, discovery and input/output functions.
org.forgerock.openig.config.env - package org.forgerock.openig.config.env: Different Environment implementations.
org.forgerock.openig.decoration - package org.forgerock.openig.decoration: Decorator API to ease heap object customization and transformation.
org.forgerock.openig.decoration.baseuri - package org.forgerock.openig.decoration.baseuri: Contains a decorator which overrides the existing request URI, making requests relative to a new base URI.
org.forgerock.openig.decoration.capture - package org.forgerock.openig.decoration.capture: Capture decoration classes that prints filters and handlers input and output messages.
org.forgerock.openig.decoration.global - package org.forgerock.openig.decoration.global: This package contains a special decorator that is responsible to invoke other decorators.
org.forgerock.openig.decoration.helper - package org.forgerock.openig.decoration.helper: Contains an abstract decorator dedicated to Filter and Handler.
org.forgerock.openig.decoration.timer - package org.forgerock.openig.decoration.timer: Contains a decorator that log time elapsed in a Filter or a Handler.
org.forgerock.openig.el - package org.forgerock.openig.el: Integrates with the Java Enterprise Edition Unified Expression Language API.
org.forgerock.openig.el.plugins - package org.forgerock.openig.el.plugins: Plugins that provide expression context.
org.forgerock.openig.filter - package org.forgerock.openig.filter: Filters the requests and/or responses of HTTP.
org.forgerock.openig.filter.allow - package org.forgerock.openig.filter.allow: Filters the HTTP request using a declarative configuration model based on a chain of predicates to validate.
org.forgerock.openig.filter.circuitbreaker - package org.forgerock.openig.filter.circuitbreaker: This package contains the components used to implement circuit breaking.
org.forgerock.openig.filter.finance - package org.forgerock.openig.filter.finance: Support for financial APIs (Open Banking, PSD2, Berlin Group, ...).
org.forgerock.openig.filter.jwt - package org.forgerock.openig.filter.jwt: This package contains the components used to implement some JWT related filter.
org.forgerock.openig.filter.oauth2 - package org.forgerock.openig.filter.oauth2: This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
org.forgerock.openig.filter.oauth2.client - package org.forgerock.openig.filter.oauth2.client: OAuth 2.0 Client filter implementation.
org.forgerock.openig.filter.oauth2.client.authentication - package org.forgerock.openig.filter.oauth2.client.authentication: Collection of heaplets supporting OAuth2 client authentication Filters.
org.forgerock.openig.filter.oauth2.cnf - package org.forgerock.openig.filter.oauth2.cnf: JWT confirmation key support for access tokens.
org.forgerock.openig.filter.oauth2.decoration - package org.forgerock.openig.filter.oauth2.decoration: Decoration for the oauth2 package: AccessTokenResolver, etc.
org.forgerock.openig.filter.throttling - package org.forgerock.openig.filter.throttling: This package contains the components used to implement a throttling rate support.
org.forgerock.openig.handler - package org.forgerock.openig.handler: Handles HTTP requests by generating responses.
org.forgerock.openig.handler.resources - package org.forgerock.openig.handler.resources: Contains components and APIs used to serve static resources.
org.forgerock.openig.handler.router - package org.forgerock.openig.handler.router: Provides automated router capability that loads its configurations files (called routes) from a given directory.
org.forgerock.openig.handler.saml - package org.forgerock.openig.handler.saml: Identity Gateway SAML support.
org.forgerock.openig.heap - package org.forgerock.openig.heap: Manages collections or "heaps" of associated objects, initialized from declarative configuration artifacts.
org.forgerock.openig.http - package org.forgerock.openig.http: Integrates with the ForgeRock HTTP Framework.
org.forgerock.openig.io - package org.forgerock.openig.io: Provides stream buffering, branching, and storage functions.
org.forgerock.openig.ldap - package org.forgerock.openig.ldap: Facilitates access to the OpenDJ LDAP SDK from within scripts.
org.forgerock.openig.openam - package org.forgerock.openig.openam: Integration classes specifically for ForgeRock Access Management.
org.forgerock.openig.openam.session - package org.forgerock.openig.openam.session: AM Session idle timeout tracking.
org.forgerock.openig.proxy - package org.forgerock.openig.proxy: Contains proxy related heaplets.
org.forgerock.openig.reactive - package org.forgerock.openig.reactive: Contains RxJava specific tools.
org.forgerock.openig.regex - package org.forgerock.openig.regex: Matches, extracts and transforms text with regular expression patterns.
org.forgerock.openig.resolver - package org.forgerock.openig.resolver: Performs object resolution for dynamic expression and script integration.
org.forgerock.openig.script - package org.forgerock.openig.script: Scripting support.
org.forgerock.openig.secrets - package org.forgerock.openig.secrets: Provides the Common Secrets API for accessing secrets of various kinds.
org.forgerock.openig.security - package org.forgerock.openig.security: Provides heap objects for security related types (KeyStore, KeyManagerFactory, ...).
org.forgerock.openig.session.jwt - package org.forgerock.openig.session.jwt: Manage the Identity Gateway session.
org.forgerock.openig.session.jwt.dirty - package org.forgerock.openig.session.jwt.dirty: Set of collection delegating classes to observes whenever a Map element is removed.
org.forgerock.openig.sql - package org.forgerock.openig.sql: Provides SQL and JDBC support.
org.forgerock.openig.text - package org.forgerock.openig.text: Processes structured text in streams and files.
org.forgerock.openig.thread - package org.forgerock.openig.thread: Provides heaplets for creating thread pools.
org.forgerock.openig.tools - package org.forgerock.openig.tools: Common tools used in policy service.
org.forgerock.openig.tools.am - package org.forgerock.openig.tools.am: Access Management Server.
org.forgerock.openig.tools.authentication - package org.forgerock.openig.tools.authentication: AM authentication service.
org.forgerock.openig.tools.authentication.chf - package org.forgerock.openig.tools.authentication.chf: HTTP-based authentication service.
org.forgerock.openig.tools.jwt.factory - package org.forgerock.openig.tools.jwt.factory: Provides JWT capabilities to the Identity Gateway.
org.forgerock.openig.tools.jwt.validation - package org.forgerock.openig.tools.jwt.validation: This package contains classes used to perform JWT validation.
org.forgerock.openig.tools.notifications - package org.forgerock.openig.tools.notifications: AM notifications service.
org.forgerock.openig.tools.notifications.ws - package org.forgerock.openig.tools.notifications.ws: Web socket notifications service implementation.
org.forgerock.openig.tools.session - package org.forgerock.openig.tools.session: This package contains classes to call AM to retrieve user's session info.
org.forgerock.openig.tools.userprofile - package org.forgerock.openig.tools.userprofile: This package contains classes to call AM to retrieve user's profile info.
org.forgerock.openig.types - package org.forgerock.openig.types: Contains everything commonly used to work with TypeDefinition.
org.forgerock.openig.types.importer - package org.forgerock.openig.types.importer: Route import support.
org.forgerock.openig.ui.record - package org.forgerock.openig.ui.record: Defines a storage service to be used by the UI to persist its component model.
org.forgerock.openig.uma - package org.forgerock.openig.uma: This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
org.forgerock.openig.util - package org.forgerock.openig.util: Miscellaneous utility classes.
org.forgerock.openig.websocket - package org.forgerock.openig.websocket: WebSocket proxy support.
org.forgerock.secrets - package org.forgerock.secrets: Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.jwkset - package org.forgerock.secrets.jwkset: Secret store backend for retrieving keys from a local or remote JWK Set.
org.forgerock.secrets.keys - package org.forgerock.secrets.keys: Contains cryptographic key related API objects.
org.forgerock.secrets.keystore - package org.forgerock.secrets.keystore: Implementations of SecretStore for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.
org.forgerock.secrets.oauth2 - package org.forgerock.secrets.oauth2: A Secrets API backend that can obtain OAuth 2 access tokens from a token endpoint, along with a collection of grant type handlers.
org.forgerock.secrets.propertyresolver - package org.forgerock.secrets.propertyresolver: Provides a SecretStore implementation that loads secrets from a Common Configuration PropertyResolver and then decodes it with a SecretPropertyFormat.
org.forgerock.services - package org.forgerock.services: This package contains the classes classes and interfaces used in the services' implementations.
org.forgerock.services.context - package org.forgerock.services.context: This package contains the Context interface and various common protocol independent implementations.
org.forgerock.services.descriptor - package org.forgerock.services.descriptor: Classes that allow services to be described.
org.forgerock.services.routing - package org.forgerock.services.routing: This package provides a simple framework for implementing routers.
org.forgerock.tokenhandler - package org.forgerock.tokenhandler: Provides token handler definition.
org.forgerock.util - package org.forgerock.util: Provides common interfaces and classes.
org.forgerock.util.annotations - package org.forgerock.util.annotations: Provides common annotations.
org.forgerock.util.crypto - package org.forgerock.util.crypto: Provides common crypto constants and classes.
org.forgerock.util.encode - package org.forgerock.util.encode: Provides fast and memory efficient Base64, Base64Url, and Hex decoding and encoding.
org.forgerock.util.generator - package org.forgerock.util.generator: Provides an abstraction of identifiers generators.
org.forgerock.util.i18n - package org.forgerock.util.i18n: Utility classes for dealing with internationalization (i18n).
org.forgerock.util.promise - package org.forgerock.util.promise: An implementation of the Promise API in Java.
org.forgerock.util.query - package org.forgerock.util.query: Provides a mechanism for implementing query filters.
org.forgerock.util.thread - package org.forgerock.util.thread: Provides a mechanism for handling shutdown of ExecutorService instances.
org.forgerock.util.thread.listener - package org.forgerock.util.thread.listener: Provides interfaces for handling shutdown.
org.forgerock.util.time - package org.forgerock.util.time: Provides a time service abstraction.
org.forgerock.util.xml - package org.forgerock.util.xml: Provides utilities for reading and processing XML.
originalUri(URI) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the originalUri value (only first UriRouterContext is expected to have that value set).
otherPrimesInfo(List<RsaJWK.PrimesInfo>) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Set the RSA other factors value.
OverflowException - Exception in org.forgerock.http.io: An exception that is thrown if a buffer would overflow as a result of a write operation.
OverflowException() - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with null as its detail message.
OverflowException(String) - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with the specified detail message.
OverflowException(String, Throwable) - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with the specified detail message and cause.
OverflowException(Throwable) - Constructor for exception org.forgerock.http.io.OverflowException: Constructs a new exception with the specified cause.

P

P256 - org.forgerock.json.jose.jws.SupportedEllipticCurve: NIST P-256.
P384 - org.forgerock.json.jose.jws.SupportedEllipticCurve: NIST P-384.
P521 - org.forgerock.json.jose.jws.SupportedEllipticCurve: NIST P-521.
Pair<F,S> - Class in org.forgerock.util: Ordered pair of arbitrary objects.
PARAM_ACTION - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter for an action.
PARAM_COUNT_ONLY - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to request only the count of results.
PARAM_CREST_API - Static variable in class org.forgerock.json.resource.http.HttpUtils: Request the CREST API Descriptor.
PARAM_FIELDS - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify which fields to return.
PARAM_MIME_TYPE - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to request a certain mimetype for a field.
PARAM_PAGE_SIZE - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to request a certain page size.
PARAM_PAGED_RESULTS_COOKIE - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a paged results cookie.
PARAM_PAGED_RESULTS_OFFSET - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a paged results offset.
PARAM_PRETTY_PRINT - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to request pretty printing.
PARAM_QUERY_EXPRESSION - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a query expression.
PARAM_QUERY_FILTER - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a query filter.
PARAM_QUERY_ID - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify a query id.
PARAM_SORT_KEYS - Static variable in class org.forgerock.json.resource.http.HttpUtils: the HTTP request parameter to specify the sort keys.
PARAM_TOTAL_PAGED_RESULTS_POLICY - Static variable in class org.forgerock.json.resource.http.HttpUtils: The policy used for counting total paged results.
parameters - Variable in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge: Any additional options that the type requires.
parent() - Method in class org.forgerock.http.io.BranchingInputStream: Returns the parent branching input stream from which this branch was created, or null if this is the trunk.
parent() - Method in class org.forgerock.json.JsonPointer: Returns a pointer to the parent of the JSON value identified by this JSON pointer, or null if the pointer has no parent JSON value (i.e.
parent() - Method in class org.forgerock.json.resource.ResourcePath: Returns the resource path which is the immediate parent of this resource path, or null if this resource path is empty.
parse(Object) - Method in class org.forgerock.http.header.HeaderFactory: Create a header instance from a provided object representation.
parse(String) - Method in interface org.forgerock.http.header.authorization.CredentialsParser: Parse the provided credentials into a rich representation.
parse(String) - Method in class org.forgerock.http.header.AuthorizationHeader.Factory
parse(String) - Method in class org.forgerock.http.header.HeaderFactory: Create a header instance from String representation, which may contain multiple values if the header supports them.
parse(String) - Static method in enum org.forgerock.http.protocol.Cookie.SameSite: Parses the given SameSite value.
parse(String) - Static method in class org.forgerock.json.jose.jwk.EcJWK: Parses a JWK from a string json object.
parse(String) - Static method in class org.forgerock.json.jose.jwk.JWK: Parses a String into the proper JWK type.
parse(String) - Static method in class org.forgerock.json.jose.jwk.JWKSet: Parses a JWKSet object from a string json object.
parse(String) - Static method in class org.forgerock.json.jose.jwk.OctJWK: Parses a OctJWK object from a string json object.
parse(String) - Static method in class org.forgerock.json.jose.jwk.RsaJWK: Parses a RsaJWK from a json string.
parse(String) - Static method in class org.forgerock.json.resource.QueryFilters: Parses the provided query string into a QueryFilter.
parse(List<String>) - Method in class org.forgerock.http.header.HeaderFactory: Create a header instance from a list of String representations, each of which may in turn contain multiple values if the header supports them.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.EcJWK: Parses a JWK from a JsonValue json object.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.JWK: Parses a JsonValue into the proper JWK type.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.JWKSet: Parses a JWKSet object from a jsonValue object.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.OctJWK: Parses a OctJWK object from a jsonValue object.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.OkpJWK: Parses a JWK from a JsonValue json object.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.RsaJWK: Parses a RsaJWK from a jsonValue Object.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo: Parses a PrimesInfo from a jsonValue Object.
parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm: Parses the given algorithm string to find the matching CompressionAlgorithm enum constant.
parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Parses the given algorithm string to find the matching Jwe algorithm enum constant.
parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Parses the given algorithm string to find the matching JwsAlgorithm enum constant.
parseAuditEventHandlerConfiguration(Class<C>, JsonValue) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Returns the audit event handler configuration from the provided JSON string.
parseAuditServiceConfiguration(InputStream) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Returns the audit service configuration from the provided input stream.
parseAuditServiceConfiguration(String) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Returns the audit service configuration from the provided JSON string.
parseAuditServiceConfiguration(JsonValue) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Returns the audit service configuration from the provided JSON value.
parseBoolean() - Static method in class org.forgerock.json.JsonValueFunctions: Returns a Boolean by converting the JsonValue using JsonValue.asLong(), or by parsing the JsonValue string using Boolean.parseBoolean(String).
parseCredentials(CredentialsParser<C>) - Method in class org.forgerock.http.header.AuthorizationHeader: Parse the credentials to a rich type.
parseCryptographicAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Parses the given algorithm string to find the matching Java Cryptographic algorithm name.
parseDate(String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the supported HTTP-date formats as specified in RFC 2616.
parseDirective(String) - Static method in class org.forgerock.http.header.HeaderUtil: Splits a single HTTP directive name and value from an input string value.
parseDirectives(Collection<String>) - Static method in class org.forgerock.http.header.HeaderUtil: Parses a set of HTTP directives from a collection of values.
parseDirectivesAsDirectiveMap(Collection<String>) - Static method in class org.forgerock.http.header.HeaderUtil: Parses a set of HTTP directives from a collection of values.
parseField(String) - Method in class org.forgerock.util.query.QueryFilterParser: Parses the field description from the current filter token into the type of field description the QueryFilter uses.
parseJson(String) - Static method in class org.forgerock.json.jose.utils.Utils: Parses the given JSON string into a NoDuplicatesMap.
ParseJsonValue() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandler.ParseJsonValue
parseLong() - Static method in class org.forgerock.json.JsonValueFunctions: Returns a Long by converting the JsonValue using JsonValue.asLong(), or by parsing the JsonValue string using Long.parseLong(String).
parseMethod(String) - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Parses the given algorithm string to find the matching EncryptionMethod enum constant.
parseMultiValuedHeader(String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the header content as a multi-valued comma separated value.
parseMultiValuedHeader(Message<?>, String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the named header from the message as a multi-valued comma separated value.
PARSER - Static variable in class org.forgerock.http.header.authorization.BasicCredentials: The parser for Basic credentials.
PARSER - Static variable in class org.forgerock.http.header.authorization.BearerToken: The parser for Bearer credentials.
parseRealm(String) - Static method in class org.forgerock.openig.tools.am.Realm: Creates a new Realm by parsing the given name.
parseSingleValuedHeader(Message<?>, String) - Static method in class org.forgerock.http.header.HeaderUtil: Parses the named single-valued header from the message.
password(char[]) - Static method in class org.forgerock.secrets.GenericSecret: A helper utility for constructing a Generic Secret from a password that never expires.
password(char[]) - Method in class org.forgerock.secrets.SecretBuilder: Sets the raw data of this secret object to the UTF-8 bytes of the given password.
password(String, char[]) - Static method in class org.forgerock.secrets.GenericSecret: A helper utility for constructing a Generic Secret from a password that never expires.
password(String, char[], Clock) - Static method in class org.forgerock.secrets.GenericSecret: A helper utility for constructing a Generic Secret from a password with a default expiry time.
PASSWORD - Static variable in class org.forgerock.secrets.Purpose: Indicates a secret intended to be used as a password for authentication to some service.
PasswordReplayFilterHeaplet - Class in org.forgerock.openig.filter: Supports password replay feature in a composite filter.
PasswordReplayFilterHeaplet() - Constructor for class org.forgerock.openig.filter.PasswordReplayFilterHeaplet
patch(JsonValue) - Method in class org.forgerock.json.JsonValue: Applies a set of modifications in a JSON patch value to the current object, resulting in the intended target value.
patch(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch: Applies a set of modifications in a JSON patch value to an original value, resulting in the intended target value.
patch(JsonValue, JsonValue, JsonPatchValueTransformer) - Static method in class org.forgerock.json.JsonPatch: Applies a set of modifications in a JSON patch value to an original value, resulting in the intended target value.
patch(Context, PatchRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
patch(Context, PatchRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Updates a JSON resource by applying a set of changes to its existing content.
patch(Context, PatchRequest) - Method in interface org.forgerock.json.resource.Connection: Updates a JSON resource by applying a set of changes to its existing content.
PATCH - org.forgerock.json.resource.RequestType: A patch request.
patchAsync(Context, PatchRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously updates a JSON resource by applying a set of changes to its existing content.
patchAsync(Context, PatchRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously updates a JSON resource by applying a set of changes to its existing content.
patchInstance(Context, String, PatchRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Patches an existing resource within the collection.
patchInstance(Context, String, PatchRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Patches an existing resource within the collection.
patchInstance(Context, String, PatchRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
patchInstance(Context, PatchRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider: Patches the single resource instance.
patchInstance(Context, PatchRequest) - Method in class org.forgerock.openig.http.ServerInfoSingletonProvider
PatchOperation - Class in org.forgerock.json.resource: An individual patch operation which is to be performed against a field within a resource.
PatchRequest - Interface in org.forgerock.json.resource: A request to update a JSON resource by applying a set of changes to its existing content.
path(String) - Method in class org.forgerock.openig.http.CookieBuilder: Set the path and return a new instance of this builder.
PATH - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The path event payload field name.
PATH_PTR - Static variable in class org.forgerock.json.JsonPatch: Path to the "path" attribute of a patch entry.
pathInfo(String) - Method in class org.forgerock.openig.http.EndpointRegistry: Returns the path info computed by appending the given name to this registry's path.
Paths - Class in org.forgerock.http.util: Utilities for manipulating paths.
pathToUrl(String) - Static method in class org.forgerock.openig.el.Functions: Returns the String representation of the URL denoting the given path.
pattern() - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON string value as a regular expression pattern.
PatternKeyValueProcessor - Class in org.forgerock.openig.decoration.capture: If the key matches the expression, return a masked value otherwise return the original value.
PatternTemplate - Class in org.forgerock.openig.regex: Expresses a transformation to be applied to a regular expression pattern match.
PatternTemplate(String) - Constructor for class org.forgerock.openig.regex.PatternTemplate: Constructs a new template with the specified value.
Payload - Interface in org.forgerock.json.jose.jwt: The interface represents the body of a JWT.
PAYLOAD_TOO_LARGE - Static variable in class org.forgerock.http.protocol.Status: The 413 (Payload Too Large) status code indicates that the server is refusing to process a request because the request payload is larger than the server is willing or able to process.
PAYMENT_REQUIRED - Static variable in class org.forgerock.http.protocol.Status: The 402 (Payment Required) status code is reserved for future use.
pemCertificate(Object) - Static method in class org.forgerock.openig.el.Functions: Convert the incoming CharSequence, which is expected to be a PEM format certificate, into a certificate.
PemPropertyFormat - Class in org.forgerock.secrets.propertyresolver: Supports decoding keys and certificates in PEM format.
PemPropertyFormat() - Constructor for class org.forgerock.secrets.propertyresolver.PemPropertyFormat: Initializes the property format without any support for decrypting private key files.
PemPropertyFormat(Supplier<SecretBuilder>) - Constructor for class org.forgerock.secrets.propertyresolver.PemPropertyFormat: Initializes the property format without any support for decrypting private key files.
PemPropertyFormat(SecretsProvider, Purpose<GenericSecret>) - Constructor for class org.forgerock.secrets.propertyresolver.PemPropertyFormat: Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.
PemPropertyFormat(SecretsProvider, Purpose<GenericSecret>, Supplier<SecretBuilder>) - Constructor for class org.forgerock.secrets.propertyresolver.PemPropertyFormat: Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.
PemPropertyFormatHeaplet - Class in org.forgerock.openig.secrets: Builds a PemPropertyFormat used to decode keys and certificates in a PEM format that can be used with SecretStore mappings configuration.
PemPropertyFormatHeaplet() - Constructor for class org.forgerock.openig.secrets.PemPropertyFormatHeaplet
PERCENTILES - Static variable in interface org.forgerock.openig.decoration.timer.TimerFactory: The percentiles published by the MeterRegistry.
performClientRegistration(Context, Issuer) - Method in interface org.forgerock.openig.filter.oauth2.client.ClientRegistrationStrategy: Perform client registration for the supplied Issuer.
PerItemEvictionStrategyCache<K,V> - Class in org.forgerock.util: PerItemEvictionStrategyCache is a thread-safe write-through cache.
PerItemEvictionStrategyCache(ScheduledExecutorService, AsyncFunction<V, Duration, Exception>) - Constructor for class org.forgerock.util.PerItemEvictionStrategyCache: Build a new PerItemEvictionStrategyCache using the given scheduled executor.
PerItemEvictionStrategyCache(ScheduledExecutorService, Duration) - Constructor for class org.forgerock.util.PerItemEvictionStrategyCache: Build a new PerItemEvictionStrategyCache using the given scheduled executor.
PermanentException - Exception in org.forgerock.json.resource: An exception that indicates that a failure is permanent, i.e.
PermanentException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.PermanentException: Constructs a new exception with the specified detail message and cause.
PERSISTENT - org.forgerock.audit.handlers.jms.DeliveryModeConfig: A persistent delivery mode.
pimpl - Variable in class org.forgerock.util.query.QueryFilter: the filter implementation.
PipeBufferedStream - Class in org.forgerock.http.io: Represents a pipe for transferring bytes from an OutputStream to a InputStream.
PipeBufferedStream() - Constructor for class org.forgerock.http.io.PipeBufferedStream: Deprecated.
Since 25.0.0. Prefer using PipeBufferedStream(Factory) to provide your own Buffer Factory
PipeBufferedStream(Factory<Buffer>) - Constructor for class org.forgerock.http.io.PipeBufferedStream: Constructs a new PipeBufferedStream with the given Factory.
PLAIN_PROPERTY_FORMAT - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve a SecretPropertyFormat that decodes PLAIN strings.
PlainPropertyFormat - Class in org.forgerock.openig.secrets: A SecretPropertyFormat for a PLAIN format.
PlainPropertyFormat() - Constructor for class org.forgerock.openig.secrets.PlainPropertyFormat
pointer() - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON string value as a JSON pointer.
PolicyDecisionContext - Class in org.forgerock.openig.openam: A PolicyDecisionContext convey policy decision information to downstream filters and handlers.
PolicyEnforcementFilter - Class in org.forgerock.openig.openam: This filter requests policy decisions from Access Management which evaluates the original URI based on the context and the policies configured, and according to the decisions, allows or denies the current request.
PolicyEnforcementFilter(RequestHandler, Handler, SessionService, ResourceUriProvider) - Constructor for class org.forgerock.openig.openam.PolicyEnforcementFilter: Creates a new enforcement filter.
PolicyEnforcementFilter.Heaplet - Class in org.forgerock.openig.openam: Creates and initializes a policy enforcement filter in a heap environment.
POLLING_INTERVAL - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration: Common Audit Batch log records queue polling timeout as Duration.
POLLING_TIMEOUT - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration: Common Audit Batch log records queue polling timeout.
POLLING_TIMEOUT_UNIT - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration: Common Audit Batch log records queue polling timeout unit.
PORT - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The port event payload field name.
positiveInteger() - Static method in class org.forgerock.openig.util.JsonValues: Returns a positive Integer from a JsonValue.
POSTGRES - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: The name used for a Postgres database.
postRetentionAction() - Method in class org.forgerock.audit.retention.RetentionHooks.NullRetentionHooks
postRetentionAction() - Method in interface org.forgerock.audit.retention.RetentionHooks: Method to run an action just before the file is run through the RetentionPolicy's.
postRotationAction(RotationContext) - Method in class org.forgerock.audit.rotation.RotationHooks.NoOpRotatationHooks
postRotationAction(RotationContext) - Method in interface org.forgerock.audit.rotation.RotationHooks: Method to run an action just after file has been rotated.
PreconditionFailedException - Exception in org.forgerock.json.resource: An exception that is thrown to indicate that a resource's current version does not match the version provided.
PreconditionFailedException() - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with null as its detail message.
PreconditionFailedException(String) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with the specified detail message.
PreconditionFailedException(String, Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with the specified detail message and cause.
PreconditionFailedException(Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException: Constructs a new exception with the specified cause.
PreconditionRequiredException - Exception in org.forgerock.json.resource: An exception that is thrown to indicate that a resource requires a version, but no version was supplied in the request.
PreconditionRequiredException() - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with null as its detail message.
PreconditionRequiredException(String) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with the specified detail message.
PreconditionRequiredException(String, Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with the specified detail message and cause.
PreconditionRequiredException(Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException: Constructs a new exception with the specified cause.
Predicate<T,E extends Exception> - Interface in org.forgerock.util: A Predicate functional interface which can thrown a checked Exception.
PredicateUtil - Class in org.forgerock.openig.util: Utility class for Predicate.
PreferredLocales - Class in org.forgerock.util.i18n: This class encapsulates an ordered list of preferred locales, and the logic to use those to retrieve i18n ResourceBundles.
PreferredLocales() - Constructor for class org.forgerock.util.i18n.PreferredLocales: Create a new, empty preference of locales.
PreferredLocales(List<Locale>) - Constructor for class org.forgerock.util.i18n.PreferredLocales: Create a new preference of locales by copying the provided locales list.
preRotationAction(RotationContext) - Method in class org.forgerock.audit.rotation.RotationHooks.NoOpRotatationHooks
preRotationAction(RotationContext) - Method in interface org.forgerock.audit.rotation.RotationHooks: Method to run an action just before file will be rotated.
present(FF) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new presence filter using the provided field name.
PRESENT - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "present" operator.
PRESERVE_ORIGINAL_QUERY_STRING_INIT_PARAM - Static variable in class org.forgerock.http.servlet.HttpFrameworkServlet: Servlet init-param for configuring how strict CHF is in regard to invalid characters in query string.
primeP(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Set the RSA First Prime Factor value.
primePExponent(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Set the RSA First Factor CRT Exponent value.
primeQ(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Set the RSA Second Prime Factor value.
primeQExponent(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Set the RSA Second factor CRT Exponent value.
PrimesInfo(String, String, String) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo: Creates the other prime factors.
PrimesInfo(RSAOtherPrimeInfo) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo: Create other prime factors.
principal(List<String>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Sets the principals of the authentication event.
PRINCIPAL - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Defines the principal key.
PrincipalResolver - Class in org.forgerock.openig.resolver: Resolves Principal objects.
PrincipalResolver() - Constructor for class org.forgerock.openig.resolver.PrincipalResolver
PRIVATE - org.forgerock.secrets.keys.KeyType: An asymmetric private key.
privateExponent(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Set the RSA Private Exponent value.
privateKey(ECPrivateKey) - 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.
privateKey(PrivateKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder: Sets the private key d-value from the given private key.
privateKeyJwtClientAuthenticationFilter() - Static method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter: Creates a new builder for PrivateKeyJwtClientAuthenticationFilter.
PrivateKeyJwtClientAuthenticationFilter - Class in org.forgerock.http.oauth2: A Filter implementation for adding the client credentials to request as signed private key jwt as per the OpenID Connect Client Authentication specification.
PrivateKeyJwtClientAuthenticationFilter.Builder<T extends PrivateKeyJwtClientAuthenticationFilter.Builder<T>> - Class in org.forgerock.http.oauth2: Builder class for creating the PrivateKey Jwt ClientAuthentication Filter.
PrivateKeyJwtClientAuthenticationFilterHeaplet - Class in org.forgerock.openig.filter.oauth2.client.authentication: Heaplet supporting creation of a private-key-jwt authentication Filter.
PrivateKeyJwtClientAuthenticationFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.authentication.PrivateKeyJwtClientAuthenticationFilterHeaplet
privateScalarValue(PrivateKey) - Static method in class org.forgerock.json.jose.utils.XECUtils: Returns the private scalar value for the given XECPrivateKey.
process(String, KeyValueProcessor.Value) - Method in class org.forgerock.openig.decoration.capture.HideKeyValueProcessor
process(String, KeyValueProcessor.Value) - Method in interface org.forgerock.openig.decoration.capture.KeyValueProcessor: For a given key/value pair, return the processed value as an Optional.
process(String, KeyValueProcessor.Value) - Method in class org.forgerock.openig.decoration.capture.ObjectMapperKeyValueProcessor
process(String, KeyValueProcessor.Value) - Method in class org.forgerock.openig.decoration.capture.PatternKeyValueProcessor
PRODUCT_INFO - Static variable in class org.forgerock.openig.util.ProductInfo: The JsonValue containing the product info.
PRODUCT_VERSION_SYNTAX - Static variable in class org.forgerock.openig.types.TypeDefinitions: The "PRODUCT_VERSION"'s Syntax.
PRODUCT_VERSION_TYPE - Static variable in class org.forgerock.openig.types.TypeDefinitions: Represents the "PRODUCT_VERSION" type, which is a String with a specific Syntax.
ProductInfo - Class in org.forgerock.openig.util: Utility class to retrieve product information.
ProductInfoProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining the information relating to the product in which the AuditService is deployed.
PRODUCTION - org.forgerock.openig.http.RunMode: Denotes a more secure mode where administrative endpoints and UI are not exposed.
Promise<V,E extends Exception> - Interface in org.forgerock.util.promise: A Promise represents the result of an asynchronous task.
PromiseImpl<V,E extends Exception> - Class in org.forgerock.util.promise: An implementation of Promise which can be used as is, or as the basis for more complex asynchronous behavior.
PromiseImpl() - Constructor for class org.forgerock.util.promise.PromiseImpl: Creates a new pending Promise implementation.
Promises - Class in org.forgerock.util.promise: Utility methods for creating and composing Promises.
Promises.Results - Class in org.forgerock.util.promise: Ordered list of joined asynchronous results.
promiseToFuture(Promise<T, E>) - Static method in class org.forgerock.openig.tools.FutureUtils: Converts a Promise to a CompletableFuture.
PromiseUtil - Class in org.forgerock.openig.util: Utility class for promises management.
properties() - Static method in class org.forgerock.openig.util.JsonValues: Returns a function that transforms the JSON value to a Properties object.
PropertyFormatBase64 - Enum in org.forgerock.secrets.propertyresolver: Decodes secrets in raw base64 format.
propertyResolver - Variable in class org.forgerock.openig.heap.HeapImpl: Resolves tokens.
PropertyResolverSecretStore - Class in org.forgerock.secrets.propertyresolver: A SecretStore implementation that resolves secrets as base64-encoded strings from an underlying PropertyResolver.
PropertyResolverSecretStore(PropertyResolver) - Constructor for class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore: Initialises the property resolver secret store using base64-encoded properties.
PropertyResolverSecretStore(PropertyResolver, SecretPropertyFormat) - Constructor for class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore: Initialises the property resolver secret store.
PropertyResolverSecretStore(PropertyResolver, SecretPropertyFormat, Map<String, SecretPropertyFormat>) - Constructor for class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore: Initialises the property resolver secret store with a mapping of purpose to format.
PROTOCOL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The protocol event payload field name.
PROTOCOL - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader: The name of the protocol value component.
PROTOCOL_VERSION_1 - Static variable in class org.forgerock.json.resource.http.HttpUtils: Protocol Version 1.
PROTOCOL_VERSION_2 - Static variable in class org.forgerock.json.resource.http.HttpUtils: Protocol Version 2 - supports upsert on PUT.
PROTOCOL_VERSION_2_1 - Static variable in class org.forgerock.json.resource.http.HttpUtils: Protocol Version 2.1 - supports defacto standard for create requests when the ID of the created resource is to be allocated by the server, which are represented as a POST to the collection endpoint without an _action query parameter.
PROTOCOL_VERSION_2_2 - Static variable in class org.forgerock.json.resource.http.HttpUtils: Protocol Version 2.2 - supports _countOnly parameter on query requests to indicate that only a count of the resources matching the supplied query filter on the resource collection are returned.
provider(Provider) - Method in class org.forgerock.secrets.SecretBuilder: Sets the provider associated with this secret.
PROXY_AUTHENTICATION_REQUIRED - Static variable in class org.forgerock.http.protocol.Status: The 407 (Proxy Authentication Required) status code is similar to 401 (Unauthorized), but it indicates that the client needs to authenticate itself in order to use a proxy.
PROXY_OPTIONS_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the default ProxyOptions instance from the Heap.
proxyInfo(URI) - Static method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo: Creates an instance of ProxyInfo for a proxy that does not require authentication.
proxyInfo(URI, String, String) - Static method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo: Creates an instance of ProxyInfo for a proxy that requires authentication.
ProxyOptions - Interface in org.forgerock.openig.tools: Configure proxy settings.
PS256 - org.forgerock.json.jose.jws.JwsAlgorithm: RSA-PSS with SHA-256 hash algorithm.
PS384 - org.forgerock.json.jose.jws.JwsAlgorithm: RSA-PSS with SHA-384 hash algorithm.
PS512 - org.forgerock.json.jose.jws.JwsAlgorithm: RSA-PSS with SHA-512 hash algorithm.
ptr(Iterable<String>) - Static method in class org.forgerock.json.JsonPointer: Constructs a JSON pointer from an iterable collection of reference tokens.
ptr(String) - Static method in class org.forgerock.json.JsonPointer: Constructs a JSON pointer, identifying the specified pointer value.
ptr(String...) - Static method in class org.forgerock.json.JsonPointer: Constructs a JSON pointer from an array of reference tokens.
PTR_AUD - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set audience JSON pointer.
PTR_EXP - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set expiry JSON pointer.
PTR_ISS - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set issuer JSON pointer.
PTR_NONCE - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set nonce JSON pointer.
PTR_TOKEN_NAME - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set tokenName JSON pointer.
PUBLIC - org.forgerock.secrets.keys.KeyType: An asymmetric public key.
publicKey(PublicKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder: Sets the public x-coordinate from the given public key.
publicKey(PublicKey) - Method in class org.forgerock.secrets.SecretBuilder: Sets the public key associated with this secret.
publicUCoordinate(PublicKey) - Static method in class org.forgerock.json.jose.utils.XECUtils: Returns the little-endian bytes of the public u-coordinate of the given XECPublicKey.
publishBatch(String) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchConsumer: Publishes the batch payload.
publishBatch(String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler: Publishes a Bulk API payload to Elasticsearch.
publishBatch(String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
publishBatch(String) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
publishEvent(Context, String, JsonValue) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Publishes an event to the provided topic.
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler: Create a csv audit log entry.
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: Publishes an event to the provided topic.
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandler
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler
publishSingleEvent(String, JsonValue) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler: Publishes a single event to the provided topic.
purpose(String, Class<T>) - Static method in class org.forgerock.secrets.Purpose: Constructs a purpose object.
purpose(String, Class<T>, SecretConstraint<? super T>...) - Static method in class org.forgerock.secrets.Purpose: Constructs a purpose object.
Purpose<T extends Secret> - Class in org.forgerock.secrets: A purpose encapsulates both a name for a function that requires access to secrets, together with a hint as to the intended usage of those secrets.
PURPOSE_KEY - Static variable in class org.forgerock.util.crypto.CryptoConstants: key for the purpose of the key used to crypt the data.
purposeOf(Class<S>) - Static method in class org.forgerock.openig.util.JsonValues: Returns a function returning a Purpose from the given String value representing the purpose label.
purposeOf(Class<T>) - Static method in class org.forgerock.openig.types.TypeDefinitions: Represents a runtime Purpose of secret's type T, which is a String with a specific Syntax.
put(int, Object) - Method in class org.forgerock.json.JsonValue: Sets the value of the specified child list element.
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.ArrayResolver
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.BeanResolver
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.HeadersResolver
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.HeapResolver
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.ListResolver
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.MapResolver
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.PrincipalResolver
put(Object, Object, Object) - Method in class org.forgerock.openig.resolver.RequestResolver
put(Object, Object, Object) - Method in interface org.forgerock.openig.resolver.Resolver: Attempts to set the value of an element of an object.
put(Object, Object, Object) - Static method in class org.forgerock.openig.resolver.Resolvers: Attempts to set the value of an element of an object.
put(String, Object) - Method in class org.forgerock.http.protocol.Headers: A script compatible put method that will accept a Header, String, Collection<String> and String[] value.
put(String, Object) - Method in class org.forgerock.json.jose.jwt.JWObject: Sets or removes the value of the specified member.
put(String, Object) - Method in class org.forgerock.json.JsonValue: Sets the value of the specified member.
put(String, Object) - Method in class org.forgerock.openig.heap.HeapImpl: Puts an object into the heap.
put(String, V) - Method in class org.forgerock.http.util.CaseInsensitiveMap
put(K, V) - Method in class org.forgerock.util.LazyMap: Associates the specified value with the specified key in the map.
put(K, V) - Method in class org.forgerock.util.MapDecorator: Associates the specified value with the specified key in the map.
put(Header) - Method in class org.forgerock.http.protocol.Headers: A put method to add a particular Header instance.
put(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue: Sets the value identified by the specified pointer, relative to this value as root.
putAdvice(String, String...) - Method in class org.forgerock.json.resource.AdviceContext: Adds advice to the context, which can be retrieved and later returned to the user.
putAll(Map<? extends String, ? extends Object>) - Method in class org.forgerock.http.protocol.Headers: A script compatible putAll method that will accept Header, String, Collection<String> and String[] values.
putAll(Map<? extends String, ? extends V>) - Method in class org.forgerock.http.util.CaseInsensitiveMap
putAll(Map<? extends K, ? extends V>) - Method in class org.forgerock.util.LazyMap: Copies all of the mappings from the specified map to the map.
putAll(Map<? extends K, ? extends V>) - Method in class org.forgerock.util.MapDecorator: Copies all of the mappings from the specified map to the map.
putField(JsonValue, String, Object) - Method in class org.forgerock.json.jose.jwk.JWK: Add a string value into a json only if it's not null.
putHeaders(Header...) - Method in interface org.forgerock.http.protocol.Message: Put one or more headers to the message.
putHeaders(Header...) - Method in class org.forgerock.http.protocol.MessageImpl
putIfNotNull(String, Object) - Method in class org.forgerock.json.JsonValue: Sets the value of the specified member, only if it is not null.
putPermissive(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue: Sets the value identified by the specified pointer, relative to this value as root.
putSingle(K, V) - Method in class org.forgerock.http.util.MultiValueMap: Maps a single value to the specified key, replacing any value(s) that are already mapped to that key.
putTrailers(Header...) - Method in class org.forgerock.http.protocol.Response: Put one or more trailers, aka trailing headers, to the response.

Q

qualified - Variable in class org.forgerock.openig.heap.GenericHeaplet: The fully qualified name of the object to be created.
query(Context, QueryRequest, Collection<? super ResourceResponse>) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
query(Context, QueryRequest, Collection<? super ResourceResponse>) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Searches for all JSON resources matching a user specified set of criteria, and places the results in the provided collection.
query(Context, QueryRequest, Collection<? super ResourceResponse>) - Method in interface org.forgerock.json.resource.Connection: Searches for all JSON resources matching a user specified set of criteria, and places the results in the provided collection.
query(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
query(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
query(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.Connection: Searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
QUERY - org.forgerock.json.resource.RequestType: A query request.
QUERY_PARAMETERS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The query parameters event payload field name.
queryAsync(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
queryAsync(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.Connection: Asynchronously searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Searches the collection for all resources which match the query request criteria.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.MemoryBackend: Searches the collection for all resources which match the query request criteria.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.openig.ui.record.RecordProvider
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Query some events from the provided topic.
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler: Perform a query on the csv audit log.
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler: Queries the Elasticsearch Search API for audit events.
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: Query some events from the provided topic.
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler: Returns NotSupportedException as query is not implemented for JMS.
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandler
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler
queryFilter() - Static method in class org.forgerock.json.resource.JsonValueFunctions: Parses and returns the JSON string value as a QueryFilter.
QueryFilter<F> - Class in org.forgerock.util.query: A filter which can be used to select resources, which is compatible with the CREST query filters.
QueryFilter(QueryFilter.Impl<F>) - Constructor for class org.forgerock.util.query.QueryFilter: Construct a QueryFilter from a base filter implementation.
QueryFilter(QueryFilter.Impl<F>, QueryFilterVisitor<StringBuilder, StringBuilder, F>) - Constructor for class org.forgerock.util.query.QueryFilter: Construct a QueryFilter from a base filter implementation and a custom toString implementation.
QueryFilterOperators - Class in org.forgerock.util.query: QueryFilter constants.
QueryFilterParser<F> - Class in org.forgerock.util.query: A query string has the following string representation:
QueryFilterParser() - Constructor for class org.forgerock.util.query.QueryFilterParser
QueryFilters - Class in org.forgerock.json.resource: Convenience methods to create QueryFilter that specify fields in terms of JsonPointer instances.
QueryFilterVisitor<R,P,F> - Interface in org.forgerock.util.query: A visitor of QueryFilters, in the style of the visitor design pattern.
QueryRequest - Interface in org.forgerock.json.resource: A request to search for all JSON resources matching a user specified set of criteria.
QueryResourceHandler - Interface in org.forgerock.json.resource: A completion handler for consuming the results of a query request.
QueryResponse - Interface in org.forgerock.json.resource: The final result of a query request returned after all resources matching the request have been returned.
quote(String) - Static method in class org.forgerock.http.header.HeaderUtil: Encloses a string in quotation marks.

R

RangeSet - Class in org.forgerock.util: Exposes a range of integer values as a set.
RangeSet(int) - Constructor for class org.forgerock.util.RangeSet: Constructs a range set for a sequence of numbers, starting at 0 with the value to stop.
RangeSet(int, int) - Constructor for class org.forgerock.util.RangeSet: Constructs a range set for the specified range of integers with a step of 1.
RangeSet(int, int, int) - Constructor for class org.forgerock.util.RangeSet: Constructs a range set for the specified range of integers and increment.
RAW - Static variable in interface org.forgerock.secrets.SecretDecoder: A decoder that populates the raw data of the secret.
rawData(byte[]) - Method in class org.forgerock.secrets.SecretBuilder: Sets the raw data of the secret object.
rawInfo() - Method in class org.forgerock.openig.tools.userprofile.UserProfile: Returns the unmodifiable Map of the user profile info, not null.
ReactiveUtils - Class in org.forgerock.openig.reactive: Utility class for ReactiveX operations.
read() - Method in class org.forgerock.http.io.FailableInputStream
read() - Method in class org.forgerock.http.io.FileBranchingStream
read() - Method in class org.forgerock.openig.util.IgTicker
read(byte[]) - Method in class org.forgerock.http.io.FailableInputStream
read(byte[], int, int) - Method in class org.forgerock.http.io.FailableInputStream
read(int) - Method in interface org.forgerock.http.io.Buffer: Reads a single byte of data from the buffer.
read(int, byte[], int, int) - Method in interface org.forgerock.http.io.Buffer: Reads up to len bytes of data from the buffer into an array of bytes.
read(String) - Static method in class org.forgerock.openig.el.Functions: Returns the content of the given file as a plain String.
read(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
read(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Reads a JSON resource.
read(Context, ReadRequest) - Method in interface org.forgerock.json.resource.Connection: Reads a JSON resource.
READ - org.forgerock.json.resource.RequestType: A read request.
readAsync(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously reads a JSON resource.
readAsync(Context, ReadRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously reads a JSON resource.
readAtMost(InputStream, int) - Static method in class org.forgerock.util.Streams: Reads at most the given number of bytes from the input stream.
readCurrentKey() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
readCurrentKey() - Method in interface org.forgerock.audit.secure.SecureStorage: Reads the current key.
readEntry(String, String...) - Method in class org.forgerock.openig.ldap.LdapConnection: Reads the named entry from the Directory Server.
readEntry(Dn, String...) - Method in class org.forgerock.openig.ldap.LdapConnection: Reads the named entry from the Directory Server.
readEvent(Context, String, String) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Reads an event with the provided resource id from the provided topic.
readEvent(Context, String, String) - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler: Read from the csv audit log.
readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler
readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler: Returns NotSupportedException as read is not implemented for JMS.
readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandler
readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
readEvent(Context, String, String) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler
readInitialKey() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
readInitialKey() - Method in interface org.forgerock.audit.secure.SecureStorage: Reads the initial key.
readInstance(Context, String, ReadRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Reads an existing resource within the collection.
readInstance(Context, String, ReadRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Reads an existing resource within the collection.
readInstance(Context, String, ReadRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
readInstance(Context, ReadRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider: Reads the single resource instance.
readInstance(Context, ReadRequest) - Method in class org.forgerock.openig.http.ServerInfoSingletonProvider
readJson(Reader) - Static method in class org.forgerock.http.util.Json: Parses to json the provided reader.
readJson(String) - Static method in class org.forgerock.http.util.Json: Parses to json the provided data.
readJson(URL) - Static method in class org.forgerock.openig.util.JsonValues: Builds a JsonValue from the given URL.
readJsonLenient(InputStream) - Static method in class org.forgerock.http.util.Json: This function it's only used to read our configuration files and allows JSON files to contain non strict JSON such as comments or single quotes.
readJsonLenient(Reader) - Static method in class org.forgerock.http.util.Json: This function it's only used to read our configuration files and allows JSON files to contain non strict JSON such as comments or single quotes.
readLength(ByteBuffer) - Static method in class org.forgerock.json.jose.utils.DerUtils: Reads a DER-encoded length field from the given byte buffer.
readPrivateKeyFromKeyStore(String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get a private key for the alias using the default password from KeyStoreHandlerDecorator.getPassword().
readPrivateKeyFromKeyStore(String, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the private key with the given alias.
readProperties(String) - Static method in class org.forgerock.openig.el.Functions: Returns the content of the given file as a Properties.
readPublicKeyFromKeyStore(String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the public key with the given alias.
ReadRequest - Interface in org.forgerock.json.resource: A request to read a single identified JSON resource.
readSecretKeyFromKeyStore(String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the secret key with the given alias using the default password from KeyStoreHandlerDecorator.getPassword().
readSecretKeyFromKeyStore(String, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the secret key with the given alias.
readUnsignedInteger(ByteBuffer, byte[], int, int) - Static method in class org.forgerock.json.jose.utils.DerUtils: Reads an unsigned integer value into the given byte array.
readWithCharset(String, Charset) - Static method in class org.forgerock.openig.el.Functions: Returns the content of the given file as a plain String using a specific Charset.
realm - Variable in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge: The realm of the authentication option.
Realm - Class in org.forgerock.openig.tools.am: This class defines a Realm as it is used in OpenAM.
REALM - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set realm key - not available in JwtClaimsSetKey.
REALM_SYNTAX - Static variable in class org.forgerock.openig.types.TypeDefinitions: The "REALM"'s Syntax.
REALM_TYPE - Static variable in class org.forgerock.openig.types.TypeDefinitions: Represents the "PRODUCT_VERSION" type, which is a String with a specific Syntax.
RealmNormalizer - Class in org.forgerock.openig.tools.am: A RealmNormalizer computes the path segment that includes the AM realm information as it should be used in REST API call.
rebase(URI) - Method in class org.forgerock.http.MutableUri: Changes the base scheme, host and port of this MutableUri to that specified in a base URI, or leaves them unchanged if the base URI is null.
rebase(URI, URI) - Static method in class org.forgerock.http.util.Uris: Changes the base scheme, host and port of a request to that specified in a base URI, or leaves them unchanged if the base URI is null.
rebase(MutableUri) - Method in class org.forgerock.http.MutableUri: Changes the base scheme, host and port of this MutableUri to that specified in a base URI, or leaves them unchanged if the base URI is null.
rebaseRequest(Expression<String>, Bindings, Request) - Static method in class org.forgerock.openig.util.BaseUriUtil: Rebase the URI of the request based on the evaluation of the baseUri expression.
recognizedHeaders(String...) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory: Configures additional application-specific header values that are understood and processed by the application.
recognizedHeaders(String...) - Method in class org.forgerock.json.jose.common.JwtReconstruction: Configures additional application-specific header values that are understood and processed by the application.
reconnect(Duration, int) - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Supply reconnect configuration to support reconnection attempts should the websocket be terminated remotely.
reconstruct(String, Class<T>) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory: Reconstructs the given JWT string into a JWT object of the specified type.
reconstructJwt(String, Class<T>) - Method in class org.forgerock.json.jose.common.JwtReconstruction: Reconstructs the given JWT string into a JWT object of the specified type.
reconstructJwt(String, Class<T>) - Static method in class org.forgerock.openig.tools.JwtUtil: Reconstruct a JWT from a {code String} representation.
recordFailure() - Method in class org.forgerock.openig.filter.circuitbreaker.SlidingCounterResultRecorder
RecordProvider - Class in org.forgerock.openig.ui.record: CREST collection service dedicated to persist JSON objects (other types are not supported: arrays, primitives, and null).
RecordProvider(RecordService) - Constructor for class org.forgerock.openig.ui.record.RecordProvider: Creates a new resource provider delegating to the given service for storage.
RecordService - Class in org.forgerock.openig.ui.record: File-based Record storage service.
RecordService(File) - Constructor for class org.forgerock.openig.ui.record.RecordService: Creates a RecordService that will record resources in the given directory.
recordSuccess() - Method in class org.forgerock.openig.filter.circuitbreaker.SlidingCounterResultRecorder
REDIRECTION - org.forgerock.http.protocol.Status.Family: The 3xx (Redirection) class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request.
ReferrerHeader - Class in org.forgerock.http.header: A Header representation of the Referrer HTTP header.
ReferrerHeader() - Constructor for class org.forgerock.http.header.ReferrerHeader
refresh() - Method in class org.forgerock.openig.secrets.Base64EncodedSecretStore
refresh() - Method in class org.forgerock.secrets.jwkset.JwkSetSecretStore
refresh() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
refresh() - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore
refresh() - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
refresh() - Method in interface org.forgerock.secrets.SecretStore: Indicates that the store should refresh its secrets from the backing storage mechanism.
refresh() - Method in class org.forgerock.secrets.ThreadPoolSecretStore
refresh(Context) - Method in class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier: Refresh (and returns) the value, in a thread-safe manner.
refreshAccessToken(Context, OAuth2Session) - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration: Refreshes the actual access token, making a refresh request to the token end-point.
RefreshTokenGrantTypeHandler - Class in org.forgerock.secrets.oauth2: A grant type handler that can obtain an access token using a previously obtained refresh token.
RefreshTokenGrantTypeHandler(String, String) - Constructor for class org.forgerock.secrets.oauth2.RefreshTokenGrantTypeHandler: Initialises the grant type handler for the given client id and refresh token.
register(Class<T>, T) - Method in class org.forgerock.audit.DependencyProviderBase: Register a new provided dependency.
register(String, Handler) - Method in class org.forgerock.openig.http.EndpointRegistry: Registers a new endpoint under the given name.
register(String, JsonValue, List<Pattern>) - Method in class org.forgerock.openig.filter.oauth2.client.IssuerRepository: Register an Issuer into the repository.
registerFactory(String, ScriptFactory) - Method in class org.forgerock.openig.script.DefaultScriptFactoryManager: Registers a given mimeType for the given ScriptFactory.
registerHandlerToService(JsonValue, AuditServiceBuilder) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Configures and registers the audit event handler corresponding to the provided JSON configuration to the provided audit service.
registerHandlerToService(JsonValue, AuditServiceBuilder, ClassLoader) - Static method in class org.forgerock.audit.json.AuditJsonConfig: Configures and registers the audit event handler corresponding to the provided JSON configuration to the provided audit service, using a specific class loader.
registerKeyStoreHandler(String, KeyStoreHandler) - Method in class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider: Register a storage with the given name.
registerRotationHooks(RotationHooks) - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
registerRotationHooks(RotationHooks) - Method in interface org.forgerock.audit.rotation.RotatableObject: Registers hooks into the rotation process.
registerSecureStorage(String, SecureStorage) - Method in class org.forgerock.audit.providers.DefaultSecureStorageProvider: Register a storage with the given name.
RegistrationException - Exception in org.forgerock.openig.filter.oauth2.client: Represents an exception whilst performing OpenID registration.
RegistrationException(String) - Constructor for exception org.forgerock.openig.filter.oauth2.client.RegistrationException: Builds an RegistrationException with a given message.
RegistrationException(String, Exception) - Constructor for exception org.forgerock.openig.filter.oauth2.client.RegistrationException: Builds an RegistrationException with a given message and cause.
Reject - Class in org.forgerock.util: A input parameter-validating utility class using fluent invocation:
rejectStateIfTrue(boolean, String) - Static method in class org.forgerock.util.Reject: Throws an IllegalStateException with a custom message if the condition parameter is true.
relativePointer() - Method in class org.forgerock.json.JsonPointer: Returns a pointer containing all but the first reference token contained in this pointer, or / if this pointer contains less than 2 reference tokens.
relativePointer(int) - Method in class org.forgerock.json.JsonPointer: Returns a pointer containing the last sz reference tokens contained in this pointer.
relativize(MutableUri) - Method in class org.forgerock.http.MutableUri: Relativizes the given URI against this URI.
RELAY - org.forgerock.openig.filter.CookieFilter.Action: Relay the cookie between remote client and remote host.
releaseReadLock() - Method in class org.forgerock.audit.AuditServiceProxy: Release the read lock.
releaseWriteLock() - Method in class org.forgerock.audit.AuditServiceProxy: Release the write lock.
reloadJwks() - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Deprecated.
Use JwksStore.reloadJwksAsync() instead.
reloadJwksAsync() - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Communicates with the configured server, attempting to download the latest JWKs for use.
remainingUri(String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the remainingUri value.
remoteAddress(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's remote address.
remotePort(int) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's remote port.
remoteUser(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's remote user.
remove() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyIterator
remove(int) - Method in class org.forgerock.json.JsonValue: Removes the specified child value, shifting any subsequent elements to the left.
remove(int) - Method in class org.forgerock.util.LazyList: Removes the element at the specified position in this list.
remove(int) - Method in class org.forgerock.util.ListDecorator: Removes the element at the specified position in this list.
remove(Object) - Method in class org.forgerock.http.protocol.Headers: Rich-type friendly remove method.
remove(Object) - Method in class org.forgerock.http.util.CaseInsensitiveMap
remove(Object) - Method in class org.forgerock.http.util.CaseInsensitiveSet
remove(Object) - Method in class org.forgerock.http.util.SetDecorator: Removes the specified element from the set if it is present (optional operation).
remove(Object) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
remove(Object) - Method in class org.forgerock.openig.session.jwt.dirty.DirtySet
remove(Object) - Method in class org.forgerock.util.LazyList: Removes the first occurrence of the specified element from this list, if it is present.
remove(Object) - Method in class org.forgerock.util.LazyMap: Removes the mapping for a key from the map if it is present.
remove(Object) - Method in class org.forgerock.util.ListDecorator: Removes the first occurrence of the specified element from this list, if it is present.
remove(Object) - Method in class org.forgerock.util.MapDecorator: Removes the mapping for a key from the map if it is present.
remove(String) - Method in class org.forgerock.json.JsonValue: Removes the specified child value.
remove(String) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the specified field.
remove(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the provided value(s) from the specified field.
remove(JsonPointer) - Method in class org.forgerock.json.JsonValue: Removes the specified child value with a pointer, relative to this value as root.
remove(JsonPointer) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the specified field.
remove(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "remove" patch operation which will remove the provided value(s) from the specified field.
removeAll(Collection<?>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
removeAll(Collection<?>) - Method in class org.forgerock.http.util.SetDecorator: Removes from the set all of its elements that are contained in the specified collection (optional operation).
removeAll(Collection<?>) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
removeAll(Collection<?>) - Method in class org.forgerock.openig.session.jwt.dirty.DirtySet
removeAll(Collection<?>) - Method in class org.forgerock.util.LazyList: Removes from this list all of its elements that are contained in the specified collection.
removeAll(Collection<?>) - Method in class org.forgerock.util.ListDecorator: Removes from this list all of its elements that are contained in the specified collection.
removeAllRoutes() - Method in class org.forgerock.services.routing.AbstractRouter: Removes all of the routes from this router.
removeAttribute(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.json.resource.FilterChain
removeDescriptorListener(Describable.Listener) - Method in interface org.forgerock.services.descriptor.Describable: Remove a listener from API Descriptor changes.
removeDescriptorListener(Describable.Listener) - Method in class org.forgerock.services.routing.AbstractRouter
removeJwksStore(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService: Remove the corresponding jwks store if exist.
removeLeadingSlash(String) - Static method in class org.forgerock.http.util.Paths: Removes the leading slash, if present, from the resource name.
removeRoute(RouteMatcher<R>...) - Method in class org.forgerock.services.routing.AbstractRouter: Removes one or more routes from this router.
removeShare(String) - Method in class org.forgerock.openig.uma.UmaSharingService: Removes the previously created Share from the registered shares.
removeShutdownListener(ShutdownListener) - Method in interface org.forgerock.util.thread.listener.ShutdownManager: Removes a ShutdownListener from this ShutdownManager.
removeTrailingSlash(String) - Static method in class org.forgerock.http.util.Paths: Removes trailing slash (if there is any), returns the same value otherwise.
renameField(JsonValue, String, String) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Renames a field within the given JsonValue.
renewSession(WebSocketAdapter) - Method in class org.forgerock.openig.tools.notifications.ws.TopicManager: Refresh the TopicManager session with a new WebSocket (on reconnection).
replace(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "replace" patch operation which will replace the value(s) of the specified field with the provided value(s).
replace(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "replace" patch operation which will replace the value(s) of the specified field with the provided value(s).
replaceKeyPeriodsWithUnderscores(String) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Replaces all period-characters in JSON keys with underscore-characters [ref].
replaceShutdownListener(ShutdownListener, ShutdownListener, ShutdownPriority) - Method in interface org.forgerock.util.thread.listener.ShutdownManager: Replaces an existing ShutdownListener with the new ShutdownListener.
report(Jwt) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator: Returns the result of the JWT validation and a list of any violations.
report(Jwt, Map<String, Object>) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator: Returns the result of the JWT validation and a list of any violations.
request(String, String) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided request details for the event.
request(String, String, JsonValue) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided request details for the event.
Request - Class in org.forgerock.http.protocol: A request message.
Request - Interface in org.forgerock.json.resource: Common attributes of all JSON resource requests.
Request() - Constructor for class org.forgerock.http.protocol.Request: Creates a new request message.
Request(Request) - Constructor for class org.forgerock.http.protocol.Request: Creates a defensive copy of the given request message.
REQUEST - org.forgerock.openig.decoration.capture.CapturePoint: Prints input request.
REQUEST - org.forgerock.openig.tools.ServerTlsOptions.ClientAuthentication: Accept client authentication if provided.
REQUEST - org.forgerock.openig.util.MessageType: Message is an HTTP request.
REQUEST - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The request event payload field name.
REQUEST_HEADER_FIELDS_TOO_LARGE - Static variable in class org.forgerock.http.protocol.Status: The 431 status code indicates that the server is unwilling to process the request because its header fields are too large.
REQUEST_TIMEOUT - Static variable in class org.forgerock.http.protocol.Status: The 408 (Request Timeout) status code indicates that the server did not receive a complete request message within the time that it was prepared to wait.
RequestAuditContext - Class in org.forgerock.services.context: A context for audit information for an incoming request.
RequestAuditContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.RequestAuditContext: Restores a saved context.
RequestAuditContext(Context) - Constructor for class org.forgerock.services.context.RequestAuditContext: Deprecated.
Prefer using RequestAuditContext(Context, Instant) not to rely on the system clock.
RequestAuditContext(Context, Clock) - Constructor for class org.forgerock.services.context.RequestAuditContext: Deprecated.
Prefer using RequestAuditContext(Context, Instant).
RequestAuditContext(Context, Instant) - Constructor for class org.forgerock.services.context.RequestAuditContext: Constructs a new context using the specified parent and the current time as the request received time.
RequestCookies - Class in org.forgerock.http.protocol: Exposes incoming request cookies.
RequestCookies(Request) - Constructor for class org.forgerock.http.protocol.RequestCookies: Constructs a new request cookies object that reads cookies from the specified request.
requestCopyFilter() - Static method in class org.forgerock.http.filter.Filters: Creates a Filter which creates a defensive copy of the Request - on which the chain of execution will be based on.
requestFromCrestRequest(Request) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets request detail from Request.
RequestHandler - Interface in org.forgerock.json.resource: Represents the contract with a set of resources.
RequestResolver - Class in org.forgerock.openig.resolver: Resolves Request objects.
RequestResolver() - Constructor for class org.forgerock.openig.resolver.RequestResolver
requestResourceApiVersionMatcher(Version) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches the request resource API version with the provided version.
requestResourceApiVersionMatcher(Version) - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a RouteMatcher instance that matches the request resource API version with the provided version.
RequestResourceUriProvider - Class in org.forgerock.openig.openam: The RequestResourceUriProvider has the following configuration:
RequestResourceUriProvider() - Constructor for class org.forgerock.openig.openam.RequestResourceUriProvider: Create a new RequestResourceUriProvider based on the defaults.
RequestResourceUriProvider(boolean, boolean) - Constructor for class org.forgerock.openig.openam.RequestResourceUriProvider: Create a new RequestResourceUriProvider based on the passed parameters.
RequestResourceUriProvider.Heaplet - Class in org.forgerock.openig.openam: Creates and initializes a RequestResourceUriProvider in a heap environment.
Requests - Class in org.forgerock.json.resource: A utility class containing various factory methods for creating and manipulating requests.
RequestType - Enum in org.forgerock.json.resource: An enumeration whose values represent the different types of request.
requestUriMatcher(RoutingMode, String) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches Requests with the provided mode and template.
requestUriMatcher(RoutingMode, String) - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a RouteMatcher instance that matches Requests with the provided mode and template.
RequestVisitor<R,P> - Interface in org.forgerock.json.resource: A visitor of Requests, in the style of the visitor design pattern.
required() - Method in class org.forgerock.json.JsonValue: Throws a JsonValueException if the JSON value is null.
required(String) - Static method in class org.forgerock.openig.util.JsonValues: Displays a custom message when the required attribute is not present in the configuration.
REQUIRED - org.forgerock.openig.tools.ServerTlsOptions.ClientAuthentication: Require client authentication.
requiredHeapObject(Heap, Class<T>) - Static method in class org.forgerock.openig.util.JsonValues: Returns a Function to transform a list of String-based JsonValues into a list of required heap objects.
requiredKeyUsages(Set<KeyUsage>) - Static method in interface org.forgerock.secrets.SecretConstraint: Enforces that the key satisfies all of the given key usage constraints.
requiredKeyUsages(KeyUsage, KeyUsage...) - Static method in interface org.forgerock.secrets.SecretConstraint: Enforces that the key satisfies all of the given key usage constraints.
requireField(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Helper method to be used when overriding AuditEventBuilder.validate().
reset() - Method in class org.forgerock.http.io.FailableInputStream
reset() - Method in class org.forgerock.openig.filter.circuitbreaker.SlidingCounterResultRecorder
reset() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
reset(Option<T>) - Method in class org.forgerock.util.Options: Resets an option to its default behavior.
RESET_CONTENT - Static variable in class org.forgerock.http.protocol.Status: The 205 (Reset Content) status code indicates that the server has fulfilled the request and desires that the user agent reset the "document view", which caused the request to be sent, to its original state as received from the origin server.
resetBuffer() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
resolve(String) - Method in interface org.forgerock.openig.alias.ClassAliasResolver: Returns the Class mapped to the given alias or null if the alias is unknown.
resolve(String) - Method in class org.forgerock.openig.alias.CoreClassAliasResolver
resolve(String) - Method in class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
resolve(String) - Method in class org.forgerock.openig.handler.saml.SamlClassAliasResolver
resolve(String) - Method in class org.forgerock.openig.heap.TokenResolver: Resolves the given token, returning null if resolution failed.
resolve(String) - Method in class org.forgerock.openig.openam.OpenAMClassAliasResolver
resolve(String) - Method in class org.forgerock.openig.uma.UmaClassAliasResolver
resolve(String, String) - Method in class org.forgerock.openig.heap.TokenResolver: Resolves the given token, returning def value if resolution failed.
resolve(MutableUri) - Method in class org.forgerock.http.MutableUri: Resolves the given URI against this URI.
resolve(JsonValue, Class<T>) - Method in interface org.forgerock.openig.heap.Heap: Resolves a mandatory object with the specified reference.
resolve(JsonValue, Class<T>) - Method in class org.forgerock.openig.heap.HeapImpl
resolve(JsonValue, Class<T>, boolean) - Method in interface org.forgerock.openig.heap.Heap: Resolves an object with the specified reference, optionally or not.
resolve(JsonValue, Class<T>, boolean) - Method in class org.forgerock.openig.heap.HeapImpl
resolve(Context, String) - Method in interface org.forgerock.http.oauth2.AccessTokenResolver: Deprecated, for removal: This API element is subject to removal in a future version.
Use AccessTokenResolver.resolve(Context, Supplier, String) instead.
resolve(Context, Supplier<Request, IOException>, String) - Method in interface org.forgerock.http.oauth2.AccessTokenResolver: Resolves a given access token against an authorization server.
resolve(Context, Supplier<Request, IOException>, String) - Method in class org.forgerock.http.oauth2.resolver.CachingAccessTokenResolver
resolve(Context, Supplier<Request, IOException>, String) - Method in class org.forgerock.http.oauth2.resolver.OpenAmAccessTokenResolver: Deprecated.
resolve(Context, Supplier<Request, IOException>, String) - Method in class org.forgerock.http.oauth2.resolver.TokenIntrospectionAccessTokenResolver
resolve(Context, Supplier<Request, IOException>, String) - Method in class org.forgerock.openig.filter.oauth2.CaffeineCacheAccessTokenResolver
resolve(Context, Supplier<Request, IOException>, String) - Method in class org.forgerock.openig.filter.oauth2.cnf.ConfirmationKeyVerifierAccessTokenResolver
resolve(Context, Supplier<Request, IOException>, String) - Method in class org.forgerock.openig.filter.oauth2.ScriptableAccessTokenResolver
resolve(Context, Supplier<Request, IOException>, String) - Method in class org.forgerock.openig.filter.oauth2.StatelessAccessTokenResolver
resolveActiveSigningCredential(String, String, Saml2EntityRole) - Method in class org.forgerock.openig.handler.saml.SecretsSaml2CredentialResolver
resolvedLocation() - Static method in class org.forgerock.openig.util.JsonValues: Returns a function that will resolve the field $location.
resolvedLocation(Bindings) - Static method in class org.forgerock.openig.util.JsonValues: Returns a function that will resolve the field $location.
resolveEntity(String, String) - Method in class org.forgerock.util.xml.XMLHandler
Resolver - Interface in org.forgerock.openig.resolver: Exposes an object's elements for access through dynamic expressions and scripts.
resolvers(Object) - Static method in class org.forgerock.openig.resolver.Resolvers: Provides an iterable object over the resolvers that are appropriate for a particular object.
Resolvers - Class in org.forgerock.openig.resolver: Performs object resolution by object type.
resolveValidDecryptionCredentials(String, String, Saml2EntityRole) - Method in class org.forgerock.openig.handler.saml.SecretsSaml2CredentialResolver
resolveValidEncryptionCredentials(String, String, Saml2EntityRole) - Method in class org.forgerock.openig.handler.saml.SecretsSaml2CredentialResolver
resolveValidSigningCredentials(String, String, Saml2EntityRole) - Method in class org.forgerock.openig.handler.saml.SecretsSaml2CredentialResolver
Resource - Interface in org.forgerock.openig.handler.resources: A Resource represents any content that can be served through the ResourceHandler.
RESOURCE - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader: The name of the resource value component.
ResourceAccess - Interface in org.forgerock.http.oauth2: A ResourceAccess encapsulates the logic of required scope selection.
ResourceApiVersionBehaviourManager - Interface in org.forgerock.http.routing: Implementations of this interface will be responsible for maintaining the behaviour of API Version routing.
resourceApiVersionContextFilter(ResourceApiVersionBehaviourManager) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a Filter which MUST be placed, in the route, before any API Version routing takes place.
resourceApiVersionContextFilter(ResourceApiVersionBehaviourManager) - Static method in class org.forgerock.json.resource.RouteMatchers: Creates a Filter which MUST be placed, in the route, before any API Version routing takes place.
resourceApiVersionMatcher(Version) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches the request resource API version with the provided version.
ResourceApiVersionRoutingFilter - Class in org.forgerock.http.routing: API Version routing filter which creates a ApiVersionRouterContext which contains the default routing behaviour when the Accept-API-Version header is set on the request.
ResourceApiVersionRoutingFilter - Class in org.forgerock.json.resource: API Version routing filter which creates a ApiVersionRouterContext which contains the default routing behaviour when the Accept-API-Version header is set on the request.
ResourceApiVersionRoutingFilter(ResourceApiVersionBehaviourManager) - Constructor for class org.forgerock.http.routing.ResourceApiVersionRoutingFilter: Constructs a new ResourceApiVersionRoutingFilter instance.
ResourceApiVersionSpecificationFilter - Class in org.forgerock.json.resource: A Filter supporting the specification of resource API version configuration to be used when a request on a specific endpoint does not contain an Accept-API-Version header.
ResourceApiVersionSpecificationFilter(ResourceApiVersionSpecificationFilter.VersionSpecification) - Constructor for class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter: Constructs a new ResourceApiVersionSpecificationFilter instance.
ResourceApiVersionSpecificationFilter.NoApiVersionHandler - Interface in org.forgerock.json.resource: Handler allowing products to extend behaviour when a request has no resource API version supplied.
ResourceApiVersionSpecificationFilter.ResourcePathAndVersion - Class in org.forgerock.json.resource: Class representing a mapping between a ResourcePath and a Version.
ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification - Class in org.forgerock.json.resource: ResourceApiVersionSpecificationFilter.VersionSpecification supporting specification of a request's resource version based on its resource path.
ResourceApiVersionSpecificationFilter.VersionSpecification - Interface in org.forgerock.json.resource: Mechanism supporting specification of a version on the request.
resourceException(String, String, String, Response) - Static method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler: Gets an Exception Promise containing an Elasticsearch HTTP response status and payload.
ResourceException - Exception in org.forgerock.json.resource: An exception that is thrown during the processing of a JSON resource request.
ResourceException(int) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code, and null as its detail message.
ResourceException(int, String) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code and detail message.
ResourceException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code, reason phrase, detail message and cause.
ResourceException(int, Throwable) - Constructor for exception org.forgerock.json.resource.ResourceException: Constructs a new exception with the specified exception code and detail message.
ResourceExceptionsUtil - Class in org.forgerock.audit.util: Utility class to use on ResourceExceptions.
ResourceHandler - Class in org.forgerock.openig.handler.resources: A ResourceHandler is a handler that serves static content (content of a directory, or a zip).
ResourceHandler(Factory<Buffer>, List<ResourceSet>, List<String>) - Constructor for class org.forgerock.openig.handler.resources.ResourceHandler: Creates a new ResourceHandler with the given sets of ResourceSet and the list of welcome pages mappings.
ResourceHandler.Heaplet - Class in org.forgerock.openig.handler.resources: Creates and initializes a ResourceHandler in a heap environment.
ResourceOwnerOAuth2ClientFilterHeaplet - Class in org.forgerock.openig.filter.oauth2.client: Creates and initializes a Filter supporting the transformation of client and user credentials to an access_token, using the grant type "password".
ResourceOwnerOAuth2ClientFilterHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.client.ResourceOwnerOAuth2ClientFilterHeaplet
ResourceOwnerOAuth2ClientFilterTypeProvider - Class in org.forgerock.openig.filter.oauth2.client: The TypeDefinitionProvider of the ResourceOwnerOAuth2ClientFilterHeaplet.
ResourceOwnerOAuth2ClientFilterTypeProvider() - Constructor for class org.forgerock.openig.filter.oauth2.client.ResourceOwnerOAuth2ClientFilterTypeProvider
ResourceOwnerPasswordGrantTypeHandler - Class in org.forgerock.secrets.oauth2: A grant type handler that can obtain an access token using the Resource Owner Password Credentials (ROPC) grant.
ResourceOwnerPasswordGrantTypeHandler(String, String, SecretReference<GenericSecret>) - Constructor for class org.forgerock.secrets.oauth2.ResourceOwnerPasswordGrantTypeHandler: Initialises the grant type handler with the given credentials and the default scope for this client.
ResourceOwnerPasswordGrantTypeHandler(String, String, SecretReference<GenericSecret>, Collection<String>) - Constructor for class org.forgerock.secrets.oauth2.ResourceOwnerPasswordGrantTypeHandler: Initialises the grant type handler with the given credentials.
resourcePath() - Static method in class org.forgerock.json.resource.JsonValueFunctions: Returns the JSON string value as a ResourcePath.
resourcePath(String) - Static method in class org.forgerock.json.resource.ResourcePath: Parses the provided string representation of a resource path.
ResourcePath - Class in org.forgerock.json.resource: A relative path, or URL, to a resource.
ResourcePath() - Constructor for class org.forgerock.json.resource.ResourcePath: Creates a new empty resource path whose string representation is the empty string and which has zero path elements.
ResourcePath(Object...) - Constructor for class org.forgerock.json.resource.ResourcePath: Creates a new resource path having the provided path elements.
ResourcePath(Collection<? extends Object>) - Constructor for class org.forgerock.json.resource.ResourcePath: Creates a new resource path having the provided path elements.
ResourcePathAndVersion(ResourcePath, Version) - Constructor for class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersion: Construct a ResourceApiVersionSpecificationFilter.ResourcePathAndVersion.
resourcePathAndVersionSpecification(JsonValue) - Static method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification: Create a new ResourcePathAndVersionSpecification configured with resource path to version specification.
ResourceResponse - Interface in org.forgerock.json.resource: A resource, comprising of a resource ID, a revision (etag), and its JSON content.
Resources - Class in org.forgerock.json.resource: This class contains methods for creating and manipulating connection factories and connections.
ResourceServerFilter - Class in org.forgerock.http.oauth2: Validates a Request that contains an OAuth 2.0 access token.
ResourceServerFilter(AccessTokenResolver, Clock, ResourceAccess, String) - Constructor for class org.forgerock.http.oauth2.ResourceServerFilter: Deprecated.
The clock attribute is not used anymore. Use ResourceServerFilter(AccessTokenResolver, ResourceAccess, String) instead. Deprecated in 25.0.0.
ResourceServerFilter(AccessTokenResolver, ResourceAccess, String) - Constructor for class org.forgerock.http.oauth2.ResourceServerFilter: Creates a new ResourceServerFilter.
ResourceSet - Interface in org.forgerock.openig.handler.resources: A ResourceSet abstracts Resource lookup mechanism.
resourceUri(Context, Request) - Method in class org.forgerock.openig.openam.RequestResourceUriProvider
resourceUri(Context, Request) - Method in interface org.forgerock.openig.openam.ResourceUriProvider: Returns the resource URI as a String to be used when making policy requests.
resourceUri(Context, Request) - Method in class org.forgerock.openig.openam.ScriptableResourceUriProvider
ResourceUriProvider - Interface in org.forgerock.openig.openam: Used to obtain the resource URI to include in policy requests.
response(AccessAuditEventBuilder.ResponseStatus, String, long, TimeUnit) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided response for the event.
Response - Class in org.forgerock.http.protocol: A response message.
Response - Interface in org.forgerock.json.resource: Common response object of all resource responses.
Response(Response) - Constructor for class org.forgerock.http.protocol.Response: Creates a defensive copy of the given response message.
Response(Status) - Constructor for class org.forgerock.http.protocol.Response: Creates a new response with a default status.
RESPONSE - org.forgerock.openig.decoration.capture.CapturePoint: Prints the output response.
RESPONSE - org.forgerock.openig.util.MessageType: Message is an HTTP response.
RESPONSE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The response event payload field name.
RESPONSE_STALE - Static variable in class org.forgerock.http.header.WarningHeader: 110 Response is stale MUST be included whenever the returned response is stale.
RESPONSE_STALE - Static variable in class org.forgerock.json.resource.AdviceWarning: 110 Response is stale MUST be included whenever the returned response is stale.
ResponseCacheControl - Class in org.forgerock.json.resource: Indicates whether a response can be cached and under what conditions.
ResponseException - Exception in org.forgerock.http.protocol: An HTTP Framework Exception that can be used by filters/handlers to simplify control-flow inside async call-backs.
ResponseException(String) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given message.
ResponseException(String, Throwable) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given message and parent cause.
ResponseException(Response) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given response.
ResponseException(Response, String, Throwable) - Constructor for exception org.forgerock.http.protocol.ResponseException: Constructs a ResponseException using the given response, message and parent cause.
Responses - Class in org.forgerock.http.protocol: Provide out-of-the-box, pre-configured Response objects.
Responses - Class in org.forgerock.json.resource: A utility class containing various factory methods for creating and manipulating responses.
responseWithDetail(AccessAuditEventBuilder.ResponseStatus, String, long, TimeUnit, JsonValue) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided response for the event, with an additional detail.
restoreKeyPeriods(JsonValue, JsonValue) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Reverses the normalization steps preformed by ElasticsearchUtil.replaceKeyPeriodsWithUnderscores(String).
result(AuthenticationAuditEventBuilder.Status) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Sets the authentication audit event overall result.
Result - Class in org.forgerock.openig.filter.oauth2.cnf: A Result represents the result of a validation operation: either a success or a failure (with an associated description).
Result - Class in org.forgerock.openig.tools.jwt.validation: A Result of a JWT validation.
RESULT - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Defines the authentication result key.
ResultHandler<V> - Interface in org.forgerock.util.promise: A completion handler for consuming the results of asynchronous tasks.
retainAll(Collection<?>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
retainAll(Collection<?>) - Method in class org.forgerock.http.util.SetDecorator: Retains only the elements in the set that are contained in the specified collection (optional operation).
retainAll(Collection<?>) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
retainAll(Collection<?>) - Method in class org.forgerock.openig.session.jwt.dirty.DirtySet
retainAll(Collection<?>) - Method in class org.forgerock.util.LazyList: Retains only the elements in this list that are contained in the specified collection.
retainAll(Collection<?>) - Method in class org.forgerock.util.ListDecorator: Retains only the elements in this list that are contained in the specified collection.
RetentionHooks - Interface in org.forgerock.audit.retention: Hook into the retention checking operations for a file.
RetentionHooks.NullRetentionHooks - Class in org.forgerock.audit.retention: RetentionHooks that do nothing.
RetentionPolicy - Interface in org.forgerock.audit.retention: Defines the retention conditions and the files that need to be deleted.
rethrowBiFunction(BiFunction<T, U, R, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils: Wrap a BiFunction to comply with BiFunction's no checked exception signature.
rethrowConsumer(Consumer<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils: Wrap a Consumer to comply with Consumer's no checked exception signature.
rethrowFunction(Function<T, R, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils: Wrap a throwing Function to comply with Function's no checked exception signature.
rethrowPredicate(Predicate<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils: Wrap a Predicate to comply with Predicate's no checked exception signature.
rethrowSupplier(Supplier<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils: Wrap a Supplier to comply with Supplier's no checked exception signature.
retire(Purpose<? extends CryptoKey>, String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore: Retires a key previously used for a given purpose.
retire(Purpose<? extends T>, String) - Method in interface org.forgerock.secrets.SecretStore: Retires the given secret for the given purpose.
retire(Purpose<? extends T>, String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
retries(int) - Method in class org.forgerock.openig.filter.RetryFilter.Builder
retrieveCryptoKeyFromSecretId(SecretsProvider, JsonValue, Class<S>) - Static method in class org.forgerock.openig.secrets.SecretsUtils: Retrieves a CryptoKey from the given node.
retrievePasswordAsReference(SecretsProvider, JsonValue, JsonValue, Logger) - Static method in class org.forgerock.openig.secrets.SecretsUtils: Retrieve a required password as a SecretReference from the given secretIdNode and deprecatedNode nodes.
retrievePasswordAsReference(SecretsProvider, JsonValue, JsonValue, Logger, boolean) - Static method in class org.forgerock.openig.secrets.SecretsUtils: Retrieve a password as a SecretReference from the given secretIdNode and deprecatedNode nodes.
RetryableException - Exception in org.forgerock.json.resource: An exception that indicates that a failure may be temporary, and that retrying the same request may be able to succeed in the future.
RetryableException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.RetryableException: Constructs a new exception with the specified detail message and cause.
retryFilter(JsonValue, MeterRegistry) - Method in class org.forgerock.openig.handler.HttpClientHandlerHeaplet: Returns a RetryFilter if the provided configuration enabled its usage, or empty if not.
RetryFilter - Class in org.forgerock.openig.filter: A RetryFilter is responsible for re-executing the incoming request should it fail with a runtime exception or if an optional condition expression evaluates to true.
RetryFilter.Builder - Class in org.forgerock.openig.filter
REVALIDATION_FAILED - Static variable in class org.forgerock.http.header.WarningHeader: 111 Revalidation failed MUST be included if a cache returns a stale response because an attempt to revalidate the response failed, due to an inability to reach the server.
REVALIDATION_FAILED - Static variable in class org.forgerock.json.resource.AdviceWarning: 111 Revalidation failed MUST be included if a cache returns a stale response because an attempt to revalidate the response failed, due to an inability to reach the server.
reveal(Function<Key, T>) - Method in class org.forgerock.secrets.keys.CryptoKey: Reveals the secret's Key temporarily, allowing it to be used for its intended purpose.
reveal(Function<byte[], T, E>) - Method in class org.forgerock.secrets.GenericSecret: Reveals the secret temporarily, allowing it to be used for its intended purpose.
revealAndClose(Function<Key, T>) - Method in class org.forgerock.secrets.keys.CryptoKey: Reveals the secret temporarily and then scrubs the secret material from memory.
revealAndDestroy(Function<byte[], T, E>) - Method in class org.forgerock.secrets.GenericSecret: Reveals the secret temporarily and then scrubs the secret material from memory.
revealAsText(Charset, Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret: Reveals the secret temporarily as characters in the given character set.
revealAsTextAndDestroy(Charset, Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret: Reveals the secret temporarily as characters in the given character set and then scrubs the secret material from memory.
revealAsUtf8(Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret: Reveals the secret temporarily as characters in UTF-8.
revealAsUtf8AndDestroy(Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret: Reveals the secret temporarily as characters in UTF-8 and then scrubs the secret from memory.
reverse(byte[]) - Static method in class org.forgerock.json.jose.utils.Utils: Reverses the given array and returns the reversed copy.
REVERSE_PROXY_HANDLER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve a default ReverseProxyHandler instance from the Heap.
reverseOrder(SortKey) - Static method in class org.forgerock.json.resource.SortKey: Creates a new sort key having the same field as the provided key, but in reverse sort order.
ReverseProxyHandlerHeaplet - Class in org.forgerock.openig.handler: Creates a reverse proxy Handler in a heap environment.
ReverseProxyHandlerHeaplet() - Constructor for class org.forgerock.openig.handler.ReverseProxyHandlerHeaplet
ReverseProxyHandlerTypeProvider - Class in org.forgerock.openig.handler: Provide ReverseProxyHandler's TypeDefinition.
ReverseProxyHandlerTypeProvider() - Constructor for class org.forgerock.openig.handler.ReverseProxyHandlerTypeProvider
REVOCATION_OPTIONS - Static variable in class org.forgerock.secrets.SecretsTrustManager: The options to pass to the revocation checker, if revocation checking is enabled.
revoke(String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore: Revokes a key from all purposes.
revoke(String) - Method in interface org.forgerock.secrets.SecretStore: Revokes the given secret for all purposes in this store.
revoke(String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
ROOT_REALM - Static variable in class org.forgerock.openig.tools.am.Realm: The root realm, known as "/".
RootContext - Class in org.forgerock.services.context: A Context which has an a globally unique ID but no parent.
RootContext() - Constructor for class org.forgerock.services.context.RootContext: Construct a new RootContext with the default IdGenerator.
RootContext(String) - Constructor for class org.forgerock.services.context.RootContext: Construct a new RootContext with the given id (uniqueness is not verified).
RootContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.RootContext: Restore from JSON representation.
rootPtr() - Static method in class org.forgerock.json.JsonPointer: Returns a JSON pointer identifying the root value of a JSON structure.
RotatableObject - Interface in org.forgerock.audit.rotation: Interface defining methods a rotatable file needs.
RotatableWriter - Class in org.forgerock.audit.events.handlers.writers: Supports file rotation and retention.
RotatableWriter(File, FileBasedEventHandlerConfiguration, boolean) - Constructor for class org.forgerock.audit.events.handlers.writers.RotatableWriter: Constructs a RotatableWriter given an initial file to manage rotation/retention, and a FileBasedEventHandlerConfiguration.
RotatableWriter(File, FileBasedEventHandlerConfiguration, boolean, RotatableWriter.RolloverLifecycleHook) - Constructor for class org.forgerock.audit.events.handlers.writers.RotatableWriter: Constructs a RotatableWriter given an initial file to manage rotation/retention, a a FileBasedEventHandlerConfiguration and a RotatableWriter.RolloverLifecycleHook.
RotatableWriter.RolloverLifecycleHook - Interface in org.forgerock.audit.events.handlers.writers: Callback hooks to allow custom action to be taken before and after the checks for rotation and retention is performed.
rotate(Purpose<? extends CryptoKey>, String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore: Rotates the key associated with a given purpose.
rotate(Purpose<? extends T>, String) - Method in interface org.forgerock.secrets.SecretStore: Rotates the active secret for the given purpose.
rotate(Purpose<? extends T>, String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
ROTATE_FILE_ACTION_NAME - Static variable in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler: Name of action to force file rotation.
ROTATE_FILE_ACTION_NAME - Static variable in class org.forgerock.audit.handlers.json.JsonAuditEventHandler: Name of action to force file rotation.
rotateIfNeeded() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Rotate the log file if any of the configured rotation policies determine that rotation is required.
rotateIfNeeded() - Method in interface org.forgerock.audit.rotation.RotatableObject: Checks the rotatable file for rotation then retention.
RotationContext - Class in org.forgerock.audit.rotation: This class holds some information while a file is being rotated.
RotationContext() - Constructor for class org.forgerock.audit.rotation.RotationContext
RotationHooks - Interface in org.forgerock.audit.rotation: Callback hooks to allow custom action to be taken before and after file rotation occurs.
RotationHooks.NoOpRotatationHooks - Class in org.forgerock.audit.rotation: RotationHooks that do nothing.
RotationPolicy - Interface in org.forgerock.audit.rotation: Interface to decide if a file should be rotated or not.
route() - Method in class org.forgerock.openig.types.importer.RouteInstance: Returns the underlying route's component instance.
route(ComponentInstance) - Method in class org.forgerock.openig.types.importer.RouteInstance: Sets the component instance supporting this route.
routeId() - Method in class org.forgerock.openig.types.importer.RouteInstance: Returns the route identifier.
RouteImporter - Class in org.forgerock.openig.types.importer: A RouteImporter is responsible for creating a RouteInstance from a given JsonValue that represents an IG route.
RouteImporter(TypeDefinitionRegistry, ComponentInstanceFactoryRegistry) - Constructor for class org.forgerock.openig.types.importer.RouteImporter: Constructs a RouteImporter with the given definitionRegistry and factoryRegistry.
RouteInstance - Class in org.forgerock.openig.types.importer: A RouteInstance describes a route with all of its internal components, all linked together.
RouteInstance(Model, String) - Constructor for class org.forgerock.openig.types.importer.RouteInstance: Constructs a new RouteInstance with the given model.
RouteMatch - Interface in org.forgerock.services.routing: Contains the result of routing to a particular route.
RouteMatcher<R> - Class in org.forgerock.services.routing: A matcher for evaluating whether a route matches the incoming request.
RouteMatcher() - Constructor for class org.forgerock.services.routing.RouteMatcher
RouteMatchers - Class in org.forgerock.http.routing: A utility class that contains methods for creating route matchers.
RouteMatchers - Class in org.forgerock.json.resource: A utility class that contains methods for creating route matchers.
Router - Class in org.forgerock.http.routing: A router which routes requests based on route matchers.
Router - Class in org.forgerock.json.resource: A router which routes requests based on route predicates.
Router() - Constructor for class org.forgerock.http.routing.Router: Creates a new router with no routes defined.
Router() - Constructor for class org.forgerock.json.resource.Router: Creates a new router with no routes defined.
Router(Router) - Constructor for class org.forgerock.http.routing.Router: Creates a new router containing the same routes and default route as the provided router.
Router(AbstractRouter<Router, Request, RequestHandler, ApiDescription>) - Constructor for class org.forgerock.json.resource.Router: Creates a new router containing the same routes and default route as the provided router.
Router.UriTemplate - Class in org.forgerock.json.resource: Represents a URI template string that will be used to match and route incoming requests.
RouterHandler - Class in org.forgerock.openig.handler.router: Auto-configured DispatchHandler.
RouterHandler(RouteBuilder, DirectoryMonitor, MeterRegistry) - Constructor for class org.forgerock.openig.handler.router.RouterHandler: Builds a router that loads its configuration from the given directory.
RouterHandler(RouteBuilder, DirectoryMonitor, MeterRegistry, Handler) - Constructor for class org.forgerock.openig.handler.router.RouterHandler: Builds a router that loads its configuration from the given directory.
RouterHandler.Heaplet - Class in org.forgerock.openig.handler.router: Creates and initializes a routing handler in a heap environment.
RouterHandlerException - Exception in org.forgerock.openig.handler.router: Represents an exception whilst managing the routes in a @RouterHandler.
RouterHandlerException(String) - Constructor for exception org.forgerock.openig.handler.router.RouterHandlerException: Builds an RouterHandlerException with a given message.
RouterHandlerException(String, Exception) - Constructor for exception org.forgerock.openig.handler.router.RouterHandlerException: Builds an RouterHandlerException with a given message and cause.
ROUTING_BASE_INIT_PARAM_NAME - Static variable in class org.forgerock.http.servlet.HttpFrameworkServlet: Servlet init-param for configuring the routing base for the HttpApplication.
RoutingMode - Enum in org.forgerock.http.routing: The algorithm which should be used when matching URI templates against request resource names.
RS256 - org.forgerock.json.jose.jws.JwsAlgorithm: RSA using SHA-256 hash algorithm.
RS384 - org.forgerock.json.jose.jws.JwsAlgorithm: RSA using SHA-384 hash algorithm.
RS512 - org.forgerock.json.jose.jws.JwsAlgorithm: RSA using SHA-512 hash algorithm.
RSA - org.forgerock.json.jose.jwe.JweAlgorithmType: RSA encryption algorithm.
RSA - org.forgerock.json.jose.jwk.KeyType: RSA key.
RSA - org.forgerock.json.jose.jws.JwsAlgorithmType: RSA signing algorithm.
RSA_OAEP - org.forgerock.json.jose.jwe.JweAlgorithm: RSA in ECB mode with OAEP with SHA-1 and MGF1 padding.
RSA_OAEP_256 - org.forgerock.json.jose.jwe.JweAlgorithm: RSA in ECB mode with OAEP with SHA-256 and MGF1 with SHA-256 padding.
RSA15AES128CBCHS256EncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption: Deprecated.
Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.
RSA15AES128CBCHS256EncryptionHandler(SigningManager) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler: Deprecated.

Constructs a new RSA15AES128CBCHS256EncryptionHandler.
RSA15AES256CBCHS512EncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption: Deprecated.
Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.
RSA15AES256CBCHS512EncryptionHandler(SigningManager) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler: Deprecated.

Constructs a new RSA15AES256CBCHS512EncryptionHandler.
RSAEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption: Abstract base class for implementations of the RSAES-PKCS1-v1_5 and RSA-OAEP encryption schemes.
RSAEncryptionHandler(EncryptionMethod, JweAlgorithm) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler: Constructs a new RSAEncryptionHandler instance.
RSAEncryptionHandler(EncryptionMethod, JweAlgorithm, Options) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler: Constructs a new RSAEncryptionHandler instance with the given options.
RSAES_PKCS1_V1_5 - org.forgerock.json.jose.jwe.JweAlgorithm: Deprecated.
RSA1_5 is an insecure encryption mode. Use JweAlgorithm.RSA_OAEP_256 instead.
RsaJWK - Class in org.forgerock.json.jose.jwk: Implements a RsaJWK.
RsaJWK(String, String, String, String, String, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK: Deprecated.
Use the builder instead.
RsaJWK(String, String, String, String, String, String, String, String, String, String, String, List<RsaJWK.PrimesInfo>, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK: Deprecated.
Use the builder instead.
RsaJWK(String, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK: Deprecated.
Use the builder instead.
RsaJWK(String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK: Deprecated.
Use the builder instead.
RsaJWK(RSAPublicKey, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK: Deprecated.
Use the builder instead.
RsaJWK(RSAPublicKey, RSAPrivateCrtKey, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK: Deprecated.
Use the builder instead.
RsaJWK(RSAPublicKey, RSAPrivateKey, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK: Deprecated.
Use the builder instead.
RsaJWK.Builder - Class in org.forgerock.json.jose.jwk: The RSA JWK builder.
RsaJWK.PrimesInfo - Class in org.forgerock.json.jose.jwk: Holds the other prime factors.
rsaPrivateCrtKey(RSAPrivateCrtKey) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Sets the RSA private certificate key.
rsaPrivateKey(RSAPrivateKey) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder: Sets the RSA private key.
RSASigningHandler - Class in org.forgerock.json.jose.jws.handlers: Deprecated.
Use SecretRSASigningHandler instead
RSASigningHandler(Key) - Constructor for class org.forgerock.json.jose.jws.handlers.RSASigningHandler: Deprecated.

Constructs a new RSASigningHandler.
RSASigningHandler(Key, SignatureUtil) - Constructor for class org.forgerock.json.jose.jws.handlers.RSASigningHandler: Deprecated.
Please use RSASigningHandler(Key).
run() - Method in class org.forgerock.http.protocol.MdcAwareAction
run() - Method in interface org.forgerock.util.Action: Runs the action, throwing the Exception if necessary.
run(Map<String, Object>) - Method in interface org.forgerock.openig.script.Script: Runs this script with the provided bindings.
RunMode - Enum in org.forgerock.openig.http: Supported runtime modes.
RUNMODE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the RunMode from the Heap.
runScript(Bindings, Context, Class<V>) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject: Synchronously runs the compiled script using the provided bindings.
runScriptAsync(Bindings, Context, Class<V>) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject: Asynchronously runs the compiled script using the provided bindings.
RuntimeExceptionFilter - Class in org.forgerock.openig.filter: This filter aims to guarantee the caller that it will always get a Response to process, even if the next returns a promise completed with a RuntimeException, or even if a RuntimeException is thrown.
RuntimeExceptionFilter() - Constructor for class org.forgerock.openig.filter.RuntimeExceptionFilter
RuntimeExceptionHandler - Interface in org.forgerock.util.promise: A completion handler for consuming runtime exceptions which occur during the execution of asynchronous tasks.

S

sameSite(Cookie.SameSite) - Method in class org.forgerock.openig.http.CookieBuilder: Set the SameSite enum and return a new instance of this builder.
SamlClassAliasResolver - Class in org.forgerock.openig.handler.saml: Register all the aliases supported by the openig-saml module.
SamlClassAliasResolver() - Constructor for class org.forgerock.openig.handler.saml.SamlClassAliasResolver
SamlFederationHandler - Class in org.forgerock.openig.handler.saml: The SAML federation handler.
SamlFederationHandler.Heaplet - Class in org.forgerock.openig.handler.saml: Reads the actual federation servlet from the JSON configuration file.
save(Session, Response) - Method in interface org.forgerock.http.session.SessionManager: Deprecated.

Saves the session into the provided response.
saveAsync(Session, Response) - Method in interface org.forgerock.http.session.AsyncSessionManager: Saves the session into the provided response.
schedule(Runnable, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
schedule(Callable<V>, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
scheduleAtFixedRate(Runnable, long, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
SCHEDULED_EXECUTOR_SERVICE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the default ScheduledExecutorService instance from the Heap.
ScheduledExecutorServiceHeaplet - Class in org.forgerock.openig.thread: Heaplet for building ScheduledExecutorService instances.
ScheduledExecutorServiceHeaplet() - Constructor for class org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet
scheduleWithFixedDelay(Runnable, long, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
scheme - Variable in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge: The type of the authentication option.
SCOPE - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set scope key - not available in JwtClaimsSetKey.
Script - Interface in org.forgerock.openig.script: Encapsulate an executable script.
SCRIPT_FACTORY_MANAGER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the global ScriptFactoryManager from the Heap.
ScriptableAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2: A Scriptable access token resolver.
ScriptableAccessTokenResolver.Heaplet - Class in org.forgerock.openig.filter.oauth2: Creates and initializes a scriptable access token resolver in a heap environment.
ScriptableFilter - Class in org.forgerock.openig.filter: A scriptable filter.
ScriptableFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes a scriptable filter in a heap environment.
ScriptableHandler - Class in org.forgerock.openig.handler: A scriptable handler.
ScriptableHandler.Heaplet - Class in org.forgerock.openig.handler: Creates and initializes a scriptable handler in a heap environment.
ScriptableJwtValidatorCustomizer - Class in org.forgerock.openig.filter.jwt: A Scriptable JWT Validator customizer.
ScriptableJwtValidatorCustomizer.Heaplet - Class in org.forgerock.openig.filter.jwt: Creates and initializes a scriptable Jwt Validator customizer in a heap environment.
ScriptableResourceAccess - Class in org.forgerock.openig.filter.oauth2: A scriptable resource access.
ScriptableResourceAccess.Heaplet - Class in org.forgerock.openig.filter.oauth2: Creates and initializes a scriptable object in a heap environment.
ScriptableResourceUriProvider - Class in org.forgerock.openig.openam: A scriptable resource URI provider.
ScriptableResourceUriProvider.Heaplet - Class in org.forgerock.openig.openam: Creates and initializes a scriptable resource url provider in a heap environment.
ScriptableThrottlingPolicy - Class in org.forgerock.openig.filter.throttling: A scriptable throttling datasource.
ScriptableThrottlingPolicy.Heaplet - Class in org.forgerock.openig.filter.throttling: Creates and initializes a scriptable object in a heap environment.
ScriptFactory - Interface in org.forgerock.openig.script: A factory for Scripts.
ScriptFactoryManager - Interface in org.forgerock.openig.script: A ScriptFactoryManager is the plug-in point where ScriptFactory implementations need to be registered in order to be available to the runtime.
search(String, SearchScope, String, String...) - Method in class org.forgerock.openig.ldap.LdapConnection: Searches the Directory Server using the provided search parameters.
search(SearchRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Searches the Directory Server using the provided search parameters.
search(SearchRequest, Collection<? super SearchResultEntry>) - Method in class org.forgerock.openig.ldap.LdapConnection: Searches the Directory Server using the provided search request.
search(SearchRequest, Collection<? super SearchResultEntry>, Collection<? super SearchResultReference>) - Method in class org.forgerock.openig.ldap.LdapConnection: Searches the Directory Server using the provided search request.
searchSingleEntry(String, SearchScope, String, String...) - Method in class org.forgerock.openig.ldap.LdapConnection: Searches the Directory Server for a single entry using the provided search parameters.
searchSingleEntry(SearchRequest) - Method in class org.forgerock.openig.ldap.LdapConnection: Searches the Directory Server for a single entry using the provided search request.
Secret - Class in org.forgerock.secrets: A secret is any piece of data that should be kept confidential.
Secret(SecretBuilder) - Constructor for class org.forgerock.secrets.Secret: Constructs the secret using the given builder.
SECRET - org.forgerock.secrets.keys.KeyType: A symmetric secret key.
SecretBuilder - Class in org.forgerock.secrets: Provides a uniform way for secrets providers to construct secrets and keys.
SecretBuilder() - Constructor for class org.forgerock.secrets.SecretBuilder
SecretConstraint<T extends Secret> - Interface in org.forgerock.secrets: Interface for constraints on a secret that must be satisfied for a given Purpose.
SecretDecoder - Interface in org.forgerock.secrets: Specifies how data retrieved from a SecretStore should be decoded into a secret object.
SecretECDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers: Elliptic Curve Digital Signature Algorithm (ECDSA) signing and verification.
SecretECDSASigningHandler(SigningKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretECDSASigningHandler: Constructs a new SecretECDSASigningHandler for creating signature with the given signingKey.
SecretECDSASigningHandler(VerificationKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretECDSASigningHandler: Constructs a new SecretECDSASigningHandler for verifying signature with the given verificationKey.
SecretEdDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers: Signing handler for Edwards Curve DSA (EdDSA) as defined in RFC 8037.
SecretEdDSASigningHandler(SigningKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretEdDSASigningHandler: Initializes the handler for signing with the given key.
SecretEdDSASigningHandler(VerificationKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretEdDSASigningHandler: Initializes the handler for verifying with the given key.
SecretHmacSigningHandler - Class in org.forgerock.json.jose.jws.handlers: An implementation of the SigningHandler which can sign and verify using algorithms from the HMAC family.
SecretHmacSigningHandler(SigningKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretHmacSigningHandler: Constructs a new SecretHmacSigningHandler for creating signature with the given signingKey.
SecretHmacSigningHandler(VerificationKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretHmacSigningHandler: Constructs a new SecretHmacSigningHandler for verifying signature with the given verificationKey.
secretKey(Key) - Method in class org.forgerock.secrets.SecretBuilder: Sets the secret key for this object.
SecretKeyPropertyFormat - Class in org.forgerock.secrets.propertyresolver: Wraps a property format that decodes raw bytes and converts it into a property format for extracting secret keys using some algorithm.
SecretKeyPropertyFormat(SecretPropertyFormat, String) - Constructor for class org.forgerock.secrets.propertyresolver.SecretKeyPropertyFormat: Initialises the format with the given raw generic secret format and the given key algorithm.
SecretKeyPropertyFormatHeaplet - Class in org.forgerock.openig.secrets: It builds a SecretPropertyFormat that can be use with SecretStore mappings configuration.
SecretKeyPropertyFormatHeaplet() - Constructor for class org.forgerock.openig.secrets.SecretKeyPropertyFormatHeaplet
secretPropertyFormat(Heap) - Static method in class org.forgerock.openig.util.JsonValues: Returns a SecretPropertyFormat object from a JsonValue.
SecretPropertyFormat - Interface in org.forgerock.secrets.propertyresolver: Defines the format of secrets loaded from configuration properties.
SecretReference<T extends Secret> - Class in org.forgerock.secrets: A long-lived reference to an active or named secret.
SecretReference(SecretsProvider, Purpose<T>) - Constructor for class org.forgerock.secrets.SecretReference: Deprecated.
Use SecretsProvider.createActiveReference(Purpose) or SecretReference.active(SecretsProvider, Purpose, Clock) instead.
SecretReference(SecretsProvider, Purpose<T>, Clock) - Constructor for class org.forgerock.secrets.SecretReference: Deprecated.
Use SecretsProvider.createActiveReference(Purpose) or SecretReference.active(SecretsProvider, Purpose, Clock) instead.
secretReferenceOf(Function<JsonValue, Purpose<S>, JsonValueException>, SecretsProvider) - Static method in class org.forgerock.openig.util.JsonValues: Returns a function that returns a SecretReference for the Purpose represented by the given String value label and known to the supplied SecretsProvider.
SecretRSASigningHandler - Class in org.forgerock.json.jose.jws.handlers: An Secret-based implementation of the SigningHandler which can sign and verify using algorithms from the RSA family.
SecretRSASigningHandler(SigningKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretRSASigningHandler: Constructs a new SecretRSASigningHandler for creating signature with the given signingKey.
SecretRSASigningHandler(VerificationKey) - Constructor for class org.forgerock.json.jose.jws.handlers.SecretRSASigningHandler: Constructs a new SecretRSASigningHandler for verifying signature with the given verificationKey.
SECRETS_SERVICE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the default SecretsService instance from the Heap.
SecretSigningHandler - Class in org.forgerock.json.jose.jws.handlers: Provides Secret-based signing and verification code base.
SecretsJwtTokenHandler - Class in org.forgerock.json.jose.tokenhandler: Token handler for creating tokens using a JWT as the store.
SecretsJwtTokenHandler(JweAlgorithm, EncryptionMethod, JwsAlgorithm, Optional<Long>, KeyPair, SigningManager, Purpose<SigningKey>, Purpose<VerificationKey>, Clock) - Constructor for class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler: Deprecated.
Use SecretsJwtTokenHandler.builder() instead.
SecretsJwtTokenHandler.Builder - Class in org.forgerock.json.jose.tokenhandler: Builder pattern object for configuring a SecretsJwtTokenHandler.
SecretsKeyManager - Class in org.forgerock.secrets: An X509ExtendedKeyManager implementation that gets keys and certificates from a SecretsProvider.
SecretsKeyManagerHeaplet - Class in org.forgerock.openig.secrets: A SecretsKeyManagerHeaplet acts as a factory of SecretsKeyManager.
SecretsKeyManagerHeaplet() - Constructor for class org.forgerock.openig.secrets.SecretsKeyManagerHeaplet
SecretsKeyStoreProvider - Class in org.forgerock.secrets: A Java security provider that exposes a KeyStore view of a secret store.
SecretsKeyStoreProvider() - Constructor for class org.forgerock.secrets.SecretsKeyStoreProvider: Default constructor.
SecretsLoadStoreParameter - Class in org.forgerock.secrets: Class used to initialise the keystore when it is initialised via the standard Java interfaces.
SecretsLoadStoreParameter(SecretsProvider, Purpose<? extends CryptoKey>, Clock) - Constructor for class org.forgerock.secrets.SecretsLoadStoreParameter: Initialises the keystore with the given secrets API objects.
secretsProvider - Variable in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: SecretsProvider capable of providing the secret.
secretsProvider - Variable in class org.forgerock.openig.filter.oauth2.client.authentication.PrivateKeyJwtClientAuthenticationFilterHeaplet: Configured SecretsProvider providing access to required keys.
secretsProvider(Heap) - Static method in class org.forgerock.openig.secrets.SecretsProviderHeaplet: Method supporting other client heaplets that wish to create a SecretsProvider using alternative compact configuration formats.
secretsProvider(SecretsProvider) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder: Configures the SecretsProvider from which to retrieve signing and encryption keys.
SecretsProvider - Class in org.forgerock.secrets: The secrets provider is used to get hold of active, named or valid secret objects.
SecretsProvider() - Constructor for class org.forgerock.secrets.SecretsProvider: Deprecated.
Prefer using SecretsProvider(Clock) and provide your own clock instance.
SecretsProvider(Clock) - Constructor for class org.forgerock.secrets.SecretsProvider: Constructs a SecretsProvider, using the provided clock to check if a secret has expired.
SecretsProviderHeaplet - Class in org.forgerock.openig.secrets: Creates and initializes a SecretsProvider in a heap environment.
SecretsProviderHeaplet() - Constructor for class org.forgerock.openig.secrets.SecretsProviderHeaplet
SecretsProviderTypeProvider - Class in org.forgerock.openig.secrets: Provide the SecretsProviderHeaplet's TypeDefinition.
SecretsProviderTypeProvider() - Constructor for class org.forgerock.openig.secrets.SecretsProviderTypeProvider
SecretsSaml2CredentialResolver - Class in org.forgerock.openig.handler.saml: An implementation of Saml2CredentialResolver that provides support for resolving secrets configured in an IG route/heap.
SecretsSaml2CredentialResolver() - Constructor for class org.forgerock.openig.handler.saml.SecretsSaml2CredentialResolver: Default constructor to allow for some logging to show when it is created.
SecretsService - Interface in org.forgerock.openig.secrets: Interface for the SecretsService.
SecretsServiceProvider - Class in org.forgerock.openig.secrets: Adapter class to present an instance of SecretsService as a SecretsProvider.
SecretsServiceProvider(SecretsService, Clock) - Constructor for class org.forgerock.openig.secrets.SecretsServiceProvider: Constructs an adapter around SecretsService so we can use it as a SecretProvider.
SecretStore<T extends Secret> - Interface in org.forgerock.secrets: A backend storage mechanism for certain kinds of secrets.
SecretsTrustManager - Class in org.forgerock.secrets: Provides an implementation of a standard Java TLS X509ExtendedTrustManager that will retrieve trusted certificates from the Secrets API.
SecretsTrustManagerHeaplet - Class in org.forgerock.openig.secrets: A SecretsTrustManagerHeaplet acts as a factory of SecretsTrustManager.
SecretsTrustManagerHeaplet() - Constructor for class org.forgerock.openig.secrets.SecretsTrustManagerHeaplet
SecretsUtils - Class in org.forgerock.openig.secrets: Utility class to use the Commons Secret API.
secure(boolean) - Method in class org.forgerock.openig.http.CookieBuilder: Set the secure flag and return a new instance of this builder.
secure(boolean) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets whether if the client connection is secure.
SECURE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The secure event payload field name.
SecureStorage - Interface in org.forgerock.audit.secure: Represents a storage for secure keys, to be used for signing files.
SecureStorageException - Exception in org.forgerock.audit.secure: Exception that can be thrown by a SecureStorage implementation.
SecureStorageException(String) - Constructor for exception org.forgerock.audit.secure.SecureStorageException: Constructs an SecureStorageException using the given message.
SecureStorageException(String, Throwable) - Constructor for exception org.forgerock.audit.secure.SecureStorageException: Constructs an SecureStorageException using the given message and parent cause.
SecureStorageException(Throwable) - Constructor for exception org.forgerock.audit.secure.SecureStorageException: Constructs an SecureStorageException using the given parent cause.
SecureStorageProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining a secure storage, used by handlers providing tamper-evident feature.
SecurityContext - Class in org.forgerock.services.context: A Context containing information about the client performing the request which may be used when performing authorization decisions.
SecurityContext(String, Context, String, Map<String, Object>) - Constructor for class org.forgerock.services.context.SecurityContext: Creates a new security context having the provided ID, and parent.
SecurityContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.SecurityContext: Restore from JSON representation.
SecurityContext(Context, String, Map<String, Object>) - Constructor for class org.forgerock.services.context.SecurityContext: Creates a new security context having the provided parent and an ID automatically generated using UUID.randomUUID().
SecurityContextFactory - Class in org.forgerock.json.resource.http: Deprecated.
This class will be removed once CAF has been migrated fully to CHF, at which point components should create SecurityContexts directly rather than via request attributes.
SEE_OTHER - Static variable in class org.forgerock.http.protocol.Status: The 303 (See Other) status code indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request.
select(AmVersion) - Static method in class org.forgerock.openig.tools.am.RealmNormalizer: Selects the normalizer to use given an AM version.
self() - Method in class org.forgerock.audit.events.AuditEventBuilder: Returns this object, as its actual type.
self() - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Returns this object, as its actual type.
selfApiMatcher() - Static method in class org.forgerock.http.routing.RouteMatchers: A matcher to check if the request is for all versions of the API descriptor of the current path.
send(Request) - Method in class org.forgerock.http.Client: Sends an HTTP request and returns a Promise representing the pending HTTP response.
send(Context, Request) - Method in class org.forgerock.http.Client: Sends an HTTP request and returns a Promise representing the pending HTTP response.
sendAsync(Request) - Method in interface org.forgerock.http.spi.HttpClient: Returns a Promise representing the asynchronous Response of the given request.
sendError(int) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
sendError(int, String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
sendObject(Object) - Method in interface org.forgerock.openig.tools.notifications.ws.WebSocketAdapter: Send the supplied request over the websocket to the remote party.
sendRedirect(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
sendWithoutClose(Request) - Method in class org.forgerock.http.Client: Sends an HTTP request and returns a Promise representing the pending HTTP response.
sendWithoutClose(Context, Request) - Method in class org.forgerock.http.Client: Sends an HTTP request and returns a Promise representing the pending HTTP response.
SeparatedValuesFile - Class in org.forgerock.openig.text: Allows records to be retrieved from a delimiter-separated file using key and value.
SeparatedValuesFile(File) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile: Builds a new SeparatedValuesFile reading the given file using a the Separators.COMMA separator specification and UTF-8 charset.
SeparatedValuesFile(File, Charset) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile: Builds a new SeparatedValuesFile reading the given file using a the Separators.COMMA separator specification.
SeparatedValuesFile(File, Charset, Separator) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile: Builds a new SeparatedValuesFile reading the given file.
SeparatedValuesFile(File, Charset, Separator, boolean) - Constructor for class org.forgerock.openig.text.SeparatedValuesFile: Builds a new SeparatedValuesFile reading the given file.
SeparatedValuesReader - Class in org.forgerock.openig.text: Reads records with delimiter-separated values from a character stream.
SeparatedValuesReader(Reader, Separator) - Constructor for class org.forgerock.openig.text.SeparatedValuesReader: Constructs a new separated values reader, to read a character stream from the specified reader and use the specified separator specification.
Separator - Class in org.forgerock.openig.text: A field separator specification, used to parse delimiter-separated values.
Separator(char, int, int) - Constructor for class org.forgerock.openig.text.Separator: Constructs a new field separator specification.
Separators - Enum in org.forgerock.openig.text: Commonly used field separator specifications.
SEQUENCE_TAG - Static variable in class org.forgerock.json.jose.utils.DerUtils: DER tag for sequence values.
SequenceHandler - Class in org.forgerock.openig.handler: Processes a request through a sequence of handlers.
SequenceHandler() - Constructor for class org.forgerock.openig.handler.SequenceHandler
SequenceHandler.Heaplet - Class in org.forgerock.openig.handler: Creates and initializes a sequence handler in a heap environment.
SequenceHandlerTypeProvider - Class in org.forgerock.openig.handler: Provide SequenceHandler's TypeDefinition.
SequenceHandlerTypeProvider() - Constructor for class org.forgerock.openig.handler.SequenceHandlerTypeProvider
serialVersionUID - Static variable in exception org.forgerock.openig.filter.oauth2.client.DiscoveryException: Serial Version UID.
serialVersionUID - Static variable in exception org.forgerock.openig.filter.oauth2.client.RegistrationException: Serial Version UID.
serialVersionUID - Static variable in exception org.forgerock.openig.handler.router.RouterHandlerException: Serial Version UID.
server(String, int) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided server values for the event.
SERVER - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The server event payload field name.
SERVER_ERROR - org.forgerock.http.protocol.Status.Family: The 5xx (Server Error) class of status code indicates that the server is aware that it has erred or is incapable of performing the requested method.
serverFromContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the server fields for the event, if the provided Context contains a ClientContext..
ServerInfoSingletonProvider - Class in org.forgerock.openig.http: Provides server info (build-time defined values only at the moment) in a read-only fashion.
ServerInfoSingletonProvider() - Constructor for class org.forgerock.openig.http.ServerInfoSingletonProvider
serverNames() - Method in class org.forgerock.openig.tools.ServerTlsOptions.SniConfiguration: Returns the SNI mapping from server names to SigningKeys.
ServerTlsOptions - Class in org.forgerock.openig.tools: Extension to TlsOptions supporting client authentication configuration used to drive the authentication negotiation between the client and IG.
ServerTlsOptions(String, KeyManager[], TrustManager[], List<String>, List<String>, boolean, ServerTlsOptions.ClientAuthentication) - Constructor for class org.forgerock.openig.tools.ServerTlsOptions: Constructs TLS options with provided values.
ServerTlsOptions(String, TrustManager[], List<String>, List<String>, boolean, ServerTlsOptions.ClientAuthentication, ServerTlsOptions.SniConfiguration) - Constructor for class org.forgerock.openig.tools.ServerTlsOptions: Constructs TLS options with provided values.
ServerTlsOptions.ClientAuthentication - Enum in org.forgerock.openig.tools: Enum representing the client authentication configuration options driving authentication negotiations between IG and the client.
ServerTlsOptions.SniConfiguration - Class in org.forgerock.openig.tools
ServerTlsOptionsHeaplet - Class in org.forgerock.openig.security: Creates and initializes server-side TLS options in a heap environment.
ServerTlsOptionsHeaplet() - Constructor for class org.forgerock.openig.security.ServerTlsOptionsHeaplet
service(HttpServletRequest, HttpServletResponse) - Method in class org.forgerock.http.servlet.HttpFrameworkServlet
SERVICE_LOADER - Static variable in interface org.forgerock.http.spi.Loader: The default Loader implementation used throughout the HTTP framework.
SERVICE_UNAVAILABLE - Static variable in class org.forgerock.http.protocol.Status: The 503 (Service Unavailable) status code indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
SERVICES - Static variable in interface org.forgerock.http.decoder.Decoder: Mapping of supported codings to associated decoders.
SERVICES - Static variable in interface org.forgerock.http.decoder.FlowableDecoder: Mapping of supported codings to associated decoders.
SERVICES - Static variable in class org.forgerock.openig.resolver.Resolvers: Mapping of supported classes to associated resolvers.
ServiceUnavailableException - Exception in org.forgerock.json.resource: An exception that is thrown during an operation on a resource when the server is temporarily unable to handle the request.
ServiceUnavailableException() - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with null as its detail message.
ServiceUnavailableException(String) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with the specified detail message.
ServiceUnavailableException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with the specified detail message and cause.
ServiceUnavailableException(Throwable) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException: Constructs a new exception with the specified cause.
session() - Method in class org.forgerock.openig.types.importer.RouteInstance: Returns the component instance of the SessionManager of this route.
session(ComponentInstance) - Method in class org.forgerock.openig.types.importer.RouteInstance: Sets the component instance supporting the SessionManager of this route.
Session - Interface in org.forgerock.http.session: An interface for managing attributes across multiple requests from the same user agent.
SESSION_FACTORY_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the default AsyncSessionManager instance from the Heap.
sessionCache(Caffeine<Object, Object>, Duration, DisconnectionStrategy) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Specifies the Caffeine cache for the CacheSessionService.
sessionCaching(boolean) - Method in class org.forgerock.openig.tools.session.CrestSessionService.Builder: Setting this to true indicates that session caching is enabled.
SessionContext - Class in org.forgerock.http.session: A SessionContext is a mechanism for maintaining state between components when processing a successive requests from the same logical client or end-user.
SessionContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.session.SessionContext: Restore from JSON representation.
SessionContext(Context, Session) - Constructor for class org.forgerock.http.session.SessionContext: Constructs a new SessionContext.
SessionException - Exception in org.forgerock.openig.tools.session: Represents an exception whilst performing Session Service.
SessionException(String) - Constructor for exception org.forgerock.openig.tools.session.SessionException: Builds an SessionException with a given message.
SessionException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.session.SessionException: Builds an SessionException with a given message and cause.
sessionIdleRefresh(boolean, Duration) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Enable or disable the session idle refresh service and set the refresh interval.
sessionIdleRefreshEnabled(boolean) - Method in class org.forgerock.openig.tools.session.CrestSessionService.Builder: Setting this to true indicates that session idle refresh is enabled.
sessionIdleRefreshInterval(Duration) - Method in class org.forgerock.openig.tools.session.CrestSessionService.Builder: Set the session idle refresh interval.
SessionInfo - Class in org.forgerock.openig.tools.session: The SessionInfo class is responsible to store session info for a given SSO Token.
SessionInfo(String, JsonValue) - Constructor for class org.forgerock.openig.tools.session.SessionInfo: Builds a new SessionInfo.
SessionInfoContext - Class in org.forgerock.openig.openam: Context to store Access Management session info and properties.
sessionInfoDetectionFilter(String, AsyncRefreshableSupplier<SsoToken, AuthenticationException>) - Static method in class org.forgerock.openig.tools.InvalidCallerTokenDetectionFilter: Returns a new detection filter suitable for use with getSessionInfo requests.
SessionInfoFilter - Class in org.forgerock.openig.openam: This filter requests user session info from Access Management and stores it on the context for later use.
SessionInfoFilter(SessionService, Expression<String>) - Constructor for class org.forgerock.openig.openam.SessionInfoFilter: Creates a new OpenAM session info filter.
SessionInfoFilter.Heaplet - Class in org.forgerock.openig.openam: Creates and initialises a session info filter in a heap environment.
SessionManager - Interface in org.forgerock.http.session: Deprecated.
SessionModeConfig - Enum in org.forgerock.audit.handlers.jms: Configuration wrapper for JMS Session.getAcknowledgeMode() SessionMode setting.
sessionProperties(Set<String>) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Set the session properties and return this builder.
sessionProperties(Set<String>) - Method in class org.forgerock.openig.tools.session.CrestSessionService.Builder: Set the session properties on this Builder.
sessionService(SessionService) - Method in class org.forgerock.openig.tools.am.AmService.Builder: Bind a SessionService instance to this builder.
SessionService - Interface in org.forgerock.openig.tools.session: The SessionService is responsible to perform interactions with AM sessions endpoint, such as session info or logout, etc.
set - Variable in class org.forgerock.http.util.SetDecorator: The set wrapped by this decorator.
set(int, E) - Method in class org.forgerock.util.LazyList: Replaces the element at the specified position in this list with the specified element.
set(int, E) - Method in class org.forgerock.util.ListDecorator: Replaces the element at the specified position in this list with the specified element.
set(Bindings, Object) - Method in class org.forgerock.openig.el.LeftValueExpression: Sets the result of an expression to a specified value.
set(Option<T>, T) - Method in class org.forgerock.util.Options: Sets an option to the provided value.
setAction(String) - Method in interface org.forgerock.json.resource.ActionRequest: Sets the ID of the action to be performed by this action request.
setActiveStore(SecretStore<? super T>, Purpose<? extends T>) - Method in class org.forgerock.secrets.SecretsProvider: Sets the active store to use for the given purpose.
setActiveStore(SecretStore<? super T>, Purpose<? extends T>...) - Method in class org.forgerock.secrets.SecretsProvider: Sets the active store to use for the given purpose.
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.ActionRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.CreateRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.DeleteRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.PatchRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.QueryRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.ReadRequest
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.Request: Sets an additional parameter which should be used to control the behavior of this action request.
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.UpdateRequest
setAgreementPartyUInfo(String) - Method in class org.forgerock.json.jose.jwe.JweHeader: Sets the Agreement PartyUInfo header parameter for this JWE.
setAgreementPartyVInfo(String) - Method in class org.forgerock.json.jose.jwe.JweHeader: Sets the Agreement PartyVInfo header parameter for this JWE.
setAlgorithm(String) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

Sets the cryptographic algorithm.
setAlgorithm(Algorithm) - Method in class org.forgerock.json.jose.jwt.JwtHeader: Sets the algorithm used to perform cryptographic signing and/or encryption on the JWT.
setApplication(String) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter: Sets the application where the policies are defined.
setArgs(Map<String, Object>) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject: Sets the parameters which should be made available to scripts.
setAttribute(String, Object) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
setAuthzToken(String) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration: Sets the Splunk authorization token required for making HTTP event collector calls.
setAutoCommit(boolean) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the auto commit value.
setAutoFlush(boolean) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the auto flush indicator.
setAutoFlush(boolean) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the auto flush indicator.
setAvailableAuditEventHandlers(List<String>) - Method in class org.forgerock.audit.AuditServiceConfiguration: Sets the list of available audit event handlers.
setBaseURI(Expression<String>) - Method in class org.forgerock.openig.filter.LocationHeaderFilter: Sets the base URI used to rewrite Location headers.
setBatch(JmsAuditEventHandlerConfiguration.BatchConfiguration) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Sets the configuration used to initialize the batch publisher.
setBuffering(ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration: Sets configuration of event buffering.
setBuffering(JsonAuditEventHandlerConfiguration.EventBufferingConfiguration) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration: Sets configuration of event buffering.
setBuffering(SplunkAuditEventHandlerConfiguration.BufferingConfiguration) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration: Sets the configuration for buffering.
setBufferingConfiguration(CsvAuditEventHandlerConfiguration.EventBufferingConfiguration) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Sets the configuration for events buffering.
setBufferingConfiguration(JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Sets the configuration for events buffering.
setBufferingConfiguration(SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Sets the configuration for events buffering.
setBufferSize(int) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setBytes(byte[]) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the raw data contained in the provided byte array.
setCacheControl(ResponseCacheControl) - Method in interface org.forgerock.json.resource.QueryResponse: Sets the cache control for this response.
setCacheControl(ResponseCacheControl) - Method in interface org.forgerock.json.resource.ResourceResponse: Sets the cache control for this response.
setCacheHeader(boolean) - Method in class org.forgerock.openig.filter.HttpBasicAuthFilter: Decide if we cache the password header result (defaults to true).
setCacheMissCacheTime(Duration) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Update the cache time before reloading the cache in case of cache miss.
setCacheTimeout(Duration) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Update the cache timeout.
setCapacity(int) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.BatchConfiguration: Sets the maximum capacity of the publishing queue.
setCaseInsensitiveFields(List<String>) - Method in class org.forgerock.audit.AuditServiceConfiguration: Set the list of audit event fields to treat case-insensitively when filtering.
setCause(Exception) - Method in class org.forgerock.http.protocol.Response: Link a 'caused by' exception to this response.
setCharacterEncoding(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
setCharacterEncoding(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setCharset(Charset) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

The Charset to use to encrypt/decrypt values.
setClaim(String, Object) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets a claim with the specified name and value.
setClaims(Map<String, Object>) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets claims using the values contained in the specified map.
setClaimsSubject(AsyncFunction<Bindings, Map<String, Object>, NeverThrowsException>) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter: Sets a function that returns a map of JWT claims to their values, for the subject.
setClientHandler(Handler) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject: Sets the HTTP client handler which should be made available to scripts.
setComment(String) - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
setCommentURL(String) - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
setCompressionAlgorithm(CompressionAlgorithm) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the Compression Algorithm header parameter for this JWE.
setConnection(ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration: Sets configuration of connection to Elasticsearch.
setConnection(SplunkAuditEventHandlerConfiguration.ConnectionConfiguration) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration: Sets configuration of connection to Splunk.
setConnectionPool(JdbcAuditEventHandlerConfiguration.ConnectionPool) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Sets the connection pool settings.
setConnectionTimeout(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the maximum amount of time to wait for a connection from the connection pool.
setConnectTimeout(int) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Sets the timeout after which attempts to connect to the Syslog daemon will be abandoned.
setContent(JsonValue) - Method in interface org.forgerock.json.resource.ActionRequest: Sets the content of this action request.
setContent(JsonValue) - Method in interface org.forgerock.json.resource.CreateRequest: Sets the content of the JSON resource to be created.
setContent(JsonValue) - Method in interface org.forgerock.json.resource.UpdateRequest: Sets the content of the JSON resource to be replaced.
setContent(Publisher<ByteBuffer>) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the provided publisher.
setContentLength(int) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setContentType(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the content type header parameter for this JWS.
setContentType(String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setContextProperties(Map<String, String>) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration: Sets the Jndi InitialContext properties.
SetCookie2Header - Class in org.forgerock.http.header: Deprecated, for removal: This API element is subject to removal in a future version.
This header is no longer supported by browsers. Use SetCookieHeader instead.
SetCookie2Header(List<Cookie>) - Constructor for class org.forgerock.http.header.SetCookie2Header: Deprecated.

Constructs a new Set-Cookie2 with the provided cookies.
SetCookieHeader - Class in org.forgerock.http.header: Processes the Set-Cookie request message header.
SetCookieHeader(List<Cookie>) - Constructor for class org.forgerock.http.header.SetCookieHeader: Constructs a new header with the provided cookies.
SetCookieUpdateFilter - Class in org.forgerock.openig.filter: This filter allows modification of response cookie attribute values for cookies found in the Set-Cookies header.
SetCookieUpdateFilter(List<CookieModifier>) - Constructor for class org.forgerock.openig.filter.SetCookieUpdateFilter: Creates a SetCookieUpdateFilter, which updates given attribute values for an existing cookie.
SetCookieUpdateFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes a SetCookieUpdateFilter in a heap environment.
setCountOnly(boolean) - Method in interface org.forgerock.json.resource.QueryRequest: Sets whether the request was to only provide a count of the query results.
setCriticalHeaders(List<String>) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the critical header parameters for this JWS.
setDatabaseType(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Sets the type of the database.
setDataEncryptionKeyReference(SecretReference<DataEncryptionKey>) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

Sets the encryption key used to encrypt headers.
setDataSourceClassName(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the datasource class name for the configured database.
setDateHeader(String, long) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
SetDecorator<E> - Class in org.forgerock.http.util: Contains another set, which is uses as its basic source of data, possibly transforming the data along the way.
SetDecorator(Set<E>) - Constructor for class org.forgerock.http.util.SetDecorator: Constructs a new set decorator, wrapping the specified set.
setDecryptionKeys(Supplier<Promise<Stream<DataDecryptionKey>, NeverThrowsException>>) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

Sets the decryption key to decrypt headers.
setDefaultAction(CookieFilter.Action) - Method in class org.forgerock.openig.filter.CookieFilter: Set the action to perform for cookies that do not match an action set.
setDefaultLoginGoto(Expression<String>) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Sets the expression which will be used for obtaining the default login "goto" URI.
setDefaultLogoutGoto(Expression<String>) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Sets the expression which will be used for obtaining the default logout "goto" URI.
setDefaultRoute(H) - Method in class org.forgerock.services.routing.AbstractRouter: Sets the handler to be used as the default route for requests which do not match any of the other defined routes.
setDefaults() - Method in class org.forgerock.audit.events.AuditEventBuilder: Called by AuditEventBuilder.toEvent() to allow any unset fields to be given their default value.
setDefaultStores(SecretStore<?>, SecretStore<?>...) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
setDefaultStores(SecretStore<?>, SecretStore<?>...) - Method in interface org.forgerock.openig.secrets.SecretsService: Sets the default store(s) to use if there is no specific store configured for a particular purpose.
setDefaultStores(SecretStore<?>, SecretStore<?>...) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
setDefaultStores(SecretStore<?>, SecretStore<?>...) - Method in class org.forgerock.secrets.SecretsProvider: Sets the default store(s) to use if there is no specific store configured for a particular purpose.
setDefaultVersion(Version) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification: Set a default Version to use if no matching resource path found for request.
setDefaultVersionBehaviour(DefaultVersionBehaviour) - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Sets the default routing behaviour to use when the request does not contain the Accept-API-Version header.
setDelegate(AuditService) - Method in class org.forgerock.audit.AuditServiceProxy: Sets the AuditService this object proxies.
setDelimiterChar(char) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting: Sets the character to use to delimit the csv entries.
setDeliveryMode(DeliveryModeConfig) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Sets the delivery mode configuration that should be used when publishing the JMS messages.
setDetail(JsonValue) - Method in exception org.forgerock.json.resource.ResourceException: Sets the additional detail which can be evaluated by applications.
setDiscard(Boolean) - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
setDomain(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the domain for which the cookie is valid.
setDriverClassName(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the class name of the driver to use for the jdbc connection.
setElasticsearchCompatible(boolean) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration: Specifies if JSON format should be transformed to be compatible with ElasticSearch format restrictions.
setEmpty() - Method in class org.forgerock.http.protocol.Entity: Mark this entity as being empty.
setEnabled(boolean) - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Sets the enabled flag for an audit event handler.
setEnabled(boolean) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Enables tamper evident logging.
setEnabled(boolean) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the buffering status.
setEnabled(boolean) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the buffering status.
setEnabled(boolean) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the buffering status.
setEnabled(boolean) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the buffering status.
setEncryptionMethod(EncryptionMethod) - Method in class org.forgerock.json.jose.jwe.JweHeader: Sets the Encryption Method header parameter for this JWE.
setEndOfLineSymbols(String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting: Gets the end of line symbol.
setEntity(Object) - Method in interface org.forgerock.http.protocol.Message: Sets the content of the entity to the provided value.
setEntity(Object) - Method in class org.forgerock.http.protocol.Request
setEntity(Object) - Method in class org.forgerock.http.protocol.Response
setEntity(Expression<String>) - Method in class org.forgerock.openig.filter.StaticRequestFilter: Sets the message entity expression.
setEnvironment(AsyncFunction<Bindings, Map<String, List<Object>>, NeverThrowsException>) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter: The environment passed from the client making the authorization request as a sets a map of keys to lists of values.
setEphemeralPublicKey(JWK) - Method in class org.forgerock.json.jose.jwe.JweHeader: Sets the Ephemeral Public Key header parameter for this JWE.
setEvent(String) - Method in class org.forgerock.audit.handlers.jdbc.TableMapping: Sets the audit event the table mapping is for.
setExcludeIf(Collection<String>) - Method in class org.forgerock.audit.filter.FilterPolicy: Sets the excludeIf list.
setExpirationTime(Date) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the expiration time of the JWT in the Claims Set.
setExpires(Date) - Method in class org.forgerock.http.protocol.Cookie: Sets the lifetime of the cookie, expressed as the date and time of expiration.
setFacility(Facility) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Sets the facility constant that should be applied to all Syslog messages.
setFailed(Throwable) - Method in class org.forgerock.http.io.FailableInputStream: Sets this stream into a failed state.
setFailureHandler(Handler) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Sets the handler which will be invoked when authentication fails.
setField(String) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping: Sets the name of the event topic field to which this mapping applies.
setFieldToColumn(Map<String, String>) - Method in class org.forgerock.audit.handlers.jdbc.TableMapping: Sets the field to column mapping.
setFilename(String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Sets the location of the keystore to be used.
setFileRetention(FileBasedEventHandlerConfiguration.FileRetention) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Sets the FileBasedEventHandlerConfiguration.FileRetention.
setFileRotation(FileBasedEventHandlerConfiguration.FileRotation) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Sets the FileBasedEventHandlerConfiguration.FileRotation.
setFilterPolicies(Map<String, FilterPolicy>) - Method in class org.forgerock.audit.AuditServiceConfiguration: Set the filter policy mappings.
setForm(Form) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the String representation of the provided Form.
setFormatting(CsvAuditEventHandlerConfiguration.CsvFormatting) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Sets the CSV formatting options.
setFragment(String) - Method in class org.forgerock.http.MutableUri: Update the fragment (not encoded) of this MutableUri.
setHandlerForQueries(String) - Method in class org.forgerock.audit.AuditServiceConfiguration: Sets the name of the handler to use for querying the audit events.
setHeader(String, String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setHost(String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Sets the host for the connection.
setHost(String) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration: Sets the host for the connection.
setHost(String) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Sets the hostname of the Syslog daemon to which messages should be published.
setHost(String) - Method in class org.forgerock.http.MutableUri: Update the host name of this MutableUri.
setHttpOnly(Boolean) - Method in class org.forgerock.http.protocol.Cookie: Sets the value indicating whether the user agent should make the cookie inaccessible to client side script.
setIdleTimeout(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the maximum time a connection is allowed to be idle.
setIncludeIf(Collection<String>) - Method in class org.forgerock.audit.filter.FilterPolicy: Sets the includeIf list.
setIndexMapping(ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration: Gets configuration of index mapping.
setIndexName(String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.IndexMappingConfiguration: Sets primary index name.
setInitialFile(File) - Method in class org.forgerock.audit.rotation.RotationContext: Set the initial file.
setIntHeader(String, int) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setIssuedAtTime(Date) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the time the JWT was issued at, in the Claims Set.
setIssuer(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the issuer this JWT was issued by.
setIssuer(URI) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the issuer this JWT was issued by.
setJdbcUrl(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the JDBC database url.
setJmsConnectionFactoryName(String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration: Sets the jndi lookup name for the JMS ConnectionFactory for which the messages will be published on.
setJmsTopicName(String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration: Sets the jndi lookup name for the JMS Topic for which the messages will be published on.
setJndi(JmsAuditEventHandlerConfiguration.JndiConfiguration) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Sets the JmsAuditEventHandlerConfiguration.JndiConfiguration.
setJson(Object) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the JSON representation of the provided object.
setJsonWebKey(JWK) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the JSON Web Key header parameter for this JWS.
setJwkSetUrl(URL) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the JWK Set URL header parameter for this JWS.
setJwkUrl(URL) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Deprecated.
Use JwksStore.setJwkUrlAsync(URL) instead.
setJwkUrlAsync(URL) - Method in class org.forgerock.json.jose.jwk.store.JwksStore: Update the JWKs URI.
setJwtId(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the unique ID of the JWT.
setJwtSubject(Expression<String>) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter: Sets the JWT string for the subject.
setKeyId(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the Key ID header parameter for this JWS.
setKeysForPurposes(Map<String, List<KeyStoreSecretStore.AliasSpec>>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore: Set the keys that are used for different purposes.
setKeyStoreHandler(KeyStoreHandler) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage: Set the key store handler.
setKeyStoreHandlerName(String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Set the key store handler name.
setLocale(Locale) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setLogDirectory(String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Sets the directory where CSV file is located.
setLogDirectory(String) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration: Sets the directory where the JSON file is located.
setLoginHandler(Handler) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Sets the handler which will be invoked when the user needs to authenticate.
setMaxAge(Integer) - Method in class org.forgerock.http.protocol.Cookie: Sets the lifetime of the cookie, expressed in seconds.
setMaxBatchedEvents(int) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the maximum number of events to read from the buffer on each interval.
setMaxBatchedEvents(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the maximum number of events that can be batched into a PreparedStatement.
setMaxBatchedEvents(int) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.BatchConfiguration: Sets the maximum count of events that will be expected to be delivered in a single publish call.
setMaxBatchedEvents(int) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration: Sets the maximum number of events to read from the buffer on each interval.
setMaxDiskSpaceToUse(long) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Sets the maximum disk space the audit logs can occupy.
setMaxFileSize(long) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the maximum file size of an audit log file in bytes.
setMaxLifetime(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the maximum lifetime of a connection in the connection pool.
setMaxNumberOfHistoryFiles(int) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Sets the maximum number of historical log files to retain.
setMaxPoolSize(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the maximum size of the connection pool.
setMaxSize(int) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the buffer capacity, which are the maximum number of events that can be buffered.
setMaxSize(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the maximum size of the events queue.
setMaxSize(int) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the buffer capacity, which are the maximum number of events that can be buffered.
setMaxSize(int) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration: Sets the buffer capacity, which are the maximum number of events that can be buffered.
setMaxSize(int) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the buffer capacity, which are the maximum number of events that can be buffered.
setMaxTimeout(Duration) - Method in class org.forgerock.util.PerItemEvictionStrategyCache: Sets the maximum timeout.
setMessageType(MessageType) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

Sets the type of message to process headers for.
setMethod(String) - Method in class org.forgerock.http.protocol.Request: Sets the method to be performed on the resource.
setMinFreeSpaceRequired(long) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Sets the minimum free space the system must contain.
setMinIdle(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the minimum number of idle connections in the connection pool.
setName(String) - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Sets the name of this handler.
setName(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the name of the cookie.
setNewResourceId(String) - Method in interface org.forgerock.json.resource.CreateRequest: Sets the client provided ID of the resource to be created.
setNextFile(File) - Method in class org.forgerock.audit.rotation.RotationContext: Set the next file.
setNoAvailableVersionHandler(ResourceApiVersionSpecificationFilter.NoApiVersionHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification: Indicate what should happen if no resource API version supplied on the request.
setNotBeforeTime(Date) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the time the JWT is not allowed to be processed before, in the Claims Set.
setObject(Object) - Method in class org.forgerock.json.JsonValue: Sets the Java object representing this JSON value.
setOf(Class<V>) - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON value as a Set containing objects whose type (and value) is specified by the parameter type.
setOf(Function<JsonValue, V, E>) - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON value as a Set containing objects whose type (and value) is specified by a transformation function.
setOperation(CryptoHeaderFilter.Operation) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter: Deprecated.

Sets the operation (encryption/decryption) to apply to the headers.
setPagedResultsCookie(String) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the opaque cookie which is used by the resource provider to track its position in the set of query results.
setPagedResultsOffset(int) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the zero-based index of the first resource which should be included in the query results.
setPageSize(int) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the requested page results page size or 0 if paged results are not required.
setParameter(String, Object) - Method in class org.forgerock.json.jose.jwe.JweHeader
setParameter(String, Object) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets a header parameter with the specified key and value.
setParameter(String, Object) - Method in class org.forgerock.json.jose.jwt.JwtHeader: Sets a header parameter with the specified key and value.
setParameters(Map<String, Object>) - Method in class org.forgerock.json.jose.jwt.JwtHeader: Sets header parameters using the values contained in the specified map.
setPassword(String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Sets the password of the keystore.
setPassword(String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Sets Elasticsearch password for HTTP basic authentication.
setPassword(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the password to use to connect to the JDBC database.
setPath(String) - Method in class org.forgerock.http.MutableUri: Update the path (not encoded) of this MutableUri.
setPath(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the subset of URLs on the origin server to which this cookie applies.
setPolicy(CookiePolicy) - Method in class org.forgerock.openig.filter.CookieFilter: Set the policy for managed cookies.
setPoolName(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the name of the connection pool.
setPort(int) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Sets the port for the connection.
setPort(int) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration: Sets the port for the connection.
setPort(int) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Sets the port of the Syslog daemon to which messages should be published.
setPort(int) - Method in class org.forgerock.http.MutableUri: Update the port of this MutableUri.
setPort(List<Integer>) - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.ActionRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.CreateRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.DeleteRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.PatchRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.QueryRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.ReadRequest
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.Request: Set the locale preference for the request.
setPreferredLocales(PreferredLocales) - Method in interface org.forgerock.json.resource.UpdateRequest
setProtocol(TransportProtocol) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Sets the protocol over which messages transmitted to the Syslog daemon.
setProtocolVersion(Version) - Method in class org.forgerock.http.routing.ApiVersionRouterContext: Sets the protocol API version of the framework used to handle the request.
setQuery(String) - Method in class org.forgerock.http.MutableUri: Update the query string (not encoded) of this MutableUri.
setQueryExpression(String) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the native query expression which will be used for processing the query request.
setQueryFilter(QueryFilter<JsonPointer>) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the query filter which will be used for selecting which JSON resources will be returned.
setQueryId(String) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the query identifier for pre-defined queries.
setQuoteChar(char) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting: Sets the character to use to quote the csv entries.
setRawContentInputStream(BranchingInputStream) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the provided input stream.
setRawFragment(String) - Method in class org.forgerock.http.MutableUri: Update the fragment (encoded) of this MutableUri.
setRawPath(String) - Method in class org.forgerock.http.MutableUri: Update the path (encoded) of this MutableUri.
setRawQuery(String) - Method in class org.forgerock.http.MutableUri: Update the query (encoded) of this MutableUri.
setRawUserInfo(String) - Method in class org.forgerock.http.MutableUri: Update the user info (encoded) of this MutableUri.
setRawValue(String) - Method in class org.forgerock.http.header.AuthorizationHeader: Set the raw value of the header.
setReason(String) - Method in exception org.forgerock.json.resource.ResourceException: Sets/overrides the short reason phrase of the exception.
setRequireHttps(boolean) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Specifies whether all incoming requests must use TLS.
setRequireLogin(boolean) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Specifies whether authentication is required for all incoming requests.
setResourceApiVersion(Version) - Method in exception org.forgerock.json.resource.ResourceException
setResourceApiVersion(Version) - Method in interface org.forgerock.json.resource.Response: Sets the API version of the resource that the request was routed to.
setResourcePath(String) - Method in interface org.forgerock.json.resource.ActionRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.CreateRequest: Sets the path of the JSON resource container beneath which the new resource should be created.
setResourcePath(String) - Method in interface org.forgerock.json.resource.DeleteRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.PatchRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.QueryRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.ReadRequest
setResourcePath(String) - Method in interface org.forgerock.json.resource.Request: Sets the non-null path of the JSON resource to which this request should be targeted.
setResourcePath(String) - Method in interface org.forgerock.json.resource.UpdateRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.ActionRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.CreateRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.DeleteRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.PatchRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.QueryRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.ReadRequest
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.Request: Sets the non-null path of the JSON resource to which this request should be targeted.
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.UpdateRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.ActionRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.CreateRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.DeleteRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.PatchRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.QueryRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.ReadRequest
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.Request: Sets the requested API version of the resource.
setResourceVersion(Version) - Method in interface org.forgerock.json.resource.UpdateRequest
setRevision(String) - Method in interface org.forgerock.json.resource.DeleteRequest: Sets the expected version information associated with the JSON resource to be deleted.
setRevision(String) - Method in interface org.forgerock.json.resource.PatchRequest: Sets the expected version information associated with the JSON resource to be patched.
setRevision(String) - Method in interface org.forgerock.json.resource.UpdateRequest: Sets the expected version information associated with the JSON resource to be updated.
setRotationEnabled(boolean) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets log rotation enabled state.
setRotationFilePrefix(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the prefix to add to a log file on rotation.
setRotationFileSuffix(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the suffix to add to a log file on rotation.
setRotationInterval(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the interval to trigger a file rotation.
setRotationRetentionCheckInterval(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Sets the interval to check time-based file rotation policies.
setRotationTimes(List<String>) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets a list of times at which file rotation should be triggered; times should be provided as Strings that can be parsed by Duration that each specify an offset from midnight.
setSameSite(Cookie.SameSite) - Method in class org.forgerock.http.protocol.Cookie: Sets the value of the SameSite attribute.
setScheme(String) - Method in class org.forgerock.http.MutableUri: Update the scheme of this MutableUri.
setSecure(Boolean) - Method in class org.forgerock.http.protocol.Cookie: Sets the value indicating whether the user agent should use only secure means to send back this cookie.
setSecurity(CsvAuditEventHandlerConfiguration.CsvSecurity) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration: Sets the CSV tamper evident options.
setSession(Session) - Method in class org.forgerock.http.session.SessionContext: Sets the Session associated with the remote client.
setSessionMode(SessionModeConfig) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration: Sets the session mode that the JMS session should use when publishing the JMS messages.
setSeverityFieldMappings(List<SyslogAuditEventHandlerConfiguration.SeverityFieldMapping>) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration: Sets the configurations for mapping audit event field values to Syslog severity values.
setSignatureInterval(String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity: Sets the signature's interval.
setSsoTokenSubject(Expression<String>) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter: Sets the SSO token for the subject.
setStatus(int) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter
setStatus(int, String) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletResponseAdapter: Deprecated.
As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.
setStatus(Status) - Method in class org.forgerock.http.protocol.Response: Sets the response status code.
setStore(KeyStore) - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
setStore(KeyStore) - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Sets the keystore.
setStore(KeyStore) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
setStreamingContent(boolean) - Method in class org.forgerock.http.protocol.Response: Set that the response's content has to be considered as a streaming and thus some special treatments may apply on it.
setString(String) - Method in class org.forgerock.http.protocol.Entity: Sets the content of this entity to the provided string.
setSubject(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the subject this JWT is issued to.
setSubject(URI) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Sets the subject this JWT is issued to.
setTable(String) - Method in class org.forgerock.audit.handlers.jdbc.TableMapping: Sets the table name for the mapping.
setTableMappings(List<TableMapping>) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration: Sets the table mappings for the audit events.
setTarget(RequestHandler) - Method in class org.forgerock.json.resource.FilterChain: Sets the target request handler which will be invoked once processing has reached the end of the filter chain.
setTarget(LeftValueExpression<?>) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter: Sets the expression which will be used for storing authorization information in the context.
setTopic(String) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping: Sets the name of the event topic to which this mapping applies.
setTopics(Set<String>) - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Sets the topics accepted by this handler.
setTotalPagedResultsPolicy(CountPolicy) - Method in interface org.forgerock.json.resource.QueryRequest: Sets the policy for calculating the total number of paged results.
setType(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet: Gets the type of the contents of the Claims Set.
setType(JwtType) - Method in class org.forgerock.json.jose.jwt.JwtHeader: Sets the type of JWT this header represents.
setup(DisconnectionStrategy, Runnable) - Static method in enum org.forgerock.openig.tools.notifications.DisconnectionStrategy: For a given DisconnectionStrategy, setup a callback that is called based on the strategy.
setupModule(Module.SetupContext) - Method in class org.forgerock.http.util.Json.JsonValueModule
setUri(String) - Method in class org.forgerock.http.protocol.Request: Sets the fully-qualified string URI of the resource being accessed.
setUri(URI) - Method in class org.forgerock.http.protocol.Request: Sets the fully-qualified URI of the resource being accessed.
setUri(MutableUri) - Method in class org.forgerock.http.header.ReferrerHeader: Set the URI value of the Referrer header.
setUri(Expression<String>) - Method in class org.forgerock.openig.filter.StaticRequestFilter: Sets the target URI as an expression to allow dynamic URI construction.
setUriDetailsIfNotPresent(Request, Context, Swagger) - Method in class org.forgerock.http.swagger.OpenApiRequestFilter: Deduce and set the base URI of the request for the OpenAPI descriptor from the request context.
setUserId(String) - Method in class org.forgerock.services.context.RequestAuditContext: Set the user ID on the context.
setUserInfo(String) - Method in class org.forgerock.http.MutableUri: Update the user info (not encoded) of this MutableUri.
setUsername(String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Sets Elasticsearch username for HTTP basic authentication.
setUsername(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool: Sets the username to use to connect to the JDBC database.
setUseSSL(boolean) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration: Sets the use of a SSL connection.
setUseSSL(boolean) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration: Sets the use of a SSL connection.
setValue(String) - Method in class org.forgerock.http.protocol.Cookie: Sets the value of the cookie.
setValueMappings(Map<String, Severity>) - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping: Sets the mapping of audit event values to Syslog severity values.
setValueWasQuoted(boolean) - Method in class org.forgerock.http.protocol.Cookie: Sets the valueWasQuoted flag to indicate if the original cookie value was enclosed in "", used when recreating the cookie header.
setVersion(Integer) - Method in class org.forgerock.http.protocol.Cookie: Deprecated.
Only valid for RFC 2965 cookies ("Cookie2"), which have been deprecated and removed by most clients.
setVersion(String) - Method in interface org.forgerock.http.protocol.Message: Sets the protocol version.
setVersion(String) - Method in class org.forgerock.http.protocol.Request
setVersion(String) - Method in class org.forgerock.http.protocol.Response
setVersion(String) - Method in class org.forgerock.openig.filter.StaticRequestFilter: Sets the new request message's version.
setWarningEnabled(boolean) - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager: Sets if warning headers should be set on the response if no Accept-API-Version header is present on the request.
setWriteInterval(String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the interval for reading events from the buffer to transmit to Elasticsearch.
setWriteInterval(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the interval to write the queued buffered events.
setWriteInterval(String) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.BatchConfiguration: Sets the interval for reading events from the buffer to transmit via jms.
setWriteInterval(String) - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets delay after which the file-writer thread is scheduled to run after encountering an empty event buffer (units of 'ms' are recommended).
setWriteInterval(String) - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration: Sets the interval for reading events from the buffer to transmit to splunk.
setWriter(Writer) - Method in class org.forgerock.audit.rotation.RotationContext: Set the writer.
setWriterThreads(int) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration: Sets the number of writer threads to use to write buffered events.
setX509CertificateChain(List<String>) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the X.509 Certificate Chain header parameter for this JWS.
setX509CertificateThumbprint(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the X.509 Certificate Thumbprint header parameter for this JWS.
setX509Url(URL) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader: Sets the X.509 URL header parameter for this JWS.
Severity - Enum in org.forgerock.audit.handlers.syslog: Defines the standard Syslog message severities.
SeverityFieldMapping() - Constructor for class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping
sha256(byte[]) - Static method in class org.forgerock.json.jose.utils.Utils: Convenience method to perform SHA-256 hashing of the input data.
Sha256AttributeCertificateThumbprintVerifier - Class in org.forgerock.openig.filter.oauth2.cnf: Verifies a certificate thumbprint against a previously calculated thumbprint, stored in a specially named attribute stored in the context's attributes.
Sha256AttributeCertificateThumbprintVerifier() - Constructor for class org.forgerock.openig.filter.oauth2.cnf.Sha256AttributeCertificateThumbprintVerifier
shouldRotateFile(RotatableObject) - Method in class org.forgerock.audit.rotation.FixedTimeRotationPolicy: This method indicates if the log file should be rotated or not.
shouldRotateFile(RotatableObject) - Method in interface org.forgerock.audit.rotation.RotationPolicy: This method indicates if the log file should be rotated or not.
shouldRotateFile(RotatableObject) - Method in class org.forgerock.audit.rotation.SizeBasedRotationPolicy: Indicates whether or not a RotatableObject needs rotation.
shouldRotateFile(RotatableObject) - Method in class org.forgerock.audit.rotation.TimeLimitRotationPolicy: Checks whether or not a RotatableObject needs rotation.
shutdown() - Method in interface org.forgerock.audit.AuditService: Closes this AuditService and all its AuditEventHandlers.
shutdown() - Method in class org.forgerock.audit.AuditServiceProxy
shutdown() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Instruct this object to flush any buffers and close any open file handles or network connections.
shutdown() - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisher: Informs the publisher to stop processing offered events.
shutdown() - Method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Stops sending batch data, and awaits termination of pending queue tasks when autoFlush is enabled.
shutdown() - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Releases any resources held by the writer.
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
shutdown() - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Releases any resources held by the writer.
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
shutdown() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler: Instruct this object to flush any buffers and close any open file handles or network connections.
shutdown() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
shutdown() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: Instruct this object to flush any buffers and close any open file handles or network connections.
shutdown() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler: Closes the JMS connection.
shutdown() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandler
shutdown() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
shutdown() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler: Closes the connections established by SyslogPublisher.
shutdown() - Method in class org.forgerock.openig.audit.NoOpAuditService
shutdown() - Method in class org.forgerock.util.DirectoryWatcher: Shuts down the directory watcher, cancelling all registered watch tasks and closing the underlying watch service.
shutdown() - Method in interface org.forgerock.util.thread.listener.ShutdownListener: The function to run when the system shutdown.
shutdown() - Method in interface org.forgerock.util.thread.listener.ShutdownManager: Shuts down all the listeners in this ShutdownManager.
shutdown() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
shutdown(boolean) - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Releases any resources held by the writer.
ShutdownListener - Interface in org.forgerock.util.thread.listener: Any component which needs to be shut down should implement this interface and use the function to shut down the component.
ShutdownManager - Interface in org.forgerock.util.thread.listener: Interface used by shutdown managers to allow for thread safe adding and removing of shutdown listeners.
shutdownNow() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
ShutdownPriority - Enum in org.forgerock.util.thread.listener: This class defines the shutdown priorities that are consumed by com.sun.identity.common.ShutdownManager.
SIG - Static variable in class org.forgerock.json.jose.jwk.KeyUseConstants: Use Key as a signature key.
sign(byte[]) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
sign(byte[]) - Method in interface org.forgerock.audit.secure.SecureStorage: Signs the provided data.
sign(PrivateKey, String, String) - Method in class org.forgerock.util.SignatureUtil: Signs a String using the given private key.
sign(SigningHandler, JwsAlgorithm) - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder: Deprecated.
Use EncryptedJwtBuilder.signedWith(SigningHandler, JwsAlgorithm) instead.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler: Deprecated.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler: Deprecated.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler: Deprecated.

Signs the given raw data bytes using the Java Cryptographic algorithm defined by the JwsAlgorithm.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.NOPSigningHandler: Deprecated.

Returns an empty byte array.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler: Deprecated.

Signs the given raw data bytes using the Java Cryptographic algorithm defined by the JwsAlgorithm.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.SecretECDSASigningHandler
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.SecretSigningHandler
sign(JwsAlgorithm, byte[]) - Method in interface org.forgerock.json.jose.jws.handlers.SigningHandler: Signs the given raw data bytes using the Java Cryptographic algorithm defined by the JwsAlgorithm.
sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler: Deprecated.
sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler: Deprecated.

Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.
sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.NOPSigningHandler: Deprecated.

Simply returns a byte array of a UTF-8 empty string.
sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler: Deprecated.

Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.
sign(JwsAlgorithm, String) - Method in interface org.forgerock.json.jose.jws.handlers.SigningHandler: Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.
SIGN - org.forgerock.json.jose.jwk.KeyOperation: Use Key to compute digital signature or MAC.
SIGN - org.forgerock.secrets.keys.KeyUsage: Key is intended for signing messages with digital signatures.
SIGN - Static variable in class org.forgerock.secrets.Purpose: Indicates a key intended for creating digital signatures or message authentication codes (MACs).
SIGNATURE_ALGORITHM - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The algorithm to use for signing and verifying.
SignatureUtil - Class in org.forgerock.util: Utility class for signing and verifying signatures.
SignedEncryptedJwsHeaderBuilder - Class in org.forgerock.json.jose.builders: Deprecated.
Use EncryptedThenSignedJwtHeaderBuilder instead.
SignedEncryptedJwsHeaderBuilder(EncryptedThenSignedJwtBuilder) - Constructor for class org.forgerock.json.jose.builders.SignedEncryptedJwsHeaderBuilder: Deprecated.

Constructs a new JwsHeaderBuilder, parented by the given JwtBuilder.
SignedEncryptedJwt - Class in org.forgerock.json.jose.jws: Deprecated.
Use EncryptedThenSignedJwt instead.
SignedEncryptedJwt(JwsHeader, EncryptedJwt, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.SignedEncryptedJwt: Deprecated.

Constructs a reconstructed SignedEncryptedJwt from its constituent parts, the JwsHeader, nested Encrypted JWT, signing input and signature.
SignedEncryptedJwt(JwsHeader, EncryptedJwt, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.SignedEncryptedJwt: Deprecated.

Constructs a fresh, new SignedEncryptedJwt from the given JwsHeader and nested Encrypted JWT.
SignedEncryptedJwtBuilder - Class in org.forgerock.json.jose.builders: Deprecated.
Use EncryptedThenSignedJwtBuilder instead.
SignedEncryptedJwtBuilder(EncryptedJwtBuilder, SigningHandler, JwsAlgorithm) - Constructor for class org.forgerock.json.jose.builders.SignedEncryptedJwtBuilder: Deprecated.

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.
SignedJwt - Class in org.forgerock.json.jose.jws: A JWS implementation of the Jwt interface.
SignedJwt(JwsHeader, JwtClaimsSet, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.SignedJwt: Constructs a reconstructed SignedJwt from its constituent parts, the JwsHeader, JwtClaimsSet, signing input and signature.
SignedJwt(JwsHeader, JwtClaimsSet, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.SignedJwt: Constructs a fresh, new SignedJwt from the given JwsHeader and JwtClaimsSet.
SignedJwt(JwsHeader, Payload, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.SignedJwt: Constructs a reconstructed SignedJwt from its constituent parts, the JwsHeader, nested Encrypted JWT, signing input and signature.
SignedJwt(JwsHeader, Payload, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.SignedJwt: Constructs a fresh, new SignedJwt from the given JwsHeader and nested Encrypted JWT.
SignedJwt(SignedJwt) - Constructor for class org.forgerock.json.jose.jws.SignedJwt: Construct an signed JWT from an existent one.
SignedJwtBuilder - Interface in org.forgerock.json.jose.builders: A base interface for both SignedJwtBuilder and SignedEncryptedJwtBuilder to create Signed JWTs and Signed and Encrypted JWTs.
SignedJwtBuilderImpl - Class in org.forgerock.json.jose.builders: An implementation of a JwtBuilder that can build a JWT and sign it, resulting in a SignedJwt object.
SignedJwtBuilderImpl(SigningHandler) - Constructor for class org.forgerock.json.jose.builders.SignedJwtBuilderImpl: Constructs a new SignedJwtBuilderImpl that will use the given private key to sign the JWT.
SignedJwtFactory - Class in org.forgerock.openig.tools.jwt.factory
SignedJwtFactory(SigningManager, SecretReference<SigningKey>, JwsAlgorithm) - Constructor for class org.forgerock.openig.tools.jwt.factory.SignedJwtFactory
SignedThenEncryptedJwt - Class in org.forgerock.json.jose.jwe: A nested signed-then-encrypted JWT.
SignedThenEncryptedJwt(EncryptedJwt) - Constructor for class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt: Constructs a fresh signed-then-encrypted JWT from an encrypted JWT.
SignedThenEncryptedJwt(JweHeader, String, byte[], byte[], byte[], byte[]) - Constructor for class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt: Reconstructs a signed-then-encrypted JWT from components parts of the encrypted JWT string.
SignedThenEncryptedJwt(JweHeader, SignedJwt, Key) - Constructor for class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt: Constructs a fresh signed-then-encrypted JWT with the given signed JWT payload, JWE headers and encryption key.
SignedThenEncryptedJwtBuilder - Class in org.forgerock.json.jose.builders: Builder for nested signed-then-encrypted JWT.
SignedThenEncryptedJwtFactory - Class in org.forgerock.openig.tools.jwt.factory
SignedThenEncryptedJwtFactory(SignedJwtFactory, JweAlgorithm, EncryptionMethod, SecretReference<DataEncryptionKey>) - Constructor for class org.forgerock.openig.tools.jwt.factory.SignedThenEncryptedJwtFactory
signedWith(SigningHandler, JwsAlgorithm) - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder: Returns an EncryptedThenSignedJwtBuilder that will build a signed JWT with this builder's encrypted JWT as its payload.
SigningHandler - Interface in org.forgerock.json.jose.jws.handlers: The interface for SigningHandlers for all the different signing algorithms.
SigningKey - Class in org.forgerock.secrets.keys: A key that is used for signing digital signatures.
SigningKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.SigningKey: Initialises the key with the given secret data.
SigningManager - Class in org.forgerock.json.jose.jws: A service to get the appropriate SigningHandler for a specific Java Cryptographic signing algorithm.
SigningManager() - Constructor for class org.forgerock.json.jose.jws.SigningManager: Deprecated.
use SigningManager(SecretsProvider) instead
SigningManager(SecretsProvider) - Constructor for class org.forgerock.json.jose.jws.SigningManager: Builds a new SigningManager that can build SigningHandler based on asynchronously retrieved Secrets from the given provider.
signingPurpose(Purpose<SigningKey>) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder: Specifies the Purpose used to retrieve signing keys from the secrets provider.
simpleCrestApplication(ConnectionFactory, String, String) - Static method in class org.forgerock.json.resource.Applications: Create a simple CrestApplication using the provided factory, id and version.
simpleHttpApplication(Handler, Factory<Buffer>) - Static method in class org.forgerock.http.Applications: Create a simple HttpApplication that just returns the provided arguments from the appropriate methods.
SingleSignOnFilter - Class in org.forgerock.openig.openam: This filter verifies the presence of a SSOToken in the given cookie name.
SingleSignOnFilter(AmService, Realm, Expression<Boolean>, String, Expression<String>, String, boolean, String) - Constructor for class org.forgerock.openig.openam.SingleSignOnFilter: Creates a new SingleSignOnFilter.
SingleSignOnFilter.Heaplet - Class in org.forgerock.openig.openam: Creates and initialises an authentication filter in a heap environment.
SingleSignOnTypeProvider - Class in org.forgerock.openig.openam: Provide SingleSignOnFilter's TypeDefinition.
SingleSignOnTypeProvider() - Constructor for class org.forgerock.openig.openam.SingleSignOnTypeProvider
SingletonResourceProvider - Interface in org.forgerock.json.resource: An implementation interface for resource providers which exposes a single permanent resource instance.
size() - Method in class org.forgerock.http.protocol.Headers
size() - Method in class org.forgerock.http.protocol.RequestCookies
size() - Method in class org.forgerock.http.util.SetDecorator
size() - Method in class org.forgerock.json.JsonPointer: Returns the number of reference tokens in the pointer.
size() - Method in class org.forgerock.json.JsonValue: Returns the number of values that this JSON value contains.
size() - Method in class org.forgerock.json.resource.ResourcePath: Returns the number of elements in this resource path, or 0 if it is empty.
size() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
size() - Method in class org.forgerock.util.LazyList: Returns the number of elements in this list.
size() - Method in class org.forgerock.util.LazyMap: Returns the number of key-value mappings in this map.
size() - Method in class org.forgerock.util.ListDecorator: Returns the number of elements in this list.
size() - Method in class org.forgerock.util.MapDecorator: Returns the number of key-value mappings in this map.
size() - Method in class org.forgerock.util.NonExpiringCache: Gets the size of the cache.
size() - Method in class org.forgerock.util.PerItemEvictionStrategyCache: Returns the number of cached values.
size() - Method in class org.forgerock.util.RangeSet: Returns the number of elements in this set.
SizeBasedRetentionPolicy - Class in org.forgerock.audit.retention: Created a size based file retention policy.
SizeBasedRetentionPolicy(int) - Constructor for class org.forgerock.audit.retention.SizeBasedRetentionPolicy: Constructs a SizeBasedRetentionPolicy with a given maximum number of archived files.
SizeBasedRotationPolicy - Class in org.forgerock.audit.rotation: Creates a file size based rotation policy.
SizeBasedRotationPolicy(long) - Constructor for class org.forgerock.audit.rotation.SizeBasedRotationPolicy: Constructs a SizeBasedRotationPolicy given a max file size in bytes.
skip(long) - Method in class org.forgerock.http.io.FailableInputStream
slashEnded() - Static method in class org.forgerock.openig.util.JsonValues: Returns the JsonValue with its value ended by a slash.
SlidingCounterResultRecorder - Class in org.forgerock.openig.filter.circuitbreaker: An implementation of a ResultRecorder to count the number of failed requests in the last size requests.
slug(String) - Static method in class org.forgerock.openig.util.StringUtil: Transform the input String value into a slug: a simpler adaptation that is compatible for usage inside an URI (without requiring URL encoding).
sniConfiguration() - Method in class org.forgerock.openig.tools.ServerTlsOptions: Get the SNI Configuration if any.
SniConfiguration(Map<String, SigningKey>, SigningKey) - Constructor for class org.forgerock.openig.tools.ServerTlsOptions.SniConfiguration: Constructs an SNI configuration instance.
SortKey - Class in org.forgerock.json.resource: A sort key which can be used to specify the order in which JSON resources should be included in the results of a query request.
SortKeyComparator - Class in org.forgerock.json.resource: This comparator iterates through the provided sortKeys and finds the first comparative difference between the left and right side JsonValues.
SortKeyComparator(List<SortKey>) - Constructor for class org.forgerock.json.resource.SortKeyComparator: Construct a Comparator that will compare two JsonValue objects based on the provided list of SortKeys.
SortKeyComparator(List<SortKey>, SortKeyComparator.NullPosition) - Constructor for class org.forgerock.json.resource.SortKeyComparator: Construct a Comparator that will compare two JsonValue objects based on the provided list of SortKeys and options.
SortKeyComparator.NullPosition - Enum in org.forgerock.json.resource: Defines possible positions for JsonValue that wraps a null object.
split(String, char) - Static method in class org.forgerock.http.header.HeaderUtil: Parses an HTTP header value, splitting it into multiple values around the specified separator.
split(String, String) - Static method in class org.forgerock.openig.el.Functions: Splits a string into an array of substrings around matches of the given regular expression.
SplunkAuditEventHandler - Class in org.forgerock.audit.handlers.splunk: Audit event handler that writes out to Splunk's HTTP event collector RAW endpoint.
SplunkAuditEventHandler(SplunkAuditEventHandlerConfiguration, EventTopicsMetaData, BatchPublisherFactory, Client) - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler: Constructs a new Splunk audit event handler.
SplunkAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.splunk: Configuration for the splunk audit event handler.
SplunkAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration
SplunkAuditEventHandlerConfiguration.BufferingConfiguration - Class in org.forgerock.audit.handlers.splunk: Configuration of event buffering.
SplunkAuditEventHandlerConfiguration.ConnectionConfiguration - Class in org.forgerock.audit.handlers.splunk: Configuration of connection to Splunk.
SqlAttributesFilter - Class in org.forgerock.openig.sql: Executes a SQL query through a prepared statement and exposes its first result.
SqlAttributesFilter(DataSource, LeftValueExpression<Map>, String) - Constructor for class org.forgerock.openig.sql.SqlAttributesFilter: Builds a new SqlAttributesFilter that will execute the given SQL statement on the given DataSource, placing the results in a Map in the specified target.
SqlAttributesFilter.Heaplet - Class in org.forgerock.openig.sql: Creates and initializes a static attribute provider in a heap environment.
ssoHeader(String, AsyncRefreshableSupplier<SsoToken, AuthenticationException>) - Method in class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Provide values for a SSO token header.
SsoToken - Class in org.forgerock.openig.tools.authentication: Represents the successful result of an authentication against the AM server.
SsoToken(String) - Constructor for class org.forgerock.openig.tools.authentication.SsoToken: Constructs a new token with the given value.
SsoTokenContext - Class in org.forgerock.openig.openam: The SsoTokenContext provides access to the token and user information related to this session.
STABLE_ID_KEY - Static variable in class org.forgerock.util.crypto.CryptoConstants: key for the id of the key used to crypt the data when purposes are in use.
stableId(String) - Method in class org.forgerock.secrets.SecretBuilder: Sets the stable id of this secret.
stableIdFor(KeyStoreSecretStore.KeyDetails, Class<? extends Secret>) - Method in interface org.forgerock.secrets.keystore.KeyStoreSecretStore.StableIdProvider: Produce the secret's stable ID.
start() - Method in interface org.forgerock.http.HttpApplication: Gets the root Handler that will handle all HTTP requests.
start() - Method in class org.forgerock.openig.audit.AuditServiceObjectHeaplet
start() - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet: Called to request the heaplet start an object.
start() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
start() - Method in class org.forgerock.openig.heap.GenericHeaplet: Called to request the heaplet start an object.
start() - Method in class org.forgerock.openig.heap.HeapImpl: Allocate all objects using each heaplet instance's configuration.
start() - Method in class org.forgerock.openig.http.AdminHttpApplication
start() - Method in class org.forgerock.openig.http.GatewayHttpApplication
start() - Method in class org.forgerock.openig.openam.AmServiceHeaplet
start() - Method in class org.forgerock.openig.tools.am.AmService: Starts this server instance (and associated services).
start() - Method in interface org.forgerock.openig.tools.LifeCycle: Starts this object.
start() - Method in class org.forgerock.openig.tools.notifications.ws.NotificationServiceImpl
start() - Method in interface org.forgerock.openig.tools.notifications.ws.WebSocketAdapter: Start the websocket client and connect to the remote endpoint.
start() - Method in class org.forgerock.openig.tools.session.CacheSessionService
startAsync() - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
startAsync(ServletRequest, ServletResponse) - Method in class org.forgerock.openig.handler.saml.ChfHttpServletRequestAdapter
STARTS_WITH - org.forgerock.http.routing.RoutingMode: The URI template must match the beginning of a request's resource name in order for the route to be selected.
STARTS_WITH - Static variable in class org.forgerock.util.query.QueryFilterOperators: the "starts-with" operator.
startsWith(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter: Creates a new starts with filter using the provided field name and value assertion.
startsWith(String) - Method in class org.forgerock.json.resource.ResourcePath: Returns true if this resource path is equal to or begins with the provided resource resource path.
startsWith(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath: Returns true if this resource path is equal to or begins with the provided resource resource path.
startup() - Method in interface org.forgerock.audit.AuditService: Allows this AuditService and all its AuditEventHandlers to perform any initialization that would be unsafe to do if any other instance of the AuditService were still running.
startup() - Method in class org.forgerock.audit.AuditServiceProxy
startup() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Instruct this object that it is safe to initialize file handles and network connections.
startup() - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisher: Informs the publisher to start processing offered events.
startup() - Method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Starts periodically sending batch data.
startup() - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
startup() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler: Instruct this object that it is safe to initialize file handles and network connections.
startup() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
startup() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler: Instruct this object that it is safe to initialize file handles and network connections.
startup() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler: Creates the JMS Topic and ConnectionFactory from the context configuration settings and opens the JMS connection.
startup() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandler
startup() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
startup() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler: Instruct this object that it is safe to initialize file handles and network connections.
startup() - Method in class org.forgerock.openig.audit.NoOpAuditService
StatelessAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2: A StatelessAccessTokenResolver that locally resolves and validates stateless access_tokens issued by AM.
StatelessAccessTokenResolver.Heaplet - Class in org.forgerock.openig.filter.oauth2: Creates and initializes a stateless access token resolver in the heap environment.
StaticRequestFilter - Class in org.forgerock.openig.filter: Creates a new request and send it down the next handler (effectively replacing the previous request).
StaticRequestFilter(String) - Constructor for class org.forgerock.openig.filter.StaticRequestFilter: Builds a new StaticRequestFilter that will uses the given HTTP method on the resource.
StaticRequestFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes a request filter in a heap environment.
StaticResponseHandler - Class in org.forgerock.openig.handler: Creates a static HTTP response.
StaticResponseHandler(Status) - Constructor for class org.forgerock.openig.handler.StaticResponseHandler: Constructor.
StaticResponseHandler(Status, Expression<String>) - Constructor for class org.forgerock.openig.handler.StaticResponseHandler: Constructor.
StaticResponseHandler.Heaplet - Class in org.forgerock.openig.handler: Creates and initializes a static response handler in a heap environment.
StaticResponseHandlerTypeProvider - Class in org.forgerock.openig.handler: Provide StaticResponseHandler's TypeDefinition.
StaticResponseHandlerTypeProvider() - Constructor for class org.forgerock.openig.handler.StaticResponseHandlerTypeProvider
Status - Class in org.forgerock.http.protocol: The status-code element is a three-digit integer code giving the result of the attempt to understand and satisfy the request.
STATUS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The status event payload field name.
STATUS_CODE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The status code event payload field name.
Status.Family - Enum in org.forgerock.http.protocol: The first digit of the status-code defines the class of response.
stop() - Method in interface org.forgerock.http.HttpApplication: Called when HTTP application is shutdown.
stop() - Method in class org.forgerock.openig.decoration.DecorationHandle: Notifies the handle to stop the decoration.
stop() - Method in class org.forgerock.openig.filter.throttling.ThrottlingFilter: Stops this filter and frees the resources.
stop() - Method in interface org.forgerock.openig.filter.throttling.ThrottlingStrategy: Stop and free any resources needed by the strategy.
stop() - Method in class org.forgerock.openig.filter.throttling.TokenBucketThrottlingStrategy
stop() - Method in class org.forgerock.openig.handler.router.RouterHandler: Stops this handler, shutting down and clearing all the managed routes.
stop() - Method in class org.forgerock.openig.http.AdminHttpApplication
stop() - Method in class org.forgerock.openig.http.GatewayHttpApplication
stop() - Method in class org.forgerock.openig.tools.am.AmService: Stops this server instance (and associated services).
stop() - Method in interface org.forgerock.openig.tools.LifeCycle: Stops this object.
stop() - Method in class org.forgerock.openig.tools.notifications.ws.NotificationServiceImpl
stop() - Method in class org.forgerock.openig.tools.session.CacheSessionService
STORAGE_TYPE_HASH - Static variable in class org.forgerock.util.crypto.CryptoConstants: A salted hash encryption storage type.
store() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
store() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Saves the keystore.
store() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
storeTypeFromKeyStore(String) - Static method in class org.forgerock.openig.util.KeyStoreUtil: Get default keystore type based on the keystore filename.
stream() - Method in class org.forgerock.json.JsonValue: Construct a Stream from this JsonValue object.
stream(InputStream, OutputStream) - Static method in class org.forgerock.http.io.IO: Streams all data from an input stream to an output stream.
stream(InputStream, OutputStream, boolean) - Static method in class org.forgerock.http.io.IO: Streams all data from an input stream to an output stream.
stream(InputStream, OutputStream, int) - Static method in class org.forgerock.http.io.IO: Streams data from an input stream to an output stream, up to a specified length.
stream(Reader, Writer) - Static method in class org.forgerock.http.io.IO: Streams all characters from a reader to a writer.
Stream(OutputStream) - Constructor for class org.forgerock.audit.events.handlers.writers.TextWriter.Stream: Creates a new text writer that will write to the provided output stream.
streamOf(Function<JsonValue, V, E>) - Static method in class org.forgerock.openig.util.JsonValues: Returns the JSON value as a Stream containing objects whose type (and value) is specified by a transformation function.
Streams - Class in org.forgerock.util: Utility methods for operating on IO streams.
STRICT - org.forgerock.http.handler.HttpClientHandler.HostnameVerifier: Requires that the host name matches the host name presented in the certificate.
STRICT - org.forgerock.http.protocol.Cookie.SameSite: In "strict" mode the cookie will not be sent unless the request originates from the same origin.
strictlyBetween(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 minExclusive and maxExclusive versions (exclusive).
STRING_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json String value type.
stringOrListOfStrings() - Static method in class org.forgerock.json.JsonValueFunctions: Return a list of string values from the given JsonValue.
StringOrURI - Class in org.forgerock.json.jose.utils: This class provides an utility method for validating that a String is either an arbitrary string without any ":" characters or if the String does contain a ":" character then the String is a valid URI.
Strings - Class in org.forgerock.util: Common utility methods for Strings.
StringUtil - Class in org.forgerock.openig.util: Miscellaneous string utility methods.
sts() - Method in class org.forgerock.openig.tools.am.AmService: Returns the transformation endpoint located in the /rest-sts namespace.
sts() - Method in class org.forgerock.openig.tools.am.UriService: Returns the transformation endpoint located in the /rest-sts namespace.
sts(String) - Method in class org.forgerock.openig.tools.am.AmService: Returns the transformation endpoint located in the /rest-sts namespace.
sts(String) - Method in class org.forgerock.openig.tools.am.UriService: Returns the transformation endpoint located in the /rest-sts namespace.
StsContext - Class in org.forgerock.openig.openam: A StsContext convey the token transformation results to downstream filters and handlers.
stsUri(String) - Method in class org.forgerock.openig.tools.am.AmService: Returns the URI of the transformation endpoint located in the /rest-sts namespace.
stsUri(String) - Method in class org.forgerock.openig.tools.am.UriService: Returns the URI of the transformation endpoint located in the /rest-sts namespace.
STUDIO_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.
sub(String) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the subject this JWT is issued to.
sub(URI) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the subject this JWT is issued to.
SUB - org.forgerock.json.jose.jwt.JwtClaimsSetKey: Subject Claim.
subList(int, int) - Method in class org.forgerock.util.LazyList: Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
subList(int, int) - Method in class org.forgerock.util.ListDecorator: Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
submit(Runnable) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
submit(Runnable, T) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
submit(Callable<T>) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
subscribe(String, NotificationListener) - Method in interface org.forgerock.openig.tools.notifications.NotificationService: Subscribes (asynchronously) to a given topic, providing a listener that will be invoked at notification reception time.
subscribe(String, NotificationListener) - Method in class org.forgerock.openig.tools.notifications.ws.NotificationServiceImpl
subscribe(String, NotificationListener) - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionService
Subscription - Interface in org.forgerock.openig.tools.notifications: Represents a managed subscription to a given topic.
SubscriptionAck - Class in org.forgerock.openig.tools.notifications.ws: A SubscriptionAck is a response message to a SubscriptionRequest.
SubscriptionException - Exception in org.forgerock.openig.tools.notifications: Represents a subscription (or un-subscription) failure.
SubscriptionException(String) - Constructor for exception org.forgerock.openig.tools.notifications.SubscriptionException: Builds a subscription (or un-subscription) failure.
SubscriptionException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.notifications.SubscriptionException: Builds a subscription (or un-subscription) failure.
SubscriptionRequest - Class in org.forgerock.openig.tools.notifications.ws: A SubscriptionRequest is a message send to the notification server when subscribing to a topic.
SubscriptionService - Class in org.forgerock.openig.tools.notifications.ws: Web-socket client endpoint that bridges AM notifications protocol to our own API.
SubscriptionService(TopicManager) - Constructor for class org.forgerock.openig.tools.notifications.ws.SubscriptionService: SubscriptionService constructor taking a TopicManager.
subSequence(int, int) - Method in class org.forgerock.json.resource.ResourcePath: Returns a resource path which is a subsequence of the path elements contained in this resource path beginning with the element at position beginIndex and ending with the element at position endIndex-1.
success() - Static method in class org.forgerock.openig.filter.oauth2.cnf.Result: Returns a Result representing validation success.
success() - Static method in class org.forgerock.openig.tools.jwt.validation.Result: Returns a Result representing validation success.
SUCCESSFUL - org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: The access request was successfully completed.
SUCCESSFUL - org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Authentication operation has completed successfully.
SUCCESSFUL - org.forgerock.http.protocol.Status.Family: The 2xx (Successful) class of status code indicates that the client's $ request was successfully received, understood, and accepted.
successfulSubscription(String, String, String) - Static method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck: Builds a successful acknowledgement.
Supplier<T,E extends Exception> - Interface in org.forgerock.util: A Supplier functional interface which can throw a checked Exception.
SupportedEllipticCurve - Enum in org.forgerock.json.jose.jws: Enumerates all supported elliptic curve parameters for ESXXX signature formats.
supportedTypes() - Method in interface org.forgerock.openig.alias.ClassAliasResolver: Returns the set of heaplet classes supported by this alias resolver.
supportedTypes() - Method in class org.forgerock.openig.alias.CoreClassAliasResolver
supportedTypes() - Method in class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
supportedTypes() - Method in class org.forgerock.openig.handler.saml.SamlClassAliasResolver
supportedTypes() - Method in class org.forgerock.openig.openam.OpenAMClassAliasResolver
supportedTypes() - Method in class org.forgerock.openig.uma.UmaClassAliasResolver
SUPPRESS - org.forgerock.openig.filter.CookieFilter.Action: Remove the cookie from request and response.
SwaggerApiProducer - Class in org.forgerock.http.swagger: An API Producer for APIs that use the Swagger model implementation of the OpenAPI specification.
SwaggerApiProducer(Info) - Constructor for class org.forgerock.http.swagger.SwaggerApiProducer: Create a new API Description Producer with null as basePath, host and no scheme.
SwaggerApiProducer(Info, String, String, Scheme...) - Constructor for class org.forgerock.http.swagger.SwaggerApiProducer: Create a new API Description Producer.
SwaggerApiProducer(Info, String, String, List<Scheme>) - Constructor for class org.forgerock.http.swagger.SwaggerApiProducer: Create a new API Description Producer.
SwaggerExtended - Class in org.forgerock.http.swagger: Extension of Swagger to override some of its behaviors.
SwaggerExtended() - Constructor for class org.forgerock.http.swagger.SwaggerExtended
SwaggerUtils - Class in org.forgerock.http.swagger: Swagger utility.
SwitchFilter - Class in org.forgerock.openig.filter: Conditionally diverts the request to another handler.
SwitchFilter() - Constructor for class org.forgerock.openig.filter.SwitchFilter
SwitchFilter.Heaplet - Class in org.forgerock.openig.filter: Creates and initializes an expect filter in a heap environment.
SWITCHING_PROTOCOLS - Static variable in class org.forgerock.http.protocol.Status: The 101 (Switching Protocols) status code indicates that the server understands and is willing to comply with the client's request, via the Upgrade header field (Section 6.7 of [RFC7230]), for a change in the application protocol being used on this connection.
sync() - Method in class org.forgerock.http.util.CaseInsensitiveMap: Synchronizes the keys of this case insensitive map and those of the map it is wrapping.
SynchronousRequestHandler - Interface in org.forgerock.json.resource: An interface for implementing synchronous RequestHandlers.
SYSLOG - org.forgerock.audit.handlers.syslog.Facility: Messages generated internally by syslogd.
SyslogAuditEventHandler - Class in org.forgerock.audit.handlers.syslog: The handler publishes audit events formatted using SyslogFormatter to a syslog daemon using the configured SyslogPublisher.
SyslogAuditEventHandler(SyslogAuditEventHandlerConfiguration, EventTopicsMetaData, ProductInfoProvider, LocalHostNameProvider) - Constructor for class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler: Create a new SyslogAuditEventHandler instance.
SyslogAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.syslog: Configuration object for the SyslogAuditEventHandler.
SyslogAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration
SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration - Class in org.forgerock.audit.handlers.syslog: Configuration of event buffering.
SyslogAuditEventHandlerConfiguration.SeverityFieldMapping - Class in org.forgerock.audit.handlers.syslog: Encapsulates configuration for mapping audit event field values to Syslog severity values.
SYSPROP_TRUST_TRANSACTION_HEADER - Static variable in class org.forgerock.http.filter.TransactionIdInboundFilter: The system property to allow to trust the HTTP header X-ForgeRock-TransactionId.
SystemAndEnvSecretStoreHeaplet - Class in org.forgerock.openig.secrets: This heaplet represents an instance of a PropertyResolverSecretStore resolving properties in system then in environment variables.
SystemAndEnvSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.SystemAndEnvSecretStoreHeaplet
SystemPropertiesPlugin - Class in org.forgerock.openig.el.plugins: An ELContext node plugin that provides read-only access to system properties.
SystemPropertiesPlugin() - Constructor for class org.forgerock.openig.el.plugins.SystemPropertiesPlugin
SystemProxyOptions - Class in org.forgerock.openig.proxy: A ProxyOptions to use when the system defined proxy must be used.
SystemProxyOptions.Heaplet - Class in org.forgerock.openig.proxy: Creates and initializes a SystemProxyOptions in a heap environment.
SystemProxyOptionsTypeProvider - Class in org.forgerock.openig.proxy: Provide the SystemProxyOptions's TypeDefinition.
SystemProxyOptionsTypeProvider() - Constructor for class org.forgerock.openig.proxy.SystemProxyOptionsTypeProvider

T

TAB - org.forgerock.openig.text.Separators: Tab separated values, with support for quoted literal strings.
TableMapping - Class in org.forgerock.audit.handlers.jdbc: Contains the necessary information to map an event to a database table, and the event fields to the columns in that database table.
TableMapping() - Constructor for class org.forgerock.audit.handlers.jdbc.TableMapping
tail(int) - Method in class org.forgerock.json.resource.ResourcePath: Returns a resource path which is a subsequence of the path elements contained in this resource path beginning with the element at position beginIndex and ending with the last element in this resource path.
TCP - org.forgerock.audit.handlers.syslog.TransportProtocol: Publish Syslog messages over TCP.
TEAPOT - Static variable in class org.forgerock.http.protocol.Status: Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot".
templateVariable(String, String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Add the given name:value pair in the variables map.
templateVariables(Map<String, String>) - Method in class org.forgerock.http.routing.UriRouterContext.Builder: Set the variables value.
TEMPORARY_REDIRECT - Static variable in class org.forgerock.http.protocol.Status: The 307 (Temporary Redirect) status code indicates that the target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI.
TEMPORARY_STORAGE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve an implementation of a Factory of Buffer instance from the Heap.
TemporaryStorageHeaplet - Class in org.forgerock.openig.io: A Heaplet to call IO.newTemporaryStorage() within a heaplet environment.
TemporaryStorageHeaplet() - Constructor for class org.forgerock.openig.io.TemporaryStorageHeaplet
test(String) - Method in class org.forgerock.util.BlackAndWhitelistFilter: Returns true if the provided string is accepted by this filter, false otherwise.
test(InetAddress) - Method in class org.forgerock.openig.util.InetAddressMask
test(Path) - Method in class org.forgerock.audit.retention.TimestampFilenameFilter
test(T) - Method in interface org.forgerock.util.Predicate: Test a value.
TextWriter - Interface in org.forgerock.audit.events.handlers.writers: A TextWriter provides a character-based stream which can be queried for number of bytes written.
TextWriter.Stream - Class in org.forgerock.audit.events.handlers.writers: A TextWriter implementation which writes to a given output stream.
TextWriterAdapter - Class in org.forgerock.audit.events.handlers.writers: Wraps a TextWriter in a Writer.
TextWriterAdapter(TextWriter) - Constructor for class org.forgerock.audit.events.handlers.writers.TextWriterAdapter: Creates the writer.
then(Function<? super V, VOUT, E>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided function for execution once this Promise has completed with a result, and returns a new Promise representing the outcome of the function.
then(Function<? super V, VOUT, E>) - Method in class org.forgerock.util.promise.PromiseImpl
then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided functions for execution once this Promise has completed (with a result or an exception), and returns a new Promise representing the outcome of the invoked function.
then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>, Function<? super RuntimeException, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided functions for execution once this Promise has completed (with a result or an exception or a RuntimeException), and returns a new Promise representing the outcome of the invoked function.
then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>, Function<? super RuntimeException, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
thenAlways(Runnable) - Method in interface org.forgerock.util.promise.Promise: Submits the provided runnable for execution once this Promise has completed, and regardless of whether it has a result or an exception.
thenAlways(Runnable) - Method in class org.forgerock.util.promise.PromiseImpl
thenAsync(AsyncFunction<? super V, VOUT, E>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided asynchronous function for execution once this Promise has completed with a result, and returns a new Promise representing the outcome of the function.
thenAsync(AsyncFunction<? super V, VOUT, E>) - Method in class org.forgerock.util.promise.PromiseImpl
thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided asynchronous functions for execution once this Promise has completed, and returns a new Promise representing the outcome of the invoked function.
thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>, AsyncFunction<? super RuntimeException, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided asynchronous functions for execution once this Promise has completed, and returns a new Promise representing the outcome of the invoked function.
thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>, AsyncFunction<? super RuntimeException, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
thenCatch(Function<? super E, V, EOUT>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided function for execution once this Promise has not completed with a result (has completed with an exception), and returns a new Promise representing the outcome of the function.
thenCatch(Function<? super E, V, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
thenCatchAsync(AsyncFunction<? super E, V, EOUT>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided asynchronous function for execution once this Promise has completed with an exception, and returns a new Promise representing the outcome of the function.
thenCatchAsync(AsyncFunction<? super E, V, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
thenCatchRuntimeException(Function<? super RuntimeException, V, E>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided function for execution once this Promise has not completed with a result nor with an exception but with a RuntimeException, and returns a new Promise representing the outcome of the function.
thenCatchRuntimeException(Function<? super RuntimeException, V, E>) - Method in class org.forgerock.util.promise.PromiseImpl
thenCatchRuntimeExceptionAsync(AsyncFunction<? super RuntimeException, V, E>) - Method in interface org.forgerock.util.promise.Promise: Submits the provided asynchronous function for execution once this Promise has completed with a RuntimeException, and returns a new Promise representing the outcome of the function.
thenCatchRuntimeExceptionAsync(AsyncFunction<? super RuntimeException, V, E>) - Method in class org.forgerock.util.promise.PromiseImpl
thenDiscardResult() - Method in interface org.forgerock.util.promise.Promise: Discards the promise result if this Promise has completed with a result.
thenFinally(Runnable) - Method in interface org.forgerock.util.promise.Promise: Submits the provided runnable for execution once this Promise has completed, and regardless of whether of its outcome.
thenFinally(Runnable) - Method in class org.forgerock.util.promise.PromiseImpl
thenOnCompletion(T) - Method in interface org.forgerock.util.promise.Promise: Registers the provided completion handler for notification for all completion cases of this Promise.
thenOnCompletion(T) - Method in class org.forgerock.util.promise.PromiseImpl
thenOnException(ExceptionHandler<? super E>) - Method in interface org.forgerock.util.promise.Promise: Registers the provided completion handler for notification if this Promise cannot be completed due to an exception.
thenOnException(ExceptionHandler<? super E>) - Method in class org.forgerock.util.promise.PromiseImpl
thenOnResult(ResultHandler<? super V>) - Method in interface org.forgerock.util.promise.Promise: Registers the provided completion handler for notification once this Promise has completed with a result.
thenOnResult(ResultHandler<? super V>) - Method in class org.forgerock.util.promise.PromiseImpl
thenOnResultOrException(Runnable) - Method in interface org.forgerock.util.promise.Promise: Submits the provided runnable for execution once this Promise has completed, and regardless of whether it has a result or an exception.
thenOnResultOrException(Runnable) - Method in class org.forgerock.util.promise.PromiseImpl
thenOnResultOrException(ResultHandler<? super V>, ExceptionHandler<? super E>) - Method in interface org.forgerock.util.promise.Promise: Registers the provided completion handlers for notification once this Promise has completed (with a result or an exception).
thenOnResultOrException(ResultHandler<? super V>, ExceptionHandler<? super E>) - Method in class org.forgerock.util.promise.PromiseImpl
thenOnRuntimeException(RuntimeExceptionHandler) - Method in interface org.forgerock.util.promise.Promise: Registers the provided completion handler for notification if this Promise cannot be completed due to an runtime exception.
thenOnRuntimeException(RuntimeExceptionHandler) - Method in class org.forgerock.util.promise.PromiseImpl
thisRouterUriMatcher - Variable in class org.forgerock.services.routing.AbstractRouter: Matches the current route.
ThreadPoolSecretStore<T extends Secret> - Class in org.forgerock.secrets: A secret store that wraps another secret store and performs all query operations in a background thread using a thread pool.
Threads - Class in org.forgerock.util: Common utility methods for Threads.
throttle(String, ThrottlingRate) - Method in interface org.forgerock.openig.filter.throttling.ThrottlingStrategy: Based on the given partitionKey and throttlingRate, return if the call is accepted or not.
throttle(String, ThrottlingRate) - Method in class org.forgerock.openig.filter.throttling.TokenBucketThrottlingStrategy
ThrottlingFilter - Class in org.forgerock.openig.filter.throttling: This filter applies a rate limitation to incoming requests : over the limit requests will be rejected with a 429 (Too Many Requests) response, others will pass through.
ThrottlingFilter(AsyncFunction<ContextAndRequest, String, Exception>, ThrottlingPolicy, ThrottlingStrategy) - Constructor for class org.forgerock.openig.filter.throttling.ThrottlingFilter: Constructs a ThrottlingFilter.
ThrottlingFilterHeaplet - Class in org.forgerock.openig.filter.throttling: Creates and initializes a throttling filter in a heap environment.
ThrottlingFilterHeaplet() - Constructor for class org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet
ThrottlingPolicy - Interface in org.forgerock.openig.filter.throttling: This interface defines the contract to lookup a ThrottlingRate that will be applied to the given Request.
ThrottlingRate - Class in org.forgerock.openig.filter.throttling: A value object to represent a throttling rate.
ThrottlingRate(int, String) - Constructor for class org.forgerock.openig.filter.throttling.ThrottlingRate: Constructs a new ThrottlingRate.
ThrottlingStrategy - Interface in org.forgerock.openig.filter.throttling: This interface defines the contract for any throttling strategy.
throwableCauses(Throwable) - Static method in class org.forgerock.openig.tools.Utils: Get the Throwable's causes as a list from a Throwable.
Throwables - Class in org.forgerock.openig.tools.notifications.ws: Throwable utilities class.
TICKER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve a Ticker instance from the Heap.
TimeLimitRotationPolicy - Class in org.forgerock.audit.rotation: Creates a rotation policy based on a time duration.
TimeLimitRotationPolicy(Duration) - Constructor for class org.forgerock.audit.rotation.TimeLimitRotationPolicy: Constructs a TimeLimitRotationPolicy with a given Duration.
TIMER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve a TimerDecorator instance from the Heap.
TimerDecorator - Class in org.forgerock.openig.decoration.timer: The timer decorator can decorate both Filter and Handler instances.
TimerDecorator.Heaplet - Class in org.forgerock.openig.decoration.timer: Creates and initializes a TimerDecorator in a heap environment.
TimerDecoratorTypeProvider - Class in org.forgerock.openig.decoration.timer: Provide TimerDecorator's TypeDefinition.
TimerDecoratorTypeProvider() - Constructor for class org.forgerock.openig.decoration.timer.TimerDecoratorTypeProvider
TimerFactory<T> - Interface in org.forgerock.openig.decoration.timer: A factory for the TimerDecorator.
timestamp(long) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets the provided time stamp for the event.
TIMESTAMP - Static variable in class org.forgerock.audit.events.AuditEventBuilder: Timestamp event payload field name.
TimestampFilenameFilter - Class in org.forgerock.audit.retention: A FilenameFilter that matches historical log files.
TimestampFilenameFilter(File, String, DateTimeFormatter) - Constructor for class org.forgerock.audit.retention.TimestampFilenameFilter: Constructs a TimestampFilenameFilter given an initial file, prefix and suffix.
TimeStampFileNamingPolicy - Class in org.forgerock.audit.retention: Creates a time stamp based file naming policy.
TimeStampFileNamingPolicy(File, String, String) - Constructor for class org.forgerock.audit.retention.TimeStampFileNamingPolicy: Constructs a TimeStampFileNaming policy with a given initial file, a timestamp format, and a prefix string.
tlsOptions(String, KeyManager[], TrustManager[], List<String>, List<String>, boolean) - Method in class org.forgerock.openig.security.ClientTlsOptionsHeaplet
tlsOptions(String, KeyManager[], TrustManager[], List<String>, List<String>, boolean) - Method in class org.forgerock.openig.security.ServerTlsOptionsHeaplet
TlsOptions - Class in org.forgerock.openig.tools: Key TLS Options used by both the ClientTlsOptions and the ServerTlsOptions.
to(TimeUnit) - Method in class org.forgerock.util.time.Duration: Convert the current duration to a number of given TimeUnit.
toArray() - Method in class org.forgerock.http.util.SetDecorator
toArray() - Method in class org.forgerock.json.JsonPointer: Returns a newly allocated array of strings, containing the pointer's reference tokens.
toArray() - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
toArray() - Method in class org.forgerock.util.LazyList: Returns an array containing all of the elements in this list in proper sequence (from first to last element).
toArray() - Method in class org.forgerock.util.ListDecorator: Returns an array containing all of the elements in this list in proper sequence (from first to last element).
toArray(T[]) - Method in class org.forgerock.http.util.SetDecorator: Returns an array containing all of the elements in the set; the runtime type of the returned array is that of the specified array.
toArray(T[]) - Method in class org.forgerock.openig.session.jwt.dirty.DirtyCollection
toArray(T[]) - Method in class org.forgerock.util.LazyList: Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
toArray(T[]) - Method in class org.forgerock.util.ListDecorator: Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
toASCIIString() - Method in class org.forgerock.http.MutableUri: Returns the content of this URI as a US-ASCII string.
toBuilder() - Method in class org.forgerock.secrets.keys.CryptoKey: Converts the key back into a SecretBuilder, pre-initialized with the fields of this CryptoKey object.
toBytesUnsigned(BigInteger) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils: Returns the unsigned big-endian byte array of a big integer.
toCryptoKey(Purpose<T>, Instant) - Method in class org.forgerock.json.jose.jwk.JWK: Converts this JWK into a CryptoKey subclass object for use with the Secrets API.
toECPrivateKey() - Method in class org.forgerock.json.jose.jwk.EcJWK: Converts the JWK to a ECPrivateKey.
toECPublicKey() - Method in class org.forgerock.json.jose.jwk.EcJWK: Converts the JWK to a ECPublicKey.
toECPublicKey() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk: Converts the public claims in the JWK into a public key object.
toECPublicKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK
toEvent() - Method in class org.forgerock.audit.events.AuditEventBuilder: Generates the audit event.
toForm() - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns the form representation of this error suitable for inclusion in an authorization call-back query.
toFormString() - Method in class org.forgerock.http.protocol.Form: Returns this form in a form URL-encoded string.
toIndex(String) - Static method in class org.forgerock.json.JsonValue: Returns the key as an list index value.
toIntDate(Date) - Static method in class org.forgerock.json.jose.utils.IntDate: Converts a Java Date object into an IntDate.
toJavaDuration() - Method in class org.forgerock.util.time.Duration: Returns this duration as a Java Duration.
toJson() - Method in class org.forgerock.services.TransactionId: Returns a representation of this TransactionId as a JsonValue.
toJson(String) - Static method in class org.forgerock.openig.el.Functions: Parse/Un-marshal the input String into a JSON structure.
toJsonContent() - Method in class org.forgerock.http.oauth2.OAuth2Error: Returns the JSON representation of this error formatted as an access token error response.
toJsonString() - Method in class org.forgerock.json.jose.jwk.JWK: Prints the JWK Object as a json string.
toJsonString() - Method in class org.forgerock.json.jose.jwk.JWKSet: Prints the JWK Set as a json string.
toJsonValue() - Method in class org.forgerock.json.jose.jwk.EcJWK
toJsonValue() - Method in class org.forgerock.json.jose.jwk.JWK: Returns a json representation of the JWK.
toJsonValue() - Method in class org.forgerock.json.jose.jwk.OctJWK
toJsonValue() - Method in class org.forgerock.json.jose.jwk.OkpJWK
toJsonValue() - Method in class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo: Returns a json representation of the other factors.
toJsonValue() - Method in class org.forgerock.json.jose.jwk.RsaJWK
toJsonValue() - Method in class org.forgerock.json.jose.jwt.JWObject: Returns a json representation of the JWObject.
toJsonValue() - Method in interface org.forgerock.json.resource.ActionRequest
toJsonValue() - Method in interface org.forgerock.json.resource.CreateRequest
toJsonValue() - Method in interface org.forgerock.json.resource.DeleteRequest
toJsonValue() - Method in class org.forgerock.json.resource.PatchOperation: Returns a JSON value representation of this patch operation.
toJsonValue() - Method in interface org.forgerock.json.resource.PatchRequest
toJsonValue() - Method in interface org.forgerock.json.resource.QueryRequest
toJsonValue() - Method in interface org.forgerock.json.resource.ReadRequest
toJsonValue() - Method in interface org.forgerock.json.resource.Request: Return a JsonValue representation of this request.
toJsonValue() - Method in exception org.forgerock.json.resource.ResourceException: Returns the exception in a JSON object structure, suitable for inclusion in the entity of an HTTP error response.
toJsonValue() - Method in interface org.forgerock.json.resource.UpdateRequest
toJsonValue() - Method in class org.forgerock.services.context.AbstractContext
toJsonValue() - Method in interface org.forgerock.services.context.Context: Return this Context as a JsonValue (for persistence).
toJsonValue() - Method in class org.forgerock.services.context.RequestAuditContext
toJsonValue() - Method in class org.forgerock.services.context.TransactionIdContext: Updates the data object to have the current transactionId state.
toJsonValue(String) - Static method in class org.forgerock.json.jose.jwk.JWK: Converts a String into a JsonValue.
toJsonValue(String) - Static method in class org.forgerock.json.jose.jwk.JWKSet: Converts a json string to a jsonValue.
TOKEN_NAME - Static variable in class org.forgerock.openig.tools.JwtUtil: Claim-set token name key - not available in JwtClaimsSetKey.
TokenBucketThrottlingStrategy - Class in org.forgerock.openig.filter.throttling: The rate limiting is implemented as a token bucket strategy that gives us the ability to handle rate limits through a sliding window.
TokenBucketThrottlingStrategy(Ticker, ScheduledExecutorService, Duration) - Constructor for class org.forgerock.openig.filter.throttling.TokenBucketThrottlingStrategy: Constructs a new TokenBucketThrottlingStrategy.
TokenHandler - Interface in org.forgerock.tokenhandler: Responsible for the validation, generation and parsing of tokens used for keying a JsonValue representative of some state.
TokenHandlerException - Exception in org.forgerock.tokenhandler: An exception generated by a TokenHandler on either creation, validation, or state extraction.
TokenHandlerException(String) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException: Constructs a new exception with the specified detail message.
TokenHandlerException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException: Constructs a new exception with the specified detail message and cause.
TokenHandlerException(Throwable) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException: Constructs a new exception with the specified cause.
tokenHeader(String) - Method in class org.forgerock.http.filter.CsrfFilter.Builder: Sets the header to use to receive the anti-CSRF token.
TokenIntrospectionAccessTokenResolver - Class in org.forgerock.http.oauth2.resolver: An AccessTokenResolver which is RFC 7662 compliant.
TokenIntrospectionAccessTokenResolver(Handler, URI) - Constructor for class org.forgerock.http.oauth2.resolver.TokenIntrospectionAccessTokenResolver: Creates a new TokenIntrospectionAccessTokenResolver.
TokenIntrospectionAccessTokenResolverHeaplet - Class in org.forgerock.openig.filter.oauth2: Creates and initializes an TokenIntrospectionAccessTokenResolver in a heap environment.
TokenIntrospectionAccessTokenResolverHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.TokenIntrospectionAccessTokenResolverHeaplet
TokenIntrospectionAccessTokenResolverTypeDefinitionProvider - Class in org.forgerock.openig.filter.oauth2: Provide TokenIntrospectionAccessTokenResolverHeaplet's TypeDefinition.
TokenIntrospectionAccessTokenResolverTypeDefinitionProvider() - Constructor for class org.forgerock.openig.filter.oauth2.TokenIntrospectionAccessTokenResolverTypeDefinitionProvider
tokenized(PropertyResolver) - Static method in class org.forgerock.openig.util.JsonValues: Returns a function performing deep token substitution and object coercion ($ "functions").
tokenLifetimeInSeconds(long) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder: Specifies the maximum lifetime (in seconds) of the tokens produced by this token handler.
tokenLifetimeInSeconds(Optional<Long>) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder: Specifies the maximum lifetime (in seconds) of the tokens produced by this token handler.
TokenResolver - Class in org.forgerock.openig.heap: Offers a user-friendly API to the COMMONS config property resolvers.
TokenTransformationFilter - Class in org.forgerock.openig.openam: A TokenTransformationFilter is responsible for transforming a token issued by Access Management into a token of another type.
TokenTransformationFilter(Handler, URI, Expression<String>) - Constructor for class org.forgerock.openig.openam.TokenTransformationFilter: Constructs a new TokenTransformationFilter transforming the OpenID Connect id_token from idToken into a SAML 2.0 Assertions structure (into StsContext).
TokenTransformationFilter.Heaplet - Class in org.forgerock.openig.openam: Creates and initializes a token transformation filter in a heap environment.
toKeyPair() - Method in class org.forgerock.json.jose.jwk.EcJWK: Converts the JWK to a KeyPair.
toKeyPair() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk: Converts the JWK to a key pair.
toKeyPair() - Method in class org.forgerock.json.jose.jwk.OkpJWK: Converts the JWK to a key-pair.
toKeyPair() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Create a KeyPair using the JWK.
toLowerCase(String) - Static method in class org.forgerock.openig.el.Functions: Converts all of the characters in a string to lower case.
TOO_MANY_REQUESTS - Static variable in class org.forgerock.http.protocol.Status: The 429 status code indicates that the user has sent too many requests in a given amount of time ("rate limiting").
TopicManager - Class in org.forgerock.openig.tools.notifications.ws: TopicManager is responsible for topic registration multiplexing.
TopicManager(Supplier<String>) - Constructor for class org.forgerock.openig.tools.notifications.ws.TopicManager: TopicManager constructor taking an ID generator and message handler to handle notifications.
toPrivateKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK: Converts the JWK to a private key object.
toPromise() - Static method in class org.forgerock.openig.reactive.ReactiveUtils: Converts a Single to a promise.
toPublicJwk() - Method in class org.forgerock.json.jose.jwk.JWK: For asymmetric keys, get the public JWK representation of this JWK.
toPublicKey() - Method in class org.forgerock.json.jose.jwk.EcJWK
toPublicKey() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk: Converts the public claims in the JWK into a public key.
toPublicKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK
toQueryString() - Method in class org.forgerock.http.protocol.Form: Returns this form in a URL-encoded query string.
toRequestEntity(Request) - Method in class org.forgerock.http.protocol.Form: Populates a request with the necessary headers and entity for the form to be submitted as a POST with application/x-www-form-urlencoded content type.
toRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form: Sets a request URI with query parameters.
toRSAPrivateKey() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Creates a RSAPrivateKey from the JWK.
toRSAPublicKey() - Method in class org.forgerock.json.jose.jwk.RsaJWK: Creates a RSAPublicKey from the JWK.
toSecretKey() - Method in class org.forgerock.json.jose.jwk.OctJWK: Returns the key as a secret key.
toSIAbbreviation(TimeUnit) - Static method in class org.forgerock.openig.util.StringUtil: Return the SI abbreviation from the given TimeUnit name.
toString() - Method in class org.forgerock.audit.events.AuditEvent
toString() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
toString() - Method in class org.forgerock.http.filter.CsrfFilter.Builder
toString() - Method in class org.forgerock.http.header.authorization.BasicCredentials
toString() - Method in class org.forgerock.http.header.authorization.BearerToken
toString() - Method in class org.forgerock.http.header.Directive
toString() - Method in class org.forgerock.http.header.ForwardedHeader.Hop
toString() - Method in class org.forgerock.http.header.Warning: Formats a Warning header value, according to RFC 2616 14.46.
toString() - Method in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge
toString() - Method in class org.forgerock.http.MutableUri
toString() - Method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder
toString() - Method in class org.forgerock.http.oauth2.OAuth2Error
toString() - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder
toString() - Method in enum org.forgerock.http.protocol.Cookie.SameSite
toString() - Method in class org.forgerock.http.protocol.Cookie
toString() - Method in class org.forgerock.http.protocol.Entity: Returns a description of this entity content (not the content itself).
toString() - Method in class org.forgerock.http.protocol.Form: Deprecated.
use Form.toFormString() instead.
toString() - Method in class org.forgerock.http.protocol.Header
toString() - Method in class org.forgerock.http.protocol.RequestCookies
toString() - Method in class org.forgerock.http.protocol.Status
toString() - Method in class org.forgerock.http.routing.Version
toString() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Turns the EncryptionMethod constant into a JSON value string.
toString() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Turns the JweAlgorithm constant into a JSON value string.
toString() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithmType: Turns the JweAlgorithmType constant into a JSON value string.
toString() - Method in enum org.forgerock.json.jose.jwe.JweHeaderKey: Turns the JweHeaderKey constant into a lowercase String.
toString() - Method in enum org.forgerock.json.jose.jwk.KeyOperation: Prints the KeyOperation value.
toString() - Method in enum org.forgerock.json.jose.jwk.KeyType: Gets the value of the KeyType.
toString() - Method in class org.forgerock.json.jose.jwk.OkpJWK
toString() - Method in class org.forgerock.json.jose.jwk.store.JwksStore
toString() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Turns the JwsAlgorithm constant into a JSON value string.
toString() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithmType: Turns the JwsAlgorithmType constant into a JSON value string.
toString() - Method in enum org.forgerock.json.jose.jws.JwsHeaderKey: Turns the JwsHeaderKey constant into a lowercase String.
toString() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
toString() - Method in class org.forgerock.json.jose.jwt.JWObject: Returns a string representation of the JWObject.
toString() - Method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey: Turns the JwtClaimsSetKey constant into a lowercase String.
toString() - Method in enum org.forgerock.json.jose.jwt.JwtHeaderKey: Turns the JwtHeaderKey constant into a lowercase String.
toString() - Method in class org.forgerock.json.JsonPointer: Returns the JSON pointer string value.
toString() - Method in class org.forgerock.json.JsonValue: Returns a string representation of the JSON value.
toString() - Method in class org.forgerock.json.resource.AdviceWarning
toString() - Method in class org.forgerock.json.resource.FilterChain
toString() - Method in class org.forgerock.json.resource.PatchOperation
toString() - Method in class org.forgerock.json.resource.ResourcePath: Returns the URL path encoded string representation of this resource path.
toString() - Method in class org.forgerock.json.resource.Router.UriTemplate: Return the string representation of the UriTemplate.
toString() - Method in class org.forgerock.json.resource.SortKey: Returns the string representation of this sort key.
toString() - Method in class org.forgerock.openig.decoration.capture.KeyValueProcessor.Value
toString() - Method in class org.forgerock.openig.el.Bindings
toString() - Method in class org.forgerock.openig.el.Expression: Returns the original string used to create this expression, unmodified.
toString() - Method in class org.forgerock.openig.filter.throttling.ThrottlingRate
toString() - Method in class org.forgerock.openig.heap.Name: Returns the fully qualified name of this Name (format: (parent '+')* leaf).
toString() - Method in class org.forgerock.openig.regex.PatternTemplate: Returns the literal template value.
toString() - Method in class org.forgerock.openig.tools.am.Version
toString() - Method in class org.forgerock.openig.tools.notifications.Notification
toString() - Method in class org.forgerock.openig.util.InetAddressMask
toString() - Method in class org.forgerock.secrets.jwkset.JwkSetSecretStore
toString() - Method in class org.forgerock.secrets.keys.CryptoKey
toString() - Method in enum org.forgerock.secrets.keys.KeyUsage
toString() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
toString() - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore
toString() - Method in class org.forgerock.secrets.oauth2.GrantTypeHandler
toString() - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
toString() - Method in class org.forgerock.secrets.propertyresolver.SecretKeyPropertyFormat
toString() - Method in class org.forgerock.secrets.Purpose
toString() - Method in class org.forgerock.secrets.Secret
toString() - Method in class org.forgerock.secrets.ThreadPoolSecretStore
toString() - Method in class org.forgerock.services.context.AbstractContext
toString() - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
toString() - Method in class org.forgerock.services.routing.RouteMatcher: Returns a String representation of the route matcher.
toString() - Method in class org.forgerock.util.DirectoryWatcher.ChangeListener
toString() - Method in class org.forgerock.util.i18n.LocalizableString: The default toString method.
toString() - Method in class org.forgerock.util.Options
toString() - Method in class org.forgerock.util.Pair
toString() - Method in class org.forgerock.util.query.QueryFilter: Returns the string representation of this query filter.
toString() - Method in class org.forgerock.util.time.Duration
toString(Object) - Static method in class org.forgerock.openig.el.Functions: Returns the string value of an arbitrary object.
toString(Charset) - Method in class org.forgerock.http.header.authorization.BasicCredentials: Get the string credentials in the specified charset.
toTranslatedString(PreferredLocales) - Method in class org.forgerock.util.i18n.LocalizableString: Returns the contained string, translated if applicable.
toUpperCase(String) - Static method in class org.forgerock.openig.el.Functions: Converts all of the characters in a string to upper case.
toWarnings(List<String>) - Static method in class org.forgerock.http.header.WarningHeader: Matches warning-headers from a List of header-values.
toWWWAuthenticateHeader() - Method in class org.forgerock.http.oauth2.OAuth2Error: Deprecated.
Use OAuth2Error.asWwwAuthenticateHeader() instead.
toX509KeyUsageBits(Set<KeyUsage>) - Static method in enum org.forgerock.secrets.keys.KeyUsage: Converts a set of key usage values to an X.509 KeyUsage constraint bit string.
toXECKeyPair() - Method in class org.forgerock.json.jose.jwk.OkpJWK: Returns a KeyPair object containing the XECPrivateKey and XECPublicKey for this JWK.
toXECPublicKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK: Converts the JWK to a Java 11 XECPublicKey instance.
TRACKING_IDS - Static variable in class org.forgerock.audit.events.AuditEventBuilder: Tracking IDs event payload field name.
trackingId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Adds an entry to trackingIds for the event.
trackingIds(Set<String>) - Method in class org.forgerock.audit.events.AuditEventBuilder: Adds the specified entries to trackingIds for the event.
TrailerHeader - Class in org.forgerock.http.header: A Header representation of the Trailer HTTP response header.
TrailerHeader() - Constructor for class org.forgerock.http.header.TrailerHeader
TRANFORMATION_APPLIED - Static variable in class org.forgerock.http.header.WarningHeader: 214 Transformation applied MUST be added by an intermediate cache or proxy if it applies any transformation changing the content-coding (as specified in the Content-Encoding header) or media-type (as specified in the Content-Type header) of the response, or the entity-body of the response, unless this Warning code already appears in the response.
TRANFORMATION_APPLIED - Static variable in class org.forgerock.json.resource.AdviceWarning: 214 Transformation applied MUST be added by an intermediate cache or proxy if it applies any transformation changing the content-coding (as specified in the Content-Encoding header) or media-type (as specified in the Content-Type header) of the response, or the entity-body of the response, unless this Warning code already appears in the response.
TRANSACTION_ID - Static variable in class org.forgerock.audit.events.AuditEventBuilder: Transaction ID event payload field name.
TRANSACTION_ID_OUTBOUND_FILTER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve a TransactionIdOutboundFilter instance from the Heap.
transactionId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets the provided transactionId for the event.
TransactionId - Class in org.forgerock.services: TransactionId value should be unique per request coming from an external agent so that all events occurring in response to the same external stimulus can be tied together.
TransactionId() - Constructor for class org.forgerock.services.TransactionId: Construct a TransactionId with a random value.
TransactionId(String) - Constructor for class org.forgerock.services.TransactionId: Construct a TransactionId with the specified value.
TRANSACTIONID_OPTION - Static variable in class org.forgerock.openig.ldap.LdapClient: The option to pass the TransactionId to LdapConnection.
TransactionIdContext - Class in org.forgerock.services.context: This context aims to hold the TransactionId.
TransactionIdContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.TransactionIdContext: Restores a saved context.
TransactionIdContext(Context, TransactionId) - Constructor for class org.forgerock.services.context.TransactionIdContext: Constructs a new TransactionIdContext.
transactionIdFromContext(Context) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets transactionId from ID of TransactionIdContext, if the provided Context contains a TransactionIdContext.
TransactionIdHeader - Class in org.forgerock.http.header: Processes the transactionId header used mainly for audit purpose.
TransactionIdHeader(String) - Constructor for class org.forgerock.http.header.TransactionIdHeader: Constructs a new header with the provided value for the transaction id.
TransactionIdHeader(TransactionId) - Constructor for class org.forgerock.http.header.TransactionIdHeader: Constructs a new header with the provided transaction id object.
TransactionIdInboundFilter - Class in org.forgerock.http.filter: This filter is responsible to create the TransactionIdContext in the context's chain.
TransactionIdInboundFilter() - Constructor for class org.forgerock.http.filter.TransactionIdInboundFilter: Deprecated.
Replaced by TransactionIdInboundFilter(boolean)
TransactionIdInboundFilter(boolean) - Constructor for class org.forgerock.http.filter.TransactionIdInboundFilter: Constructor that defines whether or not HTTP request transaction ID headers should be trusted.
TransactionIdInboundFilter(BooleanSupplier) - Constructor for class org.forgerock.http.filter.TransactionIdInboundFilter: Constructor that defines whether or not HTTP request transaction ID headers should be trusted.
TransactionIdOutboundFilter - Class in org.forgerock.http.filter: This filter aims to create a sub-transaction's id and inserts that value as a header of the request.
TransactionIdOutboundFilter() - Constructor for class org.forgerock.http.filter.TransactionIdOutboundFilter
transform(String, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "transform" patch operation which sets the value at field based on a transformation.
transform(JsonPointer, Object) - Static method in class org.forgerock.json.resource.PatchOperation: Creates a new "transform" patch operation which sets the value at field based on a transformation.
transform(Context) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Optional Context-transformation function if the implementer has requirements to override the Context provided in the Connection's method invocations.
transformApi(D, ApiProducer<D>) - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
transformApi(D, ApiProducer<D>) - Method in class org.forgerock.services.routing.RouteMatcher: Transform the API Descriptor as appropriate for the parent router's view of the child routes.
TRANSLATION_KEY_PREFIX - Static variable in class org.forgerock.util.i18n.LocalizableString: A constant used to indicate a string should be translated.
TransportProtocol - Enum in org.forgerock.audit.handlers.syslog: Transport protocol over which Syslog messages should be published.
traverseList(JsonValue) - Method in class org.forgerock.json.JsonValueTraverseFunction: Transform a JsonValue List into another object.
traverseMap(JsonValue) - Method in class org.forgerock.json.JsonValueTraverseFunction: Transform a JsonValue Map into another object.
trim(String) - Static method in class org.forgerock.openig.el.Functions: Returns a copy of a string with leading and trailing whitespace omitted.
TRUE - Static variable in class org.forgerock.util.query.QueryFilterOperators: a literal "true".
TRUST_MANAGER_ALGORITHM - Static variable in class org.forgerock.secrets.SecretsTrustManager: Algorithm to use for looking up the underlying X509ExtendedTrustManager.
TrustAllManager - Class in org.forgerock.openig.security: Trust all certificates that this class is asked to check.
TrustAllManager() - Constructor for class org.forgerock.openig.security.TrustAllManager
TrustAllManager.Heaplet - Class in org.forgerock.openig.security: Creates and initializes a trust-all manager in a heap environment.
TrustManagerHeaplet - Class in org.forgerock.openig.security: Represents an SSL Java TrustManager.
TrustManagerHeaplet() - Constructor for class org.forgerock.openig.security.TrustManagerHeaplet
tryCancel(boolean) - Method in class org.forgerock.util.promise.PromiseImpl: Invoked when the client attempts to cancel the asynchronous task represented by this promise.
tryHandleException(E) - Method in class org.forgerock.util.promise.PromiseImpl: Attempts to signal that the asynchronous task represented by this promise has failed.
tryHandleResult(V) - Method in class org.forgerock.util.promise.PromiseImpl: Attempts to signal that the asynchronous task represented by this promise has succeeded.
typ(JwtType) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder: Sets the type of the contents of the Claims Set.
TYP - org.forgerock.json.jose.jwt.JwtClaimsSetKey: Type Claim.
TYP - org.forgerock.json.jose.jwt.JwtHeaderKey: Type JWT header parameter..
TypeDefinitions - Class in org.forgerock.openig.types: Type definitions helpers for generic types.

U

UDP - org.forgerock.audit.handlers.syslog.TransportProtocol: Publish Syslog messages over UDP.
uma(String) - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /uma namespace.
uma(String) - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /uma namespace.
UmaClassAliasResolver - Class in org.forgerock.openig.uma: Register all the aliases supported by the openig-uma module.
UmaClassAliasResolver() - Constructor for class org.forgerock.openig.uma.UmaClassAliasResolver
UmaException - Exception in org.forgerock.openig.uma: UMA Resource Server specific exception thrown when unrecoverable errors are happening.
UmaException(String) - Constructor for exception org.forgerock.openig.uma.UmaException: Creates a new UmaException with the given message.
UmaException(String, Throwable) - Constructor for exception org.forgerock.openig.uma.UmaException: Creates a new UmaException with the given message and the given cause.
UmaResourceServerFilter - Class in org.forgerock.openig.uma: An UmaResourceServerFilter implements a PEP (Policy Enforcement Point) and is responsible to ensure the incoming requests (from requesting parties) all have a valid RPT (Request Party Token) with the required set of scopes.
UmaResourceServerFilter(UmaSharingService, Handler, String) - Constructor for class org.forgerock.openig.uma.UmaResourceServerFilter: Constructs a new UmaResourceServerFilter.
UmaResourceServerFilter.Heaplet - Class in org.forgerock.openig.uma: Creates and initializes an UMA resource server filter in a heap environment.
UmaSharingService - Class in org.forgerock.openig.uma: An UmaSharingService provides core UMA features to the Identity Gateway when acting as an UMA Resource Server.
UmaSharingService.Heaplet - Class in org.forgerock.openig.uma: Creates and initializes an UMA service in a heap environment.
umaUri(String) - Method in class org.forgerock.openig.tools.am.AmService: Build the endpoint URI for an endpoint located in the /uma namespace.
umaUri(String) - Method in class org.forgerock.openig.tools.am.UriService: Build the endpoint URI for an endpoint located in the /uma namespace.
UNAUTHORIZED - Static variable in class org.forgerock.http.protocol.Status: The request requires user authentication.
UNAUTHORIZED - Static variable in class org.forgerock.openig.handler.Handlers: A default Handler implementation that returns an empty (401 Unauthorized) Response.
UNAVAILABLE - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource is temporarily unable to handle the request.
UncategorizedException - Exception in org.forgerock.json.resource: An exception that indicates that a failure is not directly known to the system, and hence requires out-of-band knowledge or enhancements to determine if a failure should be categorized as temporary or permanent.
UncategorizedException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.UncategorizedException: Constructs a new exception with the specified detail message and cause.
uncloseable(Connection) - Static method in class org.forgerock.json.resource.Resources: Returns an uncloseable view of the provided connection.
uncloseable(ConnectionFactory) - Static method in class org.forgerock.json.resource.Resources: Returns an uncloseable view of the provided connection factory.
undeploy(String) - Method in class org.forgerock.openig.handler.router.RouterHandler: Undeploy a route, meaning that it unloads it but also deletes the associated file.
UNKNOWN - org.forgerock.http.protocol.Status.Family: This class of status code is for all status code above 600, that are not classified in the specification.
UNKNOWN - Static variable in interface org.forgerock.openig.filter.oauth2.cnf.ConfirmationKeyVerifier: Verifier that always fail because verification method is not supported.
unless(boolean) - Static method in class org.forgerock.util.Reject: Throws an IllegalArgumentException if the condition parameter is false.
unless(boolean, String) - Static method in class org.forgerock.util.Reject: Throws an IllegalArgumentException with a custom message if the condition parameter is false.
UNLIMITED - Static variable in class org.forgerock.util.time.Duration: Special duration that represents an unlimited duration (or indefinite).
UNLIMITED_HISTORY_FILES - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: The value of number of history files to use when the value is unlimited.
UnmodifiableCollection - Interface in org.forgerock.http.util: An marker interface for tagging collection implementations as read-only.
unmodifiableCopyOf(Options) - Static method in class org.forgerock.util.Options: Returns an unmodifiable copy of the provided set of options.
unmodifiableDefaultOptions() - Static method in class org.forgerock.util.Options: Returns an unmodifiable set of options with default settings.
unquote(String) - Static method in class org.forgerock.http.header.HeaderUtil: Unquotes a string following the logic of HeaderUtil.quote(String).
UnrecognizedCriticalHeaderException - Exception in org.forgerock.json.jose.exceptions: Indicates that the JWT had critical headers that were not recognized by the JWT library and not implemented by the application.
UnrecognizedCriticalHeaderException(Collection<String>) - Constructor for exception org.forgerock.json.jose.exceptions.UnrecognizedCriticalHeaderException: Initializes the exception with the given list of unrecognized critical headers that caused processing to fail.
unregister() - Method in class org.forgerock.openig.http.EndpointRegistry.Registration: Un-register the endpoint.
unregister() - Method in interface org.forgerock.openig.tools.notifications.NotificationService.Registration: Un-register the connection event listener.
unregisterFactory(String) - Method in class org.forgerock.openig.script.DefaultScriptFactoryManager: Un-registers the factory for the given mimeType.
UNRESOLVED - Static variable in interface org.forgerock.openig.resolver.Resolver: Singleton that is returned to indicate an element is not resolved by a resolver.
UnsignedJwtFactory - Class in org.forgerock.openig.tools.jwt.factory: Deprecated.
Since 7.0 There is no replacement, as this feature is considered insecure.
UnsignedJwtFactory() - Constructor for class org.forgerock.openig.tools.jwt.factory.UnsignedJwtFactory: Deprecated.
unsubscribe() - Method in interface org.forgerock.openig.tools.notifications.Subscription: Un-subscribes from the topic asynchronously.
UNSUPPORTED_MEDIA_TYPE - Static variable in class org.forgerock.http.protocol.Status: The 415 (Unsupported Media Type) status code indicates that the origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.
UNSUPPORTED_MEDIA_TYPE - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the media type of the request body was not acceptable to the server.
UnsupportedMediaTypeException - Exception in org.forgerock.json.resource: Indicates a 415 Unsupported Media Type response that the Content-Type of the request was not acceptable.
UnsupportedMediaTypeException(String) - Constructor for exception org.forgerock.json.resource.UnsupportedMediaTypeException: Constructs the exception with a status code of 415 and the given message.
until(Temporal, Clock) - Static method in class org.forgerock.json.resource.ResponseCacheControl: Returns a cache control that will allow caching until the given deadline according to the given clock.
UNUSED - Static variable in class org.forgerock.http.protocol.Status: The 306 status code was defined in a previous version of this specification, is no longer used, and the code is reserved.
unwrap(JsonValue, String) - Static method in class org.forgerock.openig.tools.userprofile.UserProfile: Utility method to unwrap a profile attribute that is wrapped in a JSON array.
UNWRAP_KEY - org.forgerock.json.jose.jwk.KeyOperation: Use Key to decrypt key and validate decryption, if applicable.
UNWRAP_KEY - org.forgerock.secrets.keys.KeyUsage: Key is intended for decrypting (unwrapping) other keys.
update(String, String, JsonValue) - Method in class org.forgerock.openig.handler.router.RouterHandler: Update a route.
update(String, String, JsonValue) - Method in class org.forgerock.openig.ui.record.RecordService: Update the Record identified by id (possibly at a given revision) with the provided content.
update(Context, UpdateRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
update(Context, UpdateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Updates a JSON resource by replacing its existing content with new content.
update(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.Connection: Updates a JSON resource by replacing its existing content with new content.
UPDATE - org.forgerock.json.resource.RequestType: An update request.
updateAsync(Context, UpdateRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper: Asynchronously updates a JSON resource by replacing its existing content with new content.
updateAsync(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.Connection: Asynchronously updates a JSON resource by replacing its existing content with new content.
updateInstance(Context, String, UpdateRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider: Updates an existing resource within the collection.
updateInstance(Context, String, UpdateRequest) - Method in class org.forgerock.json.resource.MemoryBackend: Updates an existing resource within the collection.
updateInstance(Context, String, UpdateRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
updateInstance(Context, UpdateRequest) - Method in interface org.forgerock.json.resource.SingletonResourceProvider: Updates the single resource instance.
updateInstance(Context, UpdateRequest) - Method in class org.forgerock.openig.http.ServerInfoSingletonProvider
UpdateRequest - Interface in org.forgerock.json.resource: A request to update a JSON resource by replacing its existing content with new content.
updateSession(OAuth2Session) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext: Replace the existing managed session (if any) with the provided one (can be null).
UPGRADE_HEADER_NAME - Static variable in class org.forgerock.openig.websocket.WebSocketUtils: HTTP WebSocket header name used to determine if a request represents a WebSocket upgrade.
UPGRADE_HEADER_VALUE - Static variable in class org.forgerock.openig.websocket.WebSocketUtils: Value for header name "Upgrade", indicating that the request represents a WebSocket.
UPGRADE_REQUIRED - Static variable in class org.forgerock.http.protocol.Status: The 426 (Upgrade Required) status code indicates that the server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
uri() - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON string value as a uniform resource identifier.
uri(String) - Static method in class org.forgerock.http.MutableUri: Factory method for avoiding typing new MutableUri("http://...").
URI_TOO_LONG - Static variable in class org.forgerock.http.protocol.Status: The 414 (URI Too Long) status code indicates that the server is refusing to service the request because the request-target (Section 5.3 of [RFC7230]) is longer than the server is willing to interpret.
URI_TYPE - Static variable in class org.forgerock.openig.types.TypeDefinitions: Represents the "URI" type, which is a String with a specific Syntax.
uriMatcher(RoutingMode, String) - Static method in class org.forgerock.http.routing.RouteMatchers: Creates a RouteMatcher instance that matches ResourcePaths with the provided mode and template.
uriMatcher(RoutingMode, String) - Method in class org.forgerock.http.routing.Router
uriMatcher(RoutingMode, String) - Method in class org.forgerock.json.resource.Router
uriMatcher(RoutingMode, String) - Method in class org.forgerock.services.routing.AbstractRouter: Create a URI matcher suitable for the request type <R>.
UriPathRewriteFilter - Class in org.forgerock.openig.filter: Filter supporting URL path rewriting.
UriPathRewriteFilter.Heaplet - Class in org.forgerock.openig.filter: Create a UriPathRewriteFilter in a heap environment.
uriRouterContext(Context) - Static method in class org.forgerock.http.routing.UriRouterContext: Return a builder for a new UriRouterContext.
UriRouterContext - Class in org.forgerock.http.routing: A Context which is created when a request has been routed.
UriRouterContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.routing.UriRouterContext: Restore from JSON representation.
UriRouterContext(Context, String, String, Map<String, String>) - Constructor for class org.forgerock.http.routing.UriRouterContext: Creates a new routing context having the provided parent, URI template variables, and an ID automatically generated using UUID.randomUUID().
UriRouterContext(Context, String, String, Map<String, String>, URI) - Constructor for class org.forgerock.http.routing.UriRouterContext: Creates a new routing context having the provided parent, URI template variables, and an ID automatically generated using UUID.randomUUID().
UriRouterContext.Builder - Class in org.forgerock.http.routing: Ease UriRouterContext construction.
Uris - Class in org.forgerock.http.util: Utility class for performing operations on universal resource identifiers.
uriService(Realm) - Method in class org.forgerock.openig.tools.am.AmService: Provides an UriService instance that creates URI for the given realm.
UriService - Class in org.forgerock.openig.tools.am: Computes AM endpoint URIs, based on path normalizer, realm and a base Uri.
UriService(RealmNormalizer, Realm, URI) - Constructor for class org.forgerock.openig.tools.am.UriService: Constructs a new URI service.
uriTemplate(String) - Static method in class org.forgerock.json.resource.Router: Creates a Router.UriTemplate from a URI template string that will be used to match and route incoming requests.
UriUtils - Class in org.forgerock.openig.websocket: URI convenience methods.
url() - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON string value as a uniform resource locator.
urlDecode(Object) - Static method in class org.forgerock.http.util.Paths: Returns the URL path decoding of the provided object's string representation.
urlDecode(String) - Static method in class org.forgerock.openig.el.Functions: Returns the URL decoding of the provided string.
urlDecodeFragment(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded fragment as per RFC 3986.
urlDecodePathElement(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded path element as per RFC 3986.
urlDecodeQueryParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded query parameter name or value as per RFC 3986.
urlDecodeUserInfo(String) - Static method in class org.forgerock.http.util.Uris: Decodes the provided URL encoded userInfo as per RFC 3986.
urlEncode(Object) - Static method in class org.forgerock.http.util.Paths: Returns the URL path encoding of the provided object's string representation.
urlEncode(String) - Static method in class org.forgerock.openig.el.Functions: Returns the URL encoding of the provided string.
urlEncodeFragment(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided fragment as per RFC 3986.
urlEncodePathElement(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided path element as per RFC 3986.
urlEncodeQueryParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided query parameter name or value as per RFC 3986.
urlEncodeUserInfo(String) - Static method in class org.forgerock.http.util.Uris: URL encodes the provided userInfo as per RFC 3986.
use - Variable in class org.forgerock.json.jose.jwk.JWK.Builder: The key use, optional.
USE_PROXY - Static variable in class org.forgerock.http.protocol.Status: The 305 (Use Proxy) status code was defined in a previous version of this specification and is now deprecated (Appendix B).
USE_WRAP_UNWRAP_OPERATIONS - Static variable in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler: Indicates whether the handler should use Cipher.wrap(Key) and Cipher.unwrap(byte[], String, int) operations or normal encrypt/decrypt operations for encrypting the per-message symmetric AES key.
USER - org.forgerock.audit.handlers.syslog.Facility: User-level messages.
USER_ID - Static variable in class org.forgerock.audit.events.AuditEventBuilder: User ID event payload field name.
userAgent(String) - Method in class org.forgerock.services.context.ClientContext.Builder: Sets the client's user agent.
userId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets the provided userId for the event.
UserProfile - Class in org.forgerock.openig.tools.userprofile: Class containing user profile information.
UserProfile(JsonValue) - Constructor for class org.forgerock.openig.tools.userprofile.UserProfile: Constructor taking the raw JsonValue.
UserProfileContext - Class in org.forgerock.openig.openam: Used by the UserProfileFilter to make the user's profile attributes available in the context.
UserProfileException - Exception in org.forgerock.openig.tools.userprofile: Represents an exception thrown whilst performing UserProfileService operations.
UserProfileException(String) - Constructor for exception org.forgerock.openig.tools.userprofile.UserProfileException: Builds an UserProfileException with a given message.
UserProfileException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.userprofile.UserProfileException: Builds an UserProfileException with a given message and cause.
UserProfileFilter - Class in org.forgerock.openig.openam: This filter requests user profile attributes from Access Management and stores them in the context for later use.
UserProfileFilterHeaplet - Class in org.forgerock.openig.openam: Creates and initialises a user profile filter in a heap environment.
UserProfileFilterHeaplet() - Constructor for class org.forgerock.openig.openam.UserProfileFilterHeaplet
UserProfileService - Interface in org.forgerock.openig.tools.userprofile: The UserProfileService is responsible for requesting user profile attributes.
UserProfileServiceHeaplet - Class in org.forgerock.openig.openam: Creates and initializes a UserProfileService in a heap environment.
UserProfileServiceHeaplet() - Constructor for class org.forgerock.openig.openam.UserProfileServiceHeaplet
useSpecificSecretForPurpose(Purpose<S>, S) - Method in class org.forgerock.openig.secrets.DefaultSecretsService: Deprecated.
useSpecificSecretForPurpose(Purpose<S>, S) - Method in interface org.forgerock.openig.secrets.SecretsService: Configures this SecretsProvider to always return the specific given secret for the given purpose.
useSpecificSecretForPurpose(Purpose<S>, S) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
useSpecificSecretForPurpose(Purpose<S>, S) - Method in class org.forgerock.secrets.SecretsProvider: Configures this SecretsProvider to always return the specific given secret for the given purpose.
USING_KEY_OPS - org.forgerock.secrets.jwkset.JwkKeyFormat: A JWK format that only includes the key_ops parameter to express the key's usage.
USING_USE - org.forgerock.secrets.jwkset.JwkKeyFormat: A JWK format that only includes the use parameter to express the key's usage.
USING_USE_AND_KEY_OPS - org.forgerock.secrets.jwkset.JwkKeyFormat: A JWK format that includes both the use and key_ops parameters to express the key's usage.
Utils - Class in org.forgerock.json.jose.utils: This class provides utility methods to share common behaviour.
Utils - Class in org.forgerock.openig.tools: Utility class.
Utils - Class in org.forgerock.util: Deprecated.
Use Strings, Closeables, Objects or Threads instead.
UUCP - org.forgerock.audit.handlers.syslog.Facility: UUCP subsystem.
uuid() - Static method in class org.forgerock.json.JsonValueFunctions: Returns the JSON string value as a universally unique identifier (UUID).

V

v(int) - Static method in class org.forgerock.openig.tools.am.Version: Builds a version from its components (minor set to 0, micro set to 0, no qualifier).
v(int, int) - Static method in class org.forgerock.openig.tools.am.Version: Builds a version from its components (micro set to 0, no qualifier).
v(int, int, int) - Static method in class org.forgerock.openig.tools.am.Version: Builds a version from its components.
validate() - Method in class org.forgerock.audit.events.AuditEventBuilder: Called by AuditEventBuilder.toEvent() to ensure that the audit event will be created in a valid state.
validate(String) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler: Deprecated.
validate(String) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler
validate(String) - Method in interface org.forgerock.tokenhandler.TokenHandler: Validates the passed token.
validate(PublicKey) - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Validates that the given public key is on this curve.
validateAlgorithm(JwsAlgorithm) - Method in class org.forgerock.json.jose.jws.handlers.SecretSigningHandler: Validate the type of the provided algorithm.
validateAndExtractState(String) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler: Deprecated.
validateAndExtractState(String) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler
validateAndExtractState(String) - Method in interface org.forgerock.tokenhandler.TokenHandler: Validates and parses the token, extracting any encapsulated state.
validateStringOrURI(String) - Static method in class org.forgerock.json.jose.utils.StringOrURI: Validates that the given String is either an arbitrary string without any ":" characters, otherwise validates that the String is a valid URI.
ValidatorConstraintContext - Class in org.forgerock.openig.tools.jwt.validation: The validation context that will be passed among the different JWT constraints validations.
value() - Method in annotation type org.forgerock.audit.Audit: The name of the dependency to inject.
value() - Method in enum org.forgerock.json.jose.jwe.JweHeaderKey: Returns a lowercase String of the JweHeaderKey constant.
value() - Method in enum org.forgerock.json.jose.jwk.KeyType: Get the value of the KeyType.
value() - Method in enum org.forgerock.json.jose.jws.JwsHeaderKey: Returns a lowercase String of the JwsHeaderKey constant.
value() - Method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey: Returns a lowercase String of the JwtClaimsSetKey constant.
value() - Method in enum org.forgerock.json.jose.jwt.JwtHeaderKey: Returns a lowercase String of the JwtHeaderKey constant.
VALUE_PTR - Static variable in class org.forgerock.json.JsonPatch: Path to the "value" attribute of a patch entry.
valueExpression - Variable in class org.forgerock.openig.el.Expression: The underlying EL expression that this object represents.
valueOf(int) - Static method in enum org.forgerock.http.protocol.Status.Family: Find the class of the given status code.
valueOf(int) - Static method in class org.forgerock.http.protocol.Status: Get a Status from the given integer.
valueOf(int, String) - Static method in class org.forgerock.http.protocol.Status: Get a Status from the given integer.
valueOf(Class<T>, Object) - Static method in class org.forgerock.openig.util.EnumUtil: Returns the enum constant of the specified enum type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.handlers.jms.SessionModeConfig: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.handlers.syslog.Facility: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.handlers.syslog.Severity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.handlers.syslog.TransportProtocol: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.http.handler.HttpClientHandler.HostnameVerifier: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.http.header.AcceptApiVersionHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.AuthorizationHeader: Parse a string as an Authorization header value.
valueOf(String) - Static method in class org.forgerock.http.header.ConnectionHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ContentApiVersionHeader: Constructs a new header, initialized from the specified string.
valueOf(String) - Static method in class org.forgerock.http.header.ContentEncodingHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ContentLengthHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ContentTypeHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.CookieHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.LocationHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.ReferrerHeader: Parse the provided value as a Referrer header.
valueOf(String) - Static method in class org.forgerock.http.header.SetCookie2Header: Deprecated.

Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.SetCookieHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.TransactionIdHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.header.Warning: Parses a warning-header value (part after Warning:).
valueOf(String) - Static method in class org.forgerock.http.header.WarningHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in class org.forgerock.http.oauth2.OAuth2Error: Parses the provided OAuth2Error.toString() representation as an OAuth 2.0 error.
valueOf(String) - Static method in enum org.forgerock.http.protocol.Cookie.SameSite: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.http.protocol.Status.Family: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.http.routing.DefaultVersionBehaviour: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.http.routing.RoutingMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithmType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.JweHeaderKey: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwk.KeyOperation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwk.KeyType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithmType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jws.JwsHeaderKey: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwt.JwtHeaderKey: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.jose.jwt.JwtType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.resource.CountPolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.json.resource.RequestType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.json.resource.ResourcePath: Parses the provided string representation of a resource path.
valueOf(String) - Static method in class org.forgerock.json.resource.SortKey: Parses the provided string as a sort key.
valueOf(String) - Static method in enum org.forgerock.json.resource.SortKeyComparator.NullPosition: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.decoration.capture.CapturePoint: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.filter.CookieFilter.Action: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.filter.CryptoHeaderFilter.Operation: Deprecated.

Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader: Constructs a new header, initialized from the specified string value.
valueOf(String) - Static method in enum org.forgerock.openig.http.RunMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.text.Separators: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.tools.notifications.ConnectionEvent: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.tools.notifications.DisconnectionStrategy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.tools.ServerTlsOptions.ClientAuthentication: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.util.MessageType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.jwkset.JwkKeyFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.keys.KeyFormatRaw: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.keys.KeyType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.keys.KeyUsage: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.propertyresolver.PropertyFormatBase64: Returns the enum constant of this type with the specified name.
valueOf(String) - Method in class org.forgerock.util.EnumValueOfHelper: Fast lookup of EnumValueOfHelper by its name.
valueOf(String) - Method in class org.forgerock.util.query.QueryFilterParser: Parses the provided string representation of a query filter as a QueryFilter.
valueOf(String) - Static method in enum org.forgerock.util.thread.listener.ShutdownPriority: Returns the enum constant of this type with the specified name.
valueOf(String...) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Create a header from a list of preferred Locale language tags.
valueOf(String, Class<T>) - Static method in class org.forgerock.openig.el.Expression: Factory method to create an Expression.
valueOf(String, Class<T>) - Static method in class org.forgerock.openig.el.LeftValueExpression: Factory method to create a LeftValueExpression.
valueOf(String, Class<T>, Bindings) - Static method in class org.forgerock.openig.el.Expression: Factory method to create an Expression.
valueOf(List<String>) - Static method in class org.forgerock.http.header.SetCookie2Header: Deprecated.

Constructs a new header, initialized from the specified list of Set-Cookie2 values.
valueOf(List<String>) - Static method in class org.forgerock.http.header.SetCookieHeader: Constructs a new header, initialized from the specified list of Set-Cookie values.
valueOf(List<String>) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader: Obtain a WwwAuthenticateHeader representation of the given header values.
valueOf(List<Locale>) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Create a header from a list of preferred Locale instances.
valueOf(Set<String>) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Create a header from a list of header values.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.AcceptApiVersionHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.AuthorizationHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.ConnectionHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.ContentApiVersionHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.ContentEncodingHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.ContentLengthHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.ContentTypeHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.LocationHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.ReferrerHeader: Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.WarningHeader: Constructs a new header, initialized from the specified message.
valueOf(Request) - Static method in class org.forgerock.http.header.CookieHeader: Constructs a new header, initialized from the specified request message.
valueOf(Request) - Static method in class org.forgerock.http.header.TransactionIdHeader: Constructs a new header, initialized from the specified request.
valueOf(Response) - Static method in class org.forgerock.http.header.SetCookie2Header: Deprecated.

Constructs a new header, initialized from the specified response message.
valueOf(Response) - Static method in class org.forgerock.http.header.SetCookieHeader: Constructs a new header, initialized from the specified response message.
valueOf(Response) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader: Obtain a WwwAuthenticateHeader representation of the headers in the given response.
valueOf(Response) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader: Constructs a new header, initialized from the specified message.
valueOf(JsonValue) - Static method in class org.forgerock.json.resource.PatchOperation: Parses the provided JSON content as a patch operation.
valueOf(JsonValue) - Static method in class org.forgerock.services.TransactionId: Creates a TransactionId from a JsonValue.
valueOf(PreferredLocales) - Static method in class org.forgerock.http.header.AcceptLanguageHeader: Creates an accept language header representation for a PreferredLocales instance.
valueOfForm(Form) - Static method in class org.forgerock.http.oauth2.OAuth2Error: Parses the Form representation of an authorization call-back error as an OAuth 2.0 error.
valueOfJsonContent(Map<String, Object>) - Static method in class org.forgerock.http.oauth2.OAuth2Error: Parses the JSON representation of an access token error response as an OAuth 2.0 error.
valueOfList(JsonValue) - Static method in class org.forgerock.json.resource.PatchOperation: Parses the provided JSON content as a list of patch operations.
valueOfWWWAuthenticateHeader(String) - Static method in class org.forgerock.http.oauth2.OAuth2Error: Parses the provided WWW-Authenticate header content as an OAuth 2.0 error.
values() - Static method in enum org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.handlers.jms.DeliveryModeConfig: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.handlers.jms.SessionModeConfig: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.handlers.syslog.Facility: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.handlers.syslog.Severity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.handlers.syslog.TransportProtocol: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.handler.HttpClientHandler.HostnameVerifier: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.protocol.Cookie.SameSite: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.forgerock.http.protocol.Headers
values() - Method in class org.forgerock.http.protocol.RequestCookies
values() - Static method in enum org.forgerock.http.protocol.Status.Family: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.routing.DefaultVersionBehaviour: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.routing.RoutingMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithmType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.JweHeaderKey: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwk.KeyOperation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwk.KeyType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithmType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jws.JwsHeaderKey: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwt.JwtHeaderKey: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwt.JwtType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.resource.CountPolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.resource.RequestType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.resource.SortKeyComparator.NullPosition: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.decoration.capture.CapturePoint: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.filter.CookieFilter.Action: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.filter.CryptoHeaderFilter.Operation: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.http.RunMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.text.Separators: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.tools.notifications.ConnectionEvent: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.tools.notifications.DisconnectionStrategy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.tools.ServerTlsOptions.ClientAuthentication: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.util.MessageType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.jwkset.JwkKeyFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.keys.KeyFormatRaw: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.keys.KeyType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.keys.KeyUsage: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.propertyresolver.PropertyFormatBase64: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.forgerock.util.LazyMap: Returns a Collection view of the values contained in the map.
values() - Method in class org.forgerock.util.MapDecorator: Returns a Collection view of the values contained in the map.
values() - Static method in enum org.forgerock.util.thread.listener.ShutdownPriority: Returns an array containing the constants of this enum type, in the order they are declared.
Values - Class in org.forgerock.openig.types: Utility methods to create Value instances related to IG.
valueWasQuoted() - Method in class org.forgerock.http.protocol.Cookie: Returns true if the cookie value was enclosed in "" when it was parsed, false otherwise.
VerificationKey - Class in org.forgerock.secrets.keys: A key used for verifying digital signatures.
VerificationKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.VerificationKey: Initialises the key with the given secret data.
verificationPurpose(Purpose<VerificationKey>) - Method in class org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder: Specifies the Purpose used to retrieve verification keys from the secrets provider.
verify(byte[], byte[]) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
verify(byte[], byte[]) - Method in interface org.forgerock.audit.secure.SecureStorage: Verifies that signed data corresponds to signature.
verify(X509Certificate, String, String, byte[]) - Method in class org.forgerock.util.SignatureUtil: Verifies a signature of a String using the certificate.
verify(PublicKey, String, String, byte[]) - Method in class org.forgerock.util.SignatureUtil: Verifies a signature of a String using the public key.
verify(SigningHandler) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt: Verifies that the signature is valid on the nested signed JWT.
verify(SigningHandler) - Method in class org.forgerock.json.jose.jws.SignedJwt: Verifies that the JWS signature is valid for the contents of its payload.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler: Deprecated.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler: Deprecated.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler: Deprecated.

Verifies that the given signature is valid for the given data.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.NOPSigningHandler: Deprecated.

Verifies that the signature length is zero.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler: Deprecated.

Verifies that the given signature is valid for the given data.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.SecretECDSASigningHandler
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.SecretSigningHandler
verify(JwsAlgorithm, byte[], byte[]) - Method in interface org.forgerock.json.jose.jws.handlers.SigningHandler: Verifies that the given signature is valid for the given data.
verify(Context, AccessTokenInfo, JsonValue) - Method in class org.forgerock.openig.filter.oauth2.cnf.ClientContextCertificateThumbprintVerifier
verify(Context, AccessTokenInfo, JsonValue) - Method in interface org.forgerock.openig.filter.oauth2.cnf.ConfirmationKeyVerifier: Verifies the given confirmation key value.
verify(Context, AccessTokenInfo, JsonValue) - Method in class org.forgerock.openig.filter.oauth2.cnf.Sha256AttributeCertificateThumbprintVerifier
VERIFY - org.forgerock.json.jose.jwk.KeyOperation: Use Key to verify digital signature or MAC.
VERIFY - org.forgerock.secrets.keys.KeyUsage: Key is intended for verifying signatures on messages.
VERIFY - Static variable in class org.forgerock.secrets.Purpose: Indicates a key intended for verifying digital signatures or message authentication codes.
VERIFY_CERTIFICATE - org.forgerock.secrets.keys.KeyUsage: Key is intended for verifying certificate signatures.
VERIFY_CERTIFICATE - Static variable in class org.forgerock.secrets.Purpose: Indicates a key intended for verifying certificate signatures.
version(int) - Static method in class org.forgerock.http.routing.Version: Creates a new version using the provided version information and a minor.
version(int, int) - Static method in class org.forgerock.http.routing.Version: Creates a new version using the provided version information.
version(String) - Static method in class org.forgerock.http.routing.Version: Parses the string argument as a version.
Version - Class in org.forgerock.http.routing: Represents some version in the form majorNumber.minorNumber, for instance 2.4.
Version - Class in org.forgerock.openig.tools.am: Supports version with the following format: major[.minor[.micro]].
Version(int, int, int) - Constructor for class org.forgerock.openig.tools.am.Version: Constructs a new Version from its given components.
VERSION_MISMATCH - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource's current version does not match the version provided.
VERSION_REQUIRED - Static variable in exception org.forgerock.json.resource.ResourceException: Indicates that the resource requires a version, but no version was supplied in the request.
Violation - Class in org.forgerock.openig.tools.jwt.validation: Describe a Violation, used for the JWT validation.
Violation(String) - Constructor for class org.forgerock.openig.tools.jwt.validation.Violation: Creates a new Violation.
VisibleForTesting - Annotation Type in org.forgerock.util.annotations: This annotation doesn't actually do anything, other than provide documentation of the fact that a function has either been marked public, or package private in order for a test (somewhere physically distant in the system) to compile.
visitActionRequest(P, ActionRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits an action request.
visitAndFilter(Void, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits an and filter.
visitAndFilter(JsonValue, List<QueryFilter<JsonPointer>>) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitAndFilter(P, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitAndFilter(P, List<QueryFilter<F>>) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits an and filter.
visitAnyFilter(P) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitBooleanLiteralFilter(Void, boolean) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a boolean literal filter.
visitBooleanLiteralFilter(JsonValue, boolean) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitBooleanLiteralFilter(P, boolean) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitBooleanLiteralFilter(P, boolean) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a boolean literal filter.
visitComplexFilter(Void, F, QueryFilter<F>) - Method in class org.forgerock.util.query.MapFilterVisitor
visitComplexFilter(JsonValue, JsonPointer, QueryFilter<JsonPointer>) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitComplexFilter(P, F, QueryFilter<F>) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a complex filter.
visitContainsFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a contains filter.
visitContainsFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitContainsFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitContainsFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a contains filter.
visitCreateRequest(P, CreateRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a create request.
visitDeleteRequest(P, DeleteRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a delete request.
visitEqualsFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a equality filter.
visitEqualsFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitEqualsFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitEqualsFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a equality filter.
visitExtendedMatchFilter(Void, F, String, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a comparison filter.
visitExtendedMatchFilter(JsonValue, JsonPointer, String, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitExtendedMatchFilter(P, F, String, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitExtendedMatchFilter(P, F, String, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a comparison filter.
visitGreaterThanFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a greater than filter.
visitGreaterThanFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitGreaterThanFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitGreaterThanFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a greater than filter.
visitGreaterThanOrEqualToFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a greater than or equal to filter.
visitGreaterThanOrEqualToFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitGreaterThanOrEqualToFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitGreaterThanOrEqualToFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a greater than or equal to filter.
visitLessThanFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a less than filter.
visitLessThanFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitLessThanFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitLessThanFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a less than filter.
visitLessThanOrEqualToFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a less than or equal to filter.
visitLessThanOrEqualToFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitLessThanOrEqualToFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitLessThanOrEqualToFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a less than or equal to filter.
visitNotFilter(Void, QueryFilter<F>) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a not filter.
visitNotFilter(JsonValue, QueryFilter<JsonPointer>) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitNotFilter(P, QueryFilter<F>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitNotFilter(P, QueryFilter<F>) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a not filter.
visitOrFilter(Void, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits an or filter.
visitOrFilter(JsonValue, List<QueryFilter<JsonPointer>>) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitOrFilter(P, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitOrFilter(P, List<QueryFilter<F>>) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits an or filter.
visitPatchRequest(P, PatchRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a patch request.
visitPresentFilter(Void, F) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a present filter.
visitPresentFilter(JsonValue, JsonPointer) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitPresentFilter(P, F) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitPresentFilter(P, F) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a present filter.
visitQueryRequest(P, QueryRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a query request.
visitReadRequest(P, ReadRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits a read request.
visitStartsWithFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor: Visits a starts with filter.
visitStartsWithFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
visitStartsWithFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
visitStartsWithFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor: Visits a starts with filter.
visitUpdateRequest(P, UpdateRequest) - Method in interface org.forgerock.json.resource.RequestVisitor: Visits an update request.

W

warnForDeprecation(JsonValue, Logger, String, String) - Static method in class org.forgerock.openig.util.JsonValues: Issues a warning that the configuration property oldName is deprecated and that the property newName should be used instead.
Warning - Class in org.forgerock.http.header: WarningHeader entry.
Warning(int, String, String) - Constructor for class org.forgerock.http.header.Warning: Creates a new instance without optional date.
Warning(int, String, String, Date) - Constructor for class org.forgerock.http.header.Warning: Creates a new instance with optional date.
WARNING - org.forgerock.audit.handlers.syslog.Severity: Warning conditions.
WarningHeader - Class in org.forgerock.http.header: Processes the Warning message header.
WarningHeader(List<Warning>) - Constructor for class org.forgerock.http.header.WarningHeader: Constructor for multiple Warnings.
WarningHeader(Warning) - Constructor for class org.forgerock.http.header.WarningHeader: Constructor for single Warning.
watch(Path, WatchEvent.Kind<Path>...) - Method in class org.forgerock.util.DirectoryWatcher: Registers a directory to be watched for change notifications.
WEBSOCKET_CLIENT_PROVIDER_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the WebSocketClientProvider instance from the Heap.
WEBSOCKET_PROXY_FILTER_PROVIDER_KEY - Static variable in class org.forgerock.openig.heap.Keys: Key to retrieve the WebSocketProxyFilterProvider instance from the Heap.
WebSocketAdapter - Interface in org.forgerock.openig.tools.notifications.ws: Basic websocket application interface facilitating different provider implementations.
WebSocketAdapterConfiguration - Class in org.forgerock.openig.tools.notifications.ws: A configuration holder to instantiate WebSocketAdapter.
WebSocketAdapterConfiguration(URI, List<String>) - Constructor for class org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration: Create an instance of a WebSocketAdapterConfiguration.
WebSocketClientProvider - Interface in org.forgerock.openig.tools.notifications.ws: Provider of a WebSocket clients.
WebSocketHandshakeContext - Class in org.forgerock.openig.websocket: Context signaling that the associated request is a WebSocket Handshake.
WebSocketHandshakeContext(Context) - Constructor for class org.forgerock.openig.websocket.WebSocketHandshakeContext: Create an instance of this context.
WebSocketHandshakeDetectorFilter - Class in org.forgerock.openig.websocket: A Filter that determines if the current request is a WebSocket handshake, in which case a WebSocketHandshakeContext is added to the Context chain.
WebSocketHandshakeDetectorFilter() - Constructor for class org.forgerock.openig.websocket.WebSocketHandshakeDetectorFilter
WebSocketProxyFilterProvider - Interface in org.forgerock.openig.websocket: A provider capable of providing a Filter to manage WebSocket upgrade requests and subsequently manage the bi-directional communication from the client to the remote application.
websocketUri(String) - Method in class org.forgerock.openig.tools.am.UriService: Build a websocket URI, based on this server's baseUri.
WebSocketUtils - Class in org.forgerock.openig.websocket: WebSocket utility methods.
WelcomeHandler - Class in org.forgerock.openig.handler: Creates a static response containing a simple HTML welcome page.
WelcomeHandler() - Constructor for class org.forgerock.openig.handler.WelcomeHandler
WelcomeHandler.Heaplet - Class in org.forgerock.openig.handler: Creates and initializes a static response handler in a heap environment.
when(List<Promise<V, E>>) - Static method in class org.forgerock.util.promise.Promises: Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
when(Promise<V, E>...) - Static method in class org.forgerock.util.promise.Promises: Returns a Promise which will be completed once all of the provided promises have succeeded, or as soon as one of them fails.
WITH_CERTIFICATE - Static variable in class org.forgerock.secrets.keys.KeyFormatPem: Exports the key material with the certificate as well.
withAdditionalTopicSchemas(JsonValue) - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder: Specifies schemas for additional topics.
withAuditEventHandler(Class<? extends AuditEventHandler>, EventHandlerConfiguration) - Method in class org.forgerock.audit.AuditServiceBuilder: Register an AuditEventHandler.
withAuditEventHandler(AuditEventHandler) - Method in class org.forgerock.audit.AuditServiceBuilder: Register an AuditEventHandler.
withAuditEventHandlerFactory(AuditEventHandlerFactory) - Method in class org.forgerock.audit.AuditServiceBuilder: Register factory for creating instances of AuditEventHandler.
withCaseInsensitiveFields(Collection<String>) - Method in class org.forgerock.audit.filter.FilterBuilder: Specifies which topic fields should be filtered case-insensitively.
withClaims(Map<String, Object>) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Sets any additional JWT claims, which may be overridden by claims created as part of creation of the private-key JWT.
withClientId(String) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Sets the client id that will be used in the private key jwt.
withClientSecretBasicAuth(String, SecretReference<GenericSecret>) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: Configures the token store to supply client credentials via HTTP Basic Authentication.
withClientSecretPostAuth(String, SecretReference<GenericSecret>) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: Configures the token store to supply client credentials via client_secret_post method.
withClock(Clock) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Sets the clock instance.
withClock(Clock) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: The clock to use for determining when an access token has expired.
withConfiguration(AuditServiceConfiguration) - Method in class org.forgerock.audit.AuditServiceBuilder: Sets the AuditServiceConfiguration that is to be passed to the AuditService.
withConfiguredPolicies(Map<String, FilterPolicy>) - Method in class org.forgerock.audit.filter.FilterBuilder: Sets the filter policies supplied through configuration.
withConstraints(SecretConstraint<? super T>...) - Method in class org.forgerock.secrets.Purpose: Constructs a new purpose that is identical to this purpose but which imposes additional constraints on the secrets that can satisfy it.
withCoreTopicSchemaExtensions(JsonValue) - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder: Specifies additional fields that should be added to the schemas for core event topics.
withDefault(T) - Static method in class org.forgerock.util.Option: Defines a boolean option with the provided default value.
withDefaultProtocolVersion(Version) - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Will set the accepted protocol version, if not provided in the Accept-API-Version header.
withDefaultResourceVersion(Version) - Method in class org.forgerock.http.header.AcceptApiVersionHeader: Will set the accepted resource version, if not provided in the Accept-API-Version header.
withDefaultStore(Supplier<SecretStore<?>>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder: Deprecated.

Configure this service with a default SecretStore supplier.
withDependencyProvider(DependencyProvider) - Method in class org.forgerock.audit.AuditServiceBuilder: Register the DependencyProvider, after which, an AuditEventHandler can be registered and receive this provider.
withEncryptionAlgorithm(JweAlgorithm) - Method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder: Sets algorithm used to encrypt the private key jwt.
withEncryptionMethod(EncryptionMethod) - Method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder: Sets encryption method used to encrypt the private key jwt.
withEncryptionPurpose(Purpose<DataEncryptionKey>) - Method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder: Deprecated, for removal: This API element is subject to removal in a future version.
Please use EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionSecretReference(SecretReference) instead. Will be removed in winter 2021 season.
withEncryptionSecretReference(SecretReference<DataEncryptionKey>) - Method in class org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder: Sets SecretReference to use as the encryption key.
withEventTopicsMetadata(EventTopicsMetaData) - Method in class org.forgerock.audit.filter.FilterBuilder: Sets the event topics metadata.
withEventTopicsMetaData(EventTopicsMetaData) - Method in class org.forgerock.audit.AuditServiceBuilder: Set the topic metadata that should be used by the audit service and the handlers.
withHandledTopics(Set<String>) - Method in class org.forgerock.audit.filter.FilterBuilder: Specifies which topics are registered to an audit event handler.
withHandler(Handler) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: Configures the Handler to use for sending requests to the token endpoint.
withHeadlessAuthentication(Handler) - Method in class org.forgerock.openig.tools.am.AmService: Returns a Handler which wraps the HeadlessAuthenticationFilter.
withInitialGrantTypeHandler(GrantTypeHandler) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: Configures the initial grant type handler to use for calling the token endpoint.
WITHOUT_CERTIFICATE - Static variable in class org.forgerock.secrets.keys.KeyFormatPem: Exports the key material without any associated certificate.
withoutQueryAndFragment(URI) - Static method in class org.forgerock.http.util.Uris: Returns a new URI having the same scheme, authority and path, but no query nor fragment.
withPath(D, String) - Method in interface org.forgerock.http.ApiProducer: Mutate the provided descriptor to add the specified path.
withPath(Swagger, String) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
withPrivateKeyJwtExpiryTime(Duration) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Sets duration after the jwt will expire.
withQuery(URI, Form) - Static method in class org.forgerock.http.util.Uris: Returns a new URI having the provided query parameters.
withReverseDnsLookup() - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Instructs the builder to lookup client.host from client.ip when populating client details.
withSecretsProvider(SecretsProvider) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Deprecated, for removal: This API element is subject to removal in a future version.
Please use SecretReference API instead. Will be removed in winter 2021 season.
withSecretsProvider(SecretsProvider) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder: Deprecated.

Configure this service with the given provider.
withSecretsService(SecretsService) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder: Deprecated.

Configure this service with the given parent secrets service.
withSigningAlgorithm(JwsAlgorithm) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Sets algorithm used to sign the private key jwt.
withSigningPurpose(Purpose<SigningKey>) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Deprecated, for removal: This API element is subject to removal in a future version.
Please use PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningSecretReference(SecretReference) instead. Will be removed in winter 2021 season.
withSigningSecretReference(SecretReference<SigningKey>) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Sets SecretReference to use as the signing key.
withSkewAllowance(TemporalAmount) - Method in class org.forgerock.openig.tools.jwt.validation.JwtValidator.Builder: Specifies the skew allowance to use for temporal constraints validations.
withTokenEndpoint(String) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: Configures the URI of the OAuth 2 token endpoint to call to obtain access tokens.
withTokenEndpoint(URI) - Method in class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder: Sets the token end point used to specify as the aud in the private key jwt.
withTokenEndpoint(URI) - Method in class org.forgerock.secrets.oauth2.AccessTokenSecretStore.Builder: Configures the URI of the OAuth 2 token endpoint to call to obtain access tokens.
withVersion(D, Version) - Method in interface org.forgerock.http.ApiProducer: Mutate the provided descriptor to add the specified version.
withVersion(Swagger, Version) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
withX509Thumbprint() - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Sets the SHA-1 X509 thumbprint based on the configured JWK.Builder.x509Chain(List).
withX509ThumbprintS256() - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Sets the SHA-256 X509 thumbprint based on the configured JWK.Builder.x509Chain(List).
wrap(SecretStore<S>) - Static method in class org.forgerock.secrets.ThreadPoolSecretStore: Wraps the given store in an asynchronous thread-pool executor using the system ForkJoinPool.commonPool().
wrap(SecretStore<S>, ExecutorService) - Static method in class org.forgerock.secrets.ThreadPoolSecretStore: Wraps the given store in an asynchronous thread-pool executor using the given thread pool.
wrap(T, MessageCapture, Set<CapturePoint>) - Method in interface org.forgerock.openig.decoration.capture.CaptureFactory: Wraps the decorator to be applied to the given object.
wrap(T, Expression<String>, Logger) - Method in interface org.forgerock.openig.decoration.baseuri.BaseUriFactory: Wraps the decorator to be applied everywhere.
wrap(T, Logger, Ticker, TimeUnit, MeterRegistry) - Method in interface org.forgerock.openig.decoration.timer.TimerFactory: Wraps the decorator to be applied on the given object.
WRAP_KEY - org.forgerock.json.jose.jwk.KeyOperation: Use Key to encrypt key.
WRAP_KEY - org.forgerock.secrets.keys.KeyUsage: Key is intended for encrypting (wrapping) other keys.
write(byte[]) - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Write the specified buffer to the stream.
write(byte[], int, int) - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Write the specified buffer to the stream.
write(char[]) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(char[], int, int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(int) - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Write the specified byte to the stream.
write(int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(String) - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Write the log record asynchronously.
write(String) - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
write(String) - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
write(String) - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Writes some text to the output stream.
write(String) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(String, int, int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
writeCurrentKey(SecretKey) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
writeCurrentKey(SecretKey) - Method in interface org.forgerock.audit.secure.SecureStorage: Writes the current key.
writeCurrentSignatureKey(SecretKey) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
writeCurrentSignatureKey(SecretKey) - Method in interface org.forgerock.audit.secure.SecureStorage: Writes the current signature key.
writeInitialKey(SecretKey) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
writeInitialKey(SecretKey) - Method in interface org.forgerock.audit.secure.SecureStorage: Writes the initial key.
writeInteger(ByteBuffer, byte[]) - Static method in class org.forgerock.json.jose.utils.DerUtils: Writes an integer value in DER format to the given buffer.
writeInterval(Duration) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: The interval duration between each write.
writeJson(Object) - Static method in class org.forgerock.http.util.Json: Writes the JSON content of the object passed in parameter.
writeJsonObject(Map<String, Object>) - Static method in class org.forgerock.json.jose.utils.Utils: Writes the given map as a string in JSON object format.
writeLength(ByteBuffer, int) - Static method in class org.forgerock.json.jose.utils.DerUtils: Writes a length field to the output.
writeToKeyStore(SecretKey, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Writes to the secret storage using the same password than the KeyStoreHandler.
writeToKeyStore(SecretKey, String, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Writes to the secret storage.
WS_KEY_HEADER_NAME - Static variable in class org.forgerock.openig.websocket.WebSocketUtils: HTTP WebSocket header name used to identify the WebSocket key.
WS_PROTOCOL_HEADER_NAME - Static variable in class org.forgerock.openig.websocket.WebSocketUtils: HTTP WebSocket header name used to identify the WebSocket protocol.
WS_VERSION_HEADER_NAME - Static variable in class org.forgerock.openig.websocket.WebSocketUtils: HTTP WebSocket header name used to determine WebSocket version.
WS_VERSION_HEADER_VALUE - Static variable in class org.forgerock.openig.websocket.WebSocketUtils: Value for header name "Sec-WebSocket-Version", indicating version "13".
WwwAuthenticateHeader - Class in org.forgerock.http.header: A Header representation of the WWW-Authenticate HTTP header.
WwwAuthenticateHeader() - Constructor for class org.forgerock.http.header.WwwAuthenticateHeader
WwwAuthenticateHeader.Challenge - Class in org.forgerock.http.header: A single WWW-Authenticate challenge.

X

x(String) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder: Sets the public key x-coordinate of the key.
X25519 - org.forgerock.json.jose.jws.SupportedEllipticCurve: Curve25519 when used for ECDH-ES key agreement (X25519).
X448 - org.forgerock.json.jose.jws.SupportedEllipticCurve: Curve448 when used for ECDH-ES key agreement (X448).
x509Chain - Variable in class org.forgerock.json.jose.jwk.JWK.Builder: The X.509 certificate chain, optional.
x509Chain(List<String>) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Set the X509 certificates attributes.
x509Thumbnail - Variable in class org.forgerock.json.jose.jwk.JWK.Builder: X.509 certificate thumbprint, optional.
x509Thumbnail(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Deprecated.
Use JWK.Builder.x509Thumbprint(String) or JWK.Builder.x509ThumbprintS256(String) instead.
x509Thumbprint(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Sets the SHA-1 X509 thumbprint.
x509ThumbprintS256(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Sets the SHA-256 X509 thumbprint.
x509url - Variable in class org.forgerock.json.jose.jwk.JWK.Builder: X.509 certificate URL, optional.
x509Url(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder: Gets the X509 URL.
x5c(List<String>) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Sets the X.509 Certificate Chain header parameter for this JWS.
X5C - org.forgerock.json.jose.jws.JwsHeaderKey: X.509 Certificate Chain header parameter.
x5t(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Sets the X.509 Certificate Thumbprint header parameter for this JWS.
X5T - org.forgerock.json.jose.jws.JwsHeaderKey: X.509 Certificate Thumbprint header parameter.
x5u(URL) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Sets the X.509 URL header parameter for this JWS.
X5U - org.forgerock.json.jose.jws.JwsHeaderKey: X.509 URL header parameter.
XC20_P1305 - org.forgerock.json.jose.jwe.EncryptionMethod: The XChaCha20-Poly1305 algorithm as used in libsodium, Wireguard, etc.
xecPrivateKey(PrivateKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder: Sets the private scalar value from the given XECPrivateKey (Java 11+).
xecPrivateKey(SupportedEllipticCurve, byte[]) - Static method in class org.forgerock.json.jose.utils.XECUtils: Converts a private scalar byte value into a XECPrivateKey on the given curve.
xecPublicKey(PublicKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder: Sets the public x-coordinate from the given XECPublicKey (Java 11+).
xecPublicKey(SupportedEllipticCurve, BigInteger) - Static method in class org.forgerock.json.jose.utils.XECUtils: Converts a public u-coordinate into a XECPublicKey on the given curve.
XECUtils - Class in org.forgerock.json.jose.utils: Utilities for handling XEC keys for X25519 and X448 ECDH key agreement.
XForwardedForHeader - Class in org.forgerock.http.header: Processes the X-Forwarded-For message header.
XForwardedForHeader() - Constructor for class org.forgerock.http.header.XForwardedForHeader
XMLHandler - Class in org.forgerock.util.xml: This is a custom XML handler to load the dtds from the classpath This should be used by all the xml parsing document builders to set the default entity resolvers.
XMLHandler() - Constructor for class org.forgerock.util.xml.XMLHandler: Creates a new XML handler.
XMLUtils - Class in org.forgerock.util.xml: Utility classes for handling XML.

Z

ZERO - Static variable in class org.forgerock.util.time.Duration: Special duration that represents a zero-length duration.
zip(CompressionAlgorithm) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
zip(CompressionAlgorithm) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder: Sets the Compression Algorithm header parameter for this JWE.
ZIP - org.forgerock.json.jose.jwe.JweHeaderKey: Compression Algorithm header parameter.

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 All Packages