Skip navigation links
OpenIG 5.5.1 API
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 

A

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.
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(Context, String) - Constructor for class org.forgerock.services.context.AbstractContext
Constructs a new AbstractContext with a null id.
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.
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
An AbstractHandlerAndFilterDecorator is the base implementation for decorators working only on Filter and Handler.
AbstractHandlerAndFilterDecorator(String) - Constructor for class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Forces to give the name of the decorator.
AbstractHttpClient - Class in org.forgerock.http.apache
This abstract client is used to share commonly used constants and methods in both synchronous and asynchronous Apache HTTP Client libraries.
AbstractHttpClient() - Constructor for class org.forgerock.http.apache.AbstractHttpClient
 
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 - Class in org.forgerock.openig.script
Creates and initializes a capture filter 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(T) - Method in interface org.forgerock.util.LambdaExceptionUtils.ThrowingConsumer
Consume the value.
accept() - Method in interface org.forgerock.util.LambdaExceptionUtils.ThrowingSupplier
Supply a value.
accept(QueryFilterVisitor<R, P, F>, P) - Method in class org.forgerock.util.query.QueryFilter
Applies a QueryFilterVisitor to this QueryFilter.
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.
AcceptLanguageHeader - Class in org.forgerock.http.header
A header class representing the Accept-Language HTTP header.
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
 
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, ...).
Action - Annotation Type in org.forgerock.api.annotations
Indicates an CREST action method on an annotated POJO.
Action - Class in org.forgerock.api.models
Class that represents the Action operation type in API descriptor.
action() - Static method in class org.forgerock.api.models.Action
Creates a new builder for Action.
action(Action) - Method in class org.forgerock.api.models.Items.Builder
Adds one Action to the list of Actions.
action(Action) - Method in class org.forgerock.api.models.Resource.Builder
Adds one Action to the list of Actions.
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.Builder - Class in org.forgerock.api.models
Builder class for creating the Action.
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, 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
 
actionInstance(Context, String, ActionRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
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.
Actions - Annotation Type in org.forgerock.api.annotations
Declare an array of Action operations from a single method.
actions(List<Action>) - Method in class org.forgerock.api.models.Items.Builder
Set Actions.
actions(List<Action>) - Method in class org.forgerock.api.models.Resource.Builder
Set Actions.
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, 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(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(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) - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
add(K, V) - Method in class org.forgerock.http.util.MultiValueMap
Adds the specified value to the list for the specified key.
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(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
add(int, Object) - Method in class org.forgerock.json.JsonValue
Adds the specified value to the list.
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(Object) - Method in class org.forgerock.json.JsonValue
Adds the specified value to the end of the list.
add(String, Object) - Method in class org.forgerock.json.JsonValue
Adds the specified value.
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(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(E) - Method in class org.forgerock.openig.jwt.dirty.DirtyCollection
 
add(AddRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Adds an entry to the Directory Server using the provided add request.
add(Entry) - Method in class org.forgerock.openig.ldap.LdapConnection
Adds the provided entry to the Directory Server.
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, String) - Method in class org.forgerock.openig.policy.PolicyRequest.EnvironmentBuilder
Adds a new singleton entry value to the environment.
add(String, Collection<String>) - Method in class org.forgerock.openig.policy.PolicyRequest.EnvironmentBuilder
Adds given values for the given key to the environment.
add(E) - Method in class org.forgerock.util.LazyList
Appends the specified element to the end of this list.
add(int, E) - Method in class org.forgerock.util.LazyList
Inserts the specified element at the specified position in this list.
add(E) - Method in class org.forgerock.util.ListDecorator
Appends the specified element to the end of this list.
add(int, E) - Method in class org.forgerock.util.ListDecorator
Inserts the specified element at the specified position in this list.
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(Collection<? extends String>) - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
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.
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(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.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(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(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(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.
addAllRoutes(T) - Method in class org.forgerock.services.routing.AbstractRouter
Adds all of the routes defined in the provided router to this router.
addApiInfo(ApiDescription) - Method in class org.forgerock.api.CrestApiProducer
 
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(Expression<Boolean>, Handler, Expression<String>) - Method in class org.forgerock.openig.handler.DispatchHandler
Binds an expression to the current handler to dispatch to.
addBinding(Handler, Expression<Boolean>) - Method in class org.forgerock.openig.handler.SequenceHandler
Binds sequenced handlers with sequence processing postconditions.
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(JsonPointer...) - Method in interface org.forgerock.json.resource.ActionRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.ActionRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.CreateRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.CreateRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.DeleteRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.DeleteRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.PatchRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.PatchRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.QueryRequest
 
addField(String...) - Method in interface org.forgerock.json.resource.QueryRequest
 
addField(JsonPointer...) - Method in interface org.forgerock.json.resource.ReadRequest
 
addField(String...) - 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(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(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
 
addField(String...) - 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, Expression<String>) - Method in class org.forgerock.openig.handler.StaticResponseHandler
Adds a pair key / expression to the header.
addHeaderToAllOperations(HeaderParameter, Swagger) - Static method in class org.forgerock.api.transform.OpenApiHelper
Adds a header to all operations.
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.
ADDITIONALITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
The additionalItems field name.
AdditionalProperties - Annotation Type in org.forgerock.api.annotations
Annotation to define JSON Schema additionalProperties, which is useful when working with key/value JSON data structures.
ADDITIONALPROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
The additionalProperties field name.
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(PatchOperation...) - Method in interface org.forgerock.json.resource.PatchRequest
Adds one or more patch operations which should be performed against the targeted resource.
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.
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(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.
addRequestBinding(Expression<Boolean>, LeftValueExpression<?>, Expression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers a conditional 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(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.
addResponseBinding(Expression<Boolean>, LeftValueExpression<?>, Expression<?>) - Method in class org.forgerock.openig.filter.AssignmentFilter
Registers a conditional 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(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(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, SingletonResourceProvider) - Method in class org.forgerock.json.resource.Router
Adds a new route to this router for the provided singleton 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(RouteMatcher<R>, H) - Method in class org.forgerock.services.routing.AbstractRouter
Adds a new route to this router for the provided handler.
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(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.
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.
addTag(String) - Method in class org.forgerock.api.transform.LocalizableOperation
 
addTag(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableOperation
Adds a Tag, a String value that is metadata related to the Operation.
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.splunk.SplunkAuditEventHandler
 
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 OpenIG Administration.
AdminHttpApplication(String, JsonValue, Environment, RunMode) - Constructor for class org.forgerock.openig.http.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(Context, Collection<String>) - Constructor for class org.forgerock.json.resource.AdviceContext
Creates a new AdviceContext with the provided parent.
AdviceContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.json.resource.AdviceContext
Restore from JSON representation.
AdviceWarning - Class in org.forgerock.json.resource
WarningHeader implements RFC 2616 section 14.46 - Warning.
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.
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.
algorithm - Variable in class org.forgerock.json.jose.jwk.JWK.Builder
The intended JOSE algorithm for the key, optional.
algorithm(Algorithm) - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Sets the algorithm parameter of the JWK.
algorithm(String) - 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_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_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.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Action
Allocates the Action operation type to the given Resource Builder.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Create
Allocates the Create operation type to the given Resource Builder.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Delete
Allocates the Delete operation type to the given Resource Builder.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Operation
Allocates the operation by operation type to the given Resource Builder by calling the corresonding method by type.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Patch
Allocates the Patch operation type to the given Resource Builder.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Query
Allocates the Query operation type to the given Resource Builder.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Read
Allocates the Read operation type to the given Resource Builder.
allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Update
Allocates the Update operation type to the given Resource Builder.
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.
anchor(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a cross-reference anchor.
anchor(String, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a cross-reference anchor, with a custom xreflabel.
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(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(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.
ANY_DISK_SPACE - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention
The disk space value when disk space is unrestricted.
anySchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
AnyTypeValidator - Class in org.forgerock.json.schema.validator.validators
AnyTypeValidator applies all the constraints of a any type.
AnyTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.AnyTypeValidator
Construct an any type validator.
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(ApiProducer<D>) - Method in interface org.forgerock.services.descriptor.Describable
Provide the API description for the component.
api - Variable in class org.forgerock.services.routing.AbstractRouter
Api of the current router.
api(ApiProducer<D>) - Method in class org.forgerock.services.routing.AbstractRouter
 
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 config.json.
ApiDescription - Class in org.forgerock.api.models
Class that represents the ApiDescription type in API descriptor.
apiDescription() - Static method in class org.forgerock.api.models.ApiDescription
Create a new Builder for ApiDescription.
ApiDescription.Builder - Class in org.forgerock.api.models
Builder for the ApiDescription.
ApiDocGenerator - Class in org.forgerock.api.markup
Generates static AsciiDoc documentation for CREST API Descriptors.
ApiDocGeneratorException - Exception in org.forgerock.api.markup
Signals that an error occurred while generating API documentation.
ApiDocGeneratorException(String) - Constructor for exception org.forgerock.api.markup.ApiDocGeneratorException
Creates a ApiDocGeneratorException with a detailed error message.
ApiDocGeneratorException(String, Throwable) - Constructor for exception org.forgerock.api.markup.ApiDocGeneratorException
Creates a ApiDocGeneratorException with a detailed error message and cause.
ApiError - Annotation Type in org.forgerock.api.annotations
Details of an error that could be returned.
ApiError - Class in org.forgerock.api.models
Class that represents the ApiError type in API descriptor.
apiError() - Static method in class org.forgerock.api.models.ApiError
New apiError builder.
ApiError.Builder - Class in org.forgerock.api.models
Builder for the ApiError.
ApiProducer<D> - Interface in org.forgerock.http
A producer of API Descriptions.
ApiValidationException - Exception in org.forgerock.api
Signals that API failed validation.
ApiValidationException(String) - Constructor for exception org.forgerock.api.ApiValidationException
Creates a ApiValidationException with a detailed error message.
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(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.
ApiVersionRouterContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.routing.ApiVersionRouterContext
Restore from JSON representation.
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.
append(char) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Appends the provided character to this message builder.
append(CharSequence) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Appends the provided character sequence to this message builder.
append(CharSequence, int, int) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Appends a subsequence of the provided character sequence to this message builder.
append(int) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Appends the provided integer to this message builder.
append(LocalizableMessage) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Appends the provided message to this message builder.
append(Object) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Appends the String representation of the provided Object to this message builder.
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.
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(JsonValue) - Method in class org.forgerock.api.models.TranslateJsonSchema
Applies the translation to string values by converting them to LocalizableString.
apply(JsonValue) - Method in class org.forgerock.json.JsonValueTraverseFunction
 
apply(ContextAndRequest) - Method in class org.forgerock.openig.el.ExpressionRequestAsyncFunction
 
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.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.
apply(T, U) - Method in interface org.forgerock.util.LambdaExceptionUtils.ThrowingBiFunction
Process the values.
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.
apv(String) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Sets the Agreement PartyVInfo header parameter for this JWE.
Arg0(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg0
Creates a parameterized instance.
Arg1(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg1
Creates a parameterized instance.
Arg2(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg2
Creates a parameterized instance.
Arg3(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg3
Creates a parameterized instance.
Arg4(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg4
Creates a parameterized instance.
Arg5(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg5
Creates a parameterized instance.
Arg6(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg6
Creates a parameterized instance.
Arg7(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg7
Creates a parameterized instance.
Arg8(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg8
Creates a parameterized instance.
Arg9(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.Arg9
Creates a parameterized instance.
ArgN(Class<?>, String, String, int) - Constructor for class org.forgerock.i18n.LocalizableMessageDescriptor.ArgN
Creates a parameterized instance.
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
 
arraySchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
ArrayTypeValidator - Class in org.forgerock.json.schema.validator.validators
ArrayTypeValidator applies all the constraints of a array type.
ArrayTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.ArrayTypeValidator
Default ctor.
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.
asBoolean() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Boolean object.
ascendingOrder(JsonPointer) - Static method in class org.forgerock.json.resource.SortKey
Creates a new ascending-order sort key for the provided JSON field.
ascendingOrder(String) - Static method in class org.forgerock.json.resource.SortKey
Creates a new ascending-order sort key for the provided JSON field.
AsciiDoc - Class in org.forgerock.api.markup.asciidoc
Root builder for AsciiDoc markup.
asciiDoc() - Static method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Creates a new builder instance.
AsciiDocException - Exception in org.forgerock.api.markup.asciidoc
Signals that an error occurred while building AsciiDoc markup.
AsciiDocException(String) - Constructor for exception org.forgerock.api.markup.asciidoc.AsciiDocException
Creates a AsciiDocException with a detailed error message.
AsciiDocSymbols - Enum in org.forgerock.api.markup.asciidoc
Enumeration of AsciiDoc markup symbols.
AsciiDocTable - Class in org.forgerock.api.markup.asciidoc
AsciiDoc table builder [ref], which defers insertion of the table, at the end of the parent document, until AsciiDocTable.tableEnd() is called.
AsciiDocTableColumnStyles - Enum in org.forgerock.api.markup.asciidoc
AsciiDoc table column-styles.
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.
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.Utils
Returns the string value as an enum constant of the specified enum type.
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.SsoTokenContext
Returns the info associated with this context 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
 
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(Class<V>) - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Map containing objects of the specified type.
asMap() - Method in class org.forgerock.openig.el.Bindings
Returns an unmodifiable Map view of this Bindings instance.
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.
asNewInstance(JsonValue, Class<T>) - Static method in class org.forgerock.openig.util.JsonValues
Creates a new instance of a named class.
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.
asRequestHandler(SynchronousRequestHandler) - Static method in class org.forgerock.json.resource.Resources
Adapts the provided SynchronousRequestHandler as a RequestHandler.
asResource(boolean, Schema, LocalizableString, LocalizableString) - Method in class org.forgerock.api.models.Items
Builds a Resource from this Items instance.
assembleException() - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
Deprecated.
assembleException() - Method in class org.forgerock.json.schema.validator.ErrorHandler
Deprecated. 
assembleException() - Method in class org.forgerock.json.schema.validator.FailFastErrorHandler
Deprecated.
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.
AsyncFunction<VIN,VOUT,E extends Exception> - Interface in org.forgerock.util
An asynchronous Function which returns a result at some point in the future.
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.
AsyncHttpClient - Class in org.forgerock.http.apache.async
Apache HTTP Async Client based implementation.
AsyncHttpClientProvider - Class in org.forgerock.http.apache.async
Creates and configures a HttpClient instance built around Apache HTTP Async Client component.
AsyncHttpClientProvider() - Constructor for class org.forgerock.http.apache.async.AsyncHttpClientProvider
 
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(Context) - Constructor for class org.forgerock.services.context.AttributesContext
Constructs a new AttributesContext.
AttributesContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.AttributesContext
Restore from JSON representation.
aud(List<String>) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets the JWT's intended audience list in the Claims Set.
Audit - Annotation Type in org.forgerock.audit
Denotes audit dependencies.
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.
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(Throwable) - Constructor for exception org.forgerock.audit.AuditException
Constructs an AuditException using the given parent cause.
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.
AuditingContext - Class in org.forgerock.audit
A Context used when auditing over the router.
AuditingContext(Context) - Constructor for class org.forgerock.audit.AuditingContext
Construct a new audit context with the provided parent.
AuditingContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.audit.AuditingContext
Restore a serialized audit context.
AuditJsonConfig - Class in org.forgerock.audit.json
Utility class to facilitate creation and configuration of audit service and audit event handlers through JSON.
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.handler.router
Creates and initializes an AuditService in a heap environment.
AuditServiceObjectHeaplet() - Constructor for class org.forgerock.openig.handler.router.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.
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.
authFailed(HttpHost, AuthScheme, HttpContext) - Method in class org.forgerock.http.apache.NoAuthenticationStrategy
 
authSucceeded(HttpHost, AuthScheme, HttpContext) - Method in class org.forgerock.http.apache.NoAuthenticationStrategy
 
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.
autoFlush(boolean) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Whether events to should be automatically flushed on shutdown.
averagePerEventPayloadSize(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Sets the average event payload size, used to initialise string buffers.

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_GATEWAY_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.BAD_GATEWAY in an API Description.
BAD_REQUEST - Static variable in class org.forgerock.http.protocol.Status
The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
BAD_REQUEST - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the request could not be understood by the resource due to malformed syntax.
BAD_REQUEST_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.BAD_REQUEST in an API Description.
BadRequestException - Exception in org.forgerock.json.resource
An exception that is thrown during a operation on a resource when the requested operation is malformed.
BadRequestException() - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with null as its detail message.
BadRequestException(String) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified detail message.
BadRequestException(String, Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified detail message and cause.
BadRequestException(Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified cause.
Base64 - Class in org.forgerock.util.encode
A very fast and memory efficient class to encode and decode to and from BASE64 in full accordance with RFC 2045.

On Windows XP sp1 with 1.4.2_04 and later ;), this encoder and decoder is about 10 times faster on small arrays (10 - 1000 bytes) and 2-3 times as fast on larger arrays (10000 - 1000000 bytes) compared to sun.misc.Encoder()/Decoder().

On byte arrays the encoder is about 20% faster than Jakarta Commons Base64 Codec for encode and about 50% faster for decoding large arrays.
Base64url - Class in org.forgerock.util.encode
Makes use of the very fast and memory efficient Base64 class to encode and decode to and from BASE64 in full accordance with RFC 2045.
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.
base64urlDecode(String) - Static method in class org.forgerock.json.jose.utils.Utils
Base64url decodes the given String and converts the decoded bytes into a UTF-8 String.
base64urlEncode(String) - Static method in class org.forgerock.json.jose.utils.Utils
Base64url encodes the given String, converting the String to UTF-8 bytes.
base64UrlEncodeUnsignedBigIndian(BigInteger) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils
Encode a big integer into a base 64 url encoded unsigned big indian.
BASE_ENV_VARIABLE - Static variable in class org.forgerock.openig.http.GatewayEnvironment
Environment variable name.
BASE_INIT_PARAM - Static variable in class org.forgerock.openig.http.GatewayEnvironment
Servlet's init-param name.
BASE_SYSTEM_PROPERTY - Static variable in class org.forgerock.openig.http.GatewayEnvironment
System property name that can be specified through command line.
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.
BaseUriUtil - Class in org.forgerock.openig.util
Utility to help with baseUri expressions.
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.
BatchPublisher<T> - Class in org.forgerock.audit.handlers.jms
Generic publisher that will queue anything for batch processing.
BatchPublisher(String, BatchPublisherConfiguration) - Constructor for class org.forgerock.audit.handlers.jms.BatchPublisher
This constructs the thread pool of worker threads.
BatchPublisherConfiguration - 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.
BatchPublisherConfiguration() - Constructor for class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
 
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.
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.
BigIntegerUtils - Class in org.forgerock.json.jose.utils
Utils to complement bit operations not covered by the BigInteger functions.
bind(String, Object) - Method in class org.forgerock.openig.el.Bindings
Binds a new value to the given name.
bind(Bindings) - Method in class org.forgerock.openig.el.Bindings
Binds all the bindings already bound from source.
bind(BindRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Authenticates to the Directory Server using the provided bind request.
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.
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
 
bindings() - Static method in class org.forgerock.openig.el.Bindings
Returns an empty Bindings instance (mutable).
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(String, Object) - Static method in class org.forgerock.openig.el.Bindings
Returns a singleton Bindings initialized with the given name and value.
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(Bindings) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function that will create some bindings based of a Map-based JsonValue.
blockTitle(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a block title.
boldText(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts bold text.
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.
booleanSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
BooleanTypeValidator - Class in org.forgerock.json.schema.validator.validators
BooleanTypeValidator applies all the constraints of a boolean type.
BooleanTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.BooleanTypeValidator
Construct a boolean type validator.
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.api.models.Action.Builder
Builds the Action instance.
build() - Method in class org.forgerock.api.models.ApiDescription.Builder
Builds the ApiDescription instance.
build() - Method in class org.forgerock.api.models.ApiError.Builder
Builds the ApiError.
build() - Method in class org.forgerock.api.models.Create.Builder
Builds the Create instance.
build() - Method in class org.forgerock.api.models.Definitions.Builder
Builds the Definitions instance.
build() - Method in class org.forgerock.api.models.Delete.Builder
Builds the Delete instance.
build() - Method in class org.forgerock.api.models.Errors.Builder
Builds the Errors instance.
build() - Method in class org.forgerock.api.models.Items.Builder
Construct a new instance of Resource.
build() - Method in class org.forgerock.api.models.Parameter.Builder
Builds the Parameter.
build() - Method in class org.forgerock.api.models.Patch.Builder
Builds the Patch instance.
build() - Method in class org.forgerock.api.models.Paths.Builder
Builds the Paths instance.
build() - Method in class org.forgerock.api.models.Query.Builder
Builds the Query instance.
build() - Method in class org.forgerock.api.models.Read.Builder
Builds the Create instance.
build() - Method in class org.forgerock.api.models.Reference.Builder
Builds the Reference instance.
build() - Method in class org.forgerock.api.models.Resource.Builder
Construct a new instance of Resource.
build() - Method in class org.forgerock.api.models.Schema.Builder
Builds the Schema instance.
build() - Method in class org.forgerock.api.models.Services.Builder
Builds the Definitions instance.
build() - Method in class org.forgerock.api.models.SubResources.Builder
Builds the SubResources instance.
build() - Method in class org.forgerock.api.models.Update.Builder
Builds the Create instance.
build() - Method in class org.forgerock.api.models.VersionedPath.Builder
Builds the VersionedPath instance.
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.FilterChainBuilder
Builds the FilterChain.
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.OctJWK.Builder
Build the Octet JWK.
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.openig.policy.PolicyRequest.Builder
Builds and return a PolicyRequest.
build() - Method in class org.forgerock.openig.policy.PolicyRequest.EnvironmentBuilder
Returns a builder containing the environment.
build() - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Builds and loads the keystore using the provided parameters.
build() - Method in class org.forgerock.services.context.ClientContext.Builder
Creates a ClientContext instance from the specified properties.
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() - Constructor for class org.forgerock.api.models.Action.Builder
 
Builder() - Constructor for class org.forgerock.api.models.Items.Builder
Private default constructor.
Builder() - Constructor for class org.forgerock.api.models.Operation.Builder
Creates a new Builder.
Builder() - Constructor for class org.forgerock.api.models.Query.Builder
 
Builder() - Constructor for class org.forgerock.api.models.Read.Builder
 
Builder() - Constructor for class org.forgerock.api.models.Resource.Builder
Private default constructor.
builder(SupportedEllipticCurve, String, String) - Static method in class org.forgerock.json.jose.jwk.EcJWK
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(KeyType) - Constructor for class org.forgerock.json.jose.jwk.JWK.Builder
The builder constructor.
builder(String) - Static method in class org.forgerock.json.jose.jwk.OctJWK
Get the Octet JWK builder.
builder(String, String) - Static method in class org.forgerock.json.jose.jwk.RsaJWK
Get the builder.
builder(RSAPublicKey) - Static method in class org.forgerock.json.jose.jwk.RsaJWK
Get the builder.
builder(String) - Static method in class org.forgerock.openig.policy.PolicyRequest
Creates a policy request builder based on the policy set name.
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.
buildPath(String, String...) - Static method in class org.forgerock.api.util.PathUtil
Builds a forward-slash-delimited path, with duplicate forward-slashes removed, and trailing slashes removed.
buildPathParameters(String) - Static method in class org.forgerock.api.util.PathUtil
Searches for curly-braces in the given pathSegment, and creates a path-parameter for each that are found.
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.
buildTimeStampFileNamingPolicy(File) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Builds a TimeStampFileNamingPolicy instance from configuration options.

C

CachePolicyDecisionFilter - Class in org.forgerock.openig.tools
A cache decision policy filter class.
CachePolicyDecisionFilter(ScheduledExecutorService, TimeService, Duration, Duration) - Constructor for class org.forgerock.openig.tools.CachePolicyDecisionFilter
Builds a CachePolicyDecisionFilter.
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(TimeService, 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.
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
 
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.Heaplet - Class in org.forgerock.openig.decoration.capture
Creates and initializes a CaptureDecorator in a heap environment.
CapturePoint - Enum in org.forgerock.openig.decoration.capture
Specify where does 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(Collection<String>) - Constructor for class org.forgerock.http.util.CaseInsensitiveSet
Constructs a new case-insensitive set containing the elements in the specified collection.
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(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.
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.
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
 
chainOf(Filter...) - Static method in class org.forgerock.http.filter.Filters
Creates a Filter which encapsulates the provided filters into a single Filter.
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(Handler, 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, List<Filter>) - Static method in class org.forgerock.http.handler.Handlers
Creates a Handler which wraps the provided filters around the provided target handler.
charAt(int) - Method in class org.forgerock.i18n.LocalizableMessage
Returns the char value at the specified index of the String representation of this message in the default locale.
charAt(Locale, int) - Method in class org.forgerock.i18n.LocalizableMessage
Returns the char value at the specified index of the String representation of this message in the specified locale.
charAt(int) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns the char value at the specified index of the String representation of this message builder in the default locale.
charAt(Locale, int) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns the char value at the specified index of the String representation of this message builder in the specified locale.
CHARSET - Static variable in class org.forgerock.json.jose.utils.Utils
UTF-8 Charset.
charset() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a character set used for byte encoding/decoding.
checkClientTrusted(X509Certificate[], String) - Method in class org.forgerock.openig.security.TrustAllManager
 
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.
checkServerTrusted(X509Certificate[], String) - Method in class org.forgerock.openig.security.TrustAllManager
 
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.
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(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.openig.heap.Name
Creates a new Name, relative to this Name with the given leaf name.
CIPHER_AES_CBC_PKCS5 - Static variable in class org.forgerock.util.crypto.CryptoConstants
A cipher value for the AES/CBC/PKCS5Padding algorithm.
claim(String, Object) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Adds a custom claim to the JWT Claims Set.
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() - 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(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.SignedJwtBuilderImpl
Sets the JwtClaimsSet for this JwtBuilder.
claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder
 
claims(Map<String, Object>) - Method in class org.forgerock.openig.policy.PolicyRequest.Builder
Sets the representation of JWT claims for the subject.
ClassAliasResolver - Interface in org.forgerock.openig.alias
This interface has to be implemented by each OpenIG 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.jwt.dirty.DirtyCollection
 
clear() - Method in class org.forgerock.openig.jwt.dirty.DirtySet
 
clear() - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
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.PerItemEvictionStrategyCache
Clean-up the cache entries.
CLIENT - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The client event payload field name.
client(String, int) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided client ip and port for the event.
client(String) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided client ip 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_HANDLER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a default ClientHandler instance from the Heap.
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.
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.
ClientHandler - Class in org.forgerock.openig.handler
Submits requests to remote servers.
ClientHandler(Handler) - Constructor for class org.forgerock.openig.handler.ClientHandler
Creates a new client handler.
ClientHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a client handler in a heap environment.
ClientRegistration - Class in org.forgerock.openig.filter.oauth2.client
A configuration for an OpenID Connect Provider.
ClientRegistration(String, JsonValue, Issuer, Handler, IdGenerator, TimeService, KeyStore) - 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, Handler, JsonValue, TimeService) - Constructor for class org.forgerock.openig.filter.oauth2.client.ClientRegistrationFilter
Creates a new dynamic registration filter.
clone(Swagger) - Static method in class org.forgerock.http.swagger.SwaggerUtils
Clone a Swagger instance.
clone() - Method in class org.forgerock.json.JsonValue
Returns a shallow copy of this JSON value.
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
Closes the rotatable file.
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.apache.async.AsyncHttpClient
 
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.ldap.LdapConnection
Releases any resources associated with this connection.
close() - Method in class org.forgerock.openig.regex.StreamPatternMatches
Closes this character stream, as well as the the reader it its iterating over.
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
 
closeSilently(Function<IN, OUT, EX>) - Static method in class org.forgerock.util.CloseSilentlyFunction
Wraps a delegate function in a CloseSilentlyFunction.
closeSilently(Closeable...) - Static method in class org.forgerock.util.Utils
Closes the provided resources ignoring any errors which occurred.
closeSilently(Iterable<? extends Closeable>) - Static method in class org.forgerock.util.Utils
Closes the provided resources ignoring any errors which occurred.
closeSilentlyAsync(Closeable...) - Static method in class org.forgerock.util.Utils
Closes asynchronously the provided resources ignoring any errors which occurred.
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.
code(Integer) - Method in class org.forgerock.api.models.ApiError.Builder
Set the error code.
collectAllValidators(Collection<Validator>) - Method in class org.forgerock.json.schema.validator.validators.ArrayTypeValidator
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
collectAllValidators(Collection<Validator>) - Method in class org.forgerock.json.schema.validator.validators.ObjectTypeValidator
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
collectAllValidators(Collection<Validator>) - Method in class org.forgerock.json.schema.validator.validators.Validator
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
collectAllValidators(Collection<Validator>, Collection<? extends Validator>) - Static method in class org.forgerock.json.schema.validator.validators.Validator
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
collectAllValidators(Collection<Validator>, Map<?, ? extends Validator>) - Static method in class org.forgerock.json.schema.validator.validators.Validator
Collects all the sub-validators held in this validator and aggregates them in the passed in Collection.
CollectErrorsHandler - Class in org.forgerock.json.schema.validator
The CollectErrorsHandler implements the ErrorHandler and never throws any exception, but collects them so callers can retrieve all of them in one go.
CollectErrorsHandler() - Constructor for class org.forgerock.json.schema.validator.CollectErrorsHandler
 
CollectionProvider - Annotation Type in org.forgerock.api.annotations
A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST collection provider resource.
CollectionResourceProvider - Interface in org.forgerock.json.resource
An implementation interface for resource providers which exposes a collection of resource instances.
COLUMN_WIDTH_MEDIUM - Static variable in class org.forgerock.api.markup.asciidoc.AsciiDocTable
COLUMN_WIDTH_SMALL - Static variable in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Small column-width for use with AsciiDocTable.columnWidths(int...).
columnCell(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Inserts a column-cell.
columnCell(String, AsciiDocTableColumnStyles) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Inserts a column-cell, with a style.
columnsPerRow(int) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Sets number of columns per row, which is implicitly set by AsciiDocTable.headers(String...) and AsciiDocTable.columnWidths(int...).
columnWidths(List<Integer>) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Sets the widths for all columns-per-row, which can be a proportional integer (the default is 1) or a percentage (1 to 99).
columnWidths(int...) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Sets the widths for all columns-per-row, which can be a proportional integer (the default is 1) or a percentage (1 to 99).
CommonAuditBatchConfiguration - Class in org.forgerock.audit.batch
This class stores the common audit logging batch process configurations.
COMMONS_API_DESCRIPTION - Static variable in class org.forgerock.api.commons.CommonsApi
The api description of "frapi:common" which only contains errors so far.
CommonsApi - Class in org.forgerock.api.commons
Commons ForgeRock API description.
CommonsApi.Errors - Enum in org.forgerock.api.commons
Common api errors.
COMPARATOR - Static variable in class org.forgerock.util.Pair
Comparator for Pairs made of Comparable elements.
compare(File, File) - Method in class org.forgerock.audit.util.LastModifiedTimeFileComparator
Compare two files based on file modification time.
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.
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.
compareTo(Action) - Method in class org.forgerock.api.models.Action
Compares two strings lexicographically.
compareTo(Query) - Method in class org.forgerock.api.models.Query
Compares two queries.
compareTo(MutableUri) - Method in class org.forgerock.http.MutableUri
 
compareTo(Version) - Method in class org.forgerock.http.routing.Version
 
compareTo(LocalizableMessage) - Method in class org.forgerock.i18n.LocalizableMessage
Compares this message with the specified message for order in the default locale.
compareTo(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath
Compares this resource path with the provided resource path.
compareTo(Duration) - Method in class org.forgerock.util.time.Duration
 
compareValues(Object, Object) - Static method in class org.forgerock.util.Utils
Compare two values based on types.
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.
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))).
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.
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(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path which is a descendant of this resource path.
concat(String) - Method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path which is a descendant of this resource path.
ConditionalFilter - Class in org.forgerock.http.filter
This filter conditionally executes a delegate Filter given the result of a 'condition' function.
ConditionalFilter(Filter, boolean) - Constructor for class org.forgerock.http.filter.ConditionalFilter
Constructs a ConditionalFilter.
ConditionalFilter(Filter, AsyncFunction<ContextAndRequest, Boolean, Exception>) - Constructor for class org.forgerock.http.filter.ConditionalFilter
Constructs a ConditionalFilter.
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.
ConditionalFilterHeaplet - Class in org.forgerock.openig.filter
Creates a ConditionalFilter into a Heap environment.
ConditionalFilterHeaplet() - Constructor for class org.forgerock.openig.filter.ConditionalFilterHeaplet
 
ConditionEnforcementFilter - Class in org.forgerock.openig.filter
An ConditionEnforcementFilter makes sure that the handled Request verifies a condition.
ConditionEnforcementFilter(Expression<Boolean>) - Constructor for class org.forgerock.openig.filter.ConditionEnforcementFilter
ConditionEnforcementFilter(Expression<Boolean>, Handler) - Constructor for class org.forgerock.openig.filter.ConditionEnforcementFilter
ConditionEnforcementFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an ConditionEnforcementFilter in a heap environment.
config - Variable in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
The heaplet's object configuration object.
config - Variable in class org.forgerock.openig.heap.GenericHeaplet
The heaplet's object configuration object.
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.
configureJwksStore(String, Duration, Duration, URL) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService
Configure a JWKs store.
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.
CONFLICT_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.CONFLICT in an API Description.
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.
ConnectionConfiguration() - Constructor for class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration
 
ConnectionConfiguration() - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration
 
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
 
constantEquals(byte[], byte[]) - Static method in class org.forgerock.json.jose.utils.Utils
Compares two byte arrays for equality, in a constant time.
Constants - Class in org.forgerock.json.schema.validator
Constants is the collection of all constant values used by the object validator implementation.
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(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
contains(String) - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
contains(Object) - Method in class org.forgerock.json.JsonValue
Returns true this JSON value contains an item with the specified value.
contains(Object, Object) - Static method in class org.forgerock.openig.el.Functions
Returns true if the object contains the value.
contains(Object) - Method in class org.forgerock.openig.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(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 - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "contains" operator".
contains(Object) - Method in class org.forgerock.util.RangeSet
Returns true if this set contains the specified element.
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.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(String) - 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 interface org.forgerock.services.context.Context
Returns true if there is a context in the chain whose name matches the provided context name.
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.
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.
containsWhitespace(String) - Static method in class org.forgerock.api.util.ValidationUtil
Checks a String for whitespace.
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
Constructs a new header based on message type, charset and boundary.
ContentTypeHeader(String, String, String, Map<String, String>) - Constructor for class org.forgerock.http.header.ContentTypeHeader
Constructs a new header based on message type, charset, boundary and any additional message parameters.
CONTEXT - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Defines the context key.
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.
ContextAndRequest - Class in org.forgerock.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.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 - 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.
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 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(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`.
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`.
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.
countPolicies(CountPolicy...) - Method in class org.forgerock.api.models.Query.Builder
Set the supported page count policies.
CountPolicy - Enum in org.forgerock.api.enums
Enum that represents the Query supported count-policy.
CountPolicy - Enum in org.forgerock.json.resource
An enum of count policy types.
Create - Annotation Type in org.forgerock.api.annotations
Indicates an CREST create method on an annotated POJO.
Create - Class in org.forgerock.api.models
Class that represents the Create Operation type in API descriptor.
create() - Static method in class org.forgerock.api.models.Create
Creates a new builder for Create.
create(Create) - Method in class org.forgerock.api.models.Items.Builder
Set create.
create(Create) - Method in class org.forgerock.api.models.Resource.Builder
Set create.
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(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() - 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(Name, JsonValue, Heap) - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
 
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.doc.SampleFilter.Heaplet
Create the filter object in the heap, setting the header name and value for the filter, based on the configuration.
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.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.CryptoHeaderFilter.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.HeaderFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.HttpBasicAuthFilter.Heaplet
 
create() - Method in class org.forgerock.openig.filter.LocationHeaderFilter.Heaplet
 
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.OAuth2ResourceServerFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.OpenAmAccessTokenResolverHeaplet
 
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.SqlAttributesFilter.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.handler.ClientHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.DesKeyGenHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.DispatchHandler.Heaplet
 
create() - Method in class org.forgerock.openig.handler.router.AuditServiceObjectHeaplet
 
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(Name, JsonValue, Heap) - Method in class org.forgerock.openig.heap.GenericHeaplet
 
create() - Method in class org.forgerock.openig.heap.GenericHeaplet
Called to request the heaplet create an object.
create(Name, JsonValue, Heap) - Method in interface org.forgerock.openig.heap.Heaplet
Called to request the heaplet to create an object.
create() - Method in class org.forgerock.openig.io.TemporaryStorageHeaplet
 
create() - Method in class org.forgerock.openig.jwt.JwtSessionManager.Heaplet
 
create() - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter.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.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
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.thread.ScheduledExecutorServiceHeaplet
 
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() - 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.Builder - Class in org.forgerock.api.models
Builder for the Create.
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(ThreadFactory) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Generates a Cached Thread Pool ExecutorService which has been pre-registered with the ShutdownManager.
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() - Method in class org.forgerock.util.thread.ExecutorServiceFactory
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) - 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 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.
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.
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) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Deprecated.
ExecutorServiceFactory.createFixedThreadPool(int, String) should be used so that threads have meaningful names.
createHttpUriRequest(Request) - Method in class org.forgerock.http.apache.AbstractHttpClient
Creates a new HttpUriRequest populated from the given request.
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
 
CreateMode - Enum in org.forgerock.api.enums
Enum that represents the Create modes.
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.
createResponseWithoutEntity(HttpResponse) - Static method in class org.forgerock.http.apache.AbstractHttpClient
Creates a new Response populated from the given AHC result.
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.
CreateSingleton - Enum in org.forgerock.api.enums
Types of create that might be singletons.
createSubTransactionId() - Method in class org.forgerock.services.TransactionId
Creates a new TransactionId, child of this one.
createThreadPool(int, int, long, TimeUnit, BlockingQueue<Runnable>) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Deprecated.
createThreadPool(int, int, long, TimeUnit, BlockingQueue<Runnable>, String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
Generates a ThreadPoolExecutor with the provided values, and registers that executor as listening for shutdown messages.
CREST_PROTOCOL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The protocol field CREST value.
CrestAnySchema - Class in org.forgerock.api.jackson
An extension to the Jackson AnySchema that includes the custom CREST JSON Schema attributes.
CrestAnySchema() - Constructor for class org.forgerock.api.jackson.CrestAnySchema
 
CrestApiProducer - Class in org.forgerock.api
An ApiProducer implementation for CREST resources, that provides ApiDescription descriptors.
CrestApiProducer(String, String, LocalizableString) - Constructor for class org.forgerock.api.CrestApiProducer
Construct a new producer.
CrestApiProducer(String, String) - Constructor for class org.forgerock.api.CrestApiProducer
Construct a new producer.
CrestApplication - Interface in org.forgerock.json.resource
Declare a CREST Application.
CrestArraySchema - Class in org.forgerock.api.jackson
An extension to the Jackson ArraySchema that includes the custom CREST JSON Schema attributes.
CrestArraySchema() - Constructor for class org.forgerock.api.jackson.CrestArraySchema
 
CrestBooleanSchema - Class in org.forgerock.api.jackson
An extension to the Jackson BooleanSchema that includes the custom CREST JSON Schema attributes.
CrestBooleanSchema() - Constructor for class org.forgerock.api.jackson.CrestBooleanSchema
 
CrestHttp - Class in org.forgerock.json.resource.http
A CREST HTTP utility class which creates instances of the HttpAdapter to handle CREST HTTP requests.
CrestJsonSchemaFactory - Class in org.forgerock.api.jackson
A JsonSchemaFactory that returns the extension schema objects rather than the default Jackson implementations.
CrestJsonSchemaFactory() - Constructor for class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
CrestObjectSchema - Class in org.forgerock.api.jackson
An extension to the Jackson ObjectSchema that includes the custom CREST JSON Schema attributes.
CrestObjectSchema() - Constructor for class org.forgerock.api.jackson.CrestObjectSchema
 
CrestPolicyService - Class in org.forgerock.openig.policy.crest
The policy service implementation using CREST.
CrestPolicyService(RequestHandler) - Constructor for class org.forgerock.openig.policy.crest.CrestPolicyService
Creates a CrestPolicyService.
CrestPropertyDetailsSchemaFactoryWrapper - Class in org.forgerock.api.jackson
A SchemaFactoryWrapper that adds the extra CREST schema attributes once the Jackson schema generation has been completed.
CrestPropertyDetailsSchemaFactoryWrapper() - Constructor for class org.forgerock.api.jackson.CrestPropertyDetailsSchemaFactoryWrapper
Create a new wrapper.
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.
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
Encrypts and decrypts header fields.
CryptoHeaderFilter() - Constructor for class org.forgerock.openig.filter.CryptoHeaderFilter
 
CryptoHeaderFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a header filter in a heap environment.
CryptoHeaderFilter.Operation - Enum in org.forgerock.openig.filter
Should the filter encrypt or decrypt the given headers ?
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.
currentDateTime() - Method in class org.forgerock.audit.util.DateUtil
Get current time.

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.
data - Variable in class org.forgerock.services.context.AbstractContext
The Context data.
DateUtil - Class in org.forgerock.audit.util
Manages timestamp strings in ISO8601 format.
debug(LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(LocalizableMessage) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(LocalizableMessage, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message using the provided Marker.
debug(Marker, LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message using the provided Marker.
debug(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
debug(Marker, LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message.
debug(Marker, LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a debug message with an accompanying exception.
Decision - Class in org.forgerock.openig.policy
Represents an immutable policy decision, returned by the OpenAM policy endpoint.
Decision(String, Map<String, Boolean>, Map<String, List<String>>, Map<String, List<String>>) - Constructor for class org.forgerock.openig.policy.Decision
Creates an immutable policy decision.
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(byte[]) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded byte array.
decode(char[]) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded char array.
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.
decodeBase64(String) - Static method in class org.forgerock.openig.el.Functions
Decode the given Base64 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.
decodeFast(byte[]) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded byte array that is known to be resonably well formatted.
decodeFast(char[]) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded char array that is known to be resonably well formatted.
decodeFast(String) - Static method in class org.forgerock.util.encode.Base64
Decodes a BASE64 encoded string that is known to be resonably well formatted.
Decoder - Interface in org.forgerock.http.decoder
Decodes an HTTP message entity input stream.
decompress(CompressionAlgorithm, String) - Method in class org.forgerock.json.jose.jwe.CompressionManager
Convenience method equivalent to getCompressionHandler(compressionAlgorithm).decompress(Base64url.decode(data)).
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.
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
 
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.baseuri.BaseUriDecorator
 
decorateFilter(Filter, JsonValue, Context) - Method in class org.forgerock.openig.decoration.capture.CaptureDecorator
 
decorateFilter(Filter, JsonValue, Context) - Method in class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Decorates the provided delegate Filter instance with the provided decoratorConfig configuration.
decorateFilter(Filter, JsonValue, Context) - Method in class org.forgerock.openig.decoration.timer.TimerDecorator
 
decorateHandler(Handler, JsonValue, Context) - Method in class org.forgerock.openig.decoration.baseuri.BaseUriDecorator
 
decorateHandler(Handler, JsonValue, Context) - Method in class org.forgerock.openig.decoration.capture.CaptureDecorator
 
decorateHandler(Handler, JsonValue, Context) - Method in class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
Decorates the provided delegate Handler instance with the provided decoratorConfig configuration.
decorateHandler(Handler, JsonValue, Context) - Method in class org.forgerock.openig.decoration.timer.TimerDecorator
 
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(Key) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
Decrypts the JWE ciphertext back into a JwtClaimsSet.
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.jws.EncryptedThenSignedJwt
Decrypts the JWE so that it Claims Set can be accessed.
decryptAndVerify(Key, SigningHandler) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
Decrypts the outer JWT and then verifies the signature on the inner JWT.
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[], 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.
decryptContentEncryptionKey(Key, byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler
decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler
Decrypts the JWE Encrypted Key to produce the Content Encryption Key (CEK).
decryptRawPayload(Key) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
Decrypts and returns the raw bytes of the payload, without attempting to decode them in any way.
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.
Default - Annotation Type in org.forgerock.api.annotations
Annotation to define JSON Schema property's default-value, represented as a String.
DEFAULT - Static variable in class org.forgerock.json.schema.validator.Constants
The default field name.
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
Default cipher algorithm to be used when none is specified.
DEFAULT_AM_VERSION - Static variable in enum org.forgerock.openig.tools.OpenAmServer.OpenAmVersion
The default AM Version used by the toolkit.
DEFAULT_CASE_INSENSITIVE_FIELDS - Static variable in class org.forgerock.audit.AuditServiceConfiguration
DEFAULT_CONNECTION_TIMEOUT - Static variable in class org.forgerock.util.SimpleHTTPClient
Default connection timeout on HTTP requests from this client.
DEFAULT_COOKIE_NAME - Static variable in class org.forgerock.openig.tools.OpenAmServer
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_READ_TIMEOUT - Static variable in class org.forgerock.util.SimpleHTTPClient
Default read timeout on HTTP requests from this client.
DEFAULT_REALM_NAME - Static variable in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet
Name of the realm when none is specified in the heaplet.
DEFAULT_ROTATION_FILE_SUFFIX - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
The default file rotation suffix format.
DEFAULT_SESSION_TIMEOUT - Static variable in class org.forgerock.openig.jwt.JwtSessionManager
Default sessionTimeout duration.
DEFAULT_TMP_FILE_LIMIT - Static variable in class org.forgerock.http.io.IO
1 GiB.
DEFAULT_TMP_INIT_LENGTH - Static variable in class org.forgerock.http.io.IO
8 KiB.
DEFAULT_TMP_MEMORY_LIMIT - Static variable in class org.forgerock.http.io.IO
64 KiB.
DEFAULT_TOKEN_KEY - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
The expression which will be used for storing authorization information in the context.
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 base directory.
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(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.
defaultOptions() - Static method in class org.forgerock.util.Options
Returns a new set of options with default settings.
DefaultRateThrottlingPolicy - Class in org.forgerock.http.filter.throttling
A DefaultRateThrottlingPolicy is a delegating ThrottlingPolicy that ensures the returned ThrottlingRate is never null.
DefaultRateThrottlingPolicy(ThrottlingRate, ThrottlingPolicy) - Constructor for class org.forgerock.http.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
 
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.
defaultValue(String) - Method in class org.forgerock.api.models.Parameter.Builder
Set the parameter default value.
DefaultVersionBehaviour - Enum in org.forgerock.http.routing
The default routing behaviour to use when no Accept-API-Version is set on the request.
definitions(Definitions) - Method in class org.forgerock.api.models.ApiDescription.Builder
Set the definitions.
Definitions - Class in org.forgerock.api.models
Class that represents API descriptor Schema definitions.
definitions() - Static method in class org.forgerock.api.models.Definitions
Create a new Builder for Definitions.
DEFINITIONS - Static variable in class org.forgerock.json.schema.validator.Constants
The definitions field name.
Definitions.Builder - Class in org.forgerock.api.models
Builder to help construct the Definitions.
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
 
delegate() - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
Returns the environment delegatee.
delegate() - Method in class org.forgerock.openig.config.env.PlatformEnvironment
 
delegate() - Method in class org.forgerock.openig.config.env.UnixEnvironment
 
delegate() - Method in class org.forgerock.openig.config.env.WindowsEnvironment
 
delegate() - Method in class org.forgerock.openig.http.GatewayEnvironment
 
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
 
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 - Annotation Type in org.forgerock.api.annotations
Indicates an CREST delete method on an annotated POJO.
Delete - Class in org.forgerock.api.models
Class that represents the Delete operation type in API descriptor.
delete() - Static method in class org.forgerock.api.models.Delete
Creates a new builder for Delete.
delete(Delete) - Method in class org.forgerock.api.models.Items.Builder
Set Delete.
delete(Delete) - Method in class org.forgerock.api.models.Resource.Builder
Set Delete.
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(DeleteRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Deletes an entry from the Directory Server using the provided delete request.
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.Builder - Class in org.forgerock.api.models
Builder for the Delete.
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(FileNamingPolicy) - Method in class org.forgerock.audit.retention.DiskSpaceUsedRetentionPolicy
 
deleteFiles(FileNamingPolicy) - Method in class org.forgerock.audit.retention.FreeDiskSpaceRetentionPolicy
 
deleteFiles(FileNamingPolicy) - Method in interface org.forgerock.audit.retention.RetentionPolicy
Returns all files that should be deleted according to the policy.
deleteFiles(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).
DEPENDENCIES - Static variable in class org.forgerock.json.schema.validator.Constants
The dependencies field name.
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.
DerUtils - Class in org.forgerock.json.jose.utils
Utility methods for reading and writing DER-encoded values.
descendingOrder(JsonPointer) - Static method in class org.forgerock.json.resource.SortKey
Creates a new descending-order sort key for the provided JSON field.
descendingOrder(String) - Static method in class org.forgerock.json.resource.SortKey
Creates a new descending-order sort key for the provided JSON field.
Describable<D,R> - Interface in org.forgerock.services.descriptor
A routing component (a CHF Handler or CREST RequestHandler) can describe its API by implementing this interface.
Describable.Listener - Interface in org.forgerock.services.descriptor
Interface for listener instances.
DescribableHandler - Interface in org.forgerock.http.handler
A handler that both handles Requests, and also supports querying for API Descriptors.
describedHttpApplication(Handler, Factory<Buffer>, ApiProducer<Swagger>) - Static method in class org.forgerock.http.Applications
Create a simple DescribedHttpApplication that just returns the provided arguments from the appropriate methods.
DescribedHttpApplication - Interface in org.forgerock.http
An HttpApplication that produces OpenAPI API Descriptors.
DescribedSyncRequestHandlerAdapter - Class in org.forgerock.json.resource
Version of SynchronousRequestHandlerAdapter that exposes a described handler.
Description - Annotation Type in org.forgerock.api.annotations
Annotation to define JSON Schema property's description.
description(String) - Method in class org.forgerock.api.models.ApiDescription.Builder
Sets the description.
description(LocalizableString) - Method in class org.forgerock.api.models.ApiDescription.Builder
Sets the description.
description(LocalizableString) - Method in class org.forgerock.api.models.ApiError.Builder
Set the error description.
description(String) - Method in class org.forgerock.api.models.ApiError.Builder
Set the error description.
description(LocalizableString) - Method in class org.forgerock.api.models.Operation.Builder
Set the description.
description(String) - Method in class org.forgerock.api.models.Operation.Builder
Set the description.
description(LocalizableString) - Method in class org.forgerock.api.models.Parameter.Builder
Set the parameter description.
description(String) - Method in class org.forgerock.api.models.Parameter.Builder
Set the parameter description.
description(LocalizableString) - Method in class org.forgerock.api.models.Resource.Builder
Set the description.
description(String) - Method in class org.forgerock.api.models.Resource.Builder
Set the description.
description(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableOperation
 
description(String) - Method in class org.forgerock.api.transform.LocalizableOperation
 
description(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
description(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
description(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableTag
 
description(String) - Method in class org.forgerock.api.transform.LocalizableTag
 
DESCRIPTION - Static variable in class org.forgerock.json.schema.validator.Constants
The type field name.
DesKeyGenHandler - Class in org.forgerock.openig.handler
Creates a static response with a generated DES key.
DesKeyGenHandler() - Constructor for class org.forgerock.openig.handler.DesKeyGenHandler
 
DesKeyGenHandler.Heaplet - Class in org.forgerock.openig.handler
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.decoration.helper.DecoratorHeaplet
 
destroy() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter.Heaplet
 
destroy() - Method in class org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet
 
destroy() - Method in class org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet
 
destroy() - Method in class org.forgerock.openig.handler.ClientHandler.Heaplet
 
destroy() - Method in class org.forgerock.openig.handler.router.AuditServiceObjectHeaplet
 
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.PolicyEnforcementFilter.Heaplet
 
destroy() - Method in class org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet
 
DETAIL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The detail event payload field name.
detailsFromAnnotation(Operation, ApiDescription, Class<?>) - Method in class org.forgerock.api.models.Operation.Builder
Set all properties in the Builder using the data in the annotation.
determineRequestType(Request) - Static method in class org.forgerock.json.resource.http.HttpUtils
Determines which CREST operation (CRUDPAQ) of the incoming request.
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.
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.
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.
DirtyCollection<E> - Class in org.forgerock.openig.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.jwt.dirty.DirtyCollection
Builds a new DirtyCollection delegating to the given Collection and notifying the provided observer.
DirtyIterator<E> - Class in org.forgerock.openig.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.jwt.dirty.DirtyIterator
Builds a new DirtyIterator delegating to the given Iterator and notifying the provided observer.
DirtyListener - Interface in org.forgerock.openig.jwt.dirty
Enable observers to be notified when one or more element are removed from a Map.
DirtySet<E> - Class in org.forgerock.openig.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.jwt.dirty.DirtySet
Constructs a new set decorator, wrapping the specified set.
DISALLOW - Static variable in class org.forgerock.json.schema.validator.Constants
Deprecated.
removed in JSON schema draft 04
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.
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.
DIVISIBLEBY - Static variable in class org.forgerock.json.schema.validator.Constants
Deprecated.
renamed to multipleOf in JSON schema draft 04
DivisibleByHelper - Class in org.forgerock.json.schema.validator.helpers
This class checks a Number instance.
DivisibleByHelper() - Constructor for class org.forgerock.json.schema.validator.helpers.DivisibleByHelper
 
dn(String, Object...) - Method in class org.forgerock.openig.ldap.LdapClient
Formats an LDAP distinguished name using the provided template and attribute values.
documentTitle(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a document title.
doFilter(String, JsonValue) - Method in interface org.forgerock.audit.filter.Filter
Runs a filter on the given audit event.
doFilter(String, JsonValue) - Method in class org.forgerock.audit.filter.FilterChainBuilder.FilterChain
Runs the filters in the filter chain.
done() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder
Marks the end to the building of the JWT header.
dotNotationToJsonPointer(String) - Static method in class org.forgerock.audit.events.AuditEventHelper
Converts dotted-path field identifier to JsonPointer form.
duration() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a Duration.
Duration - Class in org.forgerock.util.time
Represents a duration in english.
Duration(Long, TimeUnit) - Constructor for class org.forgerock.util.time.Duration
Deprecated.
duration(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.util.time.Duration
Provides a Duration that represents the given duration expressed in english.

E

E_ACCESS_DENIED - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The resource owner or authorization server denied the request.
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_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_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_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.
ECDHEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Implements Elliptic Curve Diffie-Hellman (ECDH) key agreement in ephemeral-static (ECDH-ES) mode.
ECDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers
Elliptic Curve Digital Signature Algorithm (ECDSA) signing and verification.
ECDSASigningHandler(ECPrivateKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
Constructs the ECDSA signing handler for signing only.
ECDSASigningHandler(ECPublicKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
Constructs the ECDSA signing handler for verification only.
EcJWK - Class in org.forgerock.json.jose.jwk
This class implements an Elliptical Curve Json Web Key storage and manipulation class.
EcJWK(ECPublicKey, KeyUse, String) - Constructor for class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
Use the builder instead.
EcJWK(ECPublicKey, ECPrivateKey, KeyUse, String) - Constructor for class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
Use the builder instead.
EcJWK(KeyUse, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
Use the builder instead.
EcJWK(KeyUse, 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.Builder - Class in org.forgerock.json.jose.jwk
EC JWK builder.
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.
EMPTY - Static variable in class org.forgerock.i18n.LocalizableMessage
Represents an empty message string.
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 variable in class org.forgerock.util.Pair
An empty Pair.
empty() - Static method in class org.forgerock.util.Pair
Returns an empty Pair matching the required types.
enc(EncryptionMethod) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Sets the Encryption Method header parameter for this JWE.
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[], 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(byte[]) - Static method in class org.forgerock.util.encode.Base64url
Encodes the given byte array into a Base64url encoded String.
encodeBase64(String) - Static method in class org.forgerock.openig.el.Functions
Encode the given String input into Base 64.
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.
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.
encrypt(Key) - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
Wraps the signed JWT in an outer encrypted JWE envelope.
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.
EncryptedJwt - Class in org.forgerock.json.jose.jwe
A JWE implementation of the Jwt interface.
EncryptedJwt(JweHeader, JwtClaimsSet, Key) - Constructor for class org.forgerock.json.jose.jwe.EncryptedJwt
Constructs a fresh, new EncryptedJwt from the given JweHeader and JwtClaimsSet.
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.
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
Constructs a new EncryptedJwtBuilder that will use the given public key to encrypt the JWT.
EncryptedThenSignedJwt - Class in org.forgerock.json.jose.jws
An implementation of a JWS with a nested JWE as its payload.
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.
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.
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.
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 - Enum in org.forgerock.json.jose.jwe
An Enum of the possible encryption methods that can be used when encrypting a JWT.
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 OpenIG 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.
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 - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Defines the entries key.
entries(List<?>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Sets the list of auth modules used in the authentication event and their state.
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.openig.jwt.JwtCookieSession
 
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.
ENUM - Static variable in class org.forgerock.json.schema.validator.Constants
The enum field name.
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.
EnumHelper - Class in org.forgerock.json.schema.validator.helpers
This class implements "enum" validation on all types of objects as defined in the paragraph 5.19 of the JSON Schema specification.
EnumHelper(List<Object>) - Constructor for class org.forgerock.json.schema.validator.helpers.EnumHelper
Construct a new enum helper.
EnumTitle - Annotation Type in org.forgerock.api.annotations
Annotation to provide a title for a given enum value.
enumTitles(String...) - Method in class org.forgerock.api.models.Parameter.Builder
Sets enum-titles that must be the same length as Parameter.Builder.enumValues(String[]), if provided.
EnumUtil - Class in org.forgerock.openig.util
Utility class for accessing Java enum types.
enumValues(String...) - Method in class org.forgerock.api.models.Parameter.Builder
Sets enum-values that must match.
Environment - Interface in org.forgerock.openig.config
Encapsulate logic to access configuration files and other directories of the OpenIG base directory.
environment() - Method in class org.forgerock.openig.policy.PolicyRequest.Builder
Sets a list of strings to forward to OpenAM with the request for a policy decision, that represent the environment (or context) of the request.
environment(Map<String, Set<String>>) - Method in class org.forgerock.openig.policy.PolicyRequest.Builder
Sets a list of strings to forward to OpenAM with the request for a policy decision, that represent the environment (or context) of the request.
ENVIRONMENT_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve an Environment instance from the Heap.
EnvironmentDelegate - Class in org.forgerock.openig.config.env
Environment delegate, particularly useful to share a default implementation.
EnvironmentDelegate() - Constructor for class org.forgerock.openig.config.env.EnvironmentDelegate
 
EnvironmentHeap - Class in org.forgerock.openig.heap
The root Heap that includes access to the environment additional information.
EnvironmentHeap(Name, Environment) - 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(JWK) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Sets the Ephemeral Public Key header parameter for this JWE.
epk(String) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Deprecated.
equals(Object) - Method in class org.forgerock.api.models.Action
 
equals(Object) - Method in class org.forgerock.api.models.ApiDescription
 
equals(Object) - Method in class org.forgerock.api.models.ApiError
 
equals(Object) - Method in class org.forgerock.api.models.Create
 
equals(Object) - Method in class org.forgerock.api.models.Definitions
 
equals(Object) - Method in class org.forgerock.api.models.Errors
 
equals(Object) - Method in class org.forgerock.api.models.Items
 
equals(Object) - Method in class org.forgerock.api.models.Operation
 
equals(Object) - Method in class org.forgerock.api.models.Parameter
 
equals(Object) - Method in class org.forgerock.api.models.Patch
 
equals(Object) - Method in class org.forgerock.api.models.Paths
 
equals(Object) - Method in class org.forgerock.api.models.Query
 
equals(Object) - Method in class org.forgerock.api.models.Reference
 
equals(Object) - Method in class org.forgerock.api.models.Resource
 
equals(Object) - Method in class org.forgerock.api.models.Schema
 
equals(Object) - Method in class org.forgerock.api.models.Services
 
equals(Object) - Method in class org.forgerock.api.models.SubResources
 
equals(Object) - Method in class org.forgerock.api.models.VersionedPath
 
equals(Object) - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
 
equals(Object) - Method in class org.forgerock.http.filter.throttling.ThrottlingRate
 
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.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.i18n.LocalizableMessage
Returns true if the provided object is a message whose String representation is equal to the String representation of this message in the default locale.
equals(Object) - Method in class org.forgerock.json.jose.jwe.JweEncryption
 
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.filter.oauth2.client.Issuer
 
equals(Object) - Method in class org.forgerock.openig.heap.Name
 
equals(Object) - Method in class org.forgerock.openig.jwt.dirty.DirtyCollection
 
equals(Object) - Method in class org.forgerock.openig.policy.Decision
 
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.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 - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "equals" operator.
equals(Object) - Method in class org.forgerock.util.time.Duration
 
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.
error(ApiError) - Method in class org.forgerock.api.models.Operation.Builder
Sets a single supported error.
error(LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(LocalizableMessage) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(LocalizableMessage, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message using the provided Marker.
error(Marker, LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message using the provided Marker.
error(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(Marker, LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message.
error(Marker, LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an error message with an accompanying exception.
error(ValidationException) - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
Receive notification of an error.
error(ValidationException) - Method in class org.forgerock.json.schema.validator.ErrorHandler
Receive notification of an error.
error(ValidationException) - Method in class org.forgerock.json.schema.validator.FailFastErrorHandler
Receive notification of an error.
ERROR_COMPARATOR - Static variable in class org.forgerock.api.models.ApiError
ApiError Comparator, which sorts by code and description.
ERROR_ENTRY_COMPARATOR - Static variable in class org.forgerock.api.models.Errors
ApiError Map-entry Comparator, which sorts by code and description.
ERROR_MSG_ - Static variable in class org.forgerock.json.schema.validator.Constants
{}
ERROR_MSG_ADDITIONAL_PROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
Value has additional properties.
ERROR_MSG_ENUM_VIOLATION - Static variable in class org.forgerock.json.schema.validator.Constants
Value at {} does not have a value in the enumeration.
ERROR_MSG_NULL_TYPE - Static variable in class org.forgerock.json.schema.validator.Constants
Value at {} MUST be null.
ERROR_MSG_REQUIRED_PROPERTY - Static variable in class org.forgerock.json.schema.validator.Constants
Required property violation at {}.
ERROR_MSG_TYPE_MISMATCH - Static variable in class org.forgerock.json.schema.validator.Constants
Type mismatch.
ErrorHandler - Class in org.forgerock.json.schema.validator
ErrorHandler is the abstract base class for Validators.
ErrorHandler() - Constructor for class org.forgerock.json.schema.validator.ErrorHandler
 
errors(Errors) - Method in class org.forgerock.api.models.ApiDescription.Builder
Set the errors.
Errors - Class in org.forgerock.api.models
Class that represents API descriptor ApiError errors.
errors() - Static method in class org.forgerock.api.models.Errors
Create a new Builder for Errors.
errors(List<ApiError>) - Method in class org.forgerock.api.models.Operation.Builder
Set multiple supported errors.
Errors.Builder - Class in org.forgerock.api.models
Builder to help construct the Errors.
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.
eval() - Method in class org.forgerock.openig.el.Expression
Convenient method to eval an Expression that does not need a scope.
evaluate(Map<String, Object>, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate a map that may contain some values that needs to be evaluated.
evaluate(List<Object>, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate a list that may contain some String that needs to be evaluated.
evaluate(String, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate a String.
evaluate(Object, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate an Object that may contain some String that needs to be evaluated.
evaluate(Context, PolicyRequest) - Method in class org.forgerock.openig.policy.crest.CrestPolicyService
 
evaluate(Context, PolicyRequest) - Method in interface org.forgerock.openig.policy.PolicyService
Evaluates a policy request for access to a set of resources given a subject.
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.
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.
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.
evaluateKey(String, Bindings) - Static method in class org.forgerock.openig.el.Expressions
Evaluate a String.
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 - 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.
eventTopicsMetaData - Variable in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
The event topic meta data for the handler.
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.
Example - Annotation Type in org.forgerock.api.annotations
Specify an example value for the JSON schema.
exampleBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts an example-block.
ExceptionHandler<E> - Interface in org.forgerock.util.promise
A completion handler for consuming exceptions which occur during the execution of asynchronous tasks.
EXCLUSIVEMAXIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
The exclusiveMaximum field name.
EXCLUSIVEMINIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
The exclusiveMinimum field name.
execute(String, ApiDescription, Path, Path, ApiDescription...) - Static method in class org.forgerock.api.markup.ApiDocGenerator
Generates AsciiDoc documentation for a CREST API Descriptor, to an output-directory.
execute(String, ApiDescription, Path, ApiDescription...) - Static method in class org.forgerock.api.markup.ApiDocGenerator
Generates AsciiDoc documentation for a CREST API Descriptor, to a String.
execute(LocalizableString, String, String, boolean, ApiDescription, ApiDescription...) - Static method in class org.forgerock.api.transform.OpenApiTransformer
Transforms an ApiDescription into a Swagger model.
execute(ApiDescription, ApiDescription...) - Static method in class org.forgerock.api.transform.OpenApiTransformer
Transforms an ApiDescription into a Swagger model.
execute(Object, CsvContext) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler.ParseJsonValue
 
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.
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.
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.
EXPECTATION_FAILED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.EXPECTATION_FAILED in an API Description.
expectObjectFormat(JavaType) - Method in class org.forgerock.api.jackson.CrestPropertyDetailsSchemaFactoryWrapper
 
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(Throwable) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
Constructs a new exception with the specified cause.
ExpiredTokenException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
Constructs a new exception with the specified detail message and cause.
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.
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.
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(Throwable) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified cause.
ExpressionException(String, Throwable) - Constructor for exception org.forgerock.openig.el.ExpressionException
Constructs a new exception with the specified detail message and cause.
ExpressionPlugin - Interface in org.forgerock.openig.el
A plugin that contributes a node to the Expression context tree.
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.
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.
EXTENDS - Static variable in class org.forgerock.json.schema.validator.Constants
Deprecated.
removed in JSON schema draft 04
extract(Reader) - Method in class org.forgerock.openig.regex.StreamPatternExtractor
Extracts regular expression patterns from a character streams.
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_DESCRIPTION - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the error description.
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<T> - Interface in org.forgerock.util
A factory interface.
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.
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.
FailFastErrorHandler - Class in org.forgerock.json.schema.validator
FailFastErrorHandler implements the ErrorHandler in a way it re-throws the exception at first time.
FailFastErrorHandler() - Constructor for class org.forgerock.json.schema.validator.FailFastErrorHandler
 
FALSE - Static variable in class org.forgerock.util.query.QueryFilterOperators
a literal "false.
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_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.
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.
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
 
fileToUrl(File) - Static method in class org.forgerock.openig.el.Functions
Returns the String representation of the URL denoting the given file.
filter(Set<String>) - Method in class org.forgerock.audit.events.EventTopicsMetaData
Returns a new instance of EventTopicsMetaData containing only the meta-data for topics held by this object that are named within provided topics parameter.
Filter - Interface in org.forgerock.audit.filter
Interface that represents and audit filter.
Filter - Interface in org.forgerock.http
Filters the request and/or response of an HTTP exchange.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.ConditionalFilter
 
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.throttling.ThrottlingFilter
 
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.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 - Interface in org.forgerock.json.resource
An interface for implementing request handler filters.
filter(Context, Request, Handler) - Method in class org.forgerock.openig.doc.SampleFilter
Set a header in the incoming request and in the outgoing response.
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.AssignmentFilter
 
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
 
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.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.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.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.RuntimeExceptionFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.ScriptableFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.SqlAttributesFilter
 
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(String, Object...) - Method in class org.forgerock.openig.ldap.LdapClient
Formats an LDAP filter using the provided template and assertion values.
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter
 
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.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.uma.UmaResourceServerFilter
 
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.openig.tools.CachePolicyDecisionFilter
 
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
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.
FilterChainBuilder - Class in org.forgerock.audit.filter
A builder that builds a filter chain.
FilterChainBuilder() - Constructor for class org.forgerock.audit.filter.FilterChainBuilder
 
FilterChainBuilder.FilterChain - Class in org.forgerock.audit.filter
Chains together multiple filters and runs them all.
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.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.openig.tools.NotSupportedFilter
 
filtered(Handler, Filter) - Static method in class org.forgerock.http.handler.Handlers
Creates a "filtered handler" instance.
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.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.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.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 - Class in org.forgerock.audit.filter
Utility methods for creating audit event filters.
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.
Filters.FilterNames - Enum in org.forgerock.audit.filter
The filter types.
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.openig.tools.NotSupportedFilter
 
finalize() - Method in class org.forgerock.openig.ldap.LdapClient
 
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.
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}.
findJwk(Algorithm, KeyUse) - Method in class org.forgerock.json.jose.jwk.JWKSet
Search for a JWK that matches the algorithm and the key usage.
findJwk(String) - Method in class org.forgerock.json.jose.jwk.JWKSet
Search for a JWK that matches the kid.
findJwk(Algorithm, KeyUse) - Method in class org.forgerock.json.jose.jwk.store.JwksStore
Search for a JWK that matches the algorithm and the key usage.
findJwk(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStore
Search for a JWK that matches the kid.
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.
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.http.filter.throttling
An implementation of the ThrottlingPolicy that always returns the same throtlling rate.
FixedRateThrottlingPolicy(ThrottlingRate) - Constructor for class org.forgerock.http.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.
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.
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.
FORBIDDEN_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.FORBIDDEN in an API Description.
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.
forceRotation() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
Forces a rotation of the writer.
forContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets common fields from services contexts.
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(ECKey) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the standard curve that matches the given (private or public) key.
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 - Annotation Type in org.forgerock.api.annotations
Annotation to mark a JSON Schema property's format field.
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.
FORMAT - Static variable in class org.forgerock.json.schema.validator.Constants
The format field name.
FORMAT_COLOR - Static variable in class org.forgerock.json.schema.validator.Constants
color This is a CSS color (like "#FF0000" or "red"), based on CSS 2.1 [W3C.CR-CSS21-20070719].
FORMAT_DATE - Static variable in class org.forgerock.json.schema.validator.Constants
date This SHOULD be a date in the format of YYYY-MM-DD.
FORMAT_DATE_TIME - Static variable in class org.forgerock.json.schema.validator.Constants
date-time This SHOULD be a date in ISO 8601 format of YYYY-MM- DDThh:mm:ssZ in UTC time.
FORMAT_EMAIL - Static variable in class org.forgerock.json.schema.validator.Constants
email This SHOULD be an email address.
FORMAT_HOST_NAME - Static variable in class org.forgerock.json.schema.validator.Constants
host-name This SHOULD be a host-name.
FORMAT_IP_ADDRESS - Static variable in class org.forgerock.json.schema.validator.Constants
ip-address This SHOULD be an ip version 4 address.
FORMAT_IPV6 - Static variable in class org.forgerock.json.schema.validator.Constants
ipv6 This SHOULD be an ip version 6 address.
FORMAT_PHONE - Static variable in class org.forgerock.json.schema.validator.Constants
phone This SHOULD be a phone number (format MAY follow E.123).
FORMAT_REGEX - Static variable in class org.forgerock.json.schema.validator.Constants
regex A regular expression, following the regular expression specification from ECMA 262/Perl 5.
FORMAT_STYLE - Static variable in class org.forgerock.json.schema.validator.Constants
style This is a CSS style definition (like "color: red; background- color:#FFF"), based on CSS 2.1 [W3C.CR-CSS21-20070719].
FORMAT_TIME - Static variable in class org.forgerock.json.schema.validator.Constants
time This SHOULD be a time in the format of hh:mm:ss.
FORMAT_URI - Static variable in class org.forgerock.json.schema.validator.Constants
uri This value SHOULD be a URI.
FORMAT_UTC_MILLISEC - Static variable in class org.forgerock.json.schema.validator.Constants
utc-millisec This SHOULD be the difference, measured in milliseconds, between the specified time and midnight, 00:00 of January 1, 1970 UTC.
formatDate(Date) - Static method in class org.forgerock.http.header.HeaderUtil
Formats a HTTP-date using RFC 1123 format as specified in RFC 2616.
formatDateTime(DateTime) - Method in class org.forgerock.audit.util.DateUtil
Formats a given DateTime into a timestamp.
formatDateTime(Date) - Method in class org.forgerock.audit.util.DateUtil
Formats a given date into a timestamp.
formatDateTime(long) - Method in class org.forgerock.audit.util.DateUtil
Formats a given timestamp into a ISO8601 timestamp.
FormatHelper - Class in org.forgerock.json.schema.validator.helpers
This class implements "format" validation on primitive types of objects as defined in the paragraph 5.23 of the JSON Schema specification.
FormatHelper(String) - Constructor for class org.forgerock.json.schema.validator.helpers.FormatHelper
Construct a new format helper.
formatTo(Formatter, int, int, int) - Method in class org.forgerock.i18n.LocalizableMessage
Formats this message using the provided Formatter.
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).
forSignature(byte[]) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the supported curve parameters for the given signature.
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.
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_PTR - Static variable in class org.forgerock.json.JsonPatch
Path to the "from" attribute of a patch entry.
fromAnnotatedType(Class<?>, ApiDescription, SubResources) - Static method in class org.forgerock.api.models.Items
Build an Items from an annotated request handler.
fromAnnotatedType(Class<?>, Resource.AnnotatedTypeVariant, ApiDescription) - Static method in class org.forgerock.api.models.Resource
Build a Resource from an annotated request handler.
fromAnnotatedType(Class<?>, Resource.AnnotatedTypeVariant, SubResources, ApiDescription, Parameter...) - Static method in class org.forgerock.api.models.Resource
Build a Resource from an annotated request handler.
fromAnnotatedType(Class<?>, Resource.AnnotatedTypeVariant, Items, ApiDescription, Parameter...) - Static method in class org.forgerock.api.models.Resource
Build a Resource from an annotated request handler.
fromAnnotation(Action, Method, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Action
Builds an Action object using the data in the annotation.
fromAnnotation(ApiError, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.ApiError
Builds an ApiError object from the data in the annotation.
fromAnnotation(Create, boolean, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Create
Builds a Create object from the data in the annotation.
fromAnnotation(Delete, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Delete
Builds a Delete object from the data in the Delete annotation.
fromAnnotation(Class<?>, Parameter) - Static method in class org.forgerock.api.models.Parameter
Builds a Parameter object from the data in the annotation.
fromAnnotation(Patch, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Patch
Builds a Patch object from the data stored in the annotation.
fromAnnotation(Query, Method, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Query
Builds a Query object from the data stored in the annotation.
fromAnnotation(Read, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Read
Builds a Read object from the data in the read annotation.
fromAnnotation(Schema, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Schema
Builds Schema object from the data in the annotation parameter.
fromAnnotation(Update, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Update
Builds an Update object from the data stored in the annotation.
fromFile(Environment, String, String) - Static method in class org.forgerock.openig.script.Script
Loads a script having the provided content type and file name.
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
Parses the URL-encoded form entity of a request and stores them in this object.
fromRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form
Parses the query parameters of a request and stores them in this object.
fromSource(Environment, String, String...) - Static method in class org.forgerock.openig.script.Script
Loads a script having the provided content type and content.
fromSource(Environment, String, String) - Static method in class org.forgerock.openig.script.Script
Loads a script having the provided content type and content.
fromString(String) - Method in class org.forgerock.http.protocol.Form
Deprecated.
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.

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.
GATEWAY_TIMEOUT_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.GATEWAY_TIMEOUT in an API Description.
GatewayEnvironment - Class in org.forgerock.openig.http
Represents an Environment built from a webapp.
GatewayEnvironment() - Constructor for class org.forgerock.openig.http.GatewayEnvironment
Builds a new web environment.
GatewayHttpApplication - Class in org.forgerock.openig.http
Configuration class for configuring the OpenIG Gateway.
GatewayHttpApplication(Environment, JsonValue, EndpointRegistry, RunMode, MetricRegistry) - Constructor for class org.forgerock.openig.http.GatewayHttpApplication
generate(JsonValue) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler
 
generate(JsonValue) - Method in interface org.forgerock.tokenhandler.TokenHandler
Generates a new token using the state.
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
 
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, 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.
generateJWEEncryptedKey(Key, Key) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler
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.
generateMapFromJWK(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser
Provides a Map of KeyId:Keys as indicated by the JWKSet's URL.
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
 
get(String) - Method in class org.forgerock.api.models.Definitions
Gets the Schema for a given Schema-name.
get(String) - Method in class org.forgerock.api.models.Errors
Gets the ApiError for a given ApiError-name.
get(String) - Method in class org.forgerock.api.models.Paths
Gets the Path for a given Path-name.
get(String) - Method in class org.forgerock.api.models.Services
Gets the Resource for a given service-name.
get(String) - Method in class org.forgerock.api.models.SubResources
Gets the Resource for a given sub-resource name.
get(Version) - Method in class org.forgerock.api.models.VersionedPath
Gets the Resource for a given version.
get(Object) - Method in class org.forgerock.http.protocol.Headers
Rich-type friendly get method.
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.RequestCookies
 
get(Object) - Method in class org.forgerock.http.util.CaseInsensitiveMap
 
get() - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg0
Creates a localizable message.
get(T1) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg1
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg2
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2, T3) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg3
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2, T3, T4) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg4
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg5
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg6
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg7
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg8
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.Arg9
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(Object...) - Method in class org.forgerock.i18n.LocalizableMessageDescriptor.ArgN
Creates a message with arguments that will replace format specifiers in the associated format string when the message is rendered to string representation.
get(String) - Method in class org.forgerock.json.jose.jwt.JWObject
Returns the specified item 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(JsonPointer) - Method in class org.forgerock.json.JsonValue
Returns the specified child value with a pointer, relative to this value as root.
get(String) - Method in class org.forgerock.json.JsonValue
Returns the specified item value.
get(int) - Method in class org.forgerock.json.resource.ResourcePath
Returns the path element at the specified position in this resource path.
get() - Method in class org.forgerock.openig.decoration.helper.LazyReference
Resolves the encapsulated reference.
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(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(int) - Method in class org.forgerock.util.LazyList
Returns the element at the specified position in this list.
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(int) - Method in class org.forgerock.util.ListDecorator
Returns the element at the specified position in this list.
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(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.
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(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() - Method in class org.forgerock.util.promise.PromiseImpl
 
get(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
 
get(URL) - Method in class org.forgerock.util.SimpleHTTPClient
Utility method for gathering the contents of an HTTP page.
getAcceptedIssuers() - Method in class org.forgerock.openig.security.TrustAllManager
 
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.
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.api.models.Items
Getter of actions.
getActions() - Method in class org.forgerock.api.models.Resource
Getter of actions.
getActions() - Method in class org.forgerock.openig.policy.Decision
A unmodifiable map of action name keys to Boolean values that indicate whether the action is allowed true or denied false for the specified resource.
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
Returns any additional parameters in the message or an empty map if none specified.
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).
getAdvices() - Method in class org.forgerock.openig.policy.Decision
Returns an unmodifiable map of advice names to their values, if any advice is returned according to applicable policies.
getAgent() - Method in class org.forgerock.http.header.Warning
Gets the warning's agent name.
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.
getAlgorithm(String) - Static method in class org.forgerock.json.jose.jwk.JWK
Get the algorithm corresponding.
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.
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.
getAll(Class<T>) - Method in interface org.forgerock.openig.heap.Heap
Returns all objects from the heap or its parent (if any), with the specified type or an empty list if no such object exists.
getAll(Class<T>) - Method in class org.forgerock.openig.heap.HeapImpl
 
getApiErrors() - Method in class org.forgerock.api.models.Operation
Getter of the error array.
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.
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.openig.policy.Decision
Returns an unmodifiable map of attribute names to their values, if any response attributes are returned according to applicable policies.
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.
getAuthenticationId() - Method in class org.forgerock.services.context.SecurityContext
Returns the principal that the client used during authentication.
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.
getAuthorizationServer() - Method in class org.forgerock.openig.uma.UmaSharingService
Returns the UMA authorization server base Uri.
getAuthorizeEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns the authorize end-point of this issuer.
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 class org.forgerock.openig.config.env.DefaultEnvironment
 
getBaseDirectory() - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
 
getBaseDirectory() - Method in interface org.forgerock.openig.config.Environment
Returns the base directory of the OpenIG file system.
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.OpenAmServer
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.
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.VersionUtil
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.
getBundleInPreferredLocale(String, ClassLoader) - Method in class org.forgerock.util.i18n.PreferredLocales
Get a ResourceBundle using the preferred locale list and using the provided ClassLoader.
getBytes() - Method in class org.forgerock.http.protocol.Entity
Returns a byte array containing a copy of the decoded content of this entity.
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
Retrieves the number of bytes written by this writer.
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.
getCacheMissCacheTime() - Method in class org.forgerock.json.jose.jwk.store.JwksStore
Get the cache time before reload 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.BatchPublisherConfiguration
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(String) - Method in class org.forgerock.security.keystore.KeyStoreManager
Gets the certificate from the KeyStore with the given alias.
getCertificates() - Method in class org.forgerock.services.context.ClientContext
Returns the collection (possibly empty) of certificate(s) provided by the client.
getChallenges(HttpHost, HttpResponse, HttpContext) - Method in class org.forgerock.http.apache.NoAuthenticationStrategy
 
getCharacter() - Method in class org.forgerock.openig.text.Separator
Returns the character used to separate values.
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.
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.
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.
getClass(String) - Static method in class org.forgerock.http.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.http.util.Loader
Returns the class loader that should be used consistently throughout the application.
getClientId() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration
Returns the client ID of this client registration.
getCode() - Method in class org.forgerock.api.models.ApiError
Getter of the error code.
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
Returns the intended use of a cookie.
getCommentURL() - Method in class org.forgerock.http.protocol.Cookie
Returns the URL identifying the intended use of a cookie.
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 interface org.forgerock.openig.decoration.Context
Returns the heap object being decorated configuration.
getConfigDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
 
getConfigDirectory() - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
 
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.
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.
getContentType() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets the content type header parameter for this JWS.
getContext() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
Returns the context that triggered the event.
getContext() - Method in class org.forgerock.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.
getContextProperties() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration.JndiConfiguration
Gets the Jndi InitialContext properties.
getCookieName() - Method in class org.forgerock.openig.tools.OpenAmServer
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
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.
getCountPolicies() - Method in class org.forgerock.api.models.Query
Getter of the supported paging policies.
getCreate() - Method in class org.forgerock.api.models.Items
Getter of Create.
getCreate() - Method in class org.forgerock.api.models.Resource
Getter of Create.
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".
getCurve() - Method in class org.forgerock.json.jose.jwk.EcJWK
Deprecated.
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.
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.
getDateDifferenceInDays(Date, Date, Boolean) - Static method in class org.forgerock.audit.util.DateUtil
return the number of days between the two dates.
getDateUtil() - Static method in class org.forgerock.audit.util.DateUtil
Fetches a DateUtil that is set in the default timezone.
getDateUtil(String) - Static method in class org.forgerock.audit.util.DateUtil
Returns a DateUtil using a specified timezone.
getDateUtil(DateTimeZone) - Static method in class org.forgerock.audit.util.DateUtil
Creates a DateUtil using a specified timezone.
getDecision(String) - Method in class org.forgerock.openig.policy.PolicyDecision
Returns the decision for a given resource name.
getDecisions() - Method in class org.forgerock.openig.policy.PolicyDecision
Returns an unmodifiable collection of the decisions.
getDefaultValue() - Method in class org.forgerock.api.models.Parameter
Getter of the parameter's default value.
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.
getDefinition(Reference) - Method in class org.forgerock.api.util.ReferenceResolver
Gets a Definitions Schema by JSON reference.
getDefinitions() - Method in class org.forgerock.api.models.ApiDescription
Getter of definitions.
getDefinitions() - Method in class org.forgerock.api.models.Definitions
Gets a Map of schema-names to Schemas.
getDelete() - Method in class org.forgerock.api.models.Items
Getter of Delete.
getDelete() - Method in class org.forgerock.api.models.Resource
Getter of Delete.
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.
getDescription() - Method in class org.forgerock.api.models.ApiDescription
Gets description of API Descriptor.
getDescription() - Method in class org.forgerock.api.models.ApiError
Getter of the error description.
getDescription() - Method in class org.forgerock.api.models.Operation
Getter of the description.
getDescription() - Method in class org.forgerock.api.models.Parameter
Getter of the parameter description.
getDescription() - Method in class org.forgerock.api.models.Resource
Getter of description.
getDetail() - Method in exception org.forgerock.json.resource.ResourceException
Returns the additional detail which can be evaluated by applications.
getDiscard() - Method in class org.forgerock.http.protocol.Cookie
Returns true if the user agent should discard the cookie unconditionally when it terminates.
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.http.filter.throttling.ThrottlingRate
Returns the duration of the sliding window.
getEllipticCurve() - Method in class org.forgerock.json.jose.jwk.EcJWK
Gets the elliptic curve.
getEllipticCurveName() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Return the standard name of the elliptic curve definition.
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.
getEncryptionMethod() - Method in class org.forgerock.json.jose.jwe.JweHeader
Gets the Encryption Method header parameter for this JWE.
getEndOfLineSymbols() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting
Gets the end of line symbol.
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
 
getEnumTitles() - Method in class org.forgerock.api.models.Parameter
Getter of enum-titles.
getEnumValues() - Method in class org.forgerock.api.models.Parameter
Getter of required enum-values.
getEphemeralPublicKey() - Method in class org.forgerock.json.jose.jwe.JweHeader
Gets the Ephemeral Public Key header parameter for this JWE.
getError(Reference) - Method in class org.forgerock.api.util.ReferenceResolver
Gets and Errors ApiError by JSON reference.
getError() - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns the error code specifying the cause of the failure.
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.
getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestAnySchema
 
getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestArraySchema
 
getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
getErrors() - Method in class org.forgerock.api.models.ApiDescription
Getter of errors.
getErrors() - Method in class org.forgerock.api.models.Errors
Gets a Map of error-names to ApiErrors.
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.
getExample() - Method in class org.forgerock.api.jackson.CrestAnySchema
 
getExample() - Method in class org.forgerock.api.jackson.CrestArraySchema
 
getExample() - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
getExample() - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
getExample() - Method in interface org.forgerock.api.jackson.WithExampleSchema
Gets example JSON Schema field.
getException(int) - Static method in exception org.forgerock.json.resource.ResourceException
getException(int, String) - Static method in exception org.forgerock.json.resource.ResourceException
getException(int, String, Throwable) - Static method in exception org.forgerock.json.resource.ResourceException
getException() - Method in exception org.forgerock.json.schema.validator.exceptions.SchemaException
Return the embedded exception, if any.
getExceptions() - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
Returns the collected ValidationExceptions.
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.
getExtractor() - Method in class org.forgerock.openig.filter.EntityExtractFilter
Returns the regular expression patterns extractor.
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
getFileRotation() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
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(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(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(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.
getFirst() - Method in class org.forgerock.util.Pair
Returns the first element of this pair.
getFirstValue() - Method in class org.forgerock.http.protocol.Header
Gets the first value of this header instance.
getForm() - Method in class org.forgerock.http.protocol.Request
Returns a copy of the query parameters and 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.
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.
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.
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.
getHeaderAsString(String) - Method in class org.forgerock.json.resource.http.HttpContext
Returns the first value of the named HTTP request header.
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.
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
Returns the headers whose values should be processed for encryption or decryption.
getHeap() - Method in interface org.forgerock.openig.decoration.Context
Returns the heap that spawned the decorated heap object.
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.
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.
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.api.models.ApiDescription
Getter of id.
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.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.
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.openam.SsoTokenContext
Returns the info associated with this context.
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.
getInsertTimeoutSec() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Returns the timeout in seconds the duration that the queue should block while attempting to offer a new item for the queue.
getInstance() - Static method in class org.forgerock.i18n.slf4j.LocalizedLoggerFactory
Returns a localized logger factory which will create localized loggers for the default locale.
getInstance(Locale) - Static method in class org.forgerock.i18n.slf4j.LocalizedLoggerFactory
Returns a localized logger factory which will create localized loggers for the provided locale.
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.
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.
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.
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.openam.StsContext
Returns the token issued by the OpenAM STS.
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.
getItems() - Method in class org.forgerock.api.models.Resource
Getter of items.
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
getJson(InputStream) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Returns a JSON value from the provided input stream.
getJson() - Method in class org.forgerock.http.protocol.Entity
Returns the content of this entity decoded as a JSON object.
getJsonAdvices() - Method in class org.forgerock.openig.openam.PolicyDecisionContext
Returns the unmodifiable advices entry in the policy decision (never null).
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.
getJsonPointer() - Method in class org.forgerock.json.schema.validator.validators.Validator
Returns the JSON pointer locating where the validator was defined in the schema.
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.
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.
getJwkUrl() - Method in class org.forgerock.json.jose.jwk.store.JwksStore
The JWKs URI.
getJwsAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm
getJwsAlgorithm() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Returns the JwsAlgorithm that corresponds to this elliptic curve.
getJwtExpirationTimeout() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration
Returns the expiration time on or after which the ID Token MUST NOT be accepted for processing.
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.util.Indexed
Returns the unique key to index the object by.
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.
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.
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.
getKeyPassword(String) - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the key password used to unlock individual key entries.The results in the file being opened and read into memory.
getKeyPasswordFile() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the path to file that holds the password to unlock individual keys.
getKeySize() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Gets the bit length of the Content Encryption Key (CEK).
getKeyStore() - Method in class org.forgerock.security.keystore.KeyStoreManager
Gets the managed KeyStore.
getKeyStoreConfiguration(String) - Method in interface org.forgerock.security.keystore.KeyStoreConfigurationManager
Return the KeyStore configuration for the given symbolic name.
getKeyStoreConfiguration(String) - Method in class org.forgerock.security.keystore.KeyStoreConfigurationManagerImpl
 
getKeyStoreFile() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the path to the keystore.
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.
getKeyStorePassword(String) - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the keystore password.
getKeyStorePasswordFile() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the path to the file that contains the password/pin used to unlock the keystore.
getKeyStoreType() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the keystore type.
getKeyType() - Method in class org.forgerock.json.jose.jwk.JWK
Gets the kty parameter of the JWK.
getKeyType(String) - Static method in enum org.forgerock.json.jose.jwk.KeyType
Get the KeyType given a string.
getKeyUse(String) - Static method in enum org.forgerock.json.jose.jwk.KeyUse
Get the KeyUse.
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
 
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
Retrieves the last time the file was rotated.
getLastRotationTime() - Method in interface org.forgerock.audit.rotation.RotatableObject
Retrieves the last time the file was rotated.
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.
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.i18n.slf4j.LocalizedLogger
Returns the locale to which this logger will localize all log messages.
getLocales() - Method in class org.forgerock.http.header.AcceptLanguageHeader
Returns the PreferredLocales instance that represents this header.
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.
getLocalizableDescription() - Method in class org.forgerock.api.transform.LocalizableOperation
 
getLocalizableDescription() - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
getLocalizableDescription() - Method in class org.forgerock.api.transform.LocalizableTag
 
getLocalizableName() - Method in class org.forgerock.api.transform.LocalizableTag
Returns the name of a Tag, a LocalizableString.
getLocalizableTags() - Method in class org.forgerock.api.transform.LocalizableOperation
Returns the localizable tags for this operation.
getLocalizableTitle() - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
getLocalizedLogger(Class<?>) - Static method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns a localized logger which will forward log messages to an SLF4J Logger obtained by calling LoggerFactory.getLogger(Class) .
getLocalizedLogger(Logger) - Static method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns a localized logger which will forward log messages to the provided SLF4J Logger.
getLocalizedLogger(String) - Static method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns a localized logger which will forward log messages to an SLF4J Logger obtained by calling LoggerFactory.getLogger(String).
getLocalizedLogger(Class<?>) - Method in class org.forgerock.i18n.slf4j.LocalizedLoggerFactory
Returns a localized logger which will forward log messages to an SLF4J Logger obtained by calling LoggerFactory.getLogger(Class) .
getLocalizedLogger(Logger) - Method in class org.forgerock.i18n.slf4j.LocalizedLoggerFactory
Returns a localized logger which will forward log messages to the provided SLF4J Logger.
getLocalizedLogger(String) - Method in class org.forgerock.i18n.slf4j.LocalizedLoggerFactory
Returns a localized logger which will forward log messages to an SLF4J Logger obtained by calling LoggerFactory.getLogger(String).
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() - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns the underlying SLF4J Logger wrapped by this logger.
getLogger(Context) - Method in class org.forgerock.openig.decoration.helper.AbstractDecorator
Builds a logger based on the pattern <decoratorClassname>.<decoratorName>.<decoratedObjectName>.
getLoggerForThisClass() - Static method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns a localized logger with a name corresponding to calling class name.
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.
getMaxAge() - Method in class org.forgerock.http.protocol.Cookie
Returns the lifetime of the cookie, expressed in seconds.
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.BatchPublisherConfiguration
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.
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.
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 class org.forgerock.i18n.slf4j.LocalizedMarker
Returns the message embedded into this marker.
getMessage() - Method in exception org.forgerock.json.JsonValueException
Returns the detail message string of this exception.
getMessage() - Method in exception org.forgerock.json.schema.validator.exceptions.SchemaException
Return a detail message for this exception.
getMessageObject() - Method in interface org.forgerock.i18n.LocalizableException
Returns the localizable message that explains the problem that occurred.
getMessageObject() - Method in exception org.forgerock.i18n.LocalizedIllegalArgumentException
Returns the localizable message that explains the problem that occurred.
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.
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 class org.forgerock.api.models.Create
Getter of the mode.
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.
getMultipleOf() - Method in interface org.forgerock.api.jackson.MultipleOfSchema
Gets multipleOf JSON Schema field.
getName() - Method in class org.forgerock.api.models.Action
Getter of the ID.
getName() - Method in class org.forgerock.api.models.Parameter
Getter of the name of the parameter.
getName() - Method in class org.forgerock.api.transform.LocalizableTag
 
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.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.GenericHeader
 
getName() - Method in class org.forgerock.http.header.HeaderUtil.Parameter
Represents the header name.
getName() - Method in class org.forgerock.http.header.LocationHeader
 
getName() - Method in class org.forgerock.http.header.SetCookie2Header
 
getName() - Method in class org.forgerock.http.header.SetCookieHeader
 
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.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 class org.forgerock.i18n.slf4j.LocalizedLogger
Returns the name of this logger.
getName() - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
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 class org.forgerock.openig.tools.Realm
Returns the fully qualified realm's name: '/finances/employees' The returned name always starts with /, and never ends with /.
getNames() - Method in class org.forgerock.api.models.Definitions
Returns all Schema names.
getNames() - Method in class org.forgerock.api.models.Errors
Returns all ApiError names.
getNames() - Method in class org.forgerock.api.models.Paths
Returns all Path names.
getNames() - Method in class org.forgerock.api.models.Services
Returns all Services names.
getNames() - Method in class org.forgerock.api.models.SubResources
Returns all sub-resource names.
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.
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.
getNotPresent(String, String) - Static method in class org.forgerock.json.resource.AdviceWarning
Convenience method to quickly generate frequently-used error type: 100.
getNumberOfRequests() - Method in class org.forgerock.http.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
 
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.
getOperations() - Method in class org.forgerock.api.models.Patch
Getter for supported Patch operations.
getOriginalUri() - Method in class org.forgerock.http.routing.UriRouterContext
Get the original URI.
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(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() - Method in class org.forgerock.util.promise.PromiseImpl
 
getOrThrow(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
 
getOrThrowUninterruptibly() - 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(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.
getOrThrowUninterruptibly() - Method in class org.forgerock.util.promise.PromiseImpl
 
getOrThrowUninterruptibly(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
 
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.
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.
getPagingModes() - Method in class org.forgerock.api.models.Query
Getter of the paging modes.
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, 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.
getParameter(String) - Method in class org.forgerock.json.resource.http.HttpContext
Returns an unmodifiable list containing the values of the named HTTP request parameter.
getParameterAsString(String) - Method in class org.forgerock.json.resource.http.HttpContext
Returns the first value of the named HTTP request parameter.
getParameters() - Method in class org.forgerock.api.models.Operation
Getter of the parameters array.
getParameters() - Method in class org.forgerock.api.models.Resource
Getter of the parameters array.
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.filter.SqlAttributesFilter
Returns the list of parameters to evaluate and include in the execution of the prepared statement.
getParameters() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the optional parameter map used to initialize a keystore.
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.
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.
getPatch() - Method in class org.forgerock.api.models.Items
Getter of Patch.
getPatch() - Method in class org.forgerock.api.models.Resource
Getter of Patch.
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(JsonPointer, String) - Method in class org.forgerock.json.schema.validator.validators.Validator
Gets the valid JSONPath of the node or the given property.
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.
getPathParameter() - Method in class org.forgerock.api.models.Items
Get the path parameter.
getPaths() - Method in class org.forgerock.api.models.ApiDescription
Getter of paths.
getPaths() - Method in class org.forgerock.api.models.Paths
Gets a Map of path-names to Paths.
getPaths() - Method in class org.forgerock.api.models.VersionedPath
Gets a Map of versions to Resources.
getPaths() - Method in class org.forgerock.http.swagger.SwaggerExtended
 
getPatterns() - Method in class org.forgerock.openig.regex.StreamPatternExtractor
Mapping of names to regular expression patterns to extract from the stream.
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.
getPollTimeoutSec() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Returns the timeout in seconds for the worker threads to wait for a new item to be available in the queue before exiting.
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
Returns the restricted list of port(s) to which a cookie may be returned.
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, String) - Method in class org.forgerock.security.keystore.KeyStoreManager
Gets the Private Key from the KeyStore with the given alias.
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.security.keystore.MapKeyStoreParameters
Return the properties used to configure the keystore.
getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestAnySchema
 
getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestArraySchema
 
getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
getPropertyType(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.events.AuditEventHelper
Gets a AuditEvent property type.
getProtectionParameter() - Method in class org.forgerock.security.keystore.MapKeyStoreParameters
We do not expect this method to be called.
getProtocol() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration
Returns the protocol over which messages transmitted to the Syslog daemon.
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.
getProviderArg() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the provider generic argument as a string.
getProviderClass() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Get the provider class name string.
getProviderName() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
The provider string name (LDAP, JKS, etc.).
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.
getPublicKey(String) - Method in class org.forgerock.security.keystore.KeyStoreManager
Gets the Public Key from the KeyStore with the given alias.
getPublisher(InetSocketAddress, SyslogAuditEventHandlerConfiguration) - Method in enum org.forgerock.audit.handlers.syslog.TransportProtocol
Get the publisher for the given configuration.
getQueries() - Method in class org.forgerock.api.models.Resource
Getter of queries.
getQuery() - Method in class org.forgerock.http.MutableUri
Returns the path element.
getQueryableFields() - Method in class org.forgerock.api.models.Query
Getter of the queryable fields.
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 class org.forgerock.api.models.Query
Getter of the query id.
getQueryId() - Method in interface org.forgerock.json.resource.QueryRequest
Returns the query identifier for pre-defined queries.
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.
getRawAuthority() - Method in class org.forgerock.http.MutableUri
Returns the raw (encoded) authority compound element.
getRawContentInputStream() - Method in class org.forgerock.http.protocol.Entity
Returns an input stream representing the raw content of this entity.
getRawFragment() - Method in class org.forgerock.http.MutableUri
Returns the raw (encoded) fragment element.
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.
getRead() - Method in class org.forgerock.api.models.Items
Getter of Read.
getRead() - Method in class org.forgerock.api.models.Resource
Getter of Read.
getReadonly() - Method in class org.forgerock.api.jackson.CrestBooleanSchema
Gets read-only property.
getReadonly() - Method in class org.forgerock.api.jackson.CrestObjectSchema
Gets read-only property.
getReadPolicy() - Method in class org.forgerock.api.jackson.CrestAnySchema
 
getReadPolicy() - Method in class org.forgerock.api.jackson.CrestArraySchema
 
getReadPolicy() - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
getReadPolicy() - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
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.tools.OpenAmServer
Returns the realm to use with this configuration.
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.
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.
getReference() - Method in enum org.forgerock.api.commons.CommonsApi.Errors
The reference to use in an API description.
getReference() - Method in class org.forgerock.api.models.ApiError
Getter of the reference.
getReference() - Method in class org.forgerock.api.models.Resource
Gets the reference.
getReference() - Method in class org.forgerock.api.models.Schema
Getter for reference.
getReference() - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
Returns the reference to the pointed schema.
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
 
getRegisteredHandlers() - Method in interface org.forgerock.audit.AuditService
Returns the registered handlers.
getRegisteredHandlers() - Method in class org.forgerock.audit.AuditServiceProxy
 
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.
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.
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.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.api.models.Action
Getter of the request.
getRequest() - Method in class org.forgerock.http.ContextAndRequest
Returns the request.
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
 
getRequiredFields() - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
getRequiredScopes(Context, Request) - Method in interface org.forgerock.http.oauth2.ResourceAccess
Returns the scopes required to access the resource.
getResource(String) - Static method in class org.forgerock.http.util.Loader
Finds the resource with the given name.
getResource() - Method in class org.forgerock.openig.policy.Decision
Returns the resource to which apply the decision.
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 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.
getResourceSchema() - Method in class org.forgerock.api.models.Resource
Getter of resource schema.
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 class org.forgerock.api.models.Action
Getter of the response.
getResponse() - Method in exception org.forgerock.http.protocol.ResponseException
Returns the response associated to this exception.
getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestAnySchema
 
getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestArraySchema
 
getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
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.VersionUtil
Returns the revision.
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.
getSchema() - Method in class org.forgerock.api.models.ApiError
Getter of the error schema.
getSchema() - Method in class org.forgerock.api.models.Schema
Obtain the schema definition if it is not a reference.
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.
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.
getScriptDirectory(String) - Method in class org.forgerock.openig.config.env.DefaultEnvironment
 
getScriptDirectory(String) - Method in class org.forgerock.openig.config.env.EnvironmentDelegate
 
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.
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.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.
getService(Reference) - Method in class org.forgerock.api.util.ReferenceResolver
Get a Services Resource by JSON reference.
getServices() - Method in class org.forgerock.api.models.ApiDescription
Getter of services.
getServices() - Method in class org.forgerock.api.models.Services
Gets a Map of service-names to Resources.
getSession() - Method in class org.forgerock.http.session.SessionContext
Returns the Session associated with the remote client.
getSessionMode() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
Returns the mode that the JMS session should use when publishing the JMS messages.
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.
getShutdownTimeoutSec() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Returnds the timeout in seconds for the publisher to wait for all worker threads to terminate at shutdown.
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
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.
getSigningAlgorithm() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration
Returns the JWS [JWS] signingAlgorithm algorithm [JWA] that MUST be used for signing the JWT [JWT] used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods.
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.
getSource() - Method in class org.forgerock.api.models.Parameter
Getter of the parameter source.
getStability() - Method in class org.forgerock.api.models.Operation
Getter of Operation stability.
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.
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
 
getString() - Method in class org.forgerock.http.protocol.Entity
Returns 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.
getSubresources() - Method in class org.forgerock.api.models.Items
Getter of sub-resources.
getSubresources() - Method in class org.forgerock.api.models.Resource
Getter of sub-resources.
getSubResources() - Method in class org.forgerock.api.models.SubResources
Gets a Map of paths to Resources.
getSupportedLocales() - Method in class org.forgerock.api.models.Operation
Getter of the supported locales array.
getSupportedSortKeys() - Method in class org.forgerock.api.models.Query
Getter of the supported sort keys.
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.
getTags() - Method in class org.forgerock.api.transform.LocalizableOperation
 
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 class org.forgerock.openig.config.env.EnvironmentDelegate
 
getTempDirectory() - Method in interface org.forgerock.openig.config.Environment
Returns the temporary directory of OpenIG (where we have read+write permissions).
getTemplates() - Method in class org.forgerock.openig.regex.StreamPatternExtractor
Mapping of names to optional templates to use for yielding pattern match results.
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.
getThreadCount() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Returns the count of worker threads to have processing the queue.
getTimeStamp() - Static method in class org.forgerock.openig.util.VersionUtil
Returns the timestamp.
getTitle() - Method in class org.forgerock.api.models.Resource
Getter of title.
getToken() - Method in class org.forgerock.http.oauth2.AccessTokenInfo
Returns the access token identifier issued from the authorization server.
getTokenEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns the token end-point of this issuer.
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.
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.
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.
getType() - Method in class org.forgerock.api.models.Parameter
Getter of the parameter type.
getType() - Method in class org.forgerock.api.models.Query
Getter of the query type.
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.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 interface org.forgerock.openig.handler.resources.Resource
Returns the media type of this resource.
getTypeValidator(Map<String, Object>) - Static method in class org.forgerock.json.schema.validator.ObjectValidatorFactory
Returns a validator validating the schema.
getTypeValidator(Map<String, Object>, List<String>) - Static method in class org.forgerock.json.schema.validator.ObjectValidatorFactory
Returns a validator validating the schema.
getTypeValidator(String, Map<String, Object>, List<String>) - Static method in class org.forgerock.json.schema.validator.ObjectValidatorFactory
Instantiates a validator of the passed in type with the given schema.
getUnit() - Method in class org.forgerock.util.time.Duration
Returns the TimeUnit this duration is expressed in.
getUpdate() - Method in class org.forgerock.api.models.Items
Getter of Update.
getUpdate() - Method in class org.forgerock.api.models.Resource
Getter of Update.
getUri() - Method in class org.forgerock.http.protocol.Request
Returns the fully-qualified URI of the resource being accessed.
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).
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.
getValue() - Method in class org.forgerock.api.models.Reference
Getter of the JSON reference.
getValue() - Method in class org.forgerock.audit.events.AuditEvent
Returns the Json value of this event.
getValue() - Method in class org.forgerock.http.header.HeaderUtil.Parameter
Represents header value.
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.openam.SsoTokenContext
Returns the token associated with this SsoTokenContext context.
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(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, Exception>) - Method in class org.forgerock.util.PerItemEvictionStrategyCache
Borrow (and create before hand if absent) a cache entry.
getValue() - Method in class org.forgerock.util.time.Duration
Returns the number of TimeUnit this duration represents.
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.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.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.SetCookie2Header
 
getValues() - Method in class org.forgerock.http.header.SetCookieHeader
 
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.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.api.models.ApiDescription
Getter of version.
getVersion() - Method in class org.forgerock.http.protocol.Cookie
Returns the version of the state management mechanism to which this cookie conforms.
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.openig.tools.OpenAmServer
Return the version of the configured OpenAM Server.
getVersion() - Static method in class org.forgerock.openig.util.VersionUtil
Returns the OpenIG version.
getVersions() - Method in class org.forgerock.api.models.VersionedPath
Returns all resource-versions on this path.
getWarnings() - Method in class org.forgerock.http.header.WarningHeader
Gets all Warnings.
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.
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.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.
getWritePolicy() - Method in class org.forgerock.api.jackson.CrestAnySchema
 
getWritePolicy() - Method in class org.forgerock.api.jackson.CrestArraySchema
 
getWritePolicy() - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
getWritePolicy() - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
getWriter() - Method in class org.forgerock.audit.rotation.RotationContext
Get the writer.
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.
getX509Certificate(String) - Method in class org.forgerock.security.keystore.KeyStoreManager
Gets a X509Certificate from the KeyStore with the given alias.
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.
getX509Thumbnail() - Method in class org.forgerock.json.jose.jwk.JWK
Gets the X509 thumbnail.
getX509URL() - Method in class org.forgerock.json.jose.jwk.JWK
Gets the X509 URL.
getX509Url() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets the X.509 URL header parameter for this JWS.
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).
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, 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.
GONE_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.GONE in an API Description.
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.
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.
GROOVY_MIME_TYPE - Static variable in class org.forgerock.openig.script.Script
The mime-type for Groovy scripts.

H

H2 - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler
The name used for an H2 database.
H_BEARER - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The WWW-Authenticate header prefix, 'Bearer'.
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.ClientHandler
 
handle(Context, Request) - Method in class org.forgerock.openig.handler.DesKeyGenHandler
 
handle(Context, Request) - Method in class org.forgerock.openig.handler.DispatchHandler
 
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
 
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, 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 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.
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.
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.
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.
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.
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, Collection<ResourceResponse>) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler
Searches for all JSON resources matching a user specified set of criteria.
Handler - Annotation Type in org.forgerock.api.annotations
Details of a handler.
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.
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.
hasAdvices() - Method in class org.forgerock.openig.policy.Decision
Returns true if this policy decision has any advices, false otherwise.
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).
hasChildren() - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
hasCredentials() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo
Returns true if there is a set of username/password credentials defined.
hasError() - Method in class org.forgerock.json.schema.validator.CollectErrorsHandler
Get the final result of the validation.
hasError() - Method in class org.forgerock.json.schema.validator.ErrorHandler
Get the final result of the validation.
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.
hashCode() - Method in class org.forgerock.api.models.Action
 
hashCode() - Method in class org.forgerock.api.models.ApiDescription
 
hashCode() - Method in class org.forgerock.api.models.ApiError
 
hashCode() - Method in class org.forgerock.api.models.Create
 
hashCode() - Method in class org.forgerock.api.models.Definitions
 
hashCode() - Method in class org.forgerock.api.models.Errors
 
hashCode() - Method in class org.forgerock.api.models.Items
 
hashCode() - Method in class org.forgerock.api.models.Operation
 
hashCode() - Method in class org.forgerock.api.models.Parameter
 
hashCode() - Method in class org.forgerock.api.models.Patch
 
hashCode() - Method in class org.forgerock.api.models.Paths
 
hashCode() - Method in class org.forgerock.api.models.Query
 
hashCode() - Method in class org.forgerock.api.models.Reference
 
hashCode() - Method in class org.forgerock.api.models.Resource
 
hashCode() - Method in class org.forgerock.api.models.Schema
 
hashCode() - Method in class org.forgerock.api.models.Services
 
hashCode() - Method in class org.forgerock.api.models.SubResources
 
hashCode() - Method in class org.forgerock.api.models.VersionedPath
 
hashCode() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
 
hashCode() - Method in class org.forgerock.http.filter.throttling.ThrottlingRate
 
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.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.i18n.LocalizableMessage
Returns the hash code value for this message calculated using the hash code of the String representation of this message in the default locale.
hashCode() - Method in class org.forgerock.json.jose.jwe.JweEncryption
 
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.filter.oauth2.client.Issuer
 
hashCode() - Method in class org.forgerock.openig.heap.Name
 
hashCode() - Method in class org.forgerock.openig.jwt.dirty.DirtyCollection
 
hashCode() - Method in class org.forgerock.openig.policy.Decision
 
hashCode() - Method in class org.forgerock.openig.text.Separator
 
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.HeaderUtil.Parameter
Return true if the header name is not null or empty.
hasNext() - Method in class org.forgerock.openig.jwt.dirty.DirtyIterator
 
hasNext() - Method in class org.forgerock.openig.regex.StreamPatternMatches
Returns true if the character stream has more matches.
hasNext() - Method in class org.forgerock.openig.regex.StringPatternMatches
Returns true if the character sequence has more matches.
hasReferences() - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
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.
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 - Class in org.forgerock.http.protocol
An HTTP message header.
Header() - Constructor for class org.forgerock.http.protocol.Header
 
header(String, Object) - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder
Adds a custom header parameter to the JWT 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.
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(List<String>) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Sets the column headers, where blank entries can be null/empty, but the length of the headers array must be equal to the number of columns in the table.
headers(String...) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Sets the column headers, where blank entries can be null/empty, but the length of the headers array must be equal to the number of columns in the table.
HEADERS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The headers event payload field name.
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() - 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
 
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.
HeaderUtil.Parameter - Class in org.forgerock.http.header
Represents the name/value pair of a HTTP header field.
HeadlessAuthenticationFilter - Class in org.forgerock.openig.tools
Provides an OpenAM SSO Token in the given header name for downstream components.
HeadlessAuthenticationFilter(Handler, OpenAmServer, String, String) - Constructor for class org.forgerock.openig.tools.HeadlessAuthenticationFilter
Creates a HeadlessAuthenticationFilter which will provide an OpenAM 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.
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(Throwable) - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with the specified cause.
HeapException(String, Throwable) - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with the specified detail message and cause.
HeapImpl - Class in org.forgerock.openig.heap
The concrete implementation of a 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).
HeapImpl(HeapImpl, Name) - Constructor for class org.forgerock.openig.heap.HeapImpl
Builds a new heap that is a child of the given heap.
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.doc.SampleFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.AssignmentFilter.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
 
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.HeaderFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.HttpBasicAuthFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.LocationHeaderFilter.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.ScriptableAccessTokenResolver.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.ScriptableFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.SqlAttributesFilter.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.handler.ClientHandler.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.handler.DesKeyGenHandler.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.handler.DispatchHandler.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 - Interface in org.forgerock.openig.heap
Creates and initializes an object that is stored in a Heap.
Heaplet() - Constructor for class org.forgerock.openig.jwt.JwtSessionManager.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.openam.PolicyEnforcementFilter.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.security.TrustAllManager.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
 
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.
HMAC_ALGORITHM - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage
The HMAC algorithm to use.
HmacSigningHandler - Class in org.forgerock.json.jose.jws.handlers
An implementation of the SigningHandler which can sign and verify using algorithms from the HMAC family.
HmacSigningHandler(byte[]) - Constructor for class org.forgerock.json.jose.jws.handlers.HmacSigningHandler
Constructs a new HmacSigningHandler.
horizontalRule() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a horizontal-rule divider.
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.
HTTP_VERSION_NOT_SUPPORTED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.HTTP_VERSION_NOT_SUPPORTED in an API Description.
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, TimeService) - 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(Throwable) - Constructor for exception org.forgerock.http.HttpApplicationException
Constructs a new exception with the specified cause.
HttpApplicationException(String, Throwable) - Constructor for exception org.forgerock.http.HttpApplicationException
Constructs a new exception with the specified detail message and cause.
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.
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.HttpFrameworkServlet(HttpApplication, boolean), which explicitly sets the trustTransactionIdHeader field
HttpFrameworkServlet(HttpApplication, boolean) - 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.
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.

I

iat(Date) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets the time the JWT was issued at, in the Claims Set.
id(String) - Method in class org.forgerock.api.models.ApiDescription.Builder
Set the id.
ID - Static variable in class org.forgerock.json.schema.validator.Constants
The id field name.
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.
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
Throws an IllegalArgumentException if the condition parameter is false.
ifFalse(boolean, String) - Static method in class org.forgerock.util.Reject
Throws an IllegalArgumentException with a custom message if the condition parameter is false.
ifNull(Object) - 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.
ifNull(Object, String) - Static method in class org.forgerock.util.Reject
Alias for checkNotNull to be used in fluent Reject.ifNull syntax.
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.
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.
include(String...) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts an include-directive, given a relative path to a file.
INCLUDE_PATTERN - Static variable in class org.forgerock.api.markup.asciidoc.AsciiDoc
Regex for finding Include-directives, where group 1 contains the path-value.
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(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.
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.
Indexed<T> - Interface in org.forgerock.http.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(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.
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.
info(LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(LocalizableMessage) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(LocalizableMessage, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message using the provided Marker.
info(Marker, LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message using the provided Marker.
info(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
info(Marker, LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message.
info(Marker, LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs an info message with an accompanying exception.
init() - Method in class org.forgerock.http.servlet.HttpFrameworkServlet
 
init(JsonValue, String...) - Method in class org.forgerock.openig.heap.HeapImpl
Initializes the heap using the given configuration.
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 - Static variable in class org.forgerock.http.apache.NoAuthenticationStrategy
An AuthenticationStrategy singleton instance that never performs authentication.
IntDate - Class in org.forgerock.json.jose.utils
This class provides utility methods for converting Java Date objects into and from IntDates.
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.
integerSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
IntegerTypeValidator - Class in org.forgerock.json.schema.validator.validators
IntegerTypeValidator applies all the constraints of a integer type.
IntegerTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.IntegerTypeValidator
Create an integer type validator.
integerWithRadix(String, int) - Static method in class org.forgerock.openig.el.Functions
Transforms a String to an Integer.
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_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.INTERNAL_SERVER_ERROR in an API Description.
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.
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(Throwable) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException
Constructs a new exception with the specified cause.
InvalidTokenException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException
Constructs a new exception with the specified detail message and cause.
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.
ip(String) - Method in class org.forgerock.openig.policy.PolicyRequest.EnvironmentBuilder
Adds the given IP to the environment.
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.
isAdd() - Method in class org.forgerock.json.resource.PatchOperation
Returns true if this is an "add" patch operation.
isAllowed(String) - Method in class org.forgerock.openig.policy.Decision
Returns true if the requested action is allowed for this resource, false otherwise.
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.
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
 
isAuthenticationRequested(HttpHost, HttpResponse, HttpContext) - Method in class org.forgerock.http.apache.NoAuthenticationStrategy
 
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.
isBatchEnabled() - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Returns true if handling of audit events should be done in batches.
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.Utils
Check to see if a character sequence is null or blank.
isBoolean() - Method in class org.forgerock.json.JsonValue
Returns true if the JSON value is a Boolean.
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.
isCollection() - Method in class org.forgerock.json.JsonValue
Returns true if the JSON value is a Collection.
isCompatible(Object, Object) - Static method in class org.forgerock.util.Utils
Returns whether the two objects are type-compatible.
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.
isDebugEnabled() - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log debug messages.
isDebugEnabled(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log debug messages associated with the provided marker.
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.
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(String) - Static method in class org.forgerock.api.util.ValidationUtil
Determines if a String is null, or empty, or only contains whitespace.
isEmpty(Object[]) - Static method in class org.forgerock.api.util.ValidationUtil
Determines if an array is null or zero-length.
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.jwt.dirty.DirtyCollection
 
isEmpty() - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
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.
isErrorEnabled() - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log error messages.
isErrorEnabled(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log error messages associated with the provided marker.
isExternal() - Method in class org.forgerock.services.context.ClientContext
Returns true if this client is external.
isHttpOnly() - Method in class org.forgerock.http.protocol.Cookie
Returns true if the user agent should make the cookie inaccessible to client side script.
isIncrement() - Method in class org.forgerock.json.resource.PatchOperation
Returns true if this is an "increment" patch operation.
isInfoEnabled() - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log info messages.
isInfoEnabled(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log info messages associated with the provided marker.
isInformational() - Method in class org.forgerock.http.protocol.Status
Is the family of this status a Status.Family.INFORMATIONAL one ?
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.
isMvccSupported() - Method in class org.forgerock.api.models.Resource
Informs if MVCC is supported.
isNotNull() - Method in class org.forgerock.json.JsonValue
Returns true if the value is not null.
isNull() - Method in class org.forgerock.json.JsonValue
Returns true if the value is null.
isNullOrEmpty(String) - Static method in class org.forgerock.util.Utils
Check to see if the provided String is null or empty.
isNumber() - Method in class org.forgerock.json.JsonValue
Returns true if the JSON value is a Number.
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(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.
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.
isRequired() - Method in class org.forgerock.api.models.Parameter
Getter of the required property.
isRequired() - Method in class org.forgerock.json.schema.validator.validators.Validator
Returns whether the schema represented by this validator is required.
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
 
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.
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.services.context.ClientContext
Returns true if this client connection is secure.
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.
isSingleNonNull(Object...) - Static method in class org.forgerock.api.util.ValidationUtil
Checks that there is only a single single non-null argument.
isSingleton() - Method in class org.forgerock.api.models.Create
Informs if operation creates singleton resources.
isString() - Method in class org.forgerock.json.JsonValue
Returns true if the JSON value is a String.
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.Heaplet - Class in org.forgerock.openig.filter.oauth2.client
Creates and initializes an Issuer object in a heap environment.
ISSUER_KEY - Static variable in class org.forgerock.openig.filter.oauth2.client.Issuer
The key used to store this issuer in the context.
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.
isTraceEnabled() - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log trace messages.
isTraceEnabled(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log trace messages associated with the provided marker.
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
 
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.
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.
isWarnEnabled() - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log warning messages.
isWarnEnabled(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Returns true if this logger will log warning messages associated with the provided marker.
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.
isZero() - Method in class org.forgerock.util.time.Duration
Returns true if this Duration represents a zero-length duration.
italic(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts italic text.
Items - Class in org.forgerock.api.models
Class that represents the Items type in API descriptor.
items() - Static method in class org.forgerock.api.models.Items
Create a new Builder for Resoruce.
items(Items) - Method in class org.forgerock.api.models.Resource.Builder
Adds items-resource.
ITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
The items field name.
Items.Builder - Class in org.forgerock.api.models
Builder to help construct the Items.
iterator() - Method in class org.forgerock.http.util.SetDecorator
 
iterator() - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
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.jwt.dirty.DirtyCollection
 
iterator() - Method in class org.forgerock.openig.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

JacksonUtils - Class in org.forgerock.api.jackson
Some utilities for dealing with Jackson schemas.
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.
jku(URL) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the JWK Set URL header parameter for this JWS.
JmsAuditEventHandler - Class in org.forgerock.audit.handlers.jms
Publishes Audit events on a JMS Topic.
JmsAuditEventHandler(JmsContextManager, 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.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(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(String[], String) - Static method in class org.forgerock.openig.el.Functions
Joins an array of strings into a single string value, with a 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.
joinAsString(String, Object...) - Static method in class org.forgerock.util.Utils
Returns a string whose content is the string representation of the provided objects concatenated together using the provided separator.
joinAsString(String, Iterable<?>) - Static method in class org.forgerock.util.Utils
Returns a string whose content is the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
joinAsString(StringBuilder, String, Object...) - Static method in class org.forgerock.util.Utils
Appends into the provided StringBuilder the string representation of the provided objects concatenated together using the provided separator.
joinAsString(StringBuilder, String, Iterable<?>) - Static method in class org.forgerock.util.Utils
Appends into the provided StringBuilder the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
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.
JS_MIME_TYPE - Static variable in class org.forgerock.openig.script.Script
The mime-type for Javascript scripts.
Json - Class in org.forgerock.http.util
Provides read and write JSON capabilities.
json(Object) - Static method in class org.forgerock.json.JsonValue
Returns a JSON value whose content is the provided object.
json() - Method in class org.forgerock.openig.tools.OpenAmServer
Build the endpoint URI for an endpoint located in the /json namespace.
json(String) - Method in class org.forgerock.openig.tools.OpenAmServer
Build the endpoint URI for an endpoint located in the /json namespace.
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.
JSON_HYPER_SCHEMA - Static variable in class org.forgerock.json.schema.validator.Constants
The hyper schema latest draft URI.
JSON_HYPER_SCHEMA_DRAFT03 - Static variable in class org.forgerock.json.schema.validator.Constants
The hyper schema draft 03 URI.
JSON_HYPER_SCHEMA_DRAFT04 - Static variable in class org.forgerock.json.schema.validator.Constants
The hyper schema draft 04 URI.
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 thumbnail key.
JSON_KEY_X5U - Static variable in class org.forgerock.json.jose.jwk.JWK
The X509 URL key.
JSON_LINKS - Static variable in class org.forgerock.json.schema.validator.Constants
The schema links latest draft URI.
JSON_LINKS_DRAFT03 - Static variable in class org.forgerock.json.schema.validator.Constants
The schema links draft 03 URI.
JSON_LINKS_DRAFT04 - Static variable in class org.forgerock.json.schema.validator.Constants
The schema links draft 04 URI.
JSON_SCHEMA - Static variable in class org.forgerock.json.schema.validator.Constants
The schema latest draft URI.
JSON_SCHEMA_DRAFT03 - Static variable in class org.forgerock.json.schema.validator.Constants
The schema draft 03 URI.
JSON_SCHEMA_DRAFT04 - Static variable in class org.forgerock.json.schema.validator.Constants
The schema draft 04 URI.
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(Throwable) - Constructor for exception org.forgerock.json.JsonException
Constructs a new exception with the specified cause.
JsonException(String, Throwable) - Constructor for exception org.forgerock.json.JsonException
Constructs a new exception with the specified detail message and 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
Constructs a JSON pointer, identifying the root value of a JSON structure.
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.
JsonPointer(Iterable<String>) - Constructor for class org.forgerock.json.JsonPointer
Constructs a JSON pointer from an iterable collection 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.OpenAmServer
Build the endpoint URI for an endpoint located in the /json namespace.
jsonUri(String) - Method in class org.forgerock.openig.tools.OpenAmServer
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, Throwable) - Constructor for exception org.forgerock.json.JsonValueException
Constructs a new exception with the specified JSON value and cause.
JsonValueException(JsonValue, String, Throwable) - Constructor for exception org.forgerock.json.JsonValueException
Constructs a new exception with the specified JSON value, detail message and cause.
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.
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.
JsonValueFunctions - Class in org.forgerock.json
This class contains the utility functions to convert a JsonValue to another type.
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.
jwe(Key) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory
Creates a builder for building an encrypted JWT into a base64url UTF-8 encoded JWT string.
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.
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(KeyType, KeyUse, String, String) - Constructor for class org.forgerock.json.jose.jwk.JWK
Deprecated.
Use the builder instead.
JWK(KeyType, KeyUse, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.JWK
Deprecated.
Use the builder instead.
JWK(KeyType, KeyUse, 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.
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 - 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(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.
JWKSet(List<JWK>) - Constructor for class org.forgerock.json.jose.jwk.JWKSet
Construct a JWKSet from a List of JWKs.
jwkSet(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser
Provides a jwks set as indicated by the JWKSet's URL.
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(int, int) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser
Constructor allowing the configuration of the read and connection timeouts used by the HTTP client for this parser.
JWKSetParser(SimpleHTTPClient) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser
Alternative constructor allowing the calling class to pass in an already-configured SimpleHTTPClient.
JWKSetParser(SimpleHTTPClient, JWKLookup) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser
Alternative constructor allowing the calling class to pass in an already-configured SimpleHTTPClient.
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.
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
Default constructor.
JwksStoreService(int, int) - Constructor for class org.forgerock.json.jose.jwk.store.JwksStoreService
Constructor with read and connection timeout.
JwksStoreService(SimpleHTTPClient) - 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.
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.
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
Creates a builder for building a plaintext JWT into base64url UTF-8 encoded JWT string.
Jwt - Interface in org.forgerock.json.jose.jwt
The interface for all types of JSON Web Tokens (JWTs).
jwt(String) - Method in class org.forgerock.openig.policy.PolicyRequest.Builder
Sets the JWT string for the subject making the request to the protected resource..
JwtBuilder - Interface in org.forgerock.json.jose.builders
The base interface for all JwtBuilders for each type of JWT (plaintext, signed or encrypted).
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
 
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.
JwtCookieSession - Class in org.forgerock.openig.jwt
Represents an OpenIG Session that will be stored as an encrypted and signed JSON Web Token in a Cookie.
JwtCookieSession(Request, KeyPair, String, String, TimeService, Duration, boolean, SigningHandler) - Constructor for class org.forgerock.openig.jwt.JwtCookieSession
Builds a new JwtCookieSession that will manage the given Request's session.
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, SignedEncryptedJwt).
JwtReconstruction() - Constructor for class org.forgerock.json.jose.common.JwtReconstruction
 
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.
JwtSessionManager - Class in org.forgerock.openig.jwt
A JwtSessionManager is responsible to configure and create a JwtCookieSession.
JwtSessionManager(KeyPair, String, String, TimeService, Duration, boolean, SigningHandler) - Constructor for class org.forgerock.openig.jwt.JwtSessionManager
Builds a new JwtSessionManager using the given KeyPair for session encryption, storing the opaque result in a cookie with the given name.
JwtSessionManager.Heaplet - Class in org.forgerock.openig.jwt
Creates and initializes a jwt-session in a heap environment.
JwtTokenHandler - Class in org.forgerock.json.jose.tokenhandler
Token handler for creating tokens using a JWT as the store.
JwtTokenHandler(JweAlgorithm, EncryptionMethod, KeyPair, JwsAlgorithm, SigningHandler) - Constructor for class org.forgerock.json.jose.tokenhandler.JwtTokenHandler
Constructs a new JWT token handler that never expires.
JwtTokenHandler(JweAlgorithm, EncryptionMethod, KeyPair, JwsAlgorithm, SigningHandler, Optional<Long>) - Constructor for class org.forgerock.json.jose.tokenhandler.JwtTokenHandler
Constructs a new JWT token handler.
JwtType - Enum in org.forgerock.json.jose.jwt
An Enum for the possible types of JWTs.
jwtType(String) - Static method in enum org.forgerock.json.jose.jwt.JwtType
Finds the value of the String representation of the given JWT type.

K

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
Represents 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.
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.openig.jwt.JwtCookieSession
 
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.
KeyStoreBuilder - Class in org.forgerock.security.keystore
Builder class for loading key stores.
KeyStoreBuilder() - Constructor for class org.forgerock.security.keystore.KeyStoreBuilder
 
KeyStoreConfiguration - Class in org.forgerock.security.keystore
Holds the configuration required for initializing a Keystore.
KeyStoreConfiguration(String, String, String, String, String, String, String, Map<String, Object>) - Constructor for class org.forgerock.security.keystore.KeyStoreConfiguration
Create an Immutable KeyStoreConfiguration that holds keystore configuration parameters.
KeyStoreConfigurationManager - Interface in org.forgerock.security.keystore
Defines an interface to obtain KeyStoreConfiguration objects.
KeyStoreConfigurationManagerImpl - Class in org.forgerock.security.keystore
Implements a KeyStoreConfigurationManager using JSON serialization.
KeyStoreConfigurationManagerImpl(String) - Constructor for class org.forgerock.security.keystore.KeyStoreConfigurationManagerImpl
Construct a KeyStoreConfigurationManager instance.
KeyStoreConfigurationManagerImpl(InputStream) - Constructor for class org.forgerock.security.keystore.KeyStoreConfigurationManagerImpl
Construct a KeyStoreConfigurationManager instance.
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
Represents a loaded Java KeyStore.
KeyStoreHeaplet() - Constructor for class org.forgerock.openig.security.KeyStoreHeaplet
 
KeyStoreManager - Class in org.forgerock.security.keystore
A class that manages a Java Key Store and has methods for extracting out public/private keys and certificates.
KeyStoreManager(KeyStore) - Constructor for class org.forgerock.security.keystore.KeyStoreManager
Constructs an instance of the KeyStoreManager.
KeystoreManagerException - Exception in org.forgerock.security.keystore
Represents an exception from an operation using the KeyStoreManager class.
KeystoreManagerException(String) - Constructor for exception org.forgerock.security.keystore.KeystoreManagerException
Constructs a new KeystoreManagerException with the specified detail message.
KeystoreManagerException(String, Throwable) - Constructor for exception org.forgerock.security.keystore.KeystoreManagerException
Constructs a new KeystoreManagerException with the specified detail message.
KeystoreManagerException(Throwable) - Constructor for exception org.forgerock.security.keystore.KeystoreManagerException
Constructs a new KeyStoreManagerException with the specified throwable.
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.
KeyStoreType - Enum in org.forgerock.security.keystore
Deprecated.
Specify the keystore type string directly in preference to this enum, as it is extensible at runtime
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.
keyUse(KeyUse) - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Set the key use parameter of the JWK.
KeyUse - Enum in org.forgerock.json.jose.jwk
Represents the Possible KeyUse values.
kid(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the Key ID header parameter for this JWS.

L

LambdaExceptionUtils - Class in org.forgerock.util
Utility methods for interacting with lambdas that throw exceptions.
LambdaExceptionUtils.ThrowingBiFunction<T,U,R,E extends Exception> - Interface in org.forgerock.util
A throwing Consumer functional interface.
LambdaExceptionUtils.ThrowingConsumer<T,E extends Exception> - Interface in org.forgerock.util
A throwing Consumer functional interface.
LambdaExceptionUtils.ThrowingPredicate<T,E extends Exception> - Interface in org.forgerock.util
A throwing Predicate functional interface.
LambdaExceptionUtils.ThrowingSupplier<T,E extends Exception> - Interface in org.forgerock.util
A throwing Supplier functional interface.
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.
LastModifiedTimeFileComparator - Class in org.forgerock.audit.util
Compare two files based on file modification time.
LastModifiedTimeFileComparator() - Constructor for class org.forgerock.audit.util.LastModifiedTimeFileComparator
 
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.
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.
LeftValueExpression<T> - Class in org.forgerock.openig.el
A LeftValueExpression is a specialized Expression to which we can assign a value.
leftValueExpression(Class<T>) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function for transforming JsonValues to left-value expressions.
length() - Method in interface org.forgerock.http.io.Buffer
Returns the current length of the buffer.
length() - Method in class org.forgerock.i18n.LocalizableMessage
Returns the length of the String representation of this message in the default locale.
length(Locale) - Method in class org.forgerock.i18n.LocalizableMessage
Returns the length of the String representation of this message in the specified locale.
length() - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns the length of the String representation of this message builder in the default locale.
length(Locale) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns the length of the String representation of this message builder in the specified locale.
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]).
LENGTH_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.LENGTH_REQUIRED in an API Description.
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.
link(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a cross-reference link.
link(String, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a cross-reference link, with a custom xreflabel.
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.
listContinuation() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a list-continuation, for adding complex formatted content to a list.
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.
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.
listingBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a listing-block.
listingBlock(String, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a listing-block, with the source-code type (e.g., java, json, etc.) noted for formatting purposes.
listIterator() - Method in class org.forgerock.util.LazyList
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() - 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.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, 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.
literalBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a literal-block.
load(Request) - Method in interface org.forgerock.http.session.SessionManager
Loads a new Session for the given Request.
load(Class<S>, Options) - Method in interface org.forgerock.http.spi.Loader
Loads a service of the specified type.
load(Request) - Method in class org.forgerock.openig.jwt.JwtSessionManager
 
Loader - Interface in org.forgerock.http.spi
An SPI interface for implementing alternative service loading strategies.
Loader - Class in org.forgerock.http.util
Provides methods for dynamically loading classes.
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.
loadKeyStore(String) - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Initialize and load the keystore described by this configuration There are a number of possible exceptions that can be generated - they are consolidated to a single KeyStoreException and the underlying exception is wrapped.
loadKeyStore(String, ClassLoader) - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
Initialize and load the keystore described by this configuration There are a number of possible exceptions that can be generated - they are consolidated to a single KeyStoreException and the underlying exception is wrapped.
loadList(Class<E>) - Static method in class org.forgerock.http.util.Loader
Loads services of a particular type into a list.
loadMap(Class<K>, Class<V>) - Static method in class org.forgerock.http.util.Loader
Loads services of a particular type into a map.
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.
LocalizableException - Interface in org.forgerock.i18n
A mix-in interface which can be used to identify exceptions which support localization.
LocalizableMessage - Class in org.forgerock.i18n
A localizable message whose String representation can be retrieved in one or more locales.
LocalizableMessageBuilder - Class in org.forgerock.i18n
A mutable sequence of localizable messages and their parameters.
LocalizableMessageBuilder() - Constructor for class org.forgerock.i18n.LocalizableMessageBuilder
Creates a new message builder whose content is initially empty.
LocalizableMessageBuilder(LocalizableMessage) - Constructor for class org.forgerock.i18n.LocalizableMessageBuilder
Creates a new message builder whose content is initially equal to the provided message.
LocalizableMessageBuilder(LocalizableMessageBuilder) - Constructor for class org.forgerock.i18n.LocalizableMessageBuilder
Creates a new message builder whose content is initially equal to the provided message builder.
LocalizableMessageBuilder(Object) - Constructor for class org.forgerock.i18n.LocalizableMessageBuilder
Creates a new message builder whose content is initially equal to the String representation of the provided Object.
LocalizableMessageDescriptor - Class in org.forgerock.i18n
An opaque handle to a localizable message.
LocalizableMessageDescriptor.Arg0 - Class in org.forgerock.i18n
Subclass for creating messages with no arguments.
LocalizableMessageDescriptor.Arg1<T1> - Class in org.forgerock.i18n
Subclass for creating messages with one argument.
LocalizableMessageDescriptor.Arg2<T1,T2> - Class in org.forgerock.i18n
Subclass for creating messages with two arguments.
LocalizableMessageDescriptor.Arg3<T1,T2,T3> - Class in org.forgerock.i18n
Subclass for creating messages with three arguments.
LocalizableMessageDescriptor.Arg4<T1,T2,T3,T4> - Class in org.forgerock.i18n
Subclass for creating messages with four arguments.
LocalizableMessageDescriptor.Arg5<T1,T2,T3,T4,T5> - Class in org.forgerock.i18n
Subclass for creating messages with five arguments.
LocalizableMessageDescriptor.Arg6<T1,T2,T3,T4,T5,T6> - Class in org.forgerock.i18n
Subclass for creating messages with six arguments.
LocalizableMessageDescriptor.Arg7<T1,T2,T3,T4,T5,T6,T7> - Class in org.forgerock.i18n
Subclass for creating messages with seven arguments.
LocalizableMessageDescriptor.Arg8<T1,T2,T3,T4,T5,T6,T7,T8> - Class in org.forgerock.i18n
Subclass for creating messages with eight arguments.
LocalizableMessageDescriptor.Arg9<T1,T2,T3,T4,T5,T6,T7,T8,T9> - Class in org.forgerock.i18n
Subclass for creating messages with nine arguments.
LocalizableMessageDescriptor.ArgN - Class in org.forgerock.i18n
Subclass for creating messages with an any number of arguments.
LocalizableOperation - Class in org.forgerock.api.transform
Localizable Operation.
LocalizableOperation() - Constructor for class org.forgerock.api.transform.LocalizableOperation
 
LocalizableRefProperty - Class in org.forgerock.api.transform
Localizable RefProperty.
LocalizableRefProperty() - Constructor for class org.forgerock.api.transform.LocalizableRefProperty
Creates a new LocalizableRefProperty.
LocalizableRefProperty(String) - Constructor for class org.forgerock.api.transform.LocalizableRefProperty
Creates a new LocalizableRefProperty with the given JSON Reference.
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.
LocalizableTag - Class in org.forgerock.api.transform
Localizable Tag.
LocalizableTag() - Constructor for class org.forgerock.api.transform.LocalizableTag
 
LocalizedIllegalArgumentException - Exception in org.forgerock.i18n
Thrown to indicate that a method has been passed an illegal or inappropriate argument.
LocalizedIllegalArgumentException(LocalizableMessage) - Constructor for exception org.forgerock.i18n.LocalizedIllegalArgumentException
Creates a new localized illegal argument exception with the provided message.
LocalizedIllegalArgumentException(LocalizableMessage, Throwable) - Constructor for exception org.forgerock.i18n.LocalizedIllegalArgumentException
Creates a new localized illegal argument exception with the provided message and cause.
LocalizedLogger - Class in org.forgerock.i18n.slf4j
A logger implementation which formats and localizes messages before forwarding them to an underlying SLF4J Logger.
LocalizedLoggerFactory - Class in org.forgerock.i18n.slf4j
A factory of LocalizedLogger instances which obtains a SLF4J Logger by calling the appropriate LoggerFactory method and wrapping it in an instance of LocalizedLogger.
LocalizedMarker - Class in org.forgerock.i18n.slf4j
An implementation of SLF4J marker that contains a LocalizableMessage and does not allow to manage references to other markers.
LocalizedMarker(LocalizableMessage) - Constructor for class org.forgerock.i18n.slf4j.LocalizedMarker
Create a marker with provided localizable message.
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 OpenIG.
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.
LogAttachedExceptionFilter - Class in org.forgerock.openig.filter
A LogAttachedExceptionFilter prints attached exceptions to filtered responses.
LogAttachedExceptionFilter() - Constructor for class org.forgerock.openig.filter.LogAttachedExceptionFilter
 
lookup(Context, Request) - Method in class org.forgerock.http.filter.throttling.DefaultRateThrottlingPolicy
 
lookup(Context, Request) - Method in class org.forgerock.http.filter.throttling.FixedRateThrottlingPolicy
 
lookup(Context, Request) - Method in class org.forgerock.http.filter.throttling.MappedThrottlingPolicy
 
lookup(Context, Request) - Method in interface org.forgerock.http.filter.throttling.ThrottlingPolicy
Returns the ThrottlingRate that should be used for the provided request.
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.ScriptableThrottlingPolicy
 
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.

M

main(String[]) - Static method in class org.forgerock.audit.handlers.csv.CsvSecureArchiveVerifierCli
Entry point for CLI.
main(String[]) - Static method in class org.forgerock.openig.doc.SampleApplication
Start an HTTP server.
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(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.
MalformedHeaderException(Exception) - Constructor for exception org.forgerock.http.header.MalformedHeaderException
Constructs a new exception with the given cause.
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
 
MapKeyStoreParameters - Class in org.forgerock.security.keystore
Configures a keystore based on a key/value map.
MapKeyStoreParameters(Map<String, Object>) - Constructor for class org.forgerock.security.keystore.MapKeyStoreParameters
Create a MapKeyStoreParameters based on the supplied properties.
MappedThrottlingPolicy - Class in org.forgerock.http.filter.throttling
Implementation of ThrottlingPolicy backed by a Map.
MappedThrottlingPolicy(AsyncFunction<ContextAndRequest, String, Exception>, Map<String, ThrottlingRate>, ThrottlingRate) - Constructor for class org.forgerock.http.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(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.
matches(String, String) - Static method in class org.forgerock.openig.el.Functions
Returns true if the string contains the specified regular expression pattern.
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.
matchingGroups(String, String) - Static method in class org.forgerock.openig.el.Functions
Returns an array containing the matches of a regular expression pattern against a string, or null if no match is found.
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.
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.
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.
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.
MAX_SESSION_TIMEOUT - Static variable in class org.forgerock.openig.jwt.JwtSessionManager
The maximum session timeout duration, allows for an expiry time of approx 10 years (does not take leap years into consideration).
maxBatchEvents(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Sets the maximum number of events in a given batch.
MAXIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
The maximum field name.
MaximumHelper - Class in org.forgerock.json.schema.validator.helpers
Helper compares two Numbers to check the maximum constraint.
MaximumHelper(Number, boolean) - Constructor for class org.forgerock.json.schema.validator.helpers.MaximumHelper
Create a maximum helper.
MAXITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
The maxItems field name.
MAXLENGTH - Static variable in class org.forgerock.json.schema.validator.Constants
The maxLength field name.
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.
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<ApiDescription>) - Method in class org.forgerock.api.CrestApiProducer
 
merge(String, VersionedPath) - Method in class org.forgerock.api.models.Paths.Builder
Merge the path definition into the existing path definitions.
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
 
mergeParameters(List<Parameter>, Parameter...) - Static method in class org.forgerock.api.util.PathUtil
Merges Parameter values into the given parameterList, where conflicting parameter-names will be replaced, and new parameters will otherwise be added.
Message - Interface in org.forgerock.http.protocol
Elements common to requests and responses.
MessageCapture - Class in org.forgerock.openig.decoration.capture
Capture a message.
MessageCapture(Logger, boolean) - Constructor for class org.forgerock.openig.decoration.capture.MessageCapture
Builds a new MessageCapture.
MessageCapture(Logger, boolean, boolean) - Constructor for class org.forgerock.openig.decoration.capture.MessageCapture
Builds a new MessageCapture.
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.
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_NOT_ALLOWED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.METHOD_NOT_ALLOWED in an API Description.
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.
METRIC_REGISTRY_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the MetricRegistry from the Heap.
MINIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
The minimum field name.
MinimumHelper - Class in org.forgerock.json.schema.validator.helpers
Helper compares two Numbers to check the minimum constraint.
MinimumHelper(Number, boolean) - Constructor for class org.forgerock.json.schema.validator.helpers.MinimumHelper
Create a minimum helper.
MINITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
The minItems field name.
MINLENGTH - Static variable in class org.forgerock.json.schema.validator.Constants
The minLength field name.
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.
mode(CreateMode) - Method in class org.forgerock.api.models.Create.Builder
Setter for create-mode.
modify(ModifyRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Modifies an entry in the Directory Server using the provided modify request.
modify(String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Modifies an entry in the Directory Server using the provided lines of LDIF.
modifyDN(ModifyDnRequest) - Method in class org.forgerock.openig.ldap.LdapConnection
Renames an entry in the Directory Server using the provided modify DN 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.
mono(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts monospaced (e.g., code) text.
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`.
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`.
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.
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.
MultipleOf - Annotation Type in org.forgerock.api.annotations
Annotation to mark a numeric JSON Schema property's multipleOf field.
MULTIPLEOF - Static variable in class org.forgerock.json.schema.validator.Constants
The multipleOf field name.
MultipleOfSchema - Interface in org.forgerock.api.jackson
Interface defining support for multipleOf JSON Schema field.
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(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.
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).
mvccSupported(Boolean) - Method in class org.forgerock.api.models.Resource.Builder
Setter for MVCC-supported flag.
MYSQL - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler
The name used for a MySQL database.

N

name(String) - Method in class org.forgerock.api.models.Action.Builder
Set the Id.
name(String) - Method in class org.forgerock.api.models.Parameter.Builder
Set the parameter name.
name(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableTag
Sets the name of the Tag.
name(String) - Method in class org.forgerock.api.transform.LocalizableTag
 
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.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.LocationHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.SetCookie2Header
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.TransactionIdHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.WarningHeader
The name of this header.
name - Variable in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
The fully qualified name of the object to be created.
NAME - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
The name of the header that this object represents.
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 - Class in org.forgerock.openig.heap
A Name uniquely identify an object within a hierarchy.
NAME - Static variable in class org.forgerock.openig.openam.PolicyDecisionContext
Context's name.
NAME - Static variable in class org.forgerock.openig.openam.StsContext
Context's name.
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.
NEVER_EXPIRES - Static variable in class org.forgerock.http.oauth2.AccessTokenInfo
Marker for never ending tokens.
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(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(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, 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.
newApiRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests
Returns a new API request with the provided path.
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.
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() - Static method in class org.forgerock.api.models.Schema
Create a new Builder for Schema.
newBuilder(BatchConsumer) - Static method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher
Provides a new builder.
newChildProducer(String) - Method in class org.forgerock.api.CrestApiProducer
 
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
 
newCollection(Object) - Static method in class org.forgerock.json.resource.Resources
Deprecated.
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, 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, JsonValue) - Static method in class org.forgerock.json.resource.Requests
Returns a new create request with the provided resource path, and JSON content.
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(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.
newCrestApplication(RequestHandler, String) - Static method in class org.forgerock.openig.util.CrestUtil
Creates a new CrestApplication.
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.
newDeleteRequest(String) - Static method in class org.forgerock.json.resource.Requests
Returns a new delete request with the provided resource path.
newDeleteRequest(ResourcePath) - 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, 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
Constructs a new handler for signing ES256 signatures.
newEcdsaVerificationHandler(ECPublicKey) - Method in class org.forgerock.json.jose.jws.SigningManager
Constructs a new handler for verifying ES256 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.
newFilter(String, List<String>, FilterPolicy) - Static method in class org.forgerock.audit.filter.Filters
Create a new filter for of the type specified.
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
Constructs a new HmacSigningHandler.
newHttpBasicAuthenticationFilter(String, String) - Static method in class org.forgerock.http.filter.Filters
Creates an authentication Filter that put a Basic Authorization header in the request.
newHttpBasicAuthenticationFilter(String, String, 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 class org.forgerock.http.apache.async.AsyncHttpClientProvider
 
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
newHttpHandler(ConnectionFactory, Context) - Static method in class org.forgerock.json.resource.http.CrestHttp
newHttpHandler(ConnectionFactory, HttpContextFactory) - Static method in class org.forgerock.json.resource.http.CrestHttp
newHttpHandler(RequestHandler) - Static method in class org.forgerock.json.resource.http.CrestHttp
newHttpHandler(CrestApplication) - 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, HttpContextFactory) - 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
Creates a new JSON resource HTTP handler with the provided CREST request handler.
newInstance(String) - Static method in class org.forgerock.http.util.Loader
Creates a new instance of a named class.
newInstance(String, Class<T>) - Static method in class org.forgerock.http.util.Loader
Creates a new instance of a named class.
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.oauth2.ScriptableAccessTokenResolver.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(Class<?>) - Method in interface org.forgerock.openig.heap.HeapletFactory
Returns a new Heaplet instance that know how to build the given type.
newInstance(Script, Heap) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
Creates the new heap object instance using the provided script.
newInstance() - Method in interface org.forgerock.util.Factory
Creates and returns a new object instance.
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.
newline() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a UNIX newline character, where two adjacent newlines will create a new paragraph.
newList(List<String>, String...) - Method in class org.forgerock.json.schema.validator.validators.Validator
Returns a new List with the additional elements appended at the end.
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
Constructs an implementation of the SigningHandler which does not perform any signing or verifying.
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, 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, 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(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(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.
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(ResourcePath) - 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, 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
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
Constructs a new RSASigningHandler, with a SignatureUtil instance to delegate the signing and verifying calls to.
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.
newSessionFilter(SessionManager) - Static method in class org.forgerock.http.filter.Filters
Creates a session Filter that will use the provided SessionManager to manage the users session.
newSigningHandler(Key) - Method in class org.forgerock.json.jose.jws.SigningManager
Returns the signing handler from the given Key which will be used to verify the JWT.
newSigningHandler(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 sign the JWT.
newSingleton(Object) - Static method in class org.forgerock.json.resource.Resources
Deprecated.
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.Utils
Creates a new thread factory which will create threads using the specified thread group, naming template, and daemon status.
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(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.
newUpdateRequest(CreateRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a new update request built based on the provided create request.
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(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.
newValueOrFieldFilter(List<String>, FilterPolicy) - Static method in class org.forgerock.audit.filter.Filters
Create a new filter for values and fields.
newVerificationHandler(Key) - Method in class org.forgerock.json.jose.jws.SigningManager
Returns the signing handler from the given Key which will be used to verify the JWT.
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.
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.
next() - Method in class org.forgerock.openig.jwt.dirty.DirtyIterator
 
next() - Method in class org.forgerock.openig.regex.StreamPatternMatches
Returns the next match from the character stream.
next() - Method in class org.forgerock.openig.regex.StringPatternMatches
Returns the next match from the character sequence.
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.
NoAuthenticationStrategy - Class in org.forgerock.http.apache
An authentication strategy that never performs authentication.
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]).
NOOP_ROLLOVER_LIFECYCLE_HOOK - Static variable in class org.forgerock.audit.events.handlers.writers.RotatableWriter
A RotationRetentionCheckHook 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.
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
 
NOPSigningHandler - Class in org.forgerock.json.jose.jws.handlers
An implementation of the SigningHandler which does not perform any signing or verifying.
NOPSigningHandler() - Constructor for class org.forgerock.json.jose.jws.handlers.NOPSigningHandler
 
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.
normalizeName(String...) - Static method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Normalizes a name such that it can be used as a unique filename and/or anchor in AsciiDoc.
normalizePathComponent(Realm) - Method in enum org.forgerock.openig.tools.OpenAmServer.OpenAmVersion
Returns the path as it should be used in URIs based on the combination of the realm value and OpenAmServer.OpenAmVersion.
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_ACCEPTABLE_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.NOT_ACCEPTABLE in an API Description.
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_FOUND_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.NOT_FOUND in an API Description.
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.
NOT_SUPPORTED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.NOT_SUPPORTED in an API Description.
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.
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
 
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.
now() - Method in class org.forgerock.audit.util.DateUtil
Generate a formatted timestamp for the current time.
now() - Method in interface org.forgerock.util.time.TimeService
Returns a value that represents "now" since the epoch.
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.
NullRetentionHooks() - Constructor for class org.forgerock.audit.retention.RetentionHooks.NullRetentionHooks
 
nullToFalse(Boolean) - Static method in class org.forgerock.api.util.ValidationUtil
Returns false if the given Boolean parameter is null.
NullTypeValidator - Class in org.forgerock.json.schema.validator.validators
null Value MUST be null.
NullTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.NullTypeValidator
Construct a null type validator.
NUMBER_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper
Json number value type.
numberSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
NumberTypeValidator - Class in org.forgerock.json.schema.validator.validators
NumberTypeValidator applies all the constraints of a number type.
NumberTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.NumberTypeValidator
Construct a number type validator.

O

OAuth2 - Class in org.forgerock.http.oauth2
OAuth2 utility class.
oauth2(String) - Method in class org.forgerock.openig.tools.OpenAmServer
Build the endpoint URI for an endpoint located in the /oauth2 namespace.
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>>, TimeService, 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(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(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.
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.
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
 
oauth2Uri(String) - Method in class org.forgerock.openig.tools.OpenAmServer
Build the endpoint URI for an endpoint located in the /oauth2 namespace.
object(Map.Entry<String, Object>...) - Static method in class org.forgerock.json.JsonValue
Returns a JSON object comprised of the provided JSON fields.
object(int) - Static method in class org.forgerock.json.JsonValue
Produces an empty JSON object pre-allocated for size fields.
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_MAPPER - Static variable in class org.forgerock.api.jackson.JacksonUtils
A public static ObjectMapper instance, so that they do not have to be instantiated all over the place, as they are expensive to construct.
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.
objectSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
ObjectTypeValidator - Class in org.forgerock.json.schema.validator.validators
ObjectTypeValidator applies all the constraints of a object type.
ObjectTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.ObjectTypeValidator
Default ctor.
ObjectValidator - Class in org.forgerock.json.schema.validator
The ObjectValidator is a sample implementation of how to use the validator.
ObjectValidatorFactory - Class in org.forgerock.json.schema.validator
ObjectValidatorFactory initialises the validator instances for given schemas.
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.
OctJWK - Class in org.forgerock.json.jose.jwk
Creates an Octet JWK.
OctJWK(KeyUse, 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(String...) - Static method in class org.forgerock.openig.heap.Name
Builds a new Name using the given name parts.
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(F, S) - Static method in class org.forgerock.util.Pair
Creates a new Pair.
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.
OK - Static variable in class org.forgerock.http.protocol.Status
The 200 (OK) status code indicates that the request has succeeded.
onChanges(FileChangeSet) - Method in class org.forgerock.openig.handler.router.RouterHandler
 
onElementsRemoved() - Method in interface org.forgerock.openig.jwt.dirty.DirtyListener
Called when one or more element from the underlying Map are removed.
onElementsRemoved() - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
ONEOF - Static variable in class org.forgerock.json.schema.validator.Constants
The oneOf field name.
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.
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
An OpenAmAccessTokenResolver knows how to resolve a given token identifier against an OpenAm instance.
OpenAmAccessTokenResolver(Handler, TimeService, String) - Constructor for class org.forgerock.http.oauth2.resolver.OpenAmAccessTokenResolver
Creates a new OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo OpenAm endpoint.
OpenAmAccessTokenResolverHeaplet - Class in org.forgerock.openig.filter.oauth2
Creates and initializes an OpenAmAccessTokenResolver in a heap environment.
OpenAmAccessTokenResolverHeaplet() - Constructor for class org.forgerock.openig.filter.oauth2.OpenAmAccessTokenResolverHeaplet
 
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
 
OpenAmServer - Class in org.forgerock.openig.tools
Creates a configuration class for the OpenAM Server.
OpenAmServer(String, String) - Constructor for class org.forgerock.openig.tools.OpenAmServer
Creates a configuration for the OpenAM server using default 'iPlanetDirectoryPro' cookie header name.
OpenAmServer(String, String, String, OpenAmServer.OpenAmVersion) - Constructor for class org.forgerock.openig.tools.OpenAmServer
Creates a configuration for the OpenAM server.
OpenAmServer(URI, String, String) - Constructor for class org.forgerock.openig.tools.OpenAmServer
Creates a configuration for the OpenAM server.
OpenAmServer(URI, Realm, String, OpenAmServer.OpenAmVersion) - Constructor for class org.forgerock.openig.tools.OpenAmServer
Creates a configuration for the OpenAM server.
OpenAmServer.OpenAmVersion - Enum in org.forgerock.openig.tools
The version of the OpenAM server being used by this instance.
OpenApiHelper - Class in org.forgerock.api.transform
Helper methods for applying commonly needed changes to the Swagger model.
OpenApiHelper.OperationVisitor - Interface in org.forgerock.api.transform
Visits a Swagger Operation.
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
 
OpenApiTransformer - Class in org.forgerock.api.transform
Transforms an ApiDescription into an OpenAPI/Swagger model.
OPENIG_JWT_SESSION - Static variable in class org.forgerock.openig.jwt.JwtCookieSession
Name of the cookie that will store the JWT session.
Operation - Annotation Type in org.forgerock.api.annotations
The common details of an operation.
Operation - Class in org.forgerock.api.models
Class that represents the Operation type in API descriptor.
Operation(Operation.Builder) - Constructor for class org.forgerock.api.models.Operation
Protected constructor of the Operation.
OPERATION - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The operation event payload field name.
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(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.Builder<T extends Operation.Builder<T>> - Class in org.forgerock.api.models
Builder to help construct the Operation.
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.
operations(PatchOperation...) - Method in class org.forgerock.api.models.Patch.Builder
Setter for supported Patch-operations.
operations(Operation...) - Method in class org.forgerock.api.models.Resource.Builder
Allocates the operations given in the parameter by their type.
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_HOSTNAME_VERIFIER - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies the SSL host name verification policy.
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_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 an 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_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.
OPTION_WORKER_THREADS - Static variable in class org.forgerock.http.apache.async.AsyncHttpClientProvider
Specify the number of worker threads.
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.
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(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(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.
ordinal() - Method in class org.forgerock.i18n.LocalizableMessage
Returns the ordinal associated with this message, or -1 if undefined.
org.forgerock.api - package org.forgerock.api
ForgeRock API Descriptor models, builders, and utilities.
org.forgerock.api.annotations - package org.forgerock.api.annotations
Annotations that can be used to specify information to be included in the API Descriptor.
org.forgerock.api.commons - package org.forgerock.api.commons
Data related to ForgeRock Commons API Descriptor.
org.forgerock.api.enums - package org.forgerock.api.enums
API descriptor enums.
org.forgerock.api.jackson - package org.forgerock.api.jackson
Extensions to Jackson's JSON Schema to support the API Descriptor extensions to standard JSON Schema.
org.forgerock.api.markup - package org.forgerock.api.markup
Classes that generate CREST API Descriptor documentation.
org.forgerock.api.markup.asciidoc - package org.forgerock.api.markup.asciidoc
AsciiDoc markup builder.
org.forgerock.api.models - package org.forgerock.api.models
ForgeRock API Descriptor models.
org.forgerock.api.transform - package org.forgerock.api.transform
Classes that transform ApiDescription into different API representations.
org.forgerock.api.util - package org.forgerock.api.util
API Descriptor utility classes.
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.apache - package org.forgerock.http.apache
Base classes for Apache HttpClient (synchronous and asynchronous) HttpClientProvider implementations.
org.forgerock.http.apache.async - package org.forgerock.http.apache.async
Provides HttpClientHandler client integration with Apache HttpComponents Http Async Client.
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.throttling - package org.forgerock.http.filter.throttling
This package contains the components used to implement a throttling rate support.
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.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.i18n - package org.forgerock.i18n
A common framework for embedding localizable messages in applications.
org.forgerock.i18n.slf4j - package org.forgerock.i18n.slf4j
This package provides an alternative localization mechanism to org.slf4j.cal10n.
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.json.schema.validator - package org.forgerock.json.schema.validator
These classes are the commonly used classes from other applications.
org.forgerock.json.schema.validator.exceptions - package org.forgerock.json.schema.validator.exceptions
Schema validator exceptions.
org.forgerock.json.schema.validator.helpers - package org.forgerock.json.schema.validator.helpers
These classes are capable of helping the validators to check certain constraints.
org.forgerock.json.schema.validator.validators - package org.forgerock.json.schema.validator.validators
These classes are capable of validating the objects against the initially loaded schema.
org.forgerock.openig.alias - package org.forgerock.openig.alias
Service Provider interface for registering type aliases.
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.doc - package org.forgerock.openig.doc
Files for the Sample Application used in the product documentation.
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.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.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
OpenIG 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.jwt - package org.forgerock.openig.jwt
Provides JWT capabilities to OpenIG.
org.forgerock.openig.jwt.dirty - package org.forgerock.openig.jwt.dirty
Set of collection delegating classes to observes whenever a Map element is removed.
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
OpenAM-specific integration classes.
org.forgerock.openig.policy - package org.forgerock.openig.policy
Service API for performing policy decisions.
org.forgerock.openig.policy.crest - package org.forgerock.openig.policy.crest
CREST policy service integration classes.
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.security - package org.forgerock.openig.security
Provides heap objects for security related types (KeyStore, KeyManagerFactory, ...).
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.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.security.keystore - package org.forgerock.security.keystore
This package contains classes that load, initialize, and access a managed keystore.
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 and Base64Url 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(Throwable) - Constructor for exception org.forgerock.http.io.OverflowException
Constructs a new exception with the specified cause.
OverflowException(String, Throwable) - Constructor for exception org.forgerock.http.io.OverflowException
Constructs a new exception with the specified detail message and cause.

P

PagingMode - Enum in org.forgerock.api.enums
Enum that represents the Query paging mode.
pagingModes(PagingMode...) - Method in class org.forgerock.api.models.Query.Builder
Set the paging mode.
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_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 filed.
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.
Parameter - Annotation Type in org.forgerock.api.annotations
A extra parameter to an operation.
parameter(Parameter) - Method in class org.forgerock.api.models.Operation.Builder
Sets a single supported parameters.
Parameter - Class in org.forgerock.api.models
Class that represents the Parameter type in API descriptor.
parameter() - Static method in class org.forgerock.api.models.Parameter
New parameter builder.
parameter(Parameter) - Method in class org.forgerock.api.models.Resource.Builder
Sets a single supported parameter.
Parameter.Builder - Class in org.forgerock.api.models
Builder to construct Parameter object.
parameters(List<Parameter>) - Method in class org.forgerock.api.models.Operation.Builder
Set multiple supported parameters.
parameters(List<Parameter>) - Method in class org.forgerock.api.models.Resource.Builder
Set multiple supported parameters.
ParameterSource - Enum in org.forgerock.api.enums
Enum that represents where the Parameter comes from.
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(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(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(Object) - Method in class org.forgerock.http.header.HeaderFactory
Create a header instance from a provided object representation.
parse(String) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Parses a JWK from a string json object.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Parses a JWK from a JsonValue json object.
parse(String) - Static method in class org.forgerock.json.jose.jwk.JWK
Parses a String into the proper JWK type.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.JWK
Parses a JsonValue 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(JsonValue) - Static method in class org.forgerock.json.jose.jwk.JWKSet
Parses a JWKSet object from a jsonValue object.
parse(String) - Static method in class org.forgerock.json.jose.jwk.OctJWK
Parses a OctJWK object from a string json object.
parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.OctJWK
Parses a OctJWK object from a jsonValue object.
parse(String) - Static method in class org.forgerock.json.jose.jwk.RsaJWK
Parses a RsaJWK from a json string.
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.
parse(String) - Static method in class org.forgerock.json.resource.QueryFilters
Parses the provided query string into a QueryFilter.
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.
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.
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.
parseIfDate(String) - Method in class org.forgerock.audit.util.DateUtil
Parses an ISO8601 compliant timestamp into a DateTime object.
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
 
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(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.
parseMultiValuedHeader(String) - Static method in class org.forgerock.http.header.HeaderUtil
Parses the header content as a multi-valued comma separated value.
parseOpenAmVersion(String) - Static method in enum org.forgerock.openig.tools.OpenAmServer.OpenAmVersion
For the given version string, return the corresponding OpenAmServer.OpenAmVersion enum value.
parseParameter(String) - Static method in class org.forgerock.http.header.HeaderUtil
Splits a single HTTP header parameter name and value from an input string value.
parseParameters(Collection<String>) - Static method in class org.forgerock.http.header.HeaderUtil
Parses a set of HTTP header parameters from a collection of values.
parseRealm(String) - Static method in class org.forgerock.openig.tools.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.
parseTimestamp(String) - Method in class org.forgerock.audit.util.DateUtil
Parses an ISO8601 compliant timestamp into a DateTime object.
passthroughBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a pass-through-block.
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 - Annotation Type in org.forgerock.api.annotations
Indicates an CREST patch method on an annotated POJO.
patch(Patch) - Method in class org.forgerock.api.models.Items.Builder
Set Patch.
Patch - Class in org.forgerock.api.models
Class that represents the Patch operation type in API descriptor.
patch() - Static method in class org.forgerock.api.models.Patch
Creates a new builder for Patch.
patch(Patch) - Method in class org.forgerock.api.models.Resource.Builder
Set Patch.
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(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(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.Builder - Class in org.forgerock.api.models
Builder to help construct the Patch.
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, 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
 
patchInstance(Context, String, PatchRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
PatchOperation - Enum in org.forgerock.api.enums
Represents all Patch operations.
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 - Annotation Type in org.forgerock.api.annotations
Allocate a path to a component.
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.
pathParameter(Parameter) - Method in class org.forgerock.api.models.Items.Builder
Sets the path parameter for this resource.
paths(Paths) - Method in class org.forgerock.api.models.ApiDescription.Builder
Set the paths.
Paths - Class in org.forgerock.api.models
Class that represents the Paths type in API descriptor.
paths() - Static method in class org.forgerock.api.models.Paths
Create a new Builder for Paths.
Paths - Class in org.forgerock.http.util
Utilities for manipulating paths.
Paths.Builder - Class in org.forgerock.api.models
Builder to help construct the Paths.
PathsModule - Class in org.forgerock.api.jackson
Jackson Module that adds a serializer modifier for Paths.
PathsModule() - Constructor for class org.forgerock.api.jackson.PathsModule
Default constructor.
pathToUrl(String) - Static method in class org.forgerock.openig.el.Functions
Returns the String representation of the URL denoting the given path.
PathUtil - Class in org.forgerock.api.util
Utilities for working with API Description paths and path-parameters.
pattern() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a regular expression pattern.
PATTERN - Static variable in class org.forgerock.json.schema.validator.Constants
The pattern field name.
PATTERNPROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
The patternProperties field name.
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.
PAYMENT_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.PAYMENT_REQUIRED in an API Description.
PerItemEvictionStrategyCache<K,V> - Class in org.forgerock.util
PerItemEvictionStrategyCache is a thread-safe write-through cache.
PerItemEvictionStrategyCache(ScheduledExecutorService, Duration) - Constructor for class org.forgerock.util.PerItemEvictionStrategyCache
Build a new PerItemEvictionStrategyCache using the given scheduled executor.
PerItemEvictionStrategyCache(ScheduledExecutorService, AsyncFunction<V, Duration, Exception>) - 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.
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 BranchingInputStream.
PipeBufferedStream() - Constructor for class org.forgerock.http.io.PipeBufferedStream
Constructs a new PipeBufferedStream with a default Factory.
PipeBufferedStream(Factory<Buffer>) - Constructor for class org.forgerock.http.io.PipeBufferedStream
Constructs a new PipeBufferedStream with the given Factory.
PlatformEnvironment - Class in org.forgerock.openig.config.env
Delegates to a unix or windows type environment depending on the OS.
PlatformEnvironment() - Constructor for class org.forgerock.openig.config.env.PlatformEnvironment
Builds a new platform specific Environment depending on the os.name system property.
pointer() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a JSON pointer.
PolicyDecision - Class in org.forgerock.openig.policy
Represents a immutable policy decision response from the OpenAM policy endpoint.
PolicyDecision(Decision...) - Constructor for class org.forgerock.openig.policy.PolicyDecision
Builds an immutable policy decision based on the given decisions list, not null.
PolicyDecision(List<Decision>) - Constructor for class org.forgerock.openig.policy.PolicyDecision
Builds an immutable policy decision based on the given decisions list, not null.
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 OpenAM 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) - Constructor for class org.forgerock.openig.openam.PolicyEnforcementFilter
Creates a new OpenAM enforcement filter.
PolicyEnforcementFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initializes a policy enforcement filter in a heap environment.
PolicyException - Exception in org.forgerock.openig.policy
When the policy can't be evaluated, this exception could be thrown.
PolicyException(String) - Constructor for exception org.forgerock.openig.policy.PolicyException
Builds an PolicyException with a given message.
PolicyException(String, Throwable) - Constructor for exception org.forgerock.openig.policy.PolicyException
Builds an PolicyException with a given message and cause.
PolicyRequest - Class in org.forgerock.openig.policy
Represents a policy request to the OpenAM policy endpoint.
PolicyRequest.Builder - Class in org.forgerock.openig.policy
A utility class to build a PolicyRequest.
PolicyRequest.EnvironmentBuilder - Class in org.forgerock.openig.policy
Utility class to build the environment field.
PolicyService - Interface in org.forgerock.openig.policy
A PolicyService is a service that interacts with OpenAM's policy endpoint in order to obtain policy decisions.
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.
pop() - Method in class org.forgerock.http.protocol.Entity
Restores the underlying input stream to the state it had immediately before the last call to Entity.push().
PORT - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The port event payload field name.
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.
PRECONDITION_FAILED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.PRECONDITION_FAILED in an API Description.
PRECONDITION_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.PRECONDITION_REQUIRED in an API Description.
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.
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(List<Locale>) - Constructor for class org.forgerock.util.i18n.PreferredLocales
Create a new preference of locales by copying the provided locales list.
PreferredLocales() - Constructor for class org.forgerock.util.i18n.PreferredLocales
Create a new, empty preference of locales.
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.
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 - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Defines the principal key.
principal(List<String>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Sets the principals of the authentication event.
PrincipalResolver - Class in org.forgerock.openig.resolver
Resolves Principal objects.
PrincipalResolver() - Constructor for class org.forgerock.openig.resolver.PrincipalResolver
 
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.
ProductInfoProvider - Interface in org.forgerock.audit.providers
Strategy for obtaining the information relating to the product in which the AuditService is deployed.
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.
PROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
The properties field name.
PropertyOrder - Annotation Type in org.forgerock.api.annotations
Annotation to provide a property order for a given object property.
PropertyPolicies - Annotation Type in org.forgerock.api.annotations
An annotation to declare the policies for property access in the CREST API Descriptor schema elements.
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.
PROXY_AUTH_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.PROXY_AUTH_REQUIRED in an API Description.
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.
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.
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(Iterable<String>) - Static method in class org.forgerock.json.JsonPointer
Constructs a JSON pointer from an iterable collection of reference tokens.
publish(T) - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
Offers the message to the queue.
publish(T) - Method in interface org.forgerock.audit.handlers.jms.Publisher
implement this to deliver the audit event representation to the service.
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.splunk.SplunkAuditEventHandler
 
Publisher<T> - Interface in org.forgerock.audit.handlers.jms
Defines a generic interface for audit event publishers.
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
Converts the audit event into a JMS TextMessage and then publishes the message on the configured jmsTopic.
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
 
publishMessages(List<T>) - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
This is invoked by the worker threads to have the passed in messages published immediately.
publishSingleEvent(String, JsonValue) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Publishes a single event to the provided topic.
push() - Method in class org.forgerock.http.protocol.Entity
Saves the current position of the underlying input stream and creates a new buffered input stream.
put(String, Schema) - Method in class org.forgerock.api.models.Definitions.Builder
Adds a Schema.
put(String, ApiError) - Method in class org.forgerock.api.models.Errors.Builder
Adds a ApiError.
put(String, VersionedPath) - Method in class org.forgerock.api.models.Paths.Builder
Adds a Path.
put(String, Resource) - Method in class org.forgerock.api.models.Services.Builder
Adds a Resource.
put(String, Resource) - Method in class org.forgerock.api.models.SubResources.Builder
Adds a sub-resource.
put(Version, Resource) - Method in class org.forgerock.api.models.VersionedPath.Builder
Adds a resource-version.
put(String, Resource) - Method in class org.forgerock.api.models.VersionedPath.Builder
Adds a resource-version.
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(Header) - Method in class org.forgerock.http.protocol.Headers
A put method to add a particular Header instance.
put(String, V) - Method in class org.forgerock.http.util.CaseInsensitiveMap
 
put(String, Object) - Method in class org.forgerock.json.jose.jwt.JWObject
Sets or removes the value of the specified member.
put(int, Object) - Method in class org.forgerock.json.JsonValue
Sets the value of the specified child list element.
put(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
Sets the value identified by the specified pointer, relative to this value as root.
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, Object) - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
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(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.
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 String, ?>) - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
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.
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.

Q

qualified - Variable in class org.forgerock.openig.heap.GenericHeaplet
The fully qualified name of the object to be created.
Queries - Annotation Type in org.forgerock.api.annotations
Declare an array of Query operations from a single method.
queries(List<Query>) - Method in class org.forgerock.api.models.Resource.Builder
Set Queries.
Query - Annotation Type in org.forgerock.api.annotations
Indicates an CREST query method on an annotated POJO.
Query - Class in org.forgerock.api.models
Class that represents the Create Operation type in API descriptor.
query() - Static method in class org.forgerock.api.models.Query
Creates a new builder for Query.
query(Query) - Method in class org.forgerock.api.models.Resource.Builder
Adds one Query to the list of queries.
query(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
 
query(Context, QueryRequest, Collection<? super ResourceResponse>) - 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, 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, 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(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.Builder - Class in org.forgerock.api.models
Builder to help construct the Read.
QUERY_PARAMETERS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The query parameters event payload field name.
queryableFields(String...) - Method in class org.forgerock.api.models.Query.Builder
Set the queryable fields.
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<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.
queryId(String) - Method in class org.forgerock.api.models.Query.Builder
Set the query id.
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.
QueryType - Enum in org.forgerock.api.enums
Enum that represents the Query type.
quote(String) - Static method in class org.forgerock.http.header.HeaderUtil
Encloses a string in quotation marks.

R

RANGE_NOT_SATISFIABLE_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.RANGE_NOT_SATISFIABLE in an API Description.
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(CharSequence, Object...) - Static method in class org.forgerock.i18n.LocalizableMessage
Creates an non-localizable message whose String representation is always the same regardless of the requested locale.
rawLine(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts raw line (may contain markup), and will insert one newline-characters above and below, if those newlines do not already exist.
rawParagraph(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts raw paragraph (may contain markup), and will insert two newline-characters above and below, if those newlines do not already exist [ref].
rawText(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts raw text (may contain markup or only whitespace).
Read - Annotation Type in org.forgerock.api.annotations
Indicates an CREST read method on an annotated POJO.
read(Read) - Method in class org.forgerock.api.models.Items.Builder
Set Read.
Read - Class in org.forgerock.api.models
Class that represents the Read Operation type in API descriptor.
read() - Static method in class org.forgerock.api.models.Read
Creates a new builder for Operation.
read(Read) - Method in class org.forgerock.api.models.Resource.Builder
Set Read.
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() - Method in class org.forgerock.http.io.FileBranchingStream
 
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(String) - Static method in class org.forgerock.openig.el.Functions
Returns the content of the given file as a plain String.
Read.Builder - Class in org.forgerock.api.models
Builder to help construct the Read.
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.
readCurrentKey() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
 
readCurrentKey() - Method in interface org.forgerock.audit.secure.SecureStorage
Reads the current key.
readEntry(Dn, String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Reads the named entry from the Directory Server.
readEntry(String, 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, 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
 
readInstance(Context, String, ReadRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
readJson(String) - Static method in class org.forgerock.http.util.Json
Parses to json the provided data.
readJson(Reader) - Static method in class org.forgerock.http.util.Json
Parses to json the provided reader.
readJson(URL) - Static method in class org.forgerock.openig.util.JsonValues
Builds a JsonValue from the given URL.
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.
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.
readLength(ByteBuffer) - Static method in class org.forgerock.json.jose.utils.DerUtils
Reads a DER-encoded length field from the given byte buffer.
ReadOnly - Annotation Type in org.forgerock.api.annotations
Annotation to mark a JSON Schema property as read-only.
ReadPolicy - Enum in org.forgerock.api.enums
Enum that represents the Schema read policies.
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.
Realm - Class in org.forgerock.openig.tools
This class defines a Realm as it is used in OpenAM.
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.
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.
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.
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.
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.
REF - Static variable in class org.forgerock.json.schema.validator.Constants
The $ref field name.
reference(Reference) - Method in class org.forgerock.api.models.ApiError.Builder
Set the error as a reference to another definition.
Reference - Class in org.forgerock.api.models
Class that represents the Reference type in API descriptor.
reference() - Static method in class org.forgerock.api.models.Reference
Create a new Builder for Reference.
reference(Reference) - Method in class org.forgerock.api.models.Resource.Builder
Set a reference.
reference(Reference) - Method in class org.forgerock.api.models.Schema.Builder
Sets the schema reference.
Reference.Builder - Class in org.forgerock.api.models
Builder to help construct the Reference.
ReferenceResolver - Class in org.forgerock.api.util
Helper that registers one or more ApiDescription instances and provides a means to resolve References.
ReferenceResolver(ApiDescription) - Constructor for class org.forgerock.api.util.ReferenceResolver
Creates a reference-resolver and defines the one ApiDescription that can be used for local (non-namespaced) reference lookups.
ReferenceTypeValidator - Class in org.forgerock.json.schema.validator.validators
ReferenceTypeValidator holds a reference to another validator.
ReferenceTypeValidator(Map<String, Object>, String, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
Default ctor.
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.
register(ApiDescription) - Method in class org.forgerock.api.util.ReferenceResolver
Registers an external ApiDescription, for Reference lookup, and must not have previously been registered.
register(Class<T>, T) - Method in class org.forgerock.audit.DependencyProviderBase
Register a new provided dependency.
register(String, JsonValue, List<Pattern>) - Method in class org.forgerock.openig.filter.oauth2.client.IssuerRepository
Register an Issuer into the repository.
register(String, Handler) - Method in class org.forgerock.openig.http.EndpointRegistry
Registers a new endpoint under the given name.
registerAll(ApiDescription...) - Method in class org.forgerock.api.util.ReferenceResolver
Registers external ApiDescriptions, for Reference lookup, and each must not have previously been registered.
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
Registers hooks into the rotation process.
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.
releaseReadLock() - Method in class org.forgerock.audit.AuditServiceProxy
Release the read lock.
releaseWriteLock() - Method in class org.forgerock.audit.AuditServiceProxy
Release the write lock.
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(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(Marker) - Method in class org.forgerock.i18n.slf4j.LocalizedMarker
remove(int) - Method in class org.forgerock.json.JsonValue
Removes the specified child value, shifting any subsequent elements to the left.
remove(JsonPointer) - Method in class org.forgerock.json.JsonValue
Removes the specified child value with a pointer, relative to this value as root.
remove(String) - Method in class org.forgerock.json.JsonValue
Removes the specified child value.
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.
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(Object) - Method in class org.forgerock.openig.jwt.dirty.DirtyCollection
 
remove() - Method in class org.forgerock.openig.jwt.dirty.DirtyIterator
 
remove(Object) - Method in class org.forgerock.openig.jwt.dirty.DirtySet
 
remove(Object) - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
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(int) - Method in class org.forgerock.util.LazyList
Removes the element at the specified position in this list.
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(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.util.MapDecorator
Removes the mapping for a key from the map if it is present.
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.jwt.dirty.DirtyCollection
 
removeAll(Collection<?>) - Method in class org.forgerock.openig.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.
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.
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).
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).
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.
request(Schema) - Method in class org.forgerock.api.models.Action.Builder
Set the request.
REQUEST - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The request event payload field name.
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() - 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 - Interface in org.forgerock.json.resource
Common attributes of all JSON resource requests.
REQUEST_ENTITY_TOO_LARGE_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.REQUEST_ENTITY_TOO_LARGE in an API Description.
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.
REQUEST_TIMEOUT_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.REQUEST_TIMEOUT in an API Description.
REQUEST_URI_TOO_LARGE_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.REQUEST_URI_TOO_LARGE in an API Description.
RequestAuditContext - Class in org.forgerock.services.context
A context for audit information for an incoming request.
RequestAuditContext(Context) - 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.
RequestAuditContext(Context, TimeService) - 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.
RequestAuditContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.RequestAuditContext
Restores a saved context.
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 - Annotation Type in org.forgerock.api.annotations
A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST request handler.
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.
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(Boolean) - Method in class org.forgerock.api.models.Parameter.Builder
Set the required property.
required() - Method in class org.forgerock.json.JsonValue
Throws a JsonValueException if the JSON value is null.
REQUIRED - Static variable in class org.forgerock.json.schema.validator.Constants
The required field name.
required - Variable in class org.forgerock.json.schema.validator.validators.Validator
Whether the schema represented by this validator is required.
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.
requireField(String) - Method in class org.forgerock.audit.events.AuditEventBuilder
Helper method to be used when overriding AuditEventBuilder.validate().
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.
resolve(MutableUri) - Method in class org.forgerock.http.MutableUri
Resolves the given URI against this URI.
resolve(Context, String) - Method in interface org.forgerock.http.oauth2.AccessTokenResolver
Resolves a given access token against an authorization server.
resolve(Context, String) - Method in class org.forgerock.http.oauth2.resolver.CachingAccessTokenResolver
 
resolve(Context, String) - Method in class org.forgerock.http.oauth2.resolver.OpenAmAccessTokenResolver
 
resolve(Context, String) - Method in class org.forgerock.http.oauth2.resolver.TokenIntrospectionAccessTokenResolver
 
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.doc.SampleClassAliasResolver
Get the class for a short name alias.
resolve(String) - Method in class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
 
resolve(Context, String) - Method in class org.forgerock.openig.filter.oauth2.ScriptableAccessTokenResolver
 
resolve(String) - Method in class org.forgerock.openig.handler.saml.SamlClassAliasResolver
 
resolve(JsonValue, Class<T>) - Method in interface org.forgerock.openig.heap.Heap
Resolves a mandatory object with the specified reference.
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>) - Method in class org.forgerock.openig.heap.HeapImpl
 
resolve(JsonValue, Class<T>, boolean) - Method in class org.forgerock.openig.heap.HeapImpl
 
resolve(String) - Method in class org.forgerock.openig.openam.OpenAMClassAliasResolver
 
resolve(String) - Method in class org.forgerock.openig.uma.UmaClassAliasResolver
 
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 - Class in org.forgerock.openig.resolver
Performs object resolution by object type.
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.
resolveSchemaReferences() - Method in class org.forgerock.json.schema.validator.validators.Validator
Resolves schema references for this validator.
Resource - Class in org.forgerock.api.models
Class that represents the Resource type in API descriptor.
resource() - Static method in class org.forgerock.api.models.Resource
Create a new Builder for Resoruce.
RESOURCE - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader
The name of the resource value component.
Resource - Interface in org.forgerock.openig.handler.resources
A Resource represents any content that can be served through the ResourceHandler.
resource(String) - Method in class org.forgerock.openig.policy.PolicyRequest.Builder
Sets the requested resource URI.
Resource.AnnotatedTypeVariant - Enum in org.forgerock.api.models
The variant of the annotated type.
Resource.Builder - Class in org.forgerock.api.models
Builder to help construct the Resource.
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(ResourceApiVersionBehaviourManager) - Constructor for class org.forgerock.http.routing.ResourceApiVersionRoutingFilter
Constructs a new ResourceApiVersionRoutingFilter instance.
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.
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, Throwable) - 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.
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.
resourceName() - Method in class org.forgerock.i18n.LocalizableMessage
Returns the name of the resource in which this message is defined.
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(Collection<? extends Object>) - Constructor for class org.forgerock.json.resource.ResourcePath
Creates a new resource path having the provided path elements.
ResourcePath(Object...) - Constructor for class org.forgerock.json.resource.ResourcePath
Creates a new resource path having the provided path elements.
resourcePath(String) - Static method in class org.forgerock.json.resource.ResourcePath
Parses the provided string representation of a resource path.
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.
resourceSchema(Schema) - Method in class org.forgerock.api.models.Resource.Builder
Set the resource schema.
ResourceServerFilter - Class in org.forgerock.http.oauth2
Validates a Request that contains an OAuth 2.0 access token.
ResourceServerFilter(AccessTokenResolver, TimeService, ResourceAccess, String) - Constructor for class org.forgerock.http.oauth2.ResourceServerFilter
Creates a new OAuth2Filter.
ResourceSet - Interface in org.forgerock.openig.handler.resources
A ResourceSet abstracts Resource lookup mechanism.
response(Schema) - Method in class org.forgerock.api.models.Action.Builder
Set the response.
RESPONSE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The response event payload field name.
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(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 - Interface in org.forgerock.json.resource
Common response object of all resource responses.
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.
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(Response) - Constructor for exception org.forgerock.http.protocol.ResponseException
Constructs a ResponseException using the given response.
ResponseException(String, Throwable) - Constructor for exception org.forgerock.http.protocol.ResponseException
Constructs a ResponseException using the given message and parent cause.
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 - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Defines the authentication result key.
result(AuthenticationAuditEventBuilder.Status) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Sets the authentication audit event overall result.
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.jwt.dirty.DirtyCollection
 
retainAll(Collection<?>) - Method in class org.forgerock.openig.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(LambdaExceptionUtils.ThrowingBiFunction<T, U, R, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a LambdaExceptionUtils.ThrowingBiFunction to comply with BiFunction's no checked exception signature.
rethrowConsumer(LambdaExceptionUtils.ThrowingConsumer<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a LambdaExceptionUtils.ThrowingConsumer 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(LambdaExceptionUtils.ThrowingPredicate<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a LambdaExceptionUtils.ThrowingPredicate to comply with Predicate's no checked exception signature.
rethrowSupplier(LambdaExceptionUtils.ThrowingSupplier<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a LambdaExceptionUtils.ThrowingSupplier to comply with Supplier's no checked exception signature.
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.
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.
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.
ROOT_REALM - Static variable in class org.forgerock.openig.tools.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.
RotatableObject - Interface in org.forgerock.audit.rotation
Interface defining methods a rotatable file needs.
RotatableWriter - Class in org.forgerock.audit.events.handlers.writers
Creates an RotatableWriter that 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_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.
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() - Constructor for class org.forgerock.http.routing.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 - Class in org.forgerock.json.resource
A router which routes requests based on route predicates.
Router() - Constructor for class org.forgerock.json.resource.Router
Creates a new router with no routes defined.
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) - 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.
rowEnd() - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Adds an optional space to visually delineate the end of a row in the generated markup.
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.
RsaJWK - Class in org.forgerock.json.jose.jwk
Implements a RsaJWK.
RsaJWK(KeyUse, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK
Deprecated.
Use the builder instead.
RsaJWK(KeyUse, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK
Deprecated.
Use the builder instead.
RsaJWK(KeyUse, 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(KeyUse, 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(RSAPublicKey, KeyUse, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK
Deprecated.
Use the builder instead.
RsaJWK(RSAPublicKey, RSAPrivateKey, KeyUse, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK
Deprecated.
Use the builder instead.
RsaJWK(RSAPublicKey, RSAPrivateCrtKey, KeyUse, 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
An implementation of the SigningHandler which can sign and verify using algorithms from the RSA family.
RSASigningHandler(Key, SignatureUtil) - Constructor for class org.forgerock.json.jose.jws.handlers.RSASigningHandler
Constructs a new RSASigningHandler, with a SignatureUtil instance to delegate the signing and verifying calls to.
run(Map<String, Object>) - Method in class org.forgerock.openig.script.Script
Runs this script using the provided named variable 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
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

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.
SampleApplication - Class in org.forgerock.openig.doc
Simple servlet allowing user-agents to get a login page, and to post form-based to access a protected profile page.
SampleClassAliasResolver - Class in org.forgerock.openig.doc
Allow use of short name aliases in configuration object types.
SampleClassAliasResolver() - Constructor for class org.forgerock.openig.doc.SampleClassAliasResolver
 
SampleFilter - Class in org.forgerock.openig.doc
Filter to set a header in the incoming request and in the outgoing response.
SampleFilter() - Constructor for class org.forgerock.openig.doc.SampleFilter
 
SampleFilter.Heaplet - Class in org.forgerock.openig.doc
Create and initialize the filter, based on the configuration.
save(Response) - Method in interface org.forgerock.http.session.Session
Save the session state to the response.
save(Session, Response) - Method in interface org.forgerock.http.session.SessionManager
Saves the session into the provided response.
save(Response) - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
save(Session, Response) - Method in class org.forgerock.openig.jwt.JwtSessionManager
 
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
 
Schema - Annotation Type in org.forgerock.api.annotations
Specify a schema for the element that is being described.
schema(Schema) - Method in class org.forgerock.api.models.ApiError.Builder
Set the schema.
Schema - Class in org.forgerock.api.models
Class that represents the Schema type in API descriptor.
schema(JsonValue) - Method in class org.forgerock.api.models.Schema.Builder
Sets the schema.
schema(String, Object) - Method in class org.forgerock.api.models.Schema.Builder
Sets the schema by json key-value pairs.
schema() - Static method in class org.forgerock.api.models.Schema
Create a new Builder for Schema.
SCHEMA - Static variable in class org.forgerock.json.schema.validator.Constants
The $schema field name.
Schema.Builder - Class in org.forgerock.api.models
A builder class for Schema instances.
SchemaException - Exception in org.forgerock.json.schema.validator.exceptions
Encapsulate a general JSON validator error.
SchemaException(JsonValue, String) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
Create the exception with the given value and message.
SchemaException(JsonValue, String, Throwable) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
Create the exception with the given value, message and cause.
SchemaException(JsonValue, Exception) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
Create a new SchemaException wrapping an existing exception.
SchemaException(JsonValue, String, Exception) - Constructor for exception org.forgerock.json.schema.validator.exceptions.SchemaException
Create a new SchemaException from an existing exception.
schemaFor(Class<?>) - Static method in class org.forgerock.api.jackson.JacksonUtils
Obtain the JsonSchema for a type, using the extended schema classes that are in this package.
Script - Class in org.forgerock.openig.script
A compiled script.
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.
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.
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.
search(String, SearchScope, String, String...) - Method in class org.forgerock.openig.ldap.LdapConnection
Searches the Directory Server 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.
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.
sectionTitle(String, int) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a section title, at a given level.
sectionTitle1(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a section title, level 1.
sectionTitle2(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a section title, level 2.
sectionTitle3(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a section title, level 3.
sectionTitle4(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a section title, level 4.
sectionTitle5(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a section title, level 5.
SECURE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The secure event payload field name.
secure(boolean) - Method in class org.forgerock.services.context.ClientContext.Builder
Sets whether if the client connection is secure.
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(Throwable) - Constructor for exception org.forgerock.audit.secure.SecureStorageException
Constructs an SecureStorageException using the given parent cause.
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.
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(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().
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.
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(Map<String, Header>, HttpHost, HttpResponse, HttpContext) - Method in class org.forgerock.http.apache.NoAuthenticationStrategy
 
self() - Method in class org.forgerock.api.models.Action.Builder
 
self() - Method in class org.forgerock.api.models.Create.Builder
Returns the builder so this.
self() - Method in class org.forgerock.api.models.Delete.Builder
 
self() - Method in class org.forgerock.api.models.Operation.Builder
Abstract method that returns the instantiated Builder itself.
self() - Method in class org.forgerock.api.models.Patch.Builder
 
self() - Method in class org.forgerock.api.models.Query.Builder
Returns the builder instance.
self() - Method in class org.forgerock.api.models.Read.Builder
Returns the builder instance.
self() - Method in class org.forgerock.api.models.Update.Builder
 
self() - Method in class org.forgerock.audit.events.AuditEventBuilder
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 class org.forgerock.http.apache.async.AsyncHttpClient
 
sendAsync(Request) - Method in interface org.forgerock.http.spi.HttpClient
Returns a Promise representing the asynchronous Response of the given request.
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.
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 - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The server event payload field name.
server(String, int) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided server values for the event.
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
 
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(Services) - Method in class org.forgerock.api.models.ApiDescription.Builder
Set the services.
Services - Class in org.forgerock.api.models
Class that represents API descriptor's Service Resource definitions.
services() - Static method in class org.forgerock.api.models.Services
Create a new Builder for Services.
SERVICES - Static variable in interface org.forgerock.http.decoder.Decoder
Mapping of supported codings to associated decoders.
SERVICES - Static variable in class org.forgerock.openig.resolver.Resolvers
Mapping of supported classes to associated resolvers.
Services.Builder - Class in org.forgerock.api.models
Builder to help construct the Services.
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 - 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 SessionManager instance from the Heap.
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(Context, Session) - Constructor for class org.forgerock.http.session.SessionContext
Constructs a new SessionContext.
SessionContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.session.SessionContext
Restore from JSON representation.
SessionManager - Interface in org.forgerock.http.session
A SessionFactory is responsible to create a new type of Session.
SessionModeConfig - Enum in org.forgerock.audit.handlers.jms
Configuration wrapper for JMS Session.getAcknowledgeMode() SessionMode setting.
set - Variable in class org.forgerock.http.util.SetDecorator
The set wrapped by this decorator.
set(Bindings, Object) - Method in class org.forgerock.openig.el.LeftValueExpression
Sets the result of an expression to a specified value.
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(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.
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(Algorithm) - Method in class org.forgerock.json.jose.jwt.JwtHeader
Sets the algorithm used to perform cryptographic signing and/or encryption on the JWT.
setAlgorithm(String) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Sets the cryptographic algorithm.
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.
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(BatchPublisherConfiguration) - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
Sets the configuration used to initialize the batch publisher.
setBatchEnabled(boolean) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
sets if handling of audit events should be done in batches.
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.
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.
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 reload 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.BatchPublisherConfiguration
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.
setCharset(Charset) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
The Charset to use for decrypted 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(Function<Bindings, Map<String, Object>, ExpressionException>) - 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
Sets the intended use of a cookie.
setCommentURL(String) - Method in class org.forgerock.http.protocol.Cookie
Sets the URL identifying the intended use of a cookie.
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.
setContentType(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Sets the content type header parameter for this JWS.
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
Processes the Set-Cookie2 request message header, defined in RFC 2965.
SetCookie2Header(List<Cookie>) - Constructor for class org.forgerock.http.header.SetCookie2Header
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.
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.
setDataSourceClassName(String) - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
Sets the datasource class name for the configured database.
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.
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.
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.
setDescription(String) - Method in class org.forgerock.api.transform.LocalizableOperation
 
setDescription(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
setDescription(String) - Method in class org.forgerock.api.transform.LocalizableTag
 
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
Sets the value indicating whether the user agent should discard the cookie unconditionally when it terminates.
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(Function<Bindings, Map<String, List<Object>>, ExpressionException>) - 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.
setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestAnySchema
 
setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestArraySchema
 
setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
setEvent(String) - Method in class org.forgerock.audit.handlers.jdbc.TableMapping
Sets the audit event the table mapping is for.
setExample(String) - Method in class org.forgerock.api.jackson.CrestAnySchema
 
setExample(String) - Method in class org.forgerock.api.jackson.CrestArraySchema
 
setExample(String) - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
setExample(String) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
setExample(String) - Method in interface org.forgerock.api.jackson.WithExampleSchema
Sets example JSON Schema field.
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.
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
setFileRotation(FileBasedEventHandlerConfiguration.FileRotation) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
setFilterPolicies(Map<String, FilterPolicy>) - Method in class org.forgerock.audit.AuditServiceConfiguration
Set the filter policy mappings.
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.
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.
setInsertTimeoutSec(long) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Sets the timeout in seconds the duration that the queue should block while attempting to offer a new item for the queue.
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
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
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.
setKey(Key) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Sets the encryption key.
setKeyId(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Sets the Key ID header parameter for this JWS.
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.
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.BatchPublisherConfiguration
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
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.
setMultipleOf(Double) - Method in interface org.forgerock.api.jackson.MultipleOfSchema
Sets multipleOf JSON Schema field.
setName(String) - Method in class org.forgerock.api.transform.LocalizableTag
 
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.
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(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.
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.
setOperation(CryptoHeaderFilter.Operation) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
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.
setPollTimeoutSec(long) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Sets the timeout in seconds for the worker threads to wait for a new item to be available in the queue before exiting.
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
Set the Port attribute as defined per RFC 2965 for Set-Cookie2.
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
 
setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestAnySchema
 
setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestArraySchema
 
setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
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 pah (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.
setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestAnySchema
 
setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestArraySchema
 
setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
setReason(String) - Method in exception org.forgerock.json.resource.ResourceException
Sets/overrides the short reason phrase of the exception.
setReferencedValidator(Validator) - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
Sets the validator being referenced by this object.
setRequiredFields(Set<String>) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
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(ResourcePath) - Method in interface org.forgerock.json.resource.ActionRequest
 
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(ResourcePath) - Method in interface org.forgerock.json.resource.CreateRequest
 
setResourcePath(String) - Method in interface org.forgerock.json.resource.DeleteRequest
 
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.DeleteRequest
 
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.PatchRequest
 
setResourcePath(String) - Method in interface org.forgerock.json.resource.PatchRequest
 
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.QueryRequest
 
setResourcePath(String) - Method in interface org.forgerock.json.resource.QueryRequest
 
setResourcePath(ResourcePath) - Method in interface org.forgerock.json.resource.ReadRequest
 
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(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(String) - Method in interface org.forgerock.json.resource.UpdateRequest
 
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
 
setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestAnySchema
 
setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestArraySchema
 
setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
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.
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.
setShutdownTimeoutSec(long) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Sets the timeout in seconds for the publisher to wait for all worker threads to terminate at shutdown.
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(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.
setTags(List<String>) - Method in class org.forgerock.api.transform.LocalizableOperation
 
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.
setThreadCount(int) - Method in class org.forgerock.audit.handlers.jms.BatchPublisherConfiguration
Sets the count of worker threads to have processing the queue.
setTitle(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
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.
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(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.
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
Sets the version of the state management mechanism to which this cookie conforms.
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.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.
setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestAnySchema
 
setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestArraySchema
 
setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
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.
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(boolean) - 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.BatchPublisher
This shutdowns the worker threads, and then calls BatchPublisher.shutdownPublisher().
shutdown() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandler
Closes the JMS connection.
shutdown() - Method in interface org.forgerock.audit.handlers.jms.Publisher
Cleanup services that were initialized with Publisher.startup().
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 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.
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.
ShutdownPriority - Enum in org.forgerock.util.thread.listener
This class defines the shutdown priorities that are consumed by com.sun.identity.common.ShutdownManager.
shutdownPublisher() - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
This is invoked by BatchPublisher.shutdown().
sidebarBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a sidebar-block.
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(SigningHandler, JwsAlgorithm) - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder
sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
 
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
 
sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler
Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler
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.NOPSigningHandler
Simply returns a byte array of a UTF-8 empty string.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.NOPSigningHandler
Returns an empty byte array.
sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler
Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.
sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler
Signs the given raw data bytes 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(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(PrivateKey, String, String) - Method in class org.forgerock.util.SignatureUtil
Signs a String using the given private key.
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.
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.
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.
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.
SignedEncryptedJwtBuilder - Class in org.forgerock.json.jose.builders
Deprecated.
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, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.SignedJwt
Constructs a fresh, new SignedJwt from the given JwsHeader and JwtClaimsSet.
SignedJwt(SignedJwt) - Constructor for class org.forgerock.json.jose.jws.SignedJwt
Construct an signed JWT from an existent one.
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, 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(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.
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.
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, 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.
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.
SignedThenEncryptedJwtBuilder - Class in org.forgerock.json.jose.builders
Builder for nested signed-then-encrypted JWT.
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.
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
 
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.
SimpleHTTPClient - Class in org.forgerock.util
Simple helper client for connecting to URLs over HTTP and retrieving their contents via a GET request.
SimpleHTTPClient() - Constructor for class org.forgerock.util.SimpleHTTPClient
Generates a new SimpleHTTPClient with the appropriate timeouts.
SimpleHTTPClient(int, int) - Constructor for class org.forgerock.util.SimpleHTTPClient
Generates a new SimpleHTTPClient with the appropriate timeouts.
SimpleValidator<T> - Interface in org.forgerock.json.schema.validator.validators
SimpleValidator is a base interface for all validator implementation.
since(long) - Method in interface org.forgerock.util.time.TimeService
Computes the elapsed time between now and past.
SingleSignOnFilter - Class in org.forgerock.openig.openam
This filter verifies the presence of a SSOToken in the given cookie name.
SingleSignOnFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initialises an authentication filter in a heap environment.
singleton(Boolean) - Method in class org.forgerock.api.models.Create.Builder
Setter for singleton.
SingletonProvider - Annotation Type in org.forgerock.api.annotations
A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST singleton provider resource.
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.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.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.
slashEnded() - Static method in class org.forgerock.openig.util.JsonValues
Returns the JsonValue with its value ended by a slash.
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).
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.
source(ParameterSource) - Method in class org.forgerock.api.models.Parameter.Builder
Set the parameter source.
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.filter
Executes a SQL query through a prepared statement and exposes its first result.
SqlAttributesFilter(DataSource, LeftValueExpression<Map>, String) - Constructor for class org.forgerock.openig.filter.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.filter
Creates and initializes a static attribute provider in a heap environment.
ssoToken(String) - Method in class org.forgerock.openig.policy.PolicyRequest.Builder
Sets the OpenAM SSO token ID string for the subject making the request to the protected resource.
SsoTokenContext - Class in org.forgerock.openig.openam
An SsoTokenContext could be used to store and retrieve an token.
SsoTokenContext(Context, JsonValue, String) - Constructor for class org.forgerock.openig.openam.SsoTokenContext
Creates a new SsoTokenContext context with the provided token and additional validation information such as 'realm', 'uid' and 'authModule'.
Stability - Enum in org.forgerock.api.enums
Represents API stability.
stability(Stability) - Method in class org.forgerock.api.models.Operation.Builder
Sets stability of Operation.
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.decoration.helper.DecoratorHeaplet
Called to request the heaplet start an object.
start() - Method in class org.forgerock.openig.handler.router.AuditServiceObjectHeaplet
 
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.http.AdminHttpApplication
 
start() - Method in class org.forgerock.openig.http.GatewayHttpApplication
 
STARTS_WITH - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "starts-with" operator.
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.
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(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.
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.BatchPublisher
This first initializes the worker threads that monitor the queue of items to publish, and then calls BatchPublisher.startupPublisher().
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 interface org.forgerock.audit.handlers.jms.Publisher
Initialize services that are reused by individual publish calls.
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.
startupPublisher() - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
This is invoked by BatchPublisher.startup().
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, String, 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.
STATUS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The status event payload field name.
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.Family - Enum in org.forgerock.http.protocol
The first digit of the status-code defines the class of response.
STATUS_CODE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The status code event payload field name.
stop() - Method in class org.forgerock.http.filter.throttling.ThrottlingFilter
Stops this filter and frees the resources.
stop() - Method in interface org.forgerock.http.filter.throttling.ThrottlingStrategy
Stop and free any resources needed by the strategy.
stop() - Method in class org.forgerock.http.filter.throttling.TokenBucketThrottlingStrategy
 
stop() - Method in interface org.forgerock.http.HttpApplication
Called when HTTP application is shutdown.
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
 
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
 
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.
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() - Method in class org.forgerock.json.JsonValue
Construct a Stream from this JsonValue object.
StreamPatternExtractor - Class in org.forgerock.openig.regex
Extracts regular expression patterns and/or applied templates from character streams.
StreamPatternExtractor() - Constructor for class org.forgerock.openig.regex.StreamPatternExtractor
 
StreamPatternMatches - Class in org.forgerock.openig.regex
Iterates through multiple regular expression matches within a character stream.
StreamPatternMatches(Reader, Collection<Pattern>, boolean) - Constructor for class org.forgerock.openig.regex.StreamPatternMatches
Constructs a new stream pattern match iterator.
STRING_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper
Json String value type.
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.
StringPatternMatches - Class in org.forgerock.openig.regex
Iterates through multiple regular expression matches within a character sequence.
StringPatternMatches(CharSequence, Collection<Pattern>, boolean) - Constructor for class org.forgerock.openig.regex.StringPatternMatches
Constructs a new string pattern match iterator.
stringSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory
 
StringTypeValidator - Class in org.forgerock.json.schema.validator.validators
StringTypeValidator applies all the constraints of a string type.
StringTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.StringTypeValidator
Create a string type validator.
StringUtil - Class in org.forgerock.openig.util
Miscellaneous string utility methods.
sts() - Method in class org.forgerock.openig.tools.OpenAmServer
Returns the transformation endpoint located in the /rest-sts namespace.
sts(String) - Method in class org.forgerock.openig.tools.OpenAmServer
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.OpenAmServer
Returns the URI of the transformation endpoint located in the /rest-sts namespace.
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.
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.
subresources(SubResources) - Method in class org.forgerock.api.models.Items.Builder
Sets the sub-resources for this resource.
subresources(SubResources) - Method in class org.forgerock.api.models.Resource.Builder
Sets the sub-resources for this resource.
SubResources - Class in org.forgerock.api.models
Sub-resources of a resource are declared here.
subresources() - Static method in class org.forgerock.api.models.SubResources
Create a new Builder for sub-resources.
SubResources.Builder - Class in org.forgerock.api.models
Builder to help construct the SubResources.
subSequence(int, int) - Method in class org.forgerock.i18n.LocalizableMessage
Returns a new CharSequence which is a subsequence of the String representation of this message in the default locale.
subSequence(Locale, int, int) - Method in class org.forgerock.i18n.LocalizableMessage
Returns a new CharSequence which is a subsequence of the String representation of this message in the specified locale.
subSequence(int, int) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns a new CharSequence which is a subsequence of the String representation of this message builder in the default locale.
subSequence(Locale, int, int) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns a new CharSequence which is a subsequence of the String representation of this message builder in the specified locale.
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.
SupportedEllipticCurve - Enum in org.forgerock.json.jose.jws
Enumerates all supported elliptic curve parameters for ESXXX signature formats.
supportedLocales(String...) - Method in class org.forgerock.api.models.Operation.Builder
Set the supported locale.
supportedSortKeys(String...) - Method in class org.forgerock.api.models.Query.Builder
Set the supported sort keys.
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.
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.
SYSTEM - Static variable in interface org.forgerock.util.time.TimeService
TimeService implementation based on System.
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
 

T

tableEnd() - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Completes the table being built, and inserts it at the end of the parent document.
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
 
tableStart() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Starts a table at the current position.
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.
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(T) - Method in interface org.forgerock.util.LambdaExceptionUtils.ThrowingPredicate
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, 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>, 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, E>) - Method in class org.forgerock.util.promise.PromiseImpl
 
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 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, 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>, 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, E>) - Method in class org.forgerock.util.promise.PromiseImpl
 
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 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
 
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
 
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(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(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(ResultHandler<? super V>, ExceptionHandler<? super E>) - Method in class org.forgerock.util.promise.PromiseImpl
 
thenOnResultOrException(Runnable) - 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.
throttle(String, ThrottlingRate) - Method in interface org.forgerock.http.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.http.filter.throttling.TokenBucketThrottlingStrategy
 
ThrottlingFilter - Class in org.forgerock.http.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.http.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.http.filter.throttling
This interface defines the contract to lookup a ThrottlingRate that will be applied to the given Request.
ThrottlingRate - Class in org.forgerock.http.filter.throttling
A value object to represent a throttling rate.
ThrottlingRate(int, String) - Constructor for class org.forgerock.http.filter.throttling.ThrottlingRate
Constructs a new ThrottlingRate.
ThrottlingStrategy - Interface in org.forgerock.http.filter.throttling
This interface defines the contract for any throttling strategy.
TICKER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a Ticker instance from the Heap.
TIME_SERVICE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a TimeService 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(String) - Constructor for class org.forgerock.openig.decoration.timer.TimerDecorator
Builds a new TimerDecorator where the elapsed time unit is milliseconds.
TimerDecorator(String, TimeUnit) - Constructor for class org.forgerock.openig.decoration.timer.TimerDecorator
Builds a new TimerDecorator with the given TimeUnit reference (not null), which logs the elapsed time within the decorated heap object.
TimerDecorator.Heaplet - Class in org.forgerock.openig.decoration.timer
Creates and initializes a TimerDecorator in a heap environment.
TimeService - Interface in org.forgerock.util.time
Provides time related methods for computing durations, for providing the now instant and other use cases.
TIMESTAMP - Static variable in class org.forgerock.audit.events.AuditEventBuilder
Timestamp event payload field name.
timestamp(long) - Method in class org.forgerock.audit.events.AuditEventBuilder
Sets the provided time stamp for the event.
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.
Title - Annotation Type in org.forgerock.api.annotations
Annotation to define JSON Schema property's title.
title(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable
Sets a table-title.
title(LocalizableString) - Method in class org.forgerock.api.models.Resource.Builder
Set the title.
title(String) - Method in class org.forgerock.api.models.Resource.Builder
Set the title.
title(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
title(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableRefProperty
 
TITLE - Static variable in class org.forgerock.json.schema.validator.Constants
The type field name.
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(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() - 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.jwt.dirty.DirtyCollection
 
toArray(T[]) - Method in class org.forgerock.openig.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(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() - 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.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.
toBytesUnsigned(BigInteger) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils
Returns the magnitude big-endian byte array of a big integer.
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.
toEvent() - Method in class org.forgerock.audit.events.AuditEventBuilder
Generates the audit event.
toFile(Path, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Saves builder content to a file.
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.
toJson() - Method in class org.forgerock.services.TransactionId
Returns a representation of this TransactionId as a JsonValue.
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.
toJsonString() - Method in class org.forgerock.json.jose.jwk.OctJWK
Prints the JWK as a json string.
toJsonString() - Method in class org.forgerock.json.jose.jwk.RsaJWK
Prints the RsaJWK object 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(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.
toJsonValue() - Method in class org.forgerock.json.jose.jwk.OctJWK
 
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.openig.policy.PolicyRequest
Returns the policy request as a JsonValue.
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.TransactionIdContext
Updates the data object to have the current transactionId state.
TokenBucketThrottlingStrategy - Class in org.forgerock.http.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.http.filter.throttling.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(Throwable) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException
Constructs a new exception with the specified cause.
TokenHandlerException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException
Constructs a new exception with the specified detail message and cause.
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
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
 
TokenTransformationFilter - Class in org.forgerock.openig.openam
A TokenTransformationFilter is responsible to transform a token issued by OpenAM 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 target).
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 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.
toMessage() - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns the LocalizableMessage representation of this message builder.
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").
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.api.markup.asciidoc.AsciiDoc
Converts builder content to a String.
toString() - Method in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols
Returns the AsciiDocSymbols markup symbol associated with this item.
toString() - Method in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles
Returns the character associated with the table column-style.
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.throttling.ThrottlingRate
 
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.MutableUri
 
toString() - Method in class org.forgerock.http.oauth2.OAuth2Error
 
toString() - Method in class org.forgerock.http.protocol.Cookie
 
toString() - Method in class org.forgerock.http.protocol.Entity
Returns the content of this entity decoded as a string.
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 class org.forgerock.i18n.LocalizableMessage
Returns the String representation of this message in the default locale.
toString(Locale) - Method in class org.forgerock.i18n.LocalizableMessage
Returns the String representation of this message in the specified locale.
toString() - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns the String representation of this message builder in the default locale.
toString(Locale) - Method in class org.forgerock.i18n.LocalizableMessageBuilder
Returns the String representation of this message builder in the specified locale.
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 enum org.forgerock.json.jose.jwk.KeyUse
Prints the KeyUse value.
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 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 exception org.forgerock.json.schema.validator.exceptions.SchemaException
Override toString to pick up any embedded exception.
toString() - Method in class org.forgerock.json.schema.validator.validators.Validator
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(Object) - Static method in class org.forgerock.openig.el.Functions
Returns the string value of an arbitrary object.
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.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.i18n.LocalizableString
The default toString method.
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
 
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
Returns the string representation of this error formatted as a WWW-Authenticate header.
trace(LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(String) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(String, Object) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(String, Object, Object) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(String, Object, Object, Object) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(String, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessage) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(LocalizableMessage, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message using the provided Marker.
trace(Marker, LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message using the provided Marker.
trace(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
trace(Marker, LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message.
trace(Marker, LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
traceException(Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with provided exception.
traceException(Throwable, String) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
traceException(Throwable, String, Object) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
traceException(Throwable, String, Object, Object) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
traceException(Throwable, String, Object, Object, Object) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
traceException(Throwable, String, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a trace message with an accompanying exception.
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.
trailingSlash(String) - Static method in class org.forgerock.openig.util.StringUtil
Appends a final slash on a given value.
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(Context, TransactionId) - Constructor for class org.forgerock.services.context.TransactionIdContext
Constructs a new TransactionIdContext.
TransactionIdContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.TransactionIdContext
Restores a saved context.
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
TransactionIdInboundFilter(boolean) - 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(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.
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(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.
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.
TransformerException - Exception in org.forgerock.api.transform
Signals that an error occurred while transforming an API Description to another format.
TransformerException(String) - Constructor for exception org.forgerock.api.transform.TransformerException
Creates a TransformerException with a detailed error message.
TransformerException(String, Throwable) - Constructor for exception org.forgerock.api.transform.TransformerException
Creates a TransformerException with a detailed error message and cause.
TranslateJsonSchema - Class in org.forgerock.api.models
Iterates over each JsonValue node in the JsonValue structure and if it's a String marked for translation, It replaces the String with a LocalizableString.
TranslateJsonSchema(ClassLoader) - Constructor for class org.forgerock.api.models.TranslateJsonSchema
Constructor which takes a ClassLoader where the String is defined.
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".
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.
type(String) - Method in class org.forgerock.api.models.Parameter.Builder
Set the parameter type.
type(QueryType) - Method in class org.forgerock.api.models.Query.Builder
Set the query type.
type(Class<?>) - Method in class org.forgerock.api.models.Schema.Builder
Sets the schema.
TYPE - Static variable in class org.forgerock.json.schema.validator.Constants
The type field name.
TYPE_ANY - Static variable in class org.forgerock.json.schema.validator.Constants
Deprecated.
removed in JSON schema draft 04
TYPE_ARRAY - Static variable in class org.forgerock.json.schema.validator.Constants
The array type.
TYPE_BOOLEAN - Static variable in class org.forgerock.json.schema.validator.Constants
The boolean type.
TYPE_INTEGER - Static variable in class org.forgerock.json.schema.validator.Constants
The integer type.
TYPE_NULL - Static variable in class org.forgerock.json.schema.validator.Constants
The null type.
TYPE_NUMBER - Static variable in class org.forgerock.json.schema.validator.Constants
The number type.
TYPE_OBJECT - Static variable in class org.forgerock.json.schema.validator.Constants
The object type.
TYPE_STRING - Static variable in class org.forgerock.json.schema.validator.Constants
The string type.

U

uma(String) - Method in class org.forgerock.openig.tools.OpenAmServer
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 OpenIG when acting as an UMA Resource Server.
UmaSharingService(Handler, List<ShareTemplate>, URI) - Constructor for class org.forgerock.openig.uma.UmaSharingService
Constructs an UmaSharingService bound to the given authorizationServer and dedicated to protect resource sets described by the given templates.
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.OpenAmServer
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_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.UNAUTHORIZED in an API Description.
UNAVAILABLE - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the resource is temporarily unable to handle the request.
UNAVAILABLE_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.UNAVAILABLE in an API Description.
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.
UnionTypeValidator - Class in org.forgerock.json.schema.validator.validators
Union Types An array of two or more simple validators definitions.
UnionTypeValidator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.UnionTypeValidator
Create a union type validator.
UniqueItems - Annotation Type in org.forgerock.api.annotations
Annotation to mark a JSON Schema array-items as unique.
UNIQUEITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
The uniqueItems field name.
UnixEnvironment - Class in org.forgerock.openig.config.env
Represents a UNIX default environment.
UnixEnvironment() - Constructor for class org.forgerock.openig.config.env.UnixEnvironment
Builds a new UNIX environment that will be located in the user's directory.
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.
unorderedList1(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc
Inserts a line for an unordered list, at level 1 indentation.
unquote(String) - Static method in class org.forgerock.http.header.HeaderUtil
Unquotes a string following the logic of HeaderUtil.quote(String).
unregister() - Method in class org.forgerock.openig.http.EndpointRegistry.Registration
Un-register the endpoint.
UNRESOLVED - Static variable in interface org.forgerock.openig.resolver.Resolver
Singleton that is returned to indicate an element is not resolved by a resolver.
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_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.UNSUPPORTED_MEDIA_TYPE in an API Description.
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.
UNVERSIONED - Static variable in class org.forgerock.api.models.VersionedPath
Version 0.0 represents null/empty, for when resource versions are not required by an API (e.g., OpenIDM).
Update - Annotation Type in org.forgerock.api.annotations
Indicates an CREST update method on an annotated POJO.
update(Update) - Method in class org.forgerock.api.models.Items.Builder
Set Update.
update(Update) - Method in class org.forgerock.api.models.Resource.Builder
Set Update.
Update - Class in org.forgerock.api.models
Class that represents the Create Operation type in API descriptor.
update() - Static method in class org.forgerock.api.models.Update
Creates a new builder for Operation.
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(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.Builder - Class in org.forgerock.api.models
Builder to help construct Update.
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, 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
 
updateInstance(Context, String, UpdateRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
UpdateRequest - Interface in org.forgerock.json.resource
A request to update a JSON resource by replacing its existing content with new content.
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(String) - Static method in class org.forgerock.http.MutableUri
Factory method for avoiding typing new MutableUri("http://...").
uri() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a uniform resource identifier.
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.
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>.
UriRouterContext - Class in org.forgerock.http.routing
A Context which is created when a request has been routed.
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(JsonValue, ClassLoader) - Constructor for class org.forgerock.http.routing.UriRouterContext
Restore from JSON representation.
uriRouterContext(Context) - Static method in class org.forgerock.http.routing.UriRouterContext
Return a builder for a new UriRouterContext.
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.
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.
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).
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.
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
Common utility methods.
uuid() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a universally unique identifier (UUID).

V

validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestAnySchema
 
validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestArraySchema
 
validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestBooleanSchema
 
validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestObjectSchema
 
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
 
validate(Number, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.DivisibleByHelper
 
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.EnumHelper
 
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.FormatHelper
 
validate(Number, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.MaximumHelper
 
validate(Number, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.helpers.MinimumHelper
 
validate(Object, Map<String, Object>) - Static method in class org.forgerock.json.schema.validator.ObjectValidator
Validate the given node against the schema
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.AnyTypeValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.ArrayTypeValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.BooleanTypeValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.IntegerTypeValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.NullTypeValidator
 
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.NumberTypeValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.ObjectTypeValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
Validates the node value against the embedded schema object.
validate(T, JsonPointer, ErrorHandler) - Method in interface org.forgerock.json.schema.validator.validators.SimpleValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.StringTypeValidator
Validates the node value against the embedded schema object.
validate(Object, JsonPointer, ErrorHandler) - Method in class org.forgerock.json.schema.validator.validators.UnionTypeValidator
Validates the node value against the embedded schema object.
validate(String) - Method in interface org.forgerock.tokenhandler.TokenHandler
Validates the passed token.
validateAndExtractState(String) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler
 
validateAndExtractState(String) - Method in interface org.forgerock.tokenhandler.TokenHandler
Validates and parses the token, extracting any encapsulated state.
validateJsonToSchema(String, JsonSchema) - Static method in class org.forgerock.api.jackson.JacksonUtils
Validate that the provided JSON conforms to the schema.
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.
ValidationException - Exception in org.forgerock.json.schema.validator.exceptions
Encapsulate a JSON validator error.
ValidationException(String) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
Create an exception with the given message.
ValidationException(String, Throwable) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
Create an exception with the given message and cause.
ValidationException(String, Throwable, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
Create an exception with the given message, cause and path.
ValidationException(String, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
Create an exception with the given message and path.
ValidationException(String, JsonPointer, Object) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
Create an exception with the given message, value and path.
ValidationException(Exception, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
Create an exception with the given cause and path.
ValidationException(String, Exception, JsonPointer) - Constructor for exception org.forgerock.json.schema.validator.exceptions.ValidationException
Create an exception with the given message, cause and path.
ValidationUtil - Class in org.forgerock.api.util
API Descriptor model-validation utilities.
Validator - Class in org.forgerock.json.schema.validator.validators
Validator is the abstract base class of all typed validator.
Validator(Map<String, Object>, List<String>) - Constructor for class org.forgerock.json.schema.validator.validators.Validator
Default ctor.
value(String) - Method in class org.forgerock.api.models.Reference.Builder
Setter for Reference-value.
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.jwk.KeyUse
Get the Value of the KeyUse.
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(String) - Static method in enum org.forgerock.api.commons.CommonsApi.Errors
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.CountPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.CreateMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.CreateSingleton
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.PagingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.ParameterSource
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.PatchOperation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.QueryType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.ReadPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.Stability
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.enums.WritePolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant
Returns the enum constant of this 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.filter.Filters.FilterNames
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(Message) - Static method in class org.forgerock.http.header.AcceptApiVersionHeader
Constructs a new header, initialized from the specified message.
valueOf(String) - Static method in class org.forgerock.http.header.AcceptApiVersionHeader
Constructs a new header, initialized from the specified string value.
valueOf(PreferredLocales) - Static method in class org.forgerock.http.header.AcceptLanguageHeader
Creates an accept language header representation for a PreferredLocales instance.
valueOf(List<Locale>) - Static method in class org.forgerock.http.header.AcceptLanguageHeader
Create a header from a list of preferred Locale instances.
valueOf(String...) - Static method in class org.forgerock.http.header.AcceptLanguageHeader
Create a header from a list of preferred Locale language tags.
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.ConnectionHeader
Constructs a new header, initialized from the specified message.
valueOf(String) - Static method in class org.forgerock.http.header.ConnectionHeader
Constructs a new header, initialized from the specified string value.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentApiVersionHeader
Constructs a new header, initialized from the specified message.
valueOf(String) - Static method in class org.forgerock.http.header.ContentApiVersionHeader
Constructs a new header, initialized from the specified string.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentEncodingHeader
Constructs a new header, initialized from the specified message.
valueOf(String) - Static method in class org.forgerock.http.header.ContentEncodingHeader
Constructs a new header, initialized from the specified string value.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentLengthHeader
Constructs a new header, initialized from the specified message.
valueOf(String) - Static method in class org.forgerock.http.header.ContentLengthHeader
Constructs a new header, initialized from the specified string value.
valueOf(Message) - Static method in class org.forgerock.http.header.ContentTypeHeader
Constructs a new header, initialized from the specified message.
valueOf(String) - Static method in class org.forgerock.http.header.ContentTypeHeader
Constructs a new header, initialized from the specified string value.
valueOf(Request) - Static method in class org.forgerock.http.header.CookieHeader
Constructs a new header, initialized from the specified request message.
valueOf(String) - Static method in class org.forgerock.http.header.CookieHeader
Constructs a new header, initialized from the specified string value.
valueOf(Message) - Static method in class org.forgerock.http.header.LocationHeader
Constructs a new header, initialized from the specified message.
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.SetCookie2Header
Constructs a new header, initialized from the specified string value.
valueOf(Response) - Static method in class org.forgerock.http.header.SetCookie2Header
Constructs a new header, initialized from the specified response message.
valueOf(List<String>) - Static method in class org.forgerock.http.header.SetCookie2Header
Constructs a new header, initialized from the specified list of Set-Cookie2 values.
valueOf(String) - Static method in class org.forgerock.http.header.SetCookieHeader
Constructs a new header, initialized from the specified string value.
valueOf(Response) - Static method in class org.forgerock.http.header.SetCookieHeader
Constructs a new header, initialized from the specified response message.
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(Request) - Static method in class org.forgerock.http.header.TransactionIdHeader
Constructs a new header, initialized from the specified request.
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(Message) - Static method in class org.forgerock.http.header.WarningHeader
Constructs a new header, initialized from the specified message.
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.Status.Family
Returns the enum constant of this type with the specified name.
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(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(Object) - Static method in class org.forgerock.i18n.LocalizableMessage
Creates a new message whose content is the String representation of the provided Object.
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.jwk.KeyUse
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(JsonValue) - Static method in class org.forgerock.json.resource.PatchOperation
Parses the provided JSON content as a patch operation.
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.openig.decoration.capture.CapturePoint
Returns the enum constant of this type with the specified name.
valueOf(String, Class<T>) - Static method in class org.forgerock.openig.el.Expression
Factory method to create an Expression.
valueOf(String, Class<T>, Bindings) - 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) - 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
Returns the enum constant of this type with the specified name.
valueOf(Message) - Static method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
Constructs a new header, initialized from the specified message.
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.OpenAmServer.OpenAmVersion
Returns the enum constant of this type with the specified name.
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, or null if the specified enum type has no constant with the specified name, or if the specified class object does not represent an enum type.
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.security.keystore.KeyStoreType
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(JsonValue) - Static method in class org.forgerock.services.TransactionId
Creates a TransactionId from a JsonValue.
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.
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.api.commons.CommonsApi.Errors
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.CountPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.CreateMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.CreateSingleton
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.PagingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.ParameterSource
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.PatchOperation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.QueryType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.ReadPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.Stability
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.enums.WritePolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant
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.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.filter.Filters.FilterNames
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() - 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.jwk.KeyUse
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.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
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() - Method in class org.forgerock.openig.jwt.JwtCookieSession
 
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.OpenAmServer.OpenAmVersion
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.security.keystore.KeyStoreType
Deprecated.
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.
valueWasQuoted() - Method in class org.forgerock.http.protocol.Cookie
Returns true if the cookie value was enclosed in "" when it was parsed, false otherwise.
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(SigningHandler) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
Verifies that the signature is valid on the nested signed JWT.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
 
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler
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
Verifies that the signature length is zero.
verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler
Verifies that the given signature is valid for the given data.
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(SigningHandler) - Method in class org.forgerock.json.jose.jws.SignedJwt
Verifies that the JWS signature is valid for the contents of its payload.
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.
version(String) - Method in class org.forgerock.api.models.ApiDescription.Builder
Set the version of the API.
Version - Class in org.forgerock.http.routing
Represents some version in the form majorNumber.minorNumber, for instance 2.4.
version(int, int) - Static method in class org.forgerock.http.routing.Version
Creates a new version using the provided version information.
version(int) - Static method in class org.forgerock.http.routing.Version
Creates a new version using the provided version information and a minor.
version(String) - Static method in class org.forgerock.http.routing.Version
Parses the string argument as a version.
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_MISMATCH_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.VERSION_MISMATCH in an API Description.
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.
VERSION_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi
JSON Reference to CommonsApi.Errors.VERSION_REQUIRED in an API Description.
VersionedPath - Class in org.forgerock.api.models
Class that represents versioned Resources on an API descriptor path.
versionedPath() - Static method in class org.forgerock.api.models.VersionedPath
Create a new Builder for VersionedPath.
VersionedPath.Builder - Class in org.forgerock.api.models
Builder to help construct the VersionedPath.
VersionUtil - Class in org.forgerock.openig.util
Utility class to retrieve version information about this project.
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.
visit(Operation) - Method in interface org.forgerock.api.transform.OpenApiHelper.OperationVisitor
Visits a Swagger Operation.
visitActionRequest(P, ActionRequest) - Method in interface org.forgerock.json.resource.RequestVisitor
Visits an action request.
visitAllOperations(OpenApiHelper.OperationVisitor, Swagger) - Static method in class org.forgerock.api.transform.OpenApiHelper
Visits all operations.
visitAndFilter(P, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitAndFilter(JsonValue, List<QueryFilter<JsonPointer>>) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitAndFilter(Void, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits an and filter.
visitAndFilter(P, List<QueryFilter<F>>) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits an and filter.
visitBooleanLiteralFilter(P, boolean) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitBooleanLiteralFilter(JsonValue, boolean) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitBooleanLiteralFilter(Void, boolean) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a boolean literal filter.
visitBooleanLiteralFilter(P, boolean) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a boolean literal filter.
visitContainsFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitContainsFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitContainsFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a contains filter.
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(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitEqualsFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitEqualsFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a equality filter.
visitEqualsFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a equality filter.
visitExtendedMatchFilter(P, F, String, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitExtendedMatchFilter(JsonValue, JsonPointer, String, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitExtendedMatchFilter(Void, F, String, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a comparison filter.
visitExtendedMatchFilter(P, F, String, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a comparison filter.
visitGreaterThanFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitGreaterThanFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitGreaterThanFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a greater than filter.
visitGreaterThanFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a greater than filter.
visitGreaterThanOrEqualToFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitGreaterThanOrEqualToFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitGreaterThanOrEqualToFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a greater than or equal to filter.
visitGreaterThanOrEqualToFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a greater than or equal to filter.
visitLessThanFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitLessThanFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitLessThanFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a less than filter.
visitLessThanFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a less than filter.
visitLessThanOrEqualToFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitLessThanOrEqualToFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitLessThanOrEqualToFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a less than or equal to filter.
visitLessThanOrEqualToFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a less than or equal to filter.
visitNotFilter(P, QueryFilter<F>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitNotFilter(JsonValue, QueryFilter<JsonPointer>) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitNotFilter(Void, QueryFilter<F>) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a not filter.
visitNotFilter(P, QueryFilter<F>) - Method in interface org.forgerock.util.query.QueryFilterVisitor
Visits a not filter.
visitOrFilter(P, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitOrFilter(JsonValue, List<QueryFilter<JsonPointer>>) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitOrFilter(Void, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits an or filter.
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(P, F) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitPresentFilter(JsonValue, JsonPointer) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitPresentFilter(Void, F) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a present filter.
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(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
 
visitStartsWithFilter(JsonValue, JsonPointer, Object) - Method in class org.forgerock.util.query.JsonValueFilterVisitor
 
visitStartsWithFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
Visits a starts with filter.
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

warn(LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(LocalizableMessage) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(LocalizableMessage, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg0) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message using the provided Marker.
warn(Marker, LocalizableMessageDescriptor.Arg0, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message using the provided Marker.
warn(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg1<T1>, T1, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg2<T1, T2>, T1, T2, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg3<T1, T2, T3>, T1, T2, T3, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg4<T1, T2, T3, T4>, T1, T2, T3, T4, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg5<T1, T2, T3, T4, T5>, T1, T2, T3, T4, T5, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg6<T1, T2, T3, T4, T5, T6>, T1, T2, T3, T4, T5, T6, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg7<T1, T2, T3, T4, T5, T6, T7>, T1, T2, T3, T4, T5, T6, T7, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg8<T1, T2, T3, T4, T5, T6, T7, T8>, T1, T2, T3, T4, T5, T6, T7, T8, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.Arg9<T1, T2, T3, T4, T5, T6, T7, T8, T9>, T1, T2, T3, T4, T5, T6, T7, T8, T9, Throwable) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
warn(Marker, LocalizableMessageDescriptor.ArgN, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message.
warn(Marker, LocalizableMessageDescriptor.ArgN, Throwable, Object...) - Method in class org.forgerock.i18n.slf4j.LocalizedLogger
Logs a warning message with an accompanying exception.
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
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.
WarningHeader - Class in org.forgerock.http.header
Processes the Warning message header.
WarningHeader(Warning) - Constructor for class org.forgerock.http.header.WarningHeader
Constructor for single Warning.
WarningHeader(List<Warning>) - Constructor for class org.forgerock.http.header.WarningHeader
Constructor for multiple Warnings.
wasQuoted() - Method in class org.forgerock.http.header.HeaderUtil.Parameter
Return true if the original header value was enclosed in quotes.
WelcomeHandler - Class in org.forgerock.openig.handler
Creates a static response containing a simple HTML welcome page.
WelcomeHandler(Factory<Buffer>) - Constructor for class org.forgerock.openig.handler.WelcomeHandler
Creates a new welcome page handler.
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.
WindowsEnvironment - Class in org.forgerock.openig.config.env
Represents a Windows default environment.
WindowsEnvironment() - Constructor for class org.forgerock.openig.config.env.WindowsEnvironment
Builds a new Windows environment that will be located in the $AppData$ directory.
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.
withAuditTopics(Collection<String>) - Method in class org.forgerock.audit.filter.FilterChainBuilder
Adds the topics this filter chain is for.
withCaseInsensitiveFields(List<String>) - Method in class org.forgerock.audit.filter.FilterChainBuilder
Specifies which topic fields should be filtered case-insensitively.
withConfiguration(AuditServiceConfiguration) - Method in class org.forgerock.audit.AuditServiceBuilder
Sets the AuditServiceConfiguration that is to be passed to the AuditService.
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.
withDependencyProvider(DependencyProvider) - Method in class org.forgerock.audit.AuditServiceBuilder
Register the DependencyProvider, after which, an AuditEventHandler can be registered and receive this provider.
withEventTopicsMetaData(EventTopicsMetaData) - Method in class org.forgerock.audit.AuditServiceBuilder
Set the topic metadata that should be used by the audit service and the handlers.
WithExampleSchema<T> - Interface in org.forgerock.api.jackson
Extension for CREST and OpenAPI schemas to express an example value.
withInputStream(InputStream) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the input stream to load the keystore from.
withKeyStoreFile(File) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the file to load the keystore from.
withKeyStoreFile(String) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the file to load the keystore from.
withKeyStoreType(KeyStoreType) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Deprecated.
Use withKeyStoreType(String) instead. Use of the KeyStoreType enum is deprecated as it restricts the keystore type to those specified in the enum. Library consumers may want to specify the keystore type at runtime.
withKeyStoreType(String) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the type of keystore to load.
withLoadStoreParameter(KeyStore.LoadStoreParameter) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the KeyStore.LoadStoreParameter to use to load the KeyStore.
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.
withPassword(char[]) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the password to unlock the keystore.
withPassword(String) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the password to unlock the keystore.
withPath(ApiDescription, String) - Method in class org.forgerock.api.CrestApiProducer
 
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
 
withPolicies(Map<String, FilterPolicy>) - Method in class org.forgerock.audit.filter.FilterChainBuilder
Adds the policies to chain together.
withProvider(Provider) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the security provider to use for the keystore.
withProvider(String) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the security provider to use for the keystore.
withProviderArgument(String) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the argument to the Java Keystore Provider.
withProviderClass(String) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the java class name of a keystore provider.
withProviderClass(String, ClassLoader) - Method in class org.forgerock.security.keystore.KeyStoreBuilder
Specifies the java class name of a keystore provider.
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.
withVersion(ApiDescription, Version) - Method in class org.forgerock.api.CrestApiProducer
 
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
 
write(String) - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter
Write the log record asynchronously.
write(int) - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream
Write the specified byte to the stream.
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(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(char[], int, int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
 
write(int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
 
write(char[]) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
 
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.
WritePolicy - Enum in org.forgerock.api.enums
Enum that represents the Schema write policies.
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.

X

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
Gets the X509 thumbnail.
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.
x5t(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the X.509 Certificate Thumbprint header parameter for this JWS.
x5u(URL) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the X.509 URL header parameter for this JWS.
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.
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 
Skip navigation links
OpenIG 5.5.1 API

Copyright 2011-2017 ForgeRock AS.