Skip navigation links
Identity Gateway 6.5.4 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

abandon() - Method in class org.forgerock.opendj.ldap.RequestHandle
Returns a Completable which, once subscribed, will attempt to abandon the operation.
abandonAsync(AbandonRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Abandons the unfinished operation identified in the provided abandon request.
abandonAsync(AbandonRequest) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
Abandon operations are not supported because operations are performed synchronously and the ID of the request to be abandoned cannot be determined.
abandonAsync(AbandonRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Abandons the unfinished operation identified in the provided abandon request.
AbandonRequest - Interface in org.forgerock.opendj.ldap.messages
The Abandon operation allows a client to request that the server abandon an uncompleted operation.
abort() - Method in interface org.forgerock.opendj.io.LdapSocket
Disconnects this socket.
abortWithReason(IOException) - Method in interface org.forgerock.opendj.io.LdapSocket
Disconnects the socket.
AbstractAsn1Reader - Class in org.forgerock.opendj.io
An abstract ASN1Reader which can be used as the basis for implementing new ASN1 reader implementations.
AbstractAsn1Reader() - Constructor for class org.forgerock.opendj.io.AbstractAsn1Reader
Creates a new abstract ASN.1 reader.
AbstractAsn1Writer - Class in org.forgerock.opendj.io
An abstract ASN1Writer which can be used as the basis for implementing new ASN1 writer implementations.
AbstractAsn1Writer() - Constructor for class org.forgerock.opendj.io.AbstractAsn1Writer
Creates a new abstract ASN.1 writer.
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.
AbstractAsynchronousConnection - Class in org.forgerock.opendj.ldap
An abstract connection whose synchronous methods are implemented in terms of asynchronous methods.
AbstractAsynchronousConnection() - Constructor for class org.forgerock.opendj.ldap.AbstractAsynchronousConnection
Creates a new abstract asynchronous connection.
AbstractAttribute - Class in org.forgerock.opendj.ldap
This class provides a skeletal implementation of the Attribute interface, to minimize the effort required to implement this interface.
AbstractAttribute() - Constructor for class org.forgerock.opendj.ldap.AbstractAttribute
Sole constructor.
AbstractConditionAdviceFilter - Class in org.forgerock.openig.openam
Abstract Filter base class providing policy condition advice support.
AbstractConnection - Class in org.forgerock.opendj.ldap
This class provides a skeletal implementation of the Connection interface, to minimize the effort required to implement this interface.
AbstractConnection() - Constructor for class org.forgerock.opendj.ldap.AbstractConnection
Creates a new abstract 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.
AbstractConnectionWrapper<C extends Connection> - Class in org.forgerock.opendj.ldap
An abstract base class from which connection wrappers may be easily implemented.
AbstractConnectionWrapper(C) - Constructor for class org.forgerock.opendj.ldap.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.
 
AbstractEntry - Class in org.forgerock.opendj.ldap
This class provides a skeletal implementation of the Entry interface, to minimize the effort required to implement this interface.
AbstractEntry() - Constructor for class org.forgerock.opendj.ldap.AbstractEntry
Default constructor.
AbstractEqualityMatchingRuleImpl - Class in org.forgerock.opendj.ldap.schema
This class implements an equality matching rule that matches normalized values in byte order.
AbstractEqualityMatchingRuleImpl(String) - Constructor for class org.forgerock.opendj.ldap.schema.AbstractEqualityMatchingRuleImpl
Creates an instance of the equality matching rule.
AbstractExtendedRequest<ER extends ExtendedRequest<S>,S extends ExtendedResult> - Class in org.forgerock.opendj.ldap.messages
An abstract Extended request which can be used as the basis for implementing new Extended operations.
AbstractExtendedRequest() - Constructor for class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
Creates a new abstract extended request.
AbstractExtendedRequest(ExtendedRequest<S>) - Constructor for class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
Creates a new extended request that is an exact copy of the provided request.
AbstractExtendedResult<S extends ExtendedResult> - Class in org.forgerock.opendj.ldap.messages
An abstract Extended result which can be used as the basis for implementing new Extended operations.
AbstractExtendedResult(ExtendedResult) - Constructor for class org.forgerock.opendj.ldap.messages.AbstractExtendedResult
Creates a new extended result that is an exact copy of the provided result.
AbstractExtendedResult(ResultCode) - Constructor for class org.forgerock.opendj.ldap.messages.AbstractExtendedResult
Creates a new extended result using the provided result code.
AbstractExtendedResultDecoder<S extends ExtendedResult> - Class in org.forgerock.opendj.ldap.messages
This class provides a skeletal implementation of the ExtendedResultDecoder interface, to minimize the effort required to implement this interface.
AbstractExtendedResultDecoder() - Constructor for class org.forgerock.opendj.ldap.messages.AbstractExtendedResultDecoder
Creates a new abstract extended result decoder.
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
 
AbstractIntermediateResponse<S extends IntermediateResponse> - Class in org.forgerock.opendj.ldap.messages
An abstract Intermediate response which can be used as the basis for implementing new Intermediate responses.
AbstractIntermediateResponse() - Constructor for class org.forgerock.opendj.ldap.messages.AbstractIntermediateResponse
Creates a new intermediate response.
AbstractIntermediateResponse(IntermediateResponse) - Constructor for class org.forgerock.opendj.ldap.messages.AbstractIntermediateResponse
Creates a new intermediate response that is an exact copy of the provided response.
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
 
AbstractMapEntry<M extends Map<AttributeDescription,Attribute>> - Class in org.forgerock.opendj.ldap
Abstract implementation for Map based entries.
AbstractMapEntry(Dn, M) - Constructor for class org.forgerock.opendj.ldap.AbstractMapEntry
Creates an empty entry using the provided distinguished name and Map.
AbstractMeterRegistry - Class in org.forgerock.monitoring.dropwizard
Creates and manages your application's set of meters.
AbstractMeterRegistry(Clock) - Constructor for class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Creates an abstract meter registry.
AbstractMeterRegistry.ConfigImpl - Class in org.forgerock.monitoring.dropwizard
Access to configuration options for this registry.
AbstractOrderingMatchingRuleImpl - Class in org.forgerock.opendj.ldap.schema
This class implements a default ordering matching rule that matches normalized values in byte order.
AbstractOrderingMatchingRuleImpl(String) - Constructor for class org.forgerock.opendj.ldap.schema.AbstractOrderingMatchingRuleImpl
Creates an instance of the ordering matching rule.
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.
AbstractRequestVisitor<R,P,E extends Exception> - Class in org.forgerock.opendj.ldap.messages
Abstract class that implements the RequestVisitor interface.
AbstractRequestVisitor() - Constructor for class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
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
 
AbstractSynchronousConnection - Class in org.forgerock.opendj.ldap
An abstract connection whose asynchronous methods are implemented in terms of synchronous methods.
AbstractSynchronousConnection() - Constructor for class org.forgerock.opendj.ldap.AbstractSynchronousConnection
Creates a new abstract synchronous connection.
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(Predicate<Meter.Id>) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
When the given predicate is true, the meter should be present in published metrics.
accept() - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Include a meter in published metrics.
accept(Meter.Id) - Method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
 
accept(RequestVisitor<R, P, E>, P) - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
 
accept(RequestVisitor<R, P, E>, P) - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
 
accept(RequestVisitor<R, P, E>, P) - Method in interface org.forgerock.opendj.ldap.messages.Request
Applies a RequestVisitor to this Request.
accept(RequestVisitor<R, P, E>, P) - Method in class org.forgerock.opendj.ldap.messages.UnknownRequest
 
accept(T) - Method in interface org.forgerock.util.Consumer
Consume the 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(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractAsynchronousConnection
 
action(Context, ActionRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Performs an action against a specific resource, or set of resources.
action(Context, ActionRequest) - Method in interface org.forgerock.json.resource.Connection
Performs an action against a specific resource, or set of resources.
Action<E extends Exception> - Interface in org.forgerock.util
An Runnable functional interface which can throw a checked Exception.
ACTION_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.
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.
adaptDecodeException(DecodeException) - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedResultDecoder
 
adaptDecodeException(DecodeException) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResultDecoder
Creates a new extended operation error result using the provided decoding exception.
adaptSchemaForValidation(Schema) - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns a strict view of the provided schema if the this policy is configured to check attributes and object class, or a non-strict view of the schema if not.
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(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(AddRequest) - Method in class org.forgerock.opendj.ldap.AbstractAsynchronousConnection
 
add(Object...) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
add(Entry) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
add(String...) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
add(AddRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Adds an entry to the Directory Server using the provided add request.
add(Entry) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Adds the provided entry to the Directory Server.
add(String...) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Adds an entry to the Directory Server using the provided lines of LDIF.
add(ByteString) - Method in interface org.forgerock.opendj.ldap.Attribute
Adds value to this attribute if it is not already present (optional operation).
add(Object...) - Method in interface org.forgerock.opendj.ldap.Attribute
Adds all of the provided attribute values to this attribute if they are not already present (optional operation).
add(AddRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Adds an entry to the Directory Server using the provided add request.
add(Entry) - Method in interface org.forgerock.opendj.ldap.Connection
Adds the provided entry to the Directory Server.
add(String...) - Method in interface org.forgerock.opendj.ldap.Connection
Adds an entry to the Directory Server using the provided lines of LDIF.
add(AddRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Adds an entry to the Directory Server using the provided add request.
add(ByteString) - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
add(String, Object...) - Static method in class org.forgerock.opendj.ldap.Modification
Returns a new modification for adding an attribute with the provided description and values.
ADD - Static variable in class org.forgerock.opendj.ldap.ModificationType
Add the values listed in the modification to the attribute, creating the attribute if necessary.
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(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 ByteString>) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
addAll(Collection<T>, Collection<? super T>) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
addAll(Collection<? extends ByteString>) - Method in interface org.forgerock.opendj.ldap.Attribute
Adds all of the attribute values contained in values to this attribute if they are not already present (optional operation).
addAll(Collection<T>, Collection<? super T>) - Method in interface org.forgerock.opendj.ldap.Attribute
Adds all of the attribute values contained in values to this attribute if they are 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(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
 
addAsync(AddRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
addAsync(AddRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously adds an entry to the Directory Server using the provided add request.
addAsync(AddRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously adds an entry to the Directory Server using the provided add request.
addAsync(AddRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
addAsync(AddRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously adds an entry to the Directory Server using the provided add request.
addAsync(AddRequest, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously adds an entry to the Directory Server using the provided add request.
addAttribute(Attribute, Collection<? super ByteString>) - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
addAttribute(Attribute, Collection<? super ByteString>) - Method in class org.forgerock.opendj.ldap.Entries.NullEntry
 
addAttribute(Attribute) - Method in interface org.forgerock.opendj.ldap.Entry
Ensures that this entry contains the provided attribute and values (optional operation).
addAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.Entry
Ensures that this entry contains the provided attribute and values (optional operation).
addAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.Entry
Ensures that this entry contains the provided attribute and values (optional operation).
addAttribute(Attribute) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
addAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
addAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
addAttribute(String...) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Adds the provided attribute name(s) to the list of attributes to be included with each entry that matches the search criteria.
addAttribute(Attribute) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
addAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
addAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
addAttributeIfAbsent(Attribute) - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
addAttributeIfAbsent(Attribute) - Method in interface org.forgerock.opendj.ldap.Entry
Adds the provided attribute if it is not already present in this Entry and returns null.
addAttributeType(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided attribute type definition to this schema builder.
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.
addChallenge(String, String, Map<String, String>) - Method in class org.forgerock.http.header.WwwAuthenticateHeader
Add a new challenge.
addChallenge(WwwAuthenticateHeader.Challenge) - Method in class org.forgerock.http.header.WwwAuthenticateHeader
Add a new authentication option.
addConnectionEventListener(ConnectionEventListener) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Registers the provided connection event listener so that it will be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
addConnectionEventListener(ConnectionEventListener) - Method in interface org.forgerock.opendj.ldap.Connection
Registers the provided connection event listener so that it will be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
addConnectionEventListener(ConnectionEventListener) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Registers the provided connection event listener so that it will be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
addConnectionEventListener(ConnectionEventListener) - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Registers the provided connection event listener so that it will be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
addConnectionEventListener(Consumer<ConnectionEvent>) - Method in interface org.forgerock.openig.tools.notifications.NotificationService
Registers asynchronously a listener that will be notified on connection/disconnection events.
addConnectionEventListener(Consumer<ConnectionEvent>) - Method in class org.forgerock.openig.tools.notifications.ws.TyrusNotificationService
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.AbandonRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.DeleteRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.IntermediateResponse
 
addControl(Control) - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.ProtocolOp
Adds the provided control to this protocol-op.
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.Request
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.Response
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.Result
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultReference
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.UnbindRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
addControl(Control) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
addControl(Control) - Method in interface org.forgerock.opendj.ldif.ChangeRecord
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.AbandonRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.DeleteRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.IntermediateResponse
 
addControls(Iterable<? extends Control>) - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.ProtocolOp
Adds the provided controls to this protocol-op.
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.Request
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.Response
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.Result
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultReference
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.UnbindRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
addControls(Iterable<? extends Control>) - Method in interface org.forgerock.opendj.ldif.ChangeRecord
 
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
 
addDitContentRule(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided DIT content rule definition to this schema builder.
addDitStructureRule(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided DIT structure rule definition to this schema builder.
addEnumerationSyntax(String, String, boolean, String...) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided enumeration syntax definition to this schema builder.
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.
addHeaders(Header...) - Method in interface org.forgerock.http.protocol.Message
Add one or more headers to the request.
addHeaders(Header...) - Method in class org.forgerock.http.protocol.MessageImpl
 
addHeaderValue(String, Expression<String>) - Method in class org.forgerock.openig.filter.StaticRequestFilter
Adds a new header value using the given key with the given Expression.
ADDITIONALITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
The additionalItems field name.
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.
addListener(LdapSessionCompletionListener) - Method in interface org.forgerock.opendj.ldap.LdapSession
Register a listener which will be notified when this LdapSession changes state.
addMatchingRule(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided matching rule definition to this schema builder.
addMatchingRuleUse(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided matching rule use definition to this schema builder.
addModification(Modification) - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
Appends the provided modification to the list of modifications included with this modify request.
addModification(ModificationType, String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
Appends the provided modification to the list of modifications included with this modify request.
addNameForm(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided name form definition to this schema builder.
addObjectClass(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided object class definition to this schema builder.
addOpenDjSecurityProviderSchema(SchemaBuilder) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProviderSchema
Adds the schema elements required by the OpenDJ security provider to the provided schema builder.
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.
addPatternSyntax(String, String, Pattern, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided pattern syntax definition to this schema builder.
addPermissive(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
Adds the value identified by the specified pointer, relative to this value as root.
addReferralUri(String) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
addReferralUri(String) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
addReferralUri(String) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
addReferralUri(String) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
addReferralUri(String) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
addReferralUri(String) - Method in interface org.forgerock.opendj.ldap.messages.Result
Adds the provided referral URI to this result.
addReferralUri(String) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
AddRequest - Interface in org.forgerock.opendj.ldap.messages
The Add operation allows a client to request the addition of an entry into the Directory.
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.
AddressMask - Class in org.forgerock.opendj.ldap
An address mask can be used to perform efficient comparisons against IP addresses to determine whether a particular IP address is in a given range.
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.
addSchema(Connection, Dn, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Reads the schema elements contained in the named subschema sub-entry and adds them to this schema builder.
addSchema(Entry, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds all of the schema elements contained in the provided subschema subentry to this schema builder.
addSchema(Entry, boolean, SchemaBuilder.SchemaBuilderHook) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds all of the schema elements contained in the provided subschema subentry to this schema builder.
addSchema(Schema, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds all of the schema elements in the provided schema to this schema builder.
addSchema(LdapClientSocket, Dn, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Reads the schema elements contained in the named subschema sub-entry and adds them to this schema builder.
addSchemaAsync(Connection, Dn, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Asynchronously reads the schema elements contained in the named subschema sub-entry and adds them to this schema builder.
addSchemaForEntry(Connection, Dn, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Reads the schema elements contained in the subschema sub-entry which applies to the named entry and adds them to this schema builder.
addSchemaForEntry(LdapClientSocket, Dn, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Reads the schema elements contained in the subschema sub-entry which applies to the named entry and adds them to this schema builder.
addSchemaForEntryAsync(Connection, Dn, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Asynchronously reads the schema elements contained in the subschema sub-entry which applies to the named entry and adds them to this schema builder.
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.
addStopAction(Runnable) - Method in class org.forgerock.openig.decoration.DecorationHandle
Adds an action to execute when the decoration stops.
addSubstitutionSyntax(String, String, String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided substitution syntax definition to this schema builder.
addSyntax(String, boolean) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Adds the provided syntax definition to this schema builder.
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
 
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Adds this attribute type to the schema, throwing a ConflictingSchemaElementException if there is an existing attribute type with the same numeric OID.
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds this DIT content rule to the schema, throwing a ConflictingSchemaElementException if there is an existing DIT content rule with the same structural object class OID.
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Adds this DIT structure rule to the schema, throwing a ConflictingSchemaElementException if there is an existing DIT structure rule with the same numeric ID.
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Adds this matching rule to the schema, throwing a ConflictingSchemaElementException if there is an existing matching rule with the same numeric OID.
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Adds this matching rule use definition to the schema, throwing a ConflictingSchemaElementException if there is an existing matching rule definition with the same numeric OID.
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds this name form to the schema, throwing a ConflictingSchemaElementException if there is an existing name form with the same numeric OID.
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds this object class to the schema, throwing a ConflictingSchemaElementException if there is an existing object class with the same numeric OID.
addToSchema() - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
Adds this syntax to the schema, throwing a ConflictingSchemaElementException if there is an existing syntax with the same numeric OID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Adds this attribute type to the schema overwriting any existing attribute type with the same numeric OID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds this DIT content rule to the schema overwriting any existing content rule with the same structural class OID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Adds this DIT structure rule to the schema overwriting any existing DIT structure rule with the same numeric ID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Adds this matching rule to the schema overwriting any existing matching rule with the same numeric OID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Adds this matching rule use definition to the schema overwriting any existing matching rule use definition with the same numeric OID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds this name form to the schema overwriting any existing name form with the same numeric OID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds this object class to the schema overwriting any existing object class with the same numeric OID.
addToSchemaOverwrite() - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
Adds this syntax to the schema overwriting any existing syntax with the same numeric OID.
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.
addUri(String) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultReference
Adds the provided continuation reference URI to this search result reference.
ADMIN_LIMIT_EXCEEDED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that processing on the requested operation could not continue because an administrative limit was exceeded.
AdminHttpApplication - Class in org.forgerock.openig.http
Configuration class for the Identity Gateway Administration.
AdminHttpApplication(String, JsonValue, Environment, RunMode, PropertyResolver, MeterRegistry) - Constructor for class org.forgerock.openig.http.AdminHttpApplication
AdNotificationRequestControl - Class in org.forgerock.opendj.ldap.controls
The persistent search request control for Active Directory as defined by Microsoft.
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.
AFFECTS_MULTIPLE_DSAS - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the operation could not be processed because it would impact multiple DSAs or other repositories.
afterRollingOver() - Method in interface org.forgerock.audit.events.handlers.writers.RotatableWriter.RolloverLifecycleHook
This method is called after the rotation and retention checks are done.
AgentAuthenticationService - Class in org.forgerock.openig.tools.authentication.chf
An AgentAuthenticationService authenticate agent credentials (not subject credentials), forcing the login module to Application (restricted to agents).
AgentAuthenticationService(Handler, URI) - Constructor for class org.forgerock.openig.tools.authentication.chf.AgentAuthenticationService
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.
ALIAS_DEREFERENCING_PROBLEM - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a problem was encountered while attempting to dereference an alias for a search operation.
ALIAS_PROBLEM - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it attempted to perform an illegal operation on an alias.
AliasSpec(String, BooleanSupplier) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpec
Create an alias specificiation.
allDone(Collection<Promise<?, ?>>) - Static method in class org.forgerock.util.promise.Promises
Returns a Promise which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions).
allDone(Collection<Promise<?, ?>>, V) - Static method in class org.forgerock.util.promise.Promises
Returns a Promise which will be completed successfully once all of the provided promises have completed (successfully or not, including runtime exceptions), returning back the context parameter.
ALLOW_ATTRIBUTE_TYPES_WITH_NO_SUP_OR_SYNTAX - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies whether the schema should allow attribute type definitions that do not declare a superior attribute type or syntax.
ALLOW_MALFORMED_CERTIFICATES - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies whether the Certificate syntax should allow values which do not conform to the X.509 specifications.
ALLOW_MALFORMED_JPEG_PHOTOS - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies whether the JPEG Photo syntax should allow values which do not conform to the JFIF or Exif specifications.
ALLOW_MALFORMED_NAMES_AND_OPTIONS - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies whether the schema should allow certain illegal characters in OIDs and attribute options.
ALLOW_NON_STANDARD_TELEPHONE_NUMBERS - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies whether the Telephone Number syntax should allow values which do not conform to the E.123 international telephone number format.
ALLOW_ZERO_LENGTH_DIRECTORY_STRINGS - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies whether zero-length values will be allowed by the Directory String syntax.
allowedAlgorithms(Predicate<String>) - Method in class org.forgerock.secrets.SecretBuilder
Sets the cryptographic algorithms that can be used with this key.
allowedAlgorithms(Collection<String>) - Method in class org.forgerock.secrets.SecretBuilder
Sets the cryptographic algorithms that can be used with this key.
allowMultiPartJsonRequests() - Method in interface org.forgerock.json.resource.CrestApplication
Whether the JSON content for a request can be sent in a mulipart/form-data payload.
allowsAlgorithm(String) - Method in class org.forgerock.secrets.keys.CryptoKey
Checks whether this key is allowed to be used with the given algorithm.
allUserAndOperationalAttributesFilter() - Static method in class org.forgerock.opendj.ldap.AttributeFilter
Creates a new attribute filter which will include all user and operational attributes.
ALWAYS - Static variable in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
Dereference aliases both in searching and in locating the base object of a Search operation.
alwaysFalse() - Static method in class org.forgerock.opendj.ldap.Filter
Returns the absolute false filter as defined in RFC 4526 which is comprised of an or filter containing zero components.
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.opendj.ldap.Filter
Returns the absolute true filter as defined in RFC 4526 which is comprised of an and filter containing zero components.
alwaysTrue() - Static method in class org.forgerock.util.query.QueryFilter
Returns a filter which matches all resources.
am(Version) - Static method in class org.forgerock.openig.tools.am.AmVersion
Returns a normalized AM version from the given version.
amService - Variable in class org.forgerock.openig.openam.AbstractConditionAdviceFilter
AmService instance supporting policy advice verification.
AmService - Class in org.forgerock.openig.tools.am
Creates a configuration class for AM.
AmService.Builder - Class in org.forgerock.openig.tools.am
Builder of AmService.
AmServiceHeaplet - Class in org.forgerock.openig.openam
This heaplet represents an instance of an AmService that can shared amongst AM related filters such as the SingleSignOnFilter and the PolicyEnforcementFilter.
AmServiceHeaplet() - Constructor for class org.forgerock.openig.openam.AmServiceHeaplet
 
AmVersion - Class in org.forgerock.openig.tools.am
Normalized AM version.
and(Collection<FilterCondition>) - Static method in class org.forgerock.json.resource.Filters
Returns a FilterCondition which will only match requests which match all the provided conditions.
and(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(String, String) - Method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance my merging this collection and the specific key/value pair.
and(String...) - Method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance my merging this collection and the specific key/value pairs.
and(Tag...) - Method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance my merging this collection and the specific tags.
and(Iterable<? extends Tag>) - Method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance my merging this collection and the specific tags.
and() - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical AND of zero condition results, which is always TRUE.
and(ConditionResult...) - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical AND of the provided condition results, which is TRUE if all of the provided condition results are TRUE, FALSE if at least one of them is FALSE, and UNDEFINED otherwise.
and(ConditionResult, ConditionResult) - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical AND of the provided condition results, which is TRUE if both of the provided condition results are TRUE, FALSE if at least one of them is FALSE , and UNDEFINED otherwise.
and(ConditionResult) - Method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical AND of the this condition result with the provided condition result, which is TRUE if both of the condition results are TRUE, FALSE if at least one of them is FALSE, and UNDEFINED otherwise.
and(Collection<Filter>) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new and filter using the provided list of sub-filters.
and(Filter...) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new and filter using the provided list of sub-filters.
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.
anyResultFrom(Stream<Promise<V, E>>) - Static method in class org.forgerock.util.promise.Promises
Takes a stream of promises that may not yet be resolved and returns a resolved value from them, or if none resolve to a result, the failure from the last.
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 admin.json.
ApiProducer<D> - Interface in org.forgerock.http
A producer of API Descriptions.
ApiVersionProtocolHeaderFilter - Class in org.forgerock.openig.tools
This filter overrides the protocol version in Accept-Api-Version header.
ApiVersionProtocolHeaderFilter(Version) - Constructor for class org.forgerock.openig.tools.ApiVersionProtocolHeaderFilter
Creates a new ApiVersionProtocolHeaderFilter.
ApiVersionRouterContext - Class in org.forgerock.http.routing
A Context which is created when a request is and has been routed based on resource API version.
ApiVersionRouterContext(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.
appendBerLength(int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the ASN.1 BER length encoding representation of the provided integer to this byte string builder.
appendByte(int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided byte to this byte string builder.
appendBytes(byte[]) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided byte array to this byte string builder.
appendBytes(byte[], int, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided byte array to this byte string builder.
appendBytes(ByteBuffer, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided ByteBuffer to this byte string builder.
appendBytes(ByteSequence) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided ByteSequence to this byte string builder.
appendBytes(ByteSequenceReader, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided ByteSequenceReader to this byte string builder.
appendBytes(DataInput, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided DataInput to this byte string builder.
appendBytes(InputStream, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the provided InputStream to this byte string builder.
appendCompactUnsigned(long) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the compact encoded bytes of the provided unsigned long to this byte string builder.
appendInt(int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the big-endian encoded bytes of the provided integer to this byte string builder.
appendLong(long) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the big-endian encoded bytes of the provided long to this byte string builder.
appendObject(Object) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the byte string representation of the provided object to this byte string 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.
appendShort(int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the big-endian encoded bytes of the provided short to this byte string builder.
appendUtf8(char[]) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the UTF-8 encoded bytes of the provided char array to this byte string builder.
appendUtf8(String) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Appends the UTF-8 encoded bytes of the provided string to this byte string builder.
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.json.JsonValueTraverseFunction
 
apply(ContextAndRequest) - Method in class org.forgerock.openig.el.ExpressionRequestAsyncFunction
 
apply(String, T) - Method in interface org.forgerock.openig.tools.jwt.JwtClaimConstraint
Apply a constraint to the given claim value.
apply(Jwt) - Method in interface org.forgerock.openig.tools.jwt.JwtConstraint
Apply a constraint to the given JWT.
apply(char[]) - Method in class org.forgerock.secrets.keystore.HsmKeyStoreLoader
 
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(T, U) - Method in interface org.forgerock.util.BiFunction
Process the values.
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.
applyChange(ChangeRecord) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
applyChange(ChangeRecord) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Applies the provided change request to the Directory Server.
applyChange(ChangeRecord) - Method in interface org.forgerock.opendj.ldap.Connection
Applies the provided change request to the Directory Server.
applyChange(ChangeRecord) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Applies the provided change request to the Directory Server.
applyChangeAsync(ChangeRecord) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
applyChangeAsync(ChangeRecord, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
applyChangeAsync(ChangeRecord) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously applies the provided change request to the Directory Server.
applyChangeAsync(ChangeRecord, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously applies the provided change request to the Directory Server.
applyChangeAsync(ChangeRecord) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously applies the provided change request to the Directory Server.
applyChangeAsync(ChangeRecord, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously applies the provided change request to the Directory Server.
applyTo(MatchResult) - Method in class org.forgerock.openig.regex.PatternTemplate
Performs a transformation of a match result by applying the template.
approximate(String, Object) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new approximate match filter using the provided attribute description and assertion value.
approximateMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the matching rule that should be used for approximate matching with this attribute type.
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.
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
 
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.
as(Function<ByteString, ? extends T, E>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a T using the provided Function, or null if the attribute does not contain any values.
as(Function<ByteString, ? extends T, E>, T) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a T using the provided Function, or defaultValue if the attribute does not contain any values.
asArray(Object...) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns an array containing the provided objects converted to byte strings using ByteString.valueOfObject(Object).
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.
asAttributeDescription() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or null if the attribute does not contain any values.
asAttributeDescription(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
asAttributeDescription(String) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
asBoolean() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Boolean object.
asBoolean() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a boolean, or null if the attribute does not contain any values.
asBoolean(boolean) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as an Boolean, or defaultValue if the attribute does not contain any values.
asByteString() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value, or null if the attribute does not contain any values.
asByteString(ByteString) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value, or defaultValue if the attribute does not contain any values.
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.
asCertificate() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a X509Certificate, or null if the attribute does not contain any values.
asCertificate(X509Certificate) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a X509Certificate, or defaultValue if the attribute does not contain any values.
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.
asDn() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a DN using the schema associated with this parser, or null if the attribute does not contain any values.
asDn(Dn) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a DN using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
asDn(String) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a DN using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
asDouble() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Double object.
asEnum() - Method in class org.forgerock.opendj.ldap.ModificationType
Returns the enum equivalent for this modification type.
asEnum() - Method in class org.forgerock.opendj.ldap.ResultCode
Returns the enum equivalent for this result code.
asEnum() - Method in class org.forgerock.opendj.ldap.SearchScope
Returns the enum equivalent for this search scope.
asEnum(String, Class<T>) - Static method in class org.forgerock.util.Strings
Returns the string value as an enum constant of the specified enum type.
asEnum(String, Class<T>) - Static method in class org.forgerock.util.Utils
asGeneralizedTime() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a GeneralizedTime using the generalized time syntax, or null if the attribute does not contain any values.
asGeneralizedTime(GeneralizedTime) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as an GeneralizedTime using the generalized time syntax, or defaultValue if the attribute does not contain any values.
asInputStream() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Returns an InputStream from the current position in the sequence.
asInteger() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as an Integer object.
asInteger() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as an Integer, or null if the attribute does not contain any values.
asInteger(int) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as an Integer, or defaultValue if the attribute does not contain any values.
asJsonValue() - Method in class org.forgerock.http.oauth2.AccessTokenInfo
Returns the raw JSON as a JsonValue.
asJsonValue() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the raw information of the SessionInfo object as JsonValue.
asJsonValue() - Method in class org.forgerock.openig.openam.SsoTokenContext
Returns the info associated with this context as a JsonValue.
asJsonValue() - Method in class org.forgerock.openig.openam.UserProfileContext
Get the raw JSON representation as a JsonValue.
asJwt() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder
 
asJwt() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder
 
asJwt() - Method in interface org.forgerock.json.jose.builders.JwtBuilder
Builds the JWT object from its constituent parts.
asJwt() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
 
asJwt() - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder
 
asLdapPromise(Promise<R, LdapException>) - Static method in class org.forgerock.opendj.ldap.spi.LdapPromises
Converts a Promise to a LdapPromise with a request ID of -1.
asLdapPromise(Promise<R, LdapException>, int) - Static method in class org.forgerock.opendj.ldap.spi.LdapPromises
Converts a Promise to a LdapPromise with the provided request ID.
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.
asList(Object...) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a list containing the provided objects converted to byte strings using ByteString.valueOfObject(Object).
asLong() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Long object.
asLong() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a Long, or null if the attribute does not contain any values.
asLong(long) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a Long, or defaultValue if the attribute does not contain any values.
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.
asMap() - Method in class org.forgerock.util.Pair
Get the pair as a map of key to value.
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.
Asn1 - Class in org.forgerock.opendj.io
This class contains various static factory methods for creating ASN.1 readers and writers.
Asn1Reader - Interface in org.forgerock.opendj.io
An interface for decoding ASN.1 elements from a data source.
Asn1Writer - Interface in org.forgerock.opendj.io
An interface for encoding ASN.1 elements to a data source.
asNonStrictSchema() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns a non-strict view of this schema.
asNumber() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a Number object.
asOutputStream() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns an OutputStream whose write operations append data to this byte string builder.
asPromise() - Method in interface org.forgerock.json.resource.ActionResponse
Return this response as a result Promise.
asPromise() - Method in interface org.forgerock.json.resource.QueryResponse
Return this response as a result Promise.
asPromise() - Method in exception org.forgerock.json.resource.ResourceException
Return this ResourceException as a Promise.
asPromise() - Method in interface org.forgerock.json.resource.ResourceResponse
Return this response as a result Promise.
asPromise() - Method in class org.forgerock.openig.filter.oauth2.Result
Returns a new completed promise wrapping this result.
asRawJson() - Method in class org.forgerock.openig.tools.userprofile.UserProfile
Get the raw JSON representation as a JsonValue.
asReader() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns a ByteSequenceReader which can be used to incrementally read and decode data from this byte sequence.
asReader() - Method in class org.forgerock.opendj.ldap.ByteString
Returns a ByteSequenceReader which can be used to incrementally read and decode data from this byte string.
asReader() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns a ByteSequenceReader which can be used to incrementally read and decode data from this byte string builder.
asRequestHandler(SynchronousRequestHandler) - Static method in class org.forgerock.json.resource.Resources
Adapts the provided SynchronousRequestHandler as a RequestHandler.
asSearchRequest() - Method in class org.forgerock.opendj.ldap.LdapUrl
Creates a new search request containing the parameters of this LDAP URL.
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.
Assertion - Interface in org.forgerock.opendj.ldap
A compiled attribute value assertion.
ASSERTION_FAILED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the filter contained in an assertion control failed to match the target entry.
AssertionFailureException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request failed because the filter contained in an assertion control failed to match the target entry.
AssertionRequestControl - Class in org.forgerock.opendj.ldap.controls
The assertion request control as defined in RFC 4528.
asSetOf(Function<ByteString, ? extends T, E>, Collection<? extends T>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Ts using the provided Function, or defaultValues if the attribute does not contain any values.
asSetOf(Function<ByteString, ? extends T, E>, T...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Ts using the provided Function, or defaultValues if the attribute does not contain any values.
asSetOfAttributeDescription() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or an empty set if the attribute does not contain any values.
asSetOfAttributeDescription(AttributeDescription...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
asSetOfAttributeDescription(Collection<AttributeDescription>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
asSetOfAttributeDescription(String...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
asSetOfBoolean(Boolean...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Booleans, or defaultValues if the attribute does not contain any values.
asSetOfBoolean(Collection<Boolean>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Booleans, or defaultValues if the attribute does not contain any values.
asSetOfByteString(ByteString...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values contained in the attribute, or defaultValues if the attribute does not contain any values.
asSetOfByteString(Collection<ByteString>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values contained in the attribute, or defaultValues if the attribute does not contain any values.
asSetOfCertificate() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of X509Certificates, or an empty set if the attribute does not contain any values.
asSetOfDn() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of DNs using the schema associated with this parser, or an empty set if the attribute does not contain any values.
asSetOfDn(Collection<Dn>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
asSetOfDn(Dn...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
asSetOfDn(String...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
asSetOfGeneralizedTime(Collection<GeneralizedTime>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of GeneralizedTimes using the generalized time syntax, or defaultValues if the attribute does not contain any values.
asSetOfGeneralizedTime(GeneralizedTime...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of GeneralizedTimes using the generalized time syntax, or defaultValues if the attribute does not contain any values.
asSetOfInteger(Collection<Integer>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Integers, or defaultValues if the attribute does not contain any values.
asSetOfInteger(Integer...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Integers, or defaultValues if the attribute does not contain any values.
asSetOfLong(Collection<Long>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Longs, or defaultValues if the attribute does not contain any values.
asSetOfLong(Long...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Longs, or defaultValues if the attribute does not contain any values.
asSetOfString(Collection<String>) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Strings, or defaultValues if the attribute does not contain any values.
asSetOfString(String...) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the values decoded as a set of Strings, or defaultValues if the attribute does not contain any values.
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.
asStrictSchema() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns a strict view of this schema.
asString() - Method in class org.forgerock.json.JsonValue
Returns the JSON value as a String object.
asString() - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a String, or null if the attribute does not contain any values.
asString(String) - Method in class org.forgerock.opendj.ldap.AttributeParser
Returns the first value decoded as a String, or defaultValue if the attribute does not contain any values.
asString(InputStream, Charset) - Static method in class org.forgerock.openig.util.StringUtil
Reads the provided input stream as a string and then closes the stream.
asURI() - Method in class org.forgerock.http.MutableUri
Returns the equivalent URI instance.
asWwwAuthenticateHeader() - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns a representation of this error as a WWW-Authenticate header.
AsyncFunction<VIN,VOUT,E extends Exception> - Interface in org.forgerock.util
An asynchronous Function which returns a result at some point in the future.
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.
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
 
AsyncHttpClientProvider.AsyncBehaviour - Enum in org.forgerock.http.apache.async
When does the response's promise completes.
AsyncRefreshableSupplier<V,E extends Exception> - Class in org.forgerock.openig.tools.authentication.chf
This utility class supports a lock-downgrading strategy to make sure that 2 concurrent calls to compute the "cached" value will result in a single computation.
AsyncRefreshableSupplier(AsyncFunction<Context, V, E>) - Constructor for class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier
Creates a provider ensuring "only-once" invocation of the given compute function.
AsyncResponseHttpClient - Class in org.forgerock.http.apache.async
Apache HTTP Async Client based implementation.
AsyncStreamingHttpClient - Class in org.forgerock.http.apache.async
Apache HTTP Async Client based implementation.
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 - Interface in org.forgerock.opendj.ldap
An attribute, comprising of an attribute description and zero or more attribute values.
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.
ATTRIBUTE_FILTER - Static variable in class org.forgerock.opendj.ldap.Entries
Selects which attributes will be compared.
ATTRIBUTE_OR_VALUE_EXISTS - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it would have resulted in a conflict with an existing attribute or attribute value in the target entry.
AttributeDescription - Class in org.forgerock.opendj.ldap
An attribute description as defined in RFC 4512 section 2.5.
AttributeFilter - Class in org.forgerock.opendj.ldap
A configurable factory for filtering the attributes exposed by an entry.
AttributeFilter() - Constructor for class org.forgerock.opendj.ldap.AttributeFilter
Creates a new attribute filter which will include all user attributes but no operational attributes.
AttributeFilter(Collection<String>) - Constructor for class org.forgerock.opendj.ldap.AttributeFilter
Creates a new attribute filter which will include the attributes identified by the provided search request attribute list.
AttributeFilter(Collection<String>, Schema) - Constructor for class org.forgerock.opendj.ldap.AttributeFilter
Creates a new attribute filter which will include the attributes identified by the provided search request attribute list.
AttributeFilter(String...) - Constructor for class org.forgerock.opendj.ldap.AttributeFilter
Creates a new attribute filter which will include the attributes identified by the provided search request attribute list.
AttributeParser - Class in org.forgerock.opendj.ldap
A fluent API for parsing attributes as different types of object.
Attributes - Class in org.forgerock.opendj.ldap
This class contains methods for creating and manipulating attributes.
attributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Adds the provided list of attribute types to the list of attribute type the matching rule applies to.
attributes(String...) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Adds the provided list of attribute types to the list of attribute type the matching rule applies to.
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.
AttributeType - Class in org.forgerock.opendj.ldap.schema
This class defines a data structure for storing and interacting with an attribute type, which contains information about the format of an attribute and the syntax and matching rules that should be used when interacting with it.
AttributeType.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing attribute type.
AttributeUsage - Enum in org.forgerock.opendj.ldap.schema
This enumeration defines the set of possible attribute usage values that may apply to an attribute type, as defined in RFC 2252.
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.
AUTH_METHOD_NOT_SUPPORTED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested authentication attempt failed because it referenced an invalid SASL mechanism.
authenticate(Context, String, char[]) - Method in interface org.forgerock.openig.tools.authentication.AuthenticationService
Authenticates a subject (identified with the given username and password credentials), returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException on failures (I/O, invalid credentials, ...).
authenticate(Context, String, char[]) - Method in class org.forgerock.openig.tools.authentication.chf.DefaultAuthenticationService
 
AUTHENTICATION_TYPE_SASL - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The authentication type value (0xA3) reserved for SASL authentication.
AUTHENTICATION_TYPE_SIMPLE - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The authentication type value (0x80) reserved for simple authentication.
AuthenticationAuditEventBuilder<T extends AuthenticationAuditEventBuilder<T>> - Class in org.forgerock.audit.events
Builder for audit authentication events.
AuthenticationAuditEventBuilder() - Constructor for class org.forgerock.audit.events.AuthenticationAuditEventBuilder
 
AuthenticationAuditEventBuilder.Status - Enum in org.forgerock.audit.events
Defines a fixed set of authentication statuses that can be logged.
authenticationEvent() - Static method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder
Starts to build an audit authentication event.
AuthenticationException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Bind Request failed due to an authentication failure.
AuthenticationException - Exception in org.forgerock.openig.tools.authentication
Represents an authentication error or failure.
AuthenticationException(String) - Constructor for exception org.forgerock.openig.tools.authentication.AuthenticationException
Constructs a new exception with the given message.
AuthenticationException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.authentication.AuthenticationException
Constructs a new exception with the given message and root cause.
authenticationService(AuthenticationService) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Bind a AuthenticationService instance to this builder.
AuthenticationService - Interface in org.forgerock.openig.tools.authentication
Asynchronous AM authentication service delivering SsoToken.
authFailed(HttpHost, AuthScheme, HttpContext) - Method in class org.forgerock.http.apache.NoAuthenticationStrategy
 
AUTHN_BIND_REQUEST - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Configures the connection factory to return pre-authenticated connections using the specified BindRequest.
AUTHN_BIND_REQUEST_FACTORY - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Configures the connection factory to return pre-authenticated connections using BindRequest provided by the specified Supplier.
AUTHORIZATION_DENIED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that should be used if the server will not allow the client to use the requested authorization.
AuthorizationException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request failed due to an authorization failure.
AuthorizationHeader - Class in org.forgerock.http.header
A header class representing the Authorization HTTP header.
AuthorizationHeader() - Constructor for class org.forgerock.http.header.AuthorizationHeader
 
AuthorizationHeader.Factory - Class in org.forgerock.http.header
A factory for creating AuthorizationHeader instances.
AuthorizationIdentityRequestControl - Class in org.forgerock.opendj.ldap.controls
The authorization request control as defined in RFC 3829.
AuthorizationIdentityResponseControl - Class in org.forgerock.opendj.ldap.controls
The authorization response control as defined in RFC 3829.
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.
auxiliaryObjectClasses(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided auxiliary classes to the list of auxiliary object classes that entries subject to this DIT content rule may belong to.
auxiliaryObjectClasses(String...) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided auxiliary classes to the list of auxiliary object classes that entries subject to this DIT content rule may belong to.
Ava - Class in org.forgerock.opendj.ldap
An attribute value assertion (AVA) as defined in RFC 4512 section 2.3 consists of an attribute description with zero options and an attribute value.
Ava(AttributeType, Object) - Constructor for class org.forgerock.opendj.ldap.Ava
Creates a new attribute value assertion (AVA) using the provided attribute type and value.
Ava(AttributeType, String, Object) - Constructor for class org.forgerock.opendj.ldap.Ava
Creates a new attribute value assertion (AVA) using the provided attribute type, name and value.
Ava(String, Object) - Constructor for class org.forgerock.opendj.ldap.Ava
Creates a new attribute value assertion (AVA) using the provided attribute type and value decoded using the default schema.
averagePerEventPayloadSize(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Sets the average event payload size, used to initialise string buffers.
awaitTermination(long, TimeUnit) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 

B

BAD_GATEWAY - Static variable in class org.forgerock.http.protocol.Status
The 502 (Bad Gateway) status code indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
BAD_REQUEST - Static variable in class org.forgerock.http.protocol.Status
The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
BAD_REQUEST - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the request could not be understood by the resource due to malformed syntax.
BadRequestException - Exception in org.forgerock.json.resource
An exception that is thrown during a operation on a resource when the requested operation is malformed.
BadRequestException() - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with null as its detail message.
BadRequestException(String) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified detail message.
BadRequestException(String, Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified detail message and cause.
BadRequestException(Throwable) - Constructor for exception org.forgerock.json.resource.BadRequestException
Constructs a new exception with the specified cause.
Base64 - Class in org.forgerock.opendj.ldap
This class provides methods for performing base64 encoding and decoding.
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
base64urlEncode(String) - Static method in class org.forgerock.json.jose.utils.Utils
base64UrlEncodeUnsignedBigEndian(BigInteger) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils
Encode a big integer into a base 64 url encoded unsigned big endian.
BASE_ENV_VARIABLE - Static variable in class org.forgerock.openig.http.GatewayEnvironment
Environment variable name.
BASE_OBJECT - Static variable in class org.forgerock.opendj.ldap.SearchScope
The scope is constrained to the search base entry.
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
 
baseTimeUnit() - Method in interface org.forgerock.monitoring.api.instrument.TimeGauge
 
baseTimeUnit() - Method in interface org.forgerock.monitoring.api.instrument.Timer
 
baseTimeUnit() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
baseUnit(String) - Method in class org.forgerock.monitoring.api.instrument.Counter.Builder
Associate a BaseUnit with the Counter
baseUnit(String) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
 
baseUnit(String) - Method in class org.forgerock.monitoring.api.instrument.Gauge.Builder
 
baseUnit(String) - Method in class org.forgerock.monitoring.api.instrument.Meter.Builder
 
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.
basic(String) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader
Create a basic authentication challenge header.
BasicCredentials - Class in org.forgerock.http.header.authorization
A rich representation of basic credentials.
BasicCredentials(String, String) - Constructor for class org.forgerock.http.header.authorization.BasicCredentials
Construct a new set of Basic authorization credentials.
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.
bearer(String, Map<String, String>) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader
Create a bearer authentication challenge header.
BearerToken - Class in org.forgerock.http.header.authorization
A rich representation of bearer credentials.
BearerToken(String) - Constructor for class org.forgerock.http.header.authorization.BearerToken
Construct a new set of Bearer authorization credentials.
beforeAddAttribute(AttributeType.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeAddDitContentRule(DitContentRule.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeAddDitStructureRule(DitStructureRule.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeAddMatchingRule(MatchingRule.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeAddMatchingRuleUse(MatchingRuleUse.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeAddNameForm(NameForm.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeAddObjectClass(ObjectClass.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeAddSyntax(Syntax.Builder) - Method in interface org.forgerock.opendj.ldap.schema.SchemaBuilder.SchemaBuilderHook
Allow to modify the builder before its inclusion in schema.
beforeRequest(Map<String, List<String>>) - Method in class org.forgerock.openig.tools.notifications.ws.SsoTokenConfigurator
 
beforeRollingOver() - Method in interface org.forgerock.audit.events.handlers.writers.RotatableWriter.RolloverLifecycleHook
This method is called before the rotation and retention checks are done.
bestEffortResourceServerError(Status, OAuth2Error) - Static method in class org.forgerock.http.oauth2.OAuth2Error
Returns an OAuth 2.0 resource server error whose values are determined on a best-effort basis from the provided incomplete error and HTTP status code.
between(Version, Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies if this version is in between the given minInclusive and maxInclusive versions (inclusive).
BiFunction<T,U,R,E extends Exception> - Interface in org.forgerock.util
A BiFunction functional interface which can throw a checked Exception.
BigIntegerUtils - Class in org.forgerock.json.jose.utils
Utils to complement bit operations not covered by the BigInteger functions.
bind(BindRequest) - Method in class org.forgerock.opendj.ldap.AbstractAsynchronousConnection
 
bind(String, char[]) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
bind(BindRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Authenticates to the Directory Server using the provided bind request.
bind(String, char[]) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Authenticates to the Directory Server using simple authentication and the provided user name and password.
bind(BindRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Authenticates to the Directory Server using the provided bind request.
bind(String, char[]) - Method in interface org.forgerock.opendj.ldap.Connection
Authenticates to the Directory Server using simple authentication and the provided user name and password.
bind(BindRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Authenticates to the Directory Server using the provided bind request.
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.
bindAsync(BindRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
bindAsync(BindRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously authenticates to the Directory Server using the provided bind request.
bindAsync(BindRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously authenticates to the Directory Server using the provided bind request.
bindAsync(BindRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
bindAsync(BindRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously authenticates to the Directory Server using the provided bind request.
bindAsync(BindRequest, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously authenticates to the Directory Server using the provided bind request.
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.
BindRequest - Interface in org.forgerock.opendj.ldap.messages
The Bind operation allows authentication information to be exchanged between the client and server.
BindResult - Interface in org.forgerock.opendj.ldap.messages
A Bind result indicates the status of the client's request for authentication.
bindTo(MeterRegistry) - Method in interface org.forgerock.monitoring.api.instrument.binder.MeterBinder
 
BlackAndWhitelistFilter - Class in org.forgerock.util
This class can be used for filtering string elements by using blacklists and/or whitelists.
BlackAndWhitelistFilter(Collection<Pattern>, Collection<Pattern>) - Constructor for class org.forgerock.util.BlackAndWhitelistFilter
Creates a new BlackAndWhitelistFilter with provided collections.
BLOCKING_WRITE - Static variable in class org.forgerock.opendj.ldap.LdapServer
Specify whether the response should be written synchronously.
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.
BOOLEAN_VALUE_FALSE - Static variable in class org.forgerock.opendj.io.Asn1
The byte array containing the pre-encoded ASN.1 encoding for a boolean value of "false".
BOOLEAN_VALUE_TRUE - Static variable in class org.forgerock.opendj.io.Asn1
The byte array containing the pre-encoded ASN.1 encoding for a boolean value of "false".
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.
bootstrapPropertyResolver(String, PropertyResolver) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Get the standard bootstrap property resolver, which is defined as a resolver that checks in turn: The product paths resolver Environment variables System properties Any external sources defined in the <productKey>.envconfig.dirs system property, or (if it does not exist) the <PRODUCTKEY>_ENVCONFIG_DIRS environment variable, which is treated as a comma-separated list of source directories, where the files in a directory are resolved in a non-deterministic order, and are checked for duplicate keys.
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.
buckets(HistogramConfig) - Static method in class org.forgerock.monitoring.api.instrument.histogram.PercentileHistogramBuckets
Pick values from a static set of percentile buckets that yields a decent error bound on most real world timers and distribution summaries because monitoring systems like Prometheus require us to report the same buckets at every interval, regardless of where actual samples have been observed.
Buffer - Interface in org.forgerock.http.io
A dynamically growing data buffer.
BUFFER_SIZE - Static variable in class org.forgerock.opendj.ldap.LdapServer
Size of the buffer used when reading/writing data from/to the network.
BufferedBatchPublisher - Class in org.forgerock.audit.events.handlers.buffering
Buffers audit events to a bounded queue, periodically flushing the queue to a provided BatchConsumer.
BufferedBatchPublisher.Builder - Interface in org.forgerock.audit.events.handlers.buffering
Builder used to construct a new BufferedBatchPublisher.
buffering - Variable in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
Event buffering is disabled by default.
buffering - Variable in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration
Event buffering is disabled by default.
BufferingConfiguration() - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration
 
build() - Method in class org.forgerock.audit.AuditServiceBuilder
Creates a new AuditService instance.
build() - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder
Create a new instance of EventTopicsMetaData.
build() - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Constructs a new BatchPublisher.
build() - Method in class org.forgerock.audit.filter.FilterChainBuilder
Builds the FilterChain.
build() - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Builds the CSRF filter with the configured settings.
build() - Method in class org.forgerock.http.routing.UriRouterContext.Builder
Returns a new UriRouterContext build from provided values.
build() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder
Builds the JWE into a String by calling the build method on the JWE object.
build() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder
Builds the JWS into a String by calling the build method on the JWS object.
build() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtHeaderBuilder
Creates a JwsHeader instance from the header parameters set in this builder.
build() - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder
Creates a JweHeader instance from the header parameters set in this builder.
build() - Method in class org.forgerock.json.jose.builders.JwsHeaderBuilder
Creates a JwsHeader instance from the header parameters set in this builder.
build() - Method in interface org.forgerock.json.jose.builders.JwtBuilder
Builds the JWT into a String by calling the build method on the JWT object.
build() - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Creates a JwtClaimsSet instance from the claims set in this builder.
build() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder
Creates a JwtHeader instance from the header parameters set in this builder.
build() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl
Builds the JWS into a String by calling the build method on the JWS object.
build() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
 
build() - Method in class org.forgerock.json.jose.jwk.EcJWK.Builder
Build the EC JWK.
build() - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Builds the JWK.
build() - Method in class org.forgerock.json.jose.jwk.OctJWK.Builder
Build the Octet JWK.
build() - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
 
build() - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Build the RSA JWK.
build() - Method in class org.forgerock.json.jose.jws.SignedJwt
Builds the JWT into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
build() - Method in interface org.forgerock.json.jose.jwt.Jwt
Builds the JWT into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
build() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Builds the JWT's Claims Set into a String representation of a JSON object.
build() - Method in class org.forgerock.json.jose.jwt.JwtHeader
Builds the JWT's header into a String representation of a JSON object.
build() - Method in interface org.forgerock.json.jose.jwt.Payload
Builds the JWTs Payload into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
build() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
build() - Method in class org.forgerock.openig.http.CookieBuilder
Create a Cookie based on the details held in this CookieBuilder.
build() - Method in class org.forgerock.openig.tools.am.AmService.Builder
Returns a new AmService instance.
build() - Method in class org.forgerock.openig.tools.jwt.JwtValidator.Builder
Builds the JwtValidator.
build(Class<T>) - Method in class org.forgerock.secrets.SecretBuilder
Builds a secret of the given type.
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.
buildAttributeType(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new attribute type before adding it to the schema.
buildAttributeType(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns an attribute type builder whose fields are initialized to the values of the provided attribute type.
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.
buildDitContentRule(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new DIT content rule before adding it to the schema.
buildDitContentRule(DitContentRule) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a DIT content rule builder whose fields are initialized to the values of the provided DIT content rule.
buildDitStructureRule(int) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new DIT structure rule before adding it to the schema.
buildDitStructureRule(DitStructureRule) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns an DIT structure rule builder whose fields are initialized to the values of the provided rule.
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() - Static method in class org.forgerock.json.jose.jwk.OkpJWK
Creates a new builder object for an OKP key.
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 interface org.forgerock.monitoring.api.instrument.Counter
Return the Builder object for this Counter.
builder(String) - Static method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
 
builder(String, T, ToDoubleFunction<T>) - Static method in interface org.forgerock.monitoring.api.instrument.Gauge
Setup a Gauge.Builder that will create a gauge that reports the value returned by the provided function.
builder() - Static method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
Builder() - Constructor for class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
builder(String, Meter.Type, Iterable<Measurement>) - Static method in interface org.forgerock.monitoring.api.instrument.Meter
 
builder(String, T, TimeUnit, ToDoubleFunction<T>) - Static method in interface org.forgerock.monitoring.api.instrument.TimeGauge
 
builder(String) - Static method in interface org.forgerock.monitoring.api.instrument.Timer
 
builder(Timed, String) - Static method in interface org.forgerock.monitoring.api.instrument.Timer
Create a timer builder from a Timed annotation.
builder(JsonValue, String, String) - Static method in class org.forgerock.openig.http.CookieBuilder
Create a CookieBuilder based on the JSON structure of:
builder(String) - Static method in class org.forgerock.openig.http.CookieBuilder
Create a CookieBuilder with just the cookie name set.
builder(JsonValue, Clock) - Static method in class org.forgerock.openig.secrets.DefaultSecretsService
Returns a DefaultSecretsService's builder.
builder(URI, Handler, Clock, String, SecretReference<GenericSecret>) - Static method in class org.forgerock.openig.tools.am.AmService
Returns a new AmService.Builder for creating a new AmService instance.
builder(AmService) - Static method in class org.forgerock.openig.tools.am.AmService
Returns a new AmService.Builder for creating a new AmService instance from a given one.
builder() - Static method in class org.forgerock.openig.tools.jwt.JwtValidator
Builder for the JwtValidator.
Builder() - Constructor for class org.forgerock.openig.tools.jwt.JwtValidator.Builder
 
buildEventUri(String, String) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Builds an Elasticsearch API URI for operating on a single event (e.g., index, get, etc.).
buildExternalClientContext(Context) - Static method in class org.forgerock.services.context.ClientContext
Creates a ClientContext.Builder for creating an external ClientContext instance.
buildMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new matching rule before adding it to the schema.
buildMatchingRule(MatchingRule) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a matching rule builder whose fields are initialized to the values of the provided matching rule.
buildMatchingRuleUse(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new matching rule use before adding it to the schema.
buildMatchingRuleUse(MatchingRuleUse) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a matching rule use builder whose fields are initialized to the values of the provided matching rule use object.
buildNameForm(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new name form before adding it to the schema.
buildNameForm(NameForm) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a name form builder whose fields are initialized to the values of the provided name form.
buildObjectClass(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new object class before adding it to the schema.
buildObjectClass(ObjectClass) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns an object class builder whose fields are initialized to the values of the provided object class.
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.
buildSyntax(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a builder which can be used for incrementally constructing a new syntax before adding it to the schema.
buildSyntax(Syntax) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a syntax builder whose fields are initialized to the values of the provided syntax.
buildTimeStampFileNamingPolicy(File) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Builds a TimeStampFileNamingPolicy instance from configuration options.
BUSY - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the server is too busy to process the requested operation.
BYTE_ARRAY_COMPARATOR - Static variable in interface org.forgerock.opendj.ldap.ByteSequence
A byte array comparator.
byteAt(int) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns the byte value at the specified index.
byteAt(int) - Method in class org.forgerock.opendj.ldap.ByteString
 
byteAt(int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
ByteSequence - Interface in org.forgerock.opendj.ldap
A ByteSequence is a readable sequence of byte values.
ByteSequenceReader - Class in org.forgerock.opendj.ldap
An interface for iteratively reading data from a ByteSequence .
ByteString - Class in org.forgerock.opendj.ldap
An immutable sequence of bytes backed by a byte array.
ByteStringBuilder - Class in org.forgerock.opendj.ldap
A mutable sequence of bytes backed by a byte array.
ByteStringBuilder() - Constructor for class org.forgerock.opendj.ldap.ByteStringBuilder
Creates a new byte string builder with an initial capacity of 32 bytes.
ByteStringBuilder(int) - Constructor for class org.forgerock.opendj.ldap.ByteStringBuilder
Creates a new byte string builder with the specified initial capacity.
ByteStringBuilder(ByteSequence) - Constructor for class org.forgerock.opendj.ldap.ByteStringBuilder
Creates a new byte string builder with the content of the provided ByteSequence.
byteStringToAttributeDescription(ByteString, Schema) - Static method in class org.forgerock.opendj.ldap.Functions
Parses a ByteString as an AttributeDescription using the provided schema.
byteStringToBoolean() - Static method in class org.forgerock.opendj.ldap.Functions
Returns a function which parses Boolean values.
byteStringToCertificate(ByteString) - Static method in class org.forgerock.opendj.ldap.Functions
Parses a ByteString as a X509Certificate.
byteStringToDn() - Static method in class org.forgerock.opendj.ldap.Functions
Returns a function which parses DNs using the default schema.
byteStringToDn(Schema) - Static method in class org.forgerock.opendj.ldap.Functions
Returns a function which parses DNs using the provided schema.
byteStringToGeneralizedTime() - Static method in class org.forgerock.opendj.ldap.Functions
Returns a function which parses generalized time strings.
byteStringToInteger() - Static method in class org.forgerock.opendj.ldap.Functions
Returns a function which parses Integer string values.
byteStringToLong() - Static method in class org.forgerock.opendj.ldap.Functions
Returns a function which parses Long string values.

C

CACHE - Static variable in class org.forgerock.opendj.security.KeyStoreParameters
The caching mechanism that the key store will use.
CachePolicyDecisionRequestHandler - Class in org.forgerock.openig.tools
A RequestHandler that caches policies.
CachePolicyDecisionRequestHandler(Caffeine<Object, Object>, Clock, Duration, Duration, NotificationService, CachePolicyDecisionRequestHandler.DisconnectionStrategy, RequestHandler) - Constructor for class org.forgerock.openig.tools.CachePolicyDecisionRequestHandler
Builds a CachePolicyDecisionFilter.
CachePolicyDecisionRequestHandler.DisconnectionStrategy - Enum in org.forgerock.openig.tools
The different behaviours that can be applied in case of notifications disconnections.
CacheSessionService - Class in org.forgerock.openig.tools.session
Create a CacheSessionService which is responsible to manage the cache for the SessionInfo.
CacheSessionService(SessionService, NotificationService, Caffeine<Object, Object>, Supplier<String>, Clock, Duration, CacheSessionService.DisconnectionStrategy) - Constructor for class org.forgerock.openig.tools.session.CacheSessionService
Creates a new CacheSessionService.
CacheSessionService.DisconnectionStrategy - Enum in org.forgerock.openig.tools.session
The different behaviors that can be applied in case of notifications disconnections.
CacheUserProfileService - Class in org.forgerock.openig.tools.userprofile
Create a CacheUserProfileService which is responsible for managing the UserProfile cache.
CacheUserProfileService(UserProfileService, Caffeine<Object, Object>, Duration) - Constructor for class org.forgerock.openig.tools.userprofile.CacheUserProfileService
Creates a new CacheUserProfileService.
CachingAccessTokenResolver - Class in org.forgerock.http.oauth2.resolver
A CachingAccessTokenResolver is a delegating AccessTokenResolver that uses a write-through cache to enable fast AccessTokenInfo resolution.
CachingAccessTokenResolver(Clock, AccessTokenResolver, PerItemEvictionStrategyCache<String, Promise<AccessTokenInfo, AccessTokenException>>) - Constructor for class org.forgerock.http.oauth2.resolver.CachingAccessTokenResolver
Builds a CachingAccessTokenResolver delegating to the given AccessTokenResolver using the given (pre-configured) cache.
CaffeineUtils - Class in org.forgerock.openig.tools
Utility class for Caffeine-related workarounds.
calculateCookieHeaderSize(Cookie) - Static method in class org.forgerock.openig.http.CookieBuilder
Convenience method to calculate the size of the Cookie when it is turned into a header.
camelCase - Static variable in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
cancel() - Method in class org.forgerock.opendj.ldap.RequestHandle
Returns a Single<Result> which, once subscribed, will attempt to cancel the operation.
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
 
CancelExtendedRequest - Interface in org.forgerock.opendj.ldap.messages
The cancel extended request as defined in RFC 3909.
CANCELLED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a cancel request was successful, or that the specified operation was canceled.
CancelledResultException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request was cancelled.
CancelRequestListener - Interface in org.forgerock.opendj.ldap
An object that registers to be notified when a cancellation request has been received and processing of the request should be aborted if possible.
CANNOT_CANCEL - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a cancel request was unsuccessful because the targeted operation was one that could not be canceled.
canParse(String) - Method in interface org.forgerock.http.header.authorization.CredentialsParser
Whether this parser parses the given authorization type.
capacity(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder
Sets the maximum queue capacity.
capacity() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns the current capacity of this byte string builder.
CAPTURE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a CaptureDecorator instance from the Heap.
CaptureDecorator - Class in org.forgerock.openig.decoration.capture
The capture decorator can decorates both Filter and Handler instances.
CaptureDecorator(String, boolean, boolean) - Constructor for class org.forgerock.openig.decoration.capture.CaptureDecorator
Builds a new capture decorator.
CaptureDecorator(String, boolean, boolean, int) - Constructor for class org.forgerock.openig.decoration.capture.CaptureDecorator
Builds a new capture decorator.
CaptureDecorator.Heaplet - Class in org.forgerock.openig.decoration.capture
Creates and initializes a CaptureDecorator in a heap environment.
CapturedUserPasswordContext - Class in org.forgerock.openig.openam
A CapturedUserPasswordContext to store the user's decrypted password.
CapturedUserPasswordFilter - Class in org.forgerock.openig.openam
The CapturedUserPasswordFilter is responsible for retrieving the user password from AM and to decrypt it.
CapturedUserPasswordFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initializes the filter in a heap environment.
CapturePoint - Enum in org.forgerock.openig.decoration.capture
Specify where the message capture takes place.
CaseInsensitiveMap<V> - Class in org.forgerock.http.util
An implementation of a map whose keys are case-insensitive strings.
CaseInsensitiveMap() - Constructor for class org.forgerock.http.util.CaseInsensitiveMap
Constructs a new empty case-insensitive map.
CaseInsensitiveMap(Map<String, V>) - Constructor for class org.forgerock.http.util.CaseInsensitiveMap
Wraps an existing map with a new case insensitive map.
CaseInsensitiveSet - Class in org.forgerock.http.util
An implementation of a set whose values are case-insensitive strings.
CaseInsensitiveSet() - Constructor for class org.forgerock.http.util.CaseInsensitiveSet
Constructs a new empty case-insensitive set.
CaseInsensitiveSet(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.
CdSsoConditionAdviceFilter - Class in org.forgerock.openig.openam
This filter handles any condition advices returned from AM during a policy evaluation, which one will depend on the policy.
CdSsoContext - Class in org.forgerock.openig.openam
Context implementation to maintain cross-domain SSO properties.
CdSsoContext(Context, String, JwtClaimsSet, String, CookieBuilder) - Constructor for class org.forgerock.openig.openam.CdSsoContext
Create CdSsoContext for supplied JWT.
CdSsoFailureContext - Class in org.forgerock.openig.openam
Context implementation to hold error details, should an error occur during cross-domain SSO authentication.
certificate(Certificate) - Method in class org.forgerock.secrets.SecretBuilder
Sets the certificate associated with this secret.
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.
CertificateThumbprintConfirmationKeyVerifier - Class in org.forgerock.openig.filter.oauth2
Verifies a certificate thumbprint by computing a digest of the client certificate (found in ClientContext) and comparing the result with the base64-url-encoded value provided within the confirmation key node.
CertificateThumbprintConfirmationKeyVerifier(String) - Constructor for class org.forgerock.openig.filter.oauth2.CertificateThumbprintConfirmationKeyVerifier
Constructs a new verifier with the given MessageDigest algorithm name.
ChainedPropertyResolver - Class in org.forgerock.config.resolvers
Contains a chain of PropertyResolvers that should be used to get a token replacement property.
ChainedPropertyResolver(List<? extends PropertyResolver>) - Constructor for class org.forgerock.config.resolvers.ChainedPropertyResolver
Creates a chained property resolver given a list of PropertyResolvers.
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.
Challenge(String, String, Map<String, String>) - Constructor for class org.forgerock.http.header.WwwAuthenticateHeader.Challenge
Create a new authentication option.
ChangeRecord - Interface in org.forgerock.opendj.ldif
A request to modify the content of the Directory in some way.
ChangeRecordReader - Interface in org.forgerock.opendj.ldif
An interface for reading change records from a data source, typically an LDIF file.
ChangeRecordVisitor<R,P,E extends Exception> - Class in org.forgerock.opendj.ldif
A visitor of ChangeRecords, in the style of the visitor design pattern.
ChangeRecordVisitor() - Constructor for class org.forgerock.opendj.ldif.ChangeRecordVisitor
 
ChangeRecordWriter - Interface in org.forgerock.opendj.ldif
An interface for writing change records to a data source, typically an LDIF file.
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.
checkAttributesAndObjectClasses() - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns the policy for verifying that the user attributes in an entry conform to its object classes.
checkAttributesAndObjectClasses(SchemaValidationPolicy.Action) - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Specifies the policy for verifying that the user attributes in an entry conform to its object classes.
checkAttributeValues() - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns the policy for verifying that the user attributes in an entry conform to their associated attribute type descriptions.
checkAttributeValues(SchemaValidationPolicy.Action) - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Specifies the policy for verifying that the user attributes in an entry conform to their associated attribute type descriptions.
checkClientTrusted(X509Certificate[], String) - Method in class org.forgerock.openig.security.TrustAllManager
 
checkDitContentRules() - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns the policy for validating entries against content rules defined in the schema.
checkDitContentRules(SchemaValidationPolicy.Action) - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Specifies the policy for validating entries against content rules defined in the schema.
checkDitStructureRules() - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns the policy for validating entries against structure rules defined in the schema.
checkDitStructureRules(SchemaValidationPolicy.Action, Function<Dn, Entry, LdapException>) - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Specifies the policy for validating entries against structure rules defined in the schema.
checkDitStructureRulesParentEntryResolver() - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns the parent entry resolver which should be used for retrieving the parent entry during DIT structure rule validation.
checkForTimeout(long) - Method in interface org.forgerock.opendj.ldap.TimeoutScheduler.TimeoutEventListener
Check whether or not an operation timed-out.
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.
checkNameForms() - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns the policy for validating entries against name forms defined in the schema.
checkNameForms(SchemaValidationPolicy.Action) - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Specifies the policy for validating entries against name forms defined in the schema.
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
 
checkUsingKeyStore(KeyStore) - Static method in class org.forgerock.opendj.security.TrustManagers
Creates a new X509TrustManager which will use the key store to determine whether to trust a certificate.
checkUsingKeyStoreFile(String, char[], String) - Static method in class org.forgerock.opendj.security.TrustManagers
Creates a new X509TrustManager which will use the named trust store file to determine whether to trust a certificate.
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(Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns a DN which is subordinate to this DN and having the additional RDN components contained in the provided DN.
child(Rdn) - Method in class org.forgerock.opendj.ldap.Dn
Returns a DN which is an immediate child of this DN and having the specified RDN.
child(String) - Method in class org.forgerock.opendj.ldap.Dn
Returns a DN which is subordinate to this DN and having the additional RDN components contained in the provided DN decoded using the default schema.
child(String, Object) - Method in class org.forgerock.opendj.ldap.Dn
Returns a DN which is an immediate child of this DN and with an RDN having the provided attribute type and value decoded using the default schema.
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.
claim(String, Function<JsonValue, ? extends T, E>, JwtClaimConstraint<T>) - Method in class org.forgerock.openig.tools.jwt.JwtValidator.Builder
Adds a JwtClaimConstraint on a claim.
claim(String, JwtClaimConstraint<JsonValue>) - Method in class org.forgerock.openig.tools.jwt.JwtValidator.Builder
Adds a JwtClaimConstraint on a claim.
claim(JsonPointer, JwtClaimConstraint<JsonValue>) - Method in class org.forgerock.openig.tools.jwt.JwtValidator.Builder
Adds a JwtClaimConstraint on a claim.
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() - Method in class org.forgerock.openig.filter.JwtBuilderContext
Returns the JWT claims as unmodifiable Map.
claims(String, JwtClaimConstraint<String>) - Method in class org.forgerock.openig.tools.jwt.JwtValidator.Builder
Adds a JwtClaimConstraint on a claim.
claimsAsJsonValue() - Method in class org.forgerock.openig.filter.JwtBuilderContext
Returns the JWT claims as unmodifiable JsonValue.
claimSet(String, Function<Optional<JwtClaimsSet>, Optional<T>>, JwtClaimConstraint<T>) - Method in class org.forgerock.openig.tools.jwt.JwtValidator.Builder
Adds a JwtClaimConstraint on the claimSet.
ClassAliasResolver - Interface in org.forgerock.openig.alias
This interface has to be implemented by each Identity Gateway module that wants to register new class aliases.
clear() - Method in class org.forgerock.http.protocol.Headers
 
clear() - Method in class org.forgerock.http.util.CaseInsensitiveMap
 
clear() - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
clear() - Method in class org.forgerock.http.util.SetDecorator
Removes all of the elements from the set (optional operation).
clear() - Method in class org.forgerock.json.JsonValue
Removes all child values from this JSON value, if it has any.
clear() - Method in interface org.forgerock.opendj.ldap.Attribute
Removes all of the attribute values from this attribute (optional operation).
clear() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Sets the length of this byte string builder to zero.
clear() - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
clear() - Method in class org.forgerock.opendj.ldap.MemoryBackend
Clears the contents of this memory backend so that it does not contain any entries.
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.NonExpiringCache
Clears the cache.
clear() - Method in class org.forgerock.util.PerItemEvictionStrategyCache
Clean-up the cache entries.
clearAndTruncate(int, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Sets the length of this byte string builder to zero, and resets the capacity to the specified size if above provided threshold.
clearAttributes() - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
clearAttributes() - Method in class org.forgerock.opendj.ldap.Entries.NullEntry
 
clearAttributes() - Method in interface org.forgerock.opendj.ldap.Entry
Removes all the attributes from this entry (optional operation).
clearAttributes() - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
clearAttributes() - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
clearSession() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext
Clear the existing managed session.
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 the default ClientHandler instance from the Heap.
CLIENT_SIDE_AUTH_UNKNOWN - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the user requested an unknown or unsupported authentication mechanism.
CLIENT_SIDE_CLIENT_LOOP - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the client detected a referral loop caused by servers referencing each other in a circular manner.
CLIENT_SIDE_CONNECT_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the client was not able to establish a connection to the server.
CLIENT_SIDE_CONTROL_NOT_FOUND - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the client expected a control to be present in the response from the server but it was not included.
CLIENT_SIDE_DECODING_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that an error occurred while decoding a response from the server.
CLIENT_SIDE_ENCODING_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that an error occurred while encoding a request to send to the server.
CLIENT_SIDE_FILTER_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the filter provided by the user was malformed and could not be parsed.
CLIENT_SIDE_LOCAL_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that a local error occurred that had nothing to do with interaction with the server.
CLIENT_SIDE_NO_MEMORY - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the client application was not able to allocate enough memory for the requested operation.
CLIENT_SIDE_NO_RESULTS_RETURNED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the requested single entry search operation or read operation failed because the Directory Server did not return any matching entries.
CLIENT_SIDE_NOT_SUPPORTED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the user requested an operation that is not supported.
CLIENT_SIDE_PARAM_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that there was a problem with one or more of the parameters provided by the user.
CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the client reached the maximum number of hops allowed when attempting to follow a referral (i.e., following one referral resulted in another referral which resulted in another referral and so on).
CLIENT_SIDE_SERVER_DOWN - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the server is down.
CLIENT_SIDE_TIMEOUT - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the client did not receive an expected response in a timely manner.
CLIENT_SIDE_UNEXPECTED_RESULTS_RETURNED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that the requested single entry search operation or read operation failed because the Directory Server returned multiple matching entries (or search references) when only a single matching entry was expected.
CLIENT_SIDE_USER_CANCELLED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The client-side result code that indicates that the user cancelled an operation.
clientAuthPolicy() - Method in class org.forgerock.opendj.security.SslOptions
Returns the client authentication policy.
clientAuthPolicy(SslOptions.ClientAuthPolicy) - Method in class org.forgerock.opendj.security.SslOptions
Sets the client auth policy.
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, String, List<String>, Issuer, Handler, ClientAuthentication) - 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, Clock) - Constructor for class org.forgerock.openig.filter.oauth2.client.ClientRegistrationFilter
Creates a new dynamic registration filter.
Clock - Interface in org.forgerock.monitoring.api.instrument
Used to measure absolute and relative time.
clock() - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Returns the Clock used to measure durations of Timers.
clock() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
clock(Clock) - Method in class org.forgerock.secrets.SecretBuilder
Set the source of time for the default (relative) secret expiry time.
CLOCK - Static variable in interface org.forgerock.secrets.SecretStore
Option used to specify how long secrets from a store should be used before being refreshed.
CLOCK_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a Clock instance from the Heap.
ClockTimeService - Class in org.forgerock.util.time
Deprecated.
ClockTimeService(Clock) - Constructor for class org.forgerock.util.time.ClockTimeService
Deprecated.
Constructs a Clock-based TimeService.
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.AsyncResponseHttpClient
 
close() - Method in class org.forgerock.http.apache.async.AsyncStreamingHttpClient
 
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.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
close() - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketConnector
 
close() - Method in interface org.forgerock.opendj.io.Asn1Reader
Closes this ASN.1 reader.
close() - Method in interface org.forgerock.opendj.io.Asn1Writer
Closes this ASN.1 writer, flushing it first.
close() - Method in interface org.forgerock.opendj.io.LdapSocketAcceptor
Closes this LDAP socket acceptor.
close() - Method in interface org.forgerock.opendj.io.LdapSocketConnector
Releases any resources associated with this connector.
close() - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
close() - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Releases any resources associated with this connection.
close(UnbindRequest, String) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Releases any resources associated with this connection.
close() - Method in interface org.forgerock.opendj.ldap.Connection
Releases any resources associated with this connection.
close(UnbindRequest, String) - Method in interface org.forgerock.opendj.ldap.Connection
Releases any resources associated with this connection.
close() - Method in interface org.forgerock.opendj.ldap.ConnectionFactory
Releases any resources associated with this connection factory.
close() - Method in interface org.forgerock.opendj.ldap.ConnectionPool
Releases any resources associated with this connection pool.
close() - Method in interface org.forgerock.opendj.ldap.LdapClient
Releases any resources associated with this LDAP client.
close(UnbindRequest, String) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Releases any resources associated with this connection.
close() - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Releases any resources associated with this connection.
close() - Method in class org.forgerock.opendj.ldap.LdapConnectionFactory
 
close() - Method in class org.forgerock.opendj.ldap.LdapServer
Closes this LDAP connection listener.
close() - Method in class org.forgerock.opendj.ldap.TimeoutScheduler
 
close() - Method in interface org.forgerock.opendj.ldif.ChangeRecordReader
Closes this change record reader if it not already closed.
close() - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Closes this change record writer, flushing it first.
close() - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Closes this connection change record writer, including the underlying connection.
close() - Method in class org.forgerock.opendj.ldif.ConnectionEntryReader
Closes this connection entry reader, canceling the search request if it is still active.
close() - Method in class org.forgerock.opendj.ldif.ConnectionEntryWriter
Closes this connection entry writer, including the underlying connection.
close() - Method in class org.forgerock.opendj.ldif.EntryGenerator
 
close() - Method in interface org.forgerock.opendj.ldif.EntryReader
Closes this entry reader if it is not already closed.
close() - Method in interface org.forgerock.opendj.ldif.EntryWriter
Closes this entry writer, flushing it first.
close() - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
 
close() - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
close() - Method in class org.forgerock.opendj.ldif.LdifEntryReader
 
close() - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
 
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.script.AbstractScriptableHeapObject
 
close() - Method in class org.forgerock.openig.text.SeparatedValuesReader
Closes the reader and releases any system resources associated with it.
close() - Method in class org.forgerock.openig.tools.CachePolicyDecisionRequestHandler
 
close() - Method in class org.forgerock.openig.websocket.WebSocketProxyFilter
 
close() - Method in class org.forgerock.secrets.GenericSecret
Scrubs the secret value from memory on a best-effort basis.
close() - Method in class org.forgerock.secrets.keys.CryptoKey
 
close() - Method in class org.forgerock.secrets.Secret
 
Closeables - Class in org.forgerock.util
Common utility methods for Closeables.
closeSilently(Closeable...) - Static method in class org.forgerock.util.Closeables
Closes the provided resources ignoring any errors which occurred.
closeSilently(Iterable<? extends Closeable>) - Static method in class org.forgerock.util.Closeables
Closes the provided resources ignoring any errors which occurred.
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
closeSilently(Iterable<? extends Closeable>) - Static method in class org.forgerock.util.Utils
closeSilentlyAsync(Closeable...) - Static method in class org.forgerock.util.Closeables
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.
coerce(Predicate<JsonValue>) - Static method in class org.forgerock.config.util.JsonValuePropertyEvaluator
Define a coercion function.
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
 
CollectionResourceProvider - Interface in org.forgerock.json.resource
An implementation interface for resource providers which exposes a collection of resource instances.
collective(boolean) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Specifies whether this attribute type is "collective".
CommonAuditBatchConfiguration - Class in org.forgerock.audit.batch
This class stores the common audit logging batch process configurations.
commonTags(Iterable<Tag>) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Add common tags that are applied to every meter created afterward.
commonTags(Iterable<Tag>) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Append a list of common tags to apply to all metrics reported to the monitoring system.
commonTags(String...) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Append a list of common tags to apply to all metrics reported to the monitoring system.
commonTags(Iterable<Tag>) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
commonTags(String...) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
COMPARATOR - Static variable in interface org.forgerock.opendj.ldap.ByteSequence
A ByteSequence comparator.
comparator(Collection<SortKey>) - Static method in class org.forgerock.opendj.ldap.SortKey
Returns a Comparator which can be used to compare entries using the provided list of sort keys.
comparator(Schema, Collection<SortKey>) - Static method in class org.forgerock.opendj.ldap.SortKey
Returns a Comparator which can be used to compare entries using the provided list of sort keys.
comparator(Schema, SortKey...) - Static method in class org.forgerock.opendj.ldap.SortKey
Returns a Comparator which can be used to compare entries using the provided list of sort keys.
comparator(SortKey...) - Static method in class org.forgerock.opendj.ldap.SortKey
Returns a Comparator which can be used to compare entries using the provided list of sort keys.
comparator(String) - Static method in class org.forgerock.opendj.ldap.SortKey
Returns a Comparator which can be used to compare entries using the provided string representation of a list of sort keys.
comparator() - Method in class org.forgerock.opendj.ldap.SortKey
Returns a Comparator which can be used to compare entries using this sort key.
comparator(Schema) - Method in class org.forgerock.opendj.ldap.SortKey
Returns a Comparator which can be used to compare entries using this sort key.
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.opendj.ldap.AbstractAsynchronousConnection
 
compare(String, String, String) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
compare(CompareRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Compares an entry in the Directory Server using the provided compare request.
compare(String, String, String) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Compares the named entry in the Directory Server against the provided attribute value assertion.
compare(CompareRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Compares an entry in the Directory Server using the provided compare request.
compare(String, String, String) - Method in interface org.forgerock.opendj.ldap.Connection
Compares the named entry in the Directory Server against the provided attribute value assertion.
compare(CompareRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Asynchronously compares an entry in the Directory Server using the provided compare request.
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.
COMPARE_FALSE - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the attribute value assertion included in a compare request did not match the targeted entry.
COMPARE_TRUE - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the attribute value assertion included in a compare request did match the targeted entry.
compareAsync(CompareRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
compareAsync(CompareRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously compares an entry in the Directory Server using the provided compare request.
compareAsync(CompareRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously compares an entry in the Directory Server using the provided compare request.
compareAsync(CompareRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
compareAsync(CompareRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously compares an entry in the Directory Server using the provided compare request.
compareAsync(CompareRequest, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously compares an entry in the Directory Server using the provided compare request.
compareByName() - Static method in class org.forgerock.opendj.ldap.Entries
Returns a Comparator which can be used to compare entries by name using the natural order for DN comparisons (parent before children).
CompareRequest - Interface in org.forgerock.opendj.ldap.messages
The Compare operation allows a client to compare an assertion value with the values of a particular attribute in a particular entry in the Directory.
CompareResult - Interface in org.forgerock.opendj.ldap.messages
An Compare result indicates the final status of an Compare operation.
compareTo(MutableUri) - Method in class org.forgerock.http.MutableUri
 
compareTo(Version) - Method in class org.forgerock.http.routing.Version
 
compareTo(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath
Compares this resource path with the provided resource path.
compareTo(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Compares this attribute description to the provided attribute description.
compareTo(Ava) - Method in class org.forgerock.opendj.ldap.Ava
 
compareTo(byte[], int, int) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Compares this byte sequence with the specified byte array sub-sequence for order.
compareTo(ByteSequence) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Compares this byte sequence with the specified byte sequence for order.
compareTo(byte[], int, int) - Method in class org.forgerock.opendj.ldap.ByteString
 
compareTo(ByteSequence) - Method in class org.forgerock.opendj.ldap.ByteString
 
compareTo(byte[], int, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
compareTo(ByteSequence) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
compareTo(Dn) - Method in class org.forgerock.opendj.ldap.Dn
 
compareTo(GeneralizedTime) - Method in class org.forgerock.opendj.ldap.GeneralizedTime
 
compareTo(Rdn) - Method in class org.forgerock.opendj.ldap.Rdn
 
compareTo(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Compares this attribute type to the provided attribute type.
compareTo(Version) - Method in class org.forgerock.openig.tools.am.Version
 
compareTo(Duration) - Method in class org.forgerock.util.time.Duration
 
compareValues(Object, Object) - Static method in class org.forgerock.util.Objects
Compare two values based on types.
compareValues(Object, Object) - Static method in class org.forgerock.util.Utils
comparisonFilter(FF, String, Object) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new generic comparison filter using the provided field name, operator, and value assertion.
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(JsonPointer) - Method in class org.forgerock.json.JsonPointer
Creates a new JSON pointer which is a descendant of this JSON pointer.
concat(ResourcePath) - Method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path which is a descendant of this resource path.
concat(String) - Method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path which is a descendant of this resource path.
concat(Iterable<? extends Tag>, Iterable<Tag>) - Static method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance my concatenating the specified values.
concat(Iterable<? extends Tag>, String...) - Static method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance my concatenating the specified key value pairs.
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.
ConditionResult - Enum in org.forgerock.opendj.ldap
The result of a tri-state logical expression.
CONFIDENTIALITY_REQUIRED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation could not be processed because it requires confidentiality for the communication between the client and the server.
config() - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
 
config() - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
config() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
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.
ConfigImpl() - Constructor for class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
configure(Meter.Id, HistogramConfig) - Method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
This is only called when filtering new timers and distribution summaries (i.e.
configure(String) - Method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Implements the JDK9 configure() method for compatibility with recent versions fof Java.
configureJwksStore(String, Duration, Duration, URL) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService
configureJwksStore(String, Duration, Duration, URL, Clock) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService
Configure a JWKs store.
ConfirmationKeyVerifier - Interface in org.forgerock.openig.filter.oauth2
A ConfirmationKeyVerifier is responsible to verify a confirmation key node.
ConfirmationKeyVerifierAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2
A ConfirmationKeyVerifierAccessTokenResolver is responsible of validating confirmation keys bound to the access_token (such as certificate thumbprint).
ConfirmationKeyVerifierAccessTokenResolver.Heaplet - Class in org.forgerock.openig.filter.oauth2
Creates and initializes a Confirmation Key Verifier access_token resolver in the heap environment.
CONFLICT - Static variable in class org.forgerock.http.protocol.Status
The 409 (Conflict) status code indicates that the request could not be completed due to a conflict with the current state of the target resource.
CONFLICT - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates the request could not be completed due to a conflict with the current state of the resource.
ConflictException - Exception in org.forgerock.json.resource
An exception that is thrown during a operation on a resource when such an operation would result in a conflict.
ConflictException() - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with null as its detail message.
ConflictException(String) - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with the specified detail message.
ConflictException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with the specified detail message and cause.
ConflictException(Throwable) - Constructor for exception org.forgerock.json.resource.ConflictException
Constructs a new exception with the specified cause.
ConflictingSchemaElementException - Exception in org.forgerock.opendj.ldap.schema
Thrown when addition of a schema element to a schema builder fails because the OID of the schema element conflicts with an existing schema element and the caller explicitly requested not to override existing schema elements.
ConflictingSchemaElementException(LocalizableMessage) - Constructor for exception org.forgerock.opendj.ldap.schema.ConflictingSchemaElementException
Creates a new conflicting schema element exception with the provided message.
conformsToSchema(Entry, SchemaValidationPolicy, Collection<LocalizableMessage>, Schema) - Static method in class org.forgerock.opendj.ldap.Entries
Returns true if the provided entry is valid according to the specified schema and schema validation policy.
conformsToSchema(Entry, SchemaValidationPolicy, Collection<LocalizableMessage>) - Static method in class org.forgerock.opendj.ldap.Entries
Returns true if the provided entry is valid according to the default schema and schema validation policy.
connect() - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketConnector
 
connect() - Method in interface org.forgerock.opendj.io.LdapSocketConnector
Returns a Single which connects to a peer each time it is subscribed.
connect() - Method in interface org.forgerock.opendj.ldap.LdapClient
Returns a Single which connects to a peer each time it is subscribed.
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.
CONNECT_MAX_BACKLOG - Static variable in class org.forgerock.opendj.ldap.LdapServer
Specifies the maximum queue length for incoming connections requests.
CONNECT_TIMEOUT - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Specifies the connect timeout spcified.
connection - Variable in class org.forgerock.json.resource.AbstractConnectionWrapper
The wrapped connection.
Connection - Interface in org.forgerock.json.resource
A client connection to a JSON resource provider over which read and update requests may be performed.
connection - Variable in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
The wrapped connection.
Connection - Interface in org.forgerock.opendj.ldap
A connection with a Directory Server over which read and update operations may be performed.
ConnectionChangeRecordWriter - Class in org.forgerock.opendj.ldif
A ConnectionChangeRecordWriter is a bridge from Connections to ChangeRecordWriters.
ConnectionChangeRecordWriter(Connection) - Constructor for class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Creates a new connection change record writer whose destination is the provided connection.
ConnectionConfiguration() - Constructor for class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration
 
ConnectionConfiguration() - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.ConnectionConfiguration
 
ConnectionEntryReader - Class in org.forgerock.opendj.ldif
A ConnectionEntryReader is a bridge from Connections to EntryReaders.
ConnectionEntryReader(Connection, SearchRequest) - Constructor for class org.forgerock.opendj.ldif.ConnectionEntryReader
Creates a new connection entry reader whose destination is the provided connection using an unbounded LinkedBlockingQueue.
ConnectionEntryReader(Connection, SearchRequest, BlockingQueue<Response>) - Constructor for class org.forgerock.opendj.ldif.ConnectionEntryReader
Creates a new connection entry reader whose destination is the provided connection.
ConnectionEntryWriter - Class in org.forgerock.opendj.ldif
A ConnectionEntryWriter is a bridge from Connections to EntryWriters.
ConnectionEntryWriter(Connection) - Constructor for class org.forgerock.opendj.ldif.ConnectionEntryWriter
Creates a new connection entry writer whose destination is the provided connection.
ConnectionEvent - Enum in org.forgerock.openig.tools.notifications
Describes if the event is a connection event or a disconnection event.
ConnectionEventListener - Interface in org.forgerock.opendj.ldap
An object that registers to be notified when a connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
ConnectionException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request was unsuccessful because of a connection failure.
ConnectionFactory - Interface in org.forgerock.json.resource
A connection factory provides an interface for obtaining a connection to a JSON resource provider.
ConnectionFactory - Interface in org.forgerock.opendj.ldap
A connection factory provides an interface for obtaining a connection to a Directory Server.
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
 
ConnectionPool - Interface in org.forgerock.opendj.ldap
An LDAP client which maintains and re-uses a pool of connections.
Connections - Class in org.forgerock.opendj.ldap
This class contains methods for creating and manipulating LDAP clients and connections.
ConnectionSecurity - Enum in org.forgerock.opendj.ldap
Indicates whether LDAP client connections should use SSL or StartTLS.
connectionSecurity(boolean, boolean) - Static method in enum org.forgerock.opendj.ldap.ConnectionSecurity
Returns the connection security equivalent to the provided useSsl and useStartTls boolean parameters.
ConnectionState - Class in org.forgerock.opendj.ldap.spi
This class can be used to manage the internal state of a connection, ensuring valid and atomic state transitions, as well as connection event listener notification.
ConnectionState() - Constructor for class org.forgerock.opendj.ldap.spi.ConnectionState
Creates a new connection state which is initially valid.
ConsistentHashMap<P> - Class in org.forgerock.opendj.ldap
An implementation of "consistent hashing" supporting per-partition weighting.
ConsistentHashMap() - Constructor for class org.forgerock.opendj.ldap.ConsistentHashMap
Creates a new consistent hash map which will hash keys using MD5.
ConsistentHashMap(Function<Object, Integer, NeverThrowsException>) - Constructor for class org.forgerock.opendj.ldap.ConsistentHashMap
Creates a new consistent hash map which will hash keys using the provided hash function.
constant(N) - Static method in class org.forgerock.opendj.ldap.Functions
Creates a function that returns constant value for any input.
constant(T) - Static method in class org.forgerock.secrets.SecretReference
Create a constant SecretReference for the given secret, that will never expire.
constantEquals(byte[], byte[]) - Static method in class org.forgerock.json.jose.utils.Utils
Compares two byte arrays for equality, in a constant time.
constantGauge(String, T) - Static method in interface org.forgerock.monitoring.api.instrument.Gauge
Setup a Gauge.Builder that will create a gauge that reports the value of the Number.
Constants - Class in org.forgerock.json.schema.validator
Constants is the collection of all constant values used by the object validator implementation.
constantSecretReference(Clock) - Static method in class org.forgerock.openig.util.JsonValues
Returns a SecretReference.constant(Secret) from a GenericSecret attribute value.
CONSTRAINT_VIOLATION - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it would have violated some constraint defined in the server.
Constraints - Class in org.forgerock.openig.tools.jwt
Constraints are defined for JWT validation.
ConstraintViolationException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the update Request failed because it would have left the Directory in an inconsistent state.
Consumer<T,E extends Exception> - Interface in org.forgerock.util
A Consumer functional interface which can throw a checked Exception.
contains(Object) - Method in class org.forgerock.http.util.CaseInsensitiveSet
 
contains(Object) - Method in class org.forgerock.http.util.SetDecorator
Returns true if the set contains the specified element.
contains(Object) - Method in class org.forgerock.json.JsonValue
Returns true this JSON value contains an item with the specified value.
contains(Object) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
contains(Object) - Method in interface org.forgerock.opendj.ldap.Attribute
Returns true if this attribute contains value.
contains(Object) - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
contains(Dn) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns true if the named entry exists in this memory backend.
contains(String) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns true if the named entry exists in this memory backend.
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(T) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the list contains the expected value.
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.opendj.ldap.AbstractAttribute
 
containsAll(Collection<?>) - Method in interface org.forgerock.opendj.ldap.Attribute
Returns true if this attribute contains all of the attribute values contained in values.
containsAll(Collection<?>) - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
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.
containsAnyAttributes(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.Entry
Returns true if this entry contains any non-empty attributes having an attribute description which is a sub-type of the provided attribute description.
containsAnyAttributes(String) - Method in interface org.forgerock.opendj.ldap.Entry
Returns true if this entry contains any non-empty attributes having an attribute description which is a sub-type of the provided attribute description.
containsAnyAttributes(AttributeDescription) - Method in class org.forgerock.opendj.ldap.TreeMapEntry
 
containsAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.Entry
Returns true if this entry contains all of the attribute values contained in attribute.
containsAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.Entry
Returns true if this entry contains all of the attribute values contained in values.
containsAttribute(AttributeDescription, Object...) - Method in interface org.forgerock.opendj.ldap.Entry
Returns true if this entry contains all of the attribute values contained in values.
containsAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
containsAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
containsAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
containsAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
containsChanges() - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Returns true if changes has already been written in this LdifChangeRecordWriter.
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.
containsControl(String) - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
 
containsControl(String) - Method in interface org.forgerock.opendj.ldap.messages.ProtocolOp
Returns true if this protocol-op contains the specified control.
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.
containsObjectClass(Entry, ObjectClass) - Static method in class org.forgerock.opendj.ldap.Entries
Check if the provided entry contains the provided object class.
containsObjectClass(Entry, ObjectClass, Schema) - Static method in class org.forgerock.opendj.ldap.Entries
Check if the provided entry contains the provided object class.
containsOnly(T) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the list contains only the expected value.
containsTopic(String) - Method in class org.forgerock.audit.events.EventTopicsMetaData
Returns true if this object has meta-data for the specified topic.
containsValue(Object) - Method in class org.forgerock.http.protocol.Headers
 
containsValue(Object) - Method in class org.forgerock.http.protocol.RequestCookies
 
containsValue(Object) - Method in class org.forgerock.util.LazyMap
Returns true if the map maps one or more keys to the specified value.
containsValue(Object) - Method in class org.forgerock.util.MapDecorator
Returns true if the map maps one or more keys to the specified value.
CONTENT_DISPOSITION - Static variable in class org.forgerock.json.resource.http.HttpUtils
the HTTP header for Content-Disposition.
ContentApiVersionHeader - Class in org.forgerock.http.header
Processes the Content-API-Version message header.
ContentApiVersionHeader(Version, Version) - Constructor for class org.forgerock.http.header.ContentApiVersionHeader
Constructs a new header, initialized with the specified protocol and resource versions.
ContentEncodingHeader - Class in org.forgerock.http.header
Processes the Content-Encoding message header.
ContentEncodingHeader() - Constructor for class org.forgerock.http.header.ContentEncodingHeader
Constructs a new empty header.
ContentEncodingHeader(List<String>) - Constructor for class org.forgerock.http.header.ContentEncodingHeader
Constructs a new header with the provided content encodings.
ContentLengthHeader - Class in org.forgerock.http.header
Processes the Content-Length message header.
ContentLengthHeader() - Constructor for class org.forgerock.http.header.ContentLengthHeader
Constructs a new empty header whose length is set to -1.
ContentLengthHeader(long) - Constructor for class org.forgerock.http.header.ContentLengthHeader
Constructs a new header with the provided content length.
ContentTypeHeader - Class in org.forgerock.http.header
Processes the Content-Type message header.
ContentTypeHeader() - Constructor for class org.forgerock.http.header.ContentTypeHeader
Constructs a new empty header whose type, charset, and boundary are all null.
ContentTypeHeader(String, String, String) - Constructor for class org.forgerock.http.header.ContentTypeHeader
ContentTypeHeader(String, String, String, Map<String, String>) - Constructor for class org.forgerock.http.header.ContentTypeHeader
ContentTypeHeader(String, Map<String, Directive>) - Constructor for class org.forgerock.http.header.ContentTypeHeader
Constructs a new header based on message type and any message directives.
CONTEXT - 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.
Control - Interface in org.forgerock.opendj.ldap.controls
Controls provide a mechanism whereby the semantics and arguments of existing LDAP operations may be extended.
ControlDecoder<C extends Control> - Interface in org.forgerock.opendj.ldap.controls
A factory interface for decoding a control as a control of specific type.
Controls - Class in org.forgerock.opendj.ldap.controls
Utility class to resolve controls OID from aliases.
convert(double, TimeUnit, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
convertTo(TimeUnit) - Method in class org.forgerock.util.time.Duration
Convert the current duration to a given TimeUnit.
Cookie - Class in org.forgerock.http.protocol
An HTTP cookie.
Cookie() - Constructor for class org.forgerock.http.protocol.Cookie
Creates a new uninitialized cookie.
Cookie.SameSite - Enum in org.forgerock.http.protocol
Indicates the SameSite value of the cookie.
COOKIE_APPROX_BROWSER_LIMIT - Static variable in class org.forgerock.openig.http.CookieBuilder
Browse cookie size limit.
CookieBuilder - Class in org.forgerock.openig.http
Class to collate all static cookie configuration data for building response cookies.
CookieFilter - Class in org.forgerock.openig.filter
Suppresses, relays and manages cookies.
CookieFilter() - Constructor for class org.forgerock.openig.filter.CookieFilter
 
CookieFilter.Action - Enum in org.forgerock.openig.filter
Action to be performed for a cookie.
CookieFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a cookie filter in a heap environment.
CookieHeader - Class in org.forgerock.http.header
Processes the Cookie request message header.
CookieHeader() - Constructor for class org.forgerock.http.header.CookieHeader
Constructs a new empty header.
CookieHeader(List<Cookie>) - Constructor for class org.forgerock.http.header.CookieHeader
Constructs a new header with the provided cookies.
cookieName(String) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Set the cookie/header name and returns this builder.
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.
copyFrom(Result) - Method in interface org.forgerock.opendj.ldap.messages.Result
Copies the result code, cause, diagnostic message, matched DN and referral URIs from the provided result to this result.
copyOf(PatchOperation) - Static method in class org.forgerock.json.resource.PatchOperation
Returns a deep copy of the provided patch operation.
copyOf(SchemaValidationPolicy) - Static method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Creates a copy of the provided schema validation policy.
copyOf(Options) - Static method in class org.forgerock.util.Options
Returns a copy of the provided set of options.
copyOfAbandonRequest(AbandonRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new abandon request that is an exact copy of the provided request.
copyOfActionRequest(ActionRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided action request.
copyOfAddRequest(AddRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new add request that is an exact copy of the provided request.
copyOfApiRequest(Request) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided api request.
copyOfBindRequest(BindRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new bind request that is an exact copy of the provided request.
copyOfBindResult(BindResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new bind result that is an exact copy of the provided result.
copyOfCancelExtendedRequest(CancelExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new cancel extended request that is an exact copy of the provided request.
copyOfCompareRequest(CompareRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new compare request that is an exact copy of the provided request.
copyOfCompareResult(CompareResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new compare result that is an exact copy of the provided result.
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.
copyOfDeleteRequest(DeleteRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new delete request that is an exact copy of the provided request.
copyOfGenericExtendedRequest(GenericExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new generic extended request that is an exact copy of the provided request.
copyOfGenericExtendedResult(GenericExtendedResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new generic extended result that is an exact copy of the provided result.
copyOfGenericIntermediateResponse(GenericIntermediateResponse) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new generic intermediate response that is an exact copy of the provided response.
copyOfModifyDnRequest(ModifyDnRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify DN request that is an exact copy of the provided request.
copyOfModifyRequest(ModifyRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify request that is an exact copy of the provided request.
copyOfPasswordModifyExtendedRequest(PasswordModifyExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new password modify extended request that is an exact copy of the provided request.
copyOfPasswordModifyExtendedResult(PasswordModifyExtendedResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new password modify extended result that is an exact copy of the provided result.
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.
copyOfResult(Result) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new result that is an exact copy of the provided result.
copyOfSearchRequest(SearchRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new search request that is an exact copy of the provided request.
copyOfSearchResultEntry(SearchResultEntry) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result entry that is an exact copy of the provided result.
copyOfSearchResultReference(SearchResultReference) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result reference that is an exact copy of the provided result.
copyOfSslOptions(SslOptions) - Static method in class org.forgerock.opendj.security.SslOptions
Creates a copy of the provided SslOptions.
copyOfStartTlsExtendedRequest(StartTlsExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new startTLS extended request that is an exact copy of the provided request.
copyOfUnbindRequest(UnbindRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new unbind request that is an exact copy of the provided request.
copyOfUpdateRequest(UpdateRequest) - Static method in class org.forgerock.json.resource.Requests
Returns a copy of the provided update request.
copyOfWhoAmIExtendedRequest(WhoAmIExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new Who Am I extended request that is an exact copy of the provided request.
copyOfWhoAmIExtendedResult(WhoAmIExtendedResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new who am I extended result that is an exact copy of the provided result.
copyOnWriteEntry(Entry, Function<Entry, Entry>) - Static method in class org.forgerock.opendj.ldap.Entries
Returns a shallow copy-on-write view of entry.
copyRawContentTo(OutputStream) - Method in class org.forgerock.http.protocol.Entity
Copies the raw content of this entity to the provided output stream.
copyTo(byte[]) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Copies the contents of this byte sequence to the provided byte array.
copyTo(byte[], int) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Copies the contents of this byte sequence to the specified location in the provided byte array.
copyTo(ByteStringBuilder) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Appends the entire contents of this byte sequence to the provided ByteStringBuilder.
copyTo(ByteBuffer) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Appends the content of this byte sequence to the provided ByteBuffer starting at it's current position.
copyTo(CharBuffer, CharsetDecoder) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Appends the content of this byte sequence decoded using provided charset decoder to the provided CharBuffer starting at it's current position.
copyTo(OutputStream) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Copies the entire contents of this byte sequence to the provided OutputStream.
copyTo(byte[]) - Method in class org.forgerock.opendj.ldap.ByteString
 
copyTo(byte[], int) - Method in class org.forgerock.opendj.ldap.ByteString
 
copyTo(ByteBuffer) - Method in class org.forgerock.opendj.ldap.ByteString
 
copyTo(ByteStringBuilder) - Method in class org.forgerock.opendj.ldap.ByteString
 
copyTo(CharBuffer, CharsetDecoder) - Method in class org.forgerock.opendj.ldap.ByteString
 
copyTo(OutputStream) - Method in class org.forgerock.opendj.ldap.ByteString
 
copyTo(byte[]) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
copyTo(byte[], int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
copyTo(ByteBuffer) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
copyTo(ByteStringBuilder) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
copyTo(CharBuffer, CharsetDecoder) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
copyTo(OutputStream) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
copyTo(WritableByteChannel) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Copies the entire contents of this byte string to the provided WritableByteChannel.
copyTo(ChangeRecordReader, ChangeRecordWriter) - Static method in class org.forgerock.opendj.ldif.Ldif
Copies the content of input to output.
copyTo(EntryReader, EntryWriter) - Static method in class org.forgerock.opendj.ldif.Ldif
Copies the content of input to output.
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
 
CoreSchema - Class in org.forgerock.opendj.ldap.schema
The OpenDJ SDK core schema contains standard LDAP RFC schema elements.
CoreSchemaSupportedLocales - Class in org.forgerock.opendj.ldap.schema
Provides a map of supported locale tags to OIDs.
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.
count() - Method in class org.forgerock.monitoring.api.instrument.CountAtValue
 
count() - Method in interface org.forgerock.monitoring.api.instrument.Counter
The cumulative count since this counter was created.
count() - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
The number of times that record has been called since this timer was created.
count() - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
count() - Method in interface org.forgerock.monitoring.api.instrument.Timer
The number of times that stop has been called on this timer.
count() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableCounter
 
count() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
count() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
CountAtValue - Class in org.forgerock.monitoring.api.instrument
The count accumulated to a histogram bucket.
Counter - Interface in org.forgerock.monitoring.api.instrument
Used to measure the rate of change based on calls to increment.
counter(Meter.Id) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
counter(Meter.Id) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
counter() - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
counter() - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
counter(Meter.Id) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
Counter.Builder - Class in org.forgerock.monitoring.api.instrument
Fluent builder for counters.
CountPolicy - Enum in org.forgerock.json.resource
An enum of count policy types.
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(AttributeType) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Creates an attribute description having the provided attribute type and no options.
create(String, AttributeType) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Creates an attribute description having the provided attribute name, type and no options.
create(AttributeType, String) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Creates an attribute description having the provided attribute type and single option.
create(AttributeType, Collection<String>) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Creates an attribute description having the provided attribute type and options.
create(AttributeType, String...) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Creates an attribute description having the provided attribute type and options.
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.CsrfFilterHeaplet
 
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.JwtBuilderFilter.Heaplet
 
create(Map<String, Object>) - Method in interface org.forgerock.openig.filter.JwtFactory
Produces a new Jwt.
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.ConfirmationKeyVerifierAccessTokenResolver.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.StatelessAccessTokenResolver.Heaplet
 
create() - Method in class org.forgerock.openig.filter.oauth2.TokenIntrospectionAccessTokenResolverHeaplet
 
create() - Method in class org.forgerock.openig.filter.PasswordReplayFilterHeaplet
 
create() - Method in class org.forgerock.openig.filter.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.ReverseProxyHandler.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.AmServiceHeaplet
 
create() - Method in class org.forgerock.openig.openam.CapturedUserPasswordFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.RequestResourceUriProvider
 
create() - Method in class org.forgerock.openig.openam.SessionInfoFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.SingleSignOnFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.TokenTransformationFilter.Heaplet
 
create() - Method in class org.forgerock.openig.openam.UserProfileFilterHeaplet
 
create() - Method in class org.forgerock.openig.openam.UserProfileServiceHeaplet
 
create() - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
create() - Method in class org.forgerock.openig.secrets.FileSystemSecretStoreHeaplet
 
create() - Method in class org.forgerock.openig.secrets.HsmSecretStoreHeaplet
 
create() - Method in class org.forgerock.openig.secrets.KeyStoreSecretStoreHeaplet
 
create() - Method in class org.forgerock.openig.secrets.SecretsProviderHeaplet
 
create() - Method in class org.forgerock.openig.secrets.SystemAndEnvSecretStoreHeaplet
 
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.TlsOptionsHeaplet
 
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.
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.
createExactMatchQuery(AttributeDescription, String, ByteSequence) - Method in interface org.forgerock.opendj.ldap.spi.IndexQueryFactory
Returns a query requesting an index record matching the provided key.
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.
createIndexers(IndexingOptions) - Method in class org.forgerock.opendj.ldap.schema.AbstractEqualityMatchingRuleImpl
 
createIndexers(IndexingOptions) - Method in class org.forgerock.opendj.ldap.schema.AbstractOrderingMatchingRuleImpl
 
createIndexers(IndexingOptions) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the indexers for this matching rule configured using the provided indexing options.
createIndexers(IndexingOptions) - Method in interface org.forgerock.opendj.ldap.schema.MatchingRuleImpl
Returns the indexers for this matching rule.
createIndexQuery(AttributeDescription, IndexQueryFactory<T>) - Method in interface org.forgerock.opendj.ldap.Assertion
Returns an index query appropriate for the provided attribute value assertion.
createInline(String...) - Method in class org.forgerock.openig.script.GroovyScriptFactory
 
createInline(String...) - Method in interface org.forgerock.openig.script.ScriptFactory
Build a new Script instance from the given lines representing the script content.
createInstance(Context, CreateRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider
Adds a new resource instance to the collection.
createInstance(Context, CreateRequest) - Method in class org.forgerock.json.resource.MemoryBackend
Adds a new resource instance to the collection.
createInstance(Context, CreateRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
createIntersectionQuery(Collection<T>) - Method in interface org.forgerock.opendj.ldap.spi.IndexQueryFactory
Returns a query which returns the intersection of a collection of sub-queries.
createKeys(Schema, ByteSequence, Collection<ByteString>) - Method in interface org.forgerock.opendj.ldap.spi.Indexer
Generates the set of index keys for an attribute.
createMatchAllQuery(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.spi.IndexQueryFactory
Returns a query requesting all index records.
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.
createRangeMatchQuery(AttributeDescription, String, ByteSequence, ByteSequence, boolean, boolean) - Method in interface org.forgerock.opendj.ldap.spi.IndexQueryFactory
Returns a query requesting all index records in the specified range.
createReference(Purpose<S>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService
 
createReference(Purpose<S>) - Method in interface org.forgerock.openig.secrets.SecretsService
Create a SecretReference for the given Purpose.
CreateRequest - Interface in org.forgerock.json.resource
A request to create a new JSON resource.
createResource(String) - Method in class org.forgerock.openig.script.GroovyScriptFactory
 
createResource(String) - Method in interface org.forgerock.openig.script.ScriptFactory
Build a new Script instance from a resource name.
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.
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.
createUnionQuery(Collection<T>) - Method in interface org.forgerock.opendj.ldap.spi.IndexQueryFactory
Returns a query which combines the results of a collection of sub-queries.
createUri(String, String, String, int, String, String, String, boolean) - Static method in class org.forgerock.http.util.Uris
Create a new URI given all provided URI components, query string can be strictly processed or not.
CredentialsParser<C> - Interface in org.forgerock.http.header.authorization
This interface is used to parse the credentials component of an Authorization HTTP header.
CREST_PROTOCOL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The protocol field CREST value.
CrestApplication - Interface in org.forgerock.json.resource
Declare a CREST Application.
CrestHttp - Class in org.forgerock.json.resource.http
A CREST HTTP utility class which creates instances of the HttpAdapter to handle CREST HTTP requests.
CrestSessionService - Class in org.forgerock.openig.tools.session
The CrestSessionService is responsible to perform interactions with AM sessions endpoint, such as session info or logout, etc.
CrestSessionService(RequestHandler) - Constructor for class org.forgerock.openig.tools.session.CrestSessionService
Creates a new CrestSessionService which is responsible for interactions with AM sessions endpoint.
CrestUserProfileService - Class in org.forgerock.openig.tools.userprofile
The CrestUserProfileService is responsible for interactions with AM users endpoint using resource version 3.0; since AM v13.
CrestUserProfileService(RequestHandler, Set<String>) - Constructor for class org.forgerock.openig.tools.userprofile.CrestUserProfileService
Creates a new CrestUserProfileService which is responsible for interactions with AM users endpoint.
CrestUtil - Class in org.forgerock.openig.util
CREST utility class.
crit(List<String>) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the critical header parameters for this JWS.
CrossDomainSingleSignOnFilter - Class in org.forgerock.openig.openam
This filter verifies the presence of a JWT authentication token in the configured cookie name: If the JWT is present then its validity is checked and the request is forwarded to the next handler. If the JWT is not present, then the user-agent is redirected to Access Management via its OAuth2 authorization endpoint, to obtain user authentication.
CrossDomainSingleSignOnFilter(AmService, String, String, CookieBuilder, Supplier<String>, Clock, Handler) - Constructor for class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter
Creates a new CrossDomainSingleSignOnFilter.
CrossDomainSingleSignOnFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initialises an authentication filter in a heap environment.
crtCoefficient(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Set the RSA First CRT Coefficient value.
CRYPTO - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the crypto json object.
CRYPTO_ALGORITHM - Static variable in class org.forgerock.util.crypto.CryptoConstants
Key for the crypto algorithm used to crypt the data.
CRYPTO_CIPHER - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the cipher used to crypt the data.
CRYPTO_DATA - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the password data within crypto json.
CRYPTO_IV - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the Initialization Vector (a.k.a.
CRYPTO_KEY - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the name of the key-store alias used to crypt the data.
CRYPTO_TYPE - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for crypt type used to generate the crypt value.
CRYPTO_VALUE - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the crypt value, holding the crypt meta-data.
CryptoConstants - Class in org.forgerock.util.crypto
Constants for Crypto Algorithms and Json Crypto Json pointer keys.
CryptoHeaderFilter - Class in org.forgerock.openig.filter
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 ?
CryptoKey - Class in org.forgerock.secrets.keys
Base class for all secrets that are used as keys for cryptographic operations.
CsrfFilter - Class in org.forgerock.http.filter
A generic filter for preventing cross-site request forgery (CSRF) attacks when using cookie-based authentication.
CsrfFilter.Builder - Class in org.forgerock.http.filter
Builder class for the CSRF filter.
CsrfFilterHeaplet - Class in org.forgerock.openig.filter
Creates and initializes a CsrfFilter supporting the injection and validation of an anti-CSRF token in the request header.
CsrfFilterHeaplet() - Constructor for class org.forgerock.openig.filter.CsrfFilterHeaplet
 
CsvAuditEventHandler - Class in org.forgerock.audit.handlers.csv
Handles AuditEvents by writing them to a CSV file.
CsvAuditEventHandler(CsvAuditEventHandlerConfiguration, EventTopicsMetaData, KeyStoreHandlerProvider) - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandler
Create a new CsvAuditEventHandler instance.
CsvAuditEventHandler.ParseJsonValue - Class in org.forgerock.audit.handlers.csv
CellProcessor for parsing JsonValue objects from CSV file.
CsvAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.csv
A configuration for CSV audit event handler.
CsvAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
 
CsvAuditEventHandlerConfiguration.CsvFormatting - Class in org.forgerock.audit.handlers.csv
Contains the csv writer configuration parameters.
CsvAuditEventHandlerConfiguration.CsvSecurity - Class in org.forgerock.audit.handlers.csv
Contains the configuration parameters to configure tamper evident logging.
CsvAuditEventHandlerConfiguration.EventBufferingConfiguration - Class in org.forgerock.audit.handlers.csv
Configuration of event buffering.
CsvFormatting() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting
 
CsvSecureArchiveVerifierCli - Class in org.forgerock.audit.handlers.csv
Command line interface for verifying an archived set of tamper evident CSV audit log files for a particular topic.
CsvSecurity() - Constructor for class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity
 
cty(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder
Sets the content type header parameter for this JWS.
currentDateTime() - Method in class org.forgerock.audit.util.DateUtil
Get current time.
currentTime() - Static method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a generalized time whose value is the current time, using the default time zone and locale.
curve(SupportedEllipticCurve) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the elliptic curve that this key uses.
curve(Key) - Static method in class org.forgerock.json.jose.utils.XECUtils
Returns the curve that this XECKey is for.

D

d(String) - Method in class org.forgerock.json.jose.jwk.EcJWK.Builder
Set the unsigned big-endian base64 url encoding of the d value for the elliptical curve private key.
d(String) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the private key d-value of the key.
data - Variable in class org.forgerock.services.context.AbstractContext
The Context data.
DATA_DECRYPTION - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for decrypting data.
DATA_ENCRYPTION - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for encrypting data.
DataDecryptionKey - Class in org.forgerock.secrets.keys
A key that is used for decrypting confidential data.
DataDecryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.DataDecryptionKey
Initialises the key with the given secret data.
DataEncryptionKey - Class in org.forgerock.secrets.keys
A key that is used for encrypting confidential data.
DataEncryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.DataEncryptionKey
Initialises the key with the given secret data.
DateUtil - Class in org.forgerock.audit.util
Manages timestamp strings in ISO8601 format.
daysToUnit(double, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
decode(InputStream) - Method in interface org.forgerock.http.decoder.Decoder
Returns an instance of an input stream that decodes the specified input.
decode(InputStream) - Method in class org.forgerock.http.header.ContentEncodingHeader
Returns an input stream that decodes the specified input stream, given the content-codings that are specified in the codings list.
decode(String) - Static method in class org.forgerock.opendj.ldap.Base64
Decodes the provided base64 encoded data.
decode(Reader) - Method in class org.forgerock.openig.tools.notifications.ws.JsonValueDecoder
 
decode(String) - Method in enum org.forgerock.secrets.propertyresolver.PropertyFormatBase64
 
decode(String) - Method in class org.forgerock.secrets.propertyresolver.SecretKeyPropertyFormat
 
decode(String) - Method in interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat
Decodes the input property value, setting relevant properties on a SecretBuilder object.
decode(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.
decodeControl(Control, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.controls.ControlDecoder
Decodes the provided control as a Control of type C.
decodeControl(Control) - Method in interface org.forgerock.opendj.ldap.controls.ControlDecoder
Decodes the provided control as a Control of type C using the default decode options.
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.
DecodeException - Exception in org.forgerock.opendj.ldap
Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way.
decodeExtendedRequest(ExtendedRequest<?>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequestDecoder
Decodes the provided extended operation request as an ExtendedRequest of type R.
decodeExtendedResult(ExtendedResult, DecodeOptions) - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedResultDecoder
 
decodeExtendedResult(ExtendedResult, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResultDecoder
Decodes the provided extended operation result as a Result of type S.
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.
decodeJwtComponent(String) - Static method in class org.forgerock.json.jose.utils.Utils
Decodes the given String and converts the decoded bytes into a UTF-8 String.
DecodeOptions - Class in org.forgerock.opendj.ldap
Decode options allow applications to control how requests and responses are decoded.
DecodeOptions() - Constructor for class org.forgerock.opendj.ldap.DecodeOptions
Creates a new set of decode options which will always use the default schema returned by Schema.getDefaultSchema(), LinkedAttribute, and LinkedHashMapEntry.
DecodeOptions(DecodeOptions) - Constructor for class org.forgerock.opendj.ldap.DecodeOptions
Creates a new set of decode options having the same initial set of options as the provided set of decode options.
Decoder - Interface in org.forgerock.http.decoder
Decodes an HTTP message entity input stream.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
A decoder which can be used for decoding the LDAP assertion request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
A decoder which can be used for decoding the authorization identity request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
A decoder which can be used for decoding the authorization identity response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
A decoder which can be used for decoding the entry change notification response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
A decoder which can be used for decoding the get effective rights request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
A decoder which can be used for decoding the Manage DsaIT request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
A decoder which can be used for decoding the matched values request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
A decoder which can be used for decoding the password expired response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
A decoder which can be used for decoding the password expiring response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
A decoder which can be used for decoding the password policy request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
A decoder which can be used for decoding the password policy response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
A decoder which can be used for decoding the permissive modify request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
A decoder which can be used for decoding the persistent search request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
A decoder which can be used for decoding the post-read request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
A decoder which can be used for decoding the post-read response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
A decoder which can be used for decoding the pre-read request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
A decoder which can be used for decoding the pre-read response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
A decoder which can be used for decoding the proxied authorization v1 request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
A decoder which can be used for decoding the proxied authorization v2 request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
A decoder which can be used for decoding the permissive modify request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
A decoder which can be used for decoding the server side sort request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
A decoder which can be used for decoding the server side sort response control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
A decoder which can be used for decoding the simple paged results control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
A decoder which can be used for decoding the sub-entries request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
A decoder which can be used for decoding the sub-tree delete request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
A decoder which can be used for decoding the virtual list view request control.
DECODER - Static variable in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
A decoder which can be used for decoding the virtual list view response control.
DECODER - Static variable in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
A decoder which can be used to decode cancel extended operation requests.
DECODER - Static variable in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
A decoder which can be used to decode generic extended operation requests.
DECODER - Static variable in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
A decoder which can be used to decode password modify extended operation requests.
DECODER - Static variable in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
A decoder which can be used to decode start TLS extended operation requests.
DECODER - Static variable in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
A decoder which can be used to decode who am I extended operation requests.
decodeToPromise(String) - Method in interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat
Decodes the input property value, setting relevant properties on a SecretBuilder object.
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
 
DecorationHandle - Class in org.forgerock.openig.decoration
A DecorationHandle is handle to get the decorated object and being able to notify the decoration to stop.
DecorationHandle(Object) - Constructor for class org.forgerock.openig.decoration.DecorationHandle
Constructs a DecorationHandle.
DecorationHandle(Object, Runnable) - Constructor for class org.forgerock.openig.decoration.DecorationHandle
Constructs a DecorationHandle.
Decorator - Interface in org.forgerock.openig.decoration
A Decorator is responsible for decorating existing object's instances.
DecoratorHeaplet - Class in org.forgerock.openig.decoration.helper
A base class for decorator heaplets.
DecoratorHeaplet() - Constructor for class org.forgerock.openig.decoration.helper.DecoratorHeaplet
Can only be called by sub-classes.
decrypt(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.
deepCopyOfEntry(Entry) - Static method in class org.forgerock.opendj.ldap.LinkedHashMapEntry
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
deepCopyOfEntry(Entry) - Static method in class org.forgerock.opendj.ldap.TreeMapEntry
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
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 - Static variable in class org.forgerock.json.schema.validator.Constants
The default field name.
DEFAULT - Static variable in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
DEFAULT - Static variable in interface org.forgerock.opendj.ldap.SchemaResolver
A schema resolver which always returns the current default schema as returned by Schema.getDefaultSchema().
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 class org.forgerock.openig.tools.am.AmService
AM 5.0.0 (equivalent of OpenAM 14.0.0).
DEFAULT_CASE_INSENSITIVE_FIELDS - Static variable in class org.forgerock.audit.AuditServiceConfiguration
DEFAULT_CLIENT_HANDLER - Static variable in class org.forgerock.openig.http.DefaultDeclarations
The client handler that deals with third-party services.
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.am.AmService
The default cookie header name for the OpenAM Server.
DEFAULT_MATCHING_RULE_OID - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies the OID of the default matching rule which will be used when parsing unrecognized attributes.
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_REVERSE_PROXY_HANDLER - Static variable in class org.forgerock.openig.http.DefaultDeclarations
The proxy client handler that deals with the application traffic.
DEFAULT_ROTATION_FILE_SUFFIX - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
The default file rotation suffix format.
DEFAULT_SCHEDULED_THREAD_POOL - Static variable in class org.forgerock.openig.http.DefaultDeclarations
Default scheduler for configurations that require periodic execution of tasks such as cache eviction.
DEFAULT_SESSION_TIMEOUT - Static variable in class org.forgerock.openig.jwt.JwtSessionManager
Default sessionTimeout duration.
DEFAULT_SYNTAX_OID - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies the OID of the default syntax which will be used when parsing unrecognized attributes.
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.
defaultAsyncBehavior() - Method in class org.forgerock.openig.handler.ClientHandler.Heaplet
Returns default asyncBehavior value if undefined in configuration.
defaultAsyncBehavior() - Method in class org.forgerock.openig.handler.ReverseProxyHandler.Heaplet
 
DefaultAuthenticationService - Class in org.forgerock.openig.tools.authentication.chf
Implements an HTTP-based authentication service.
DefaultAuthenticationService(Handler, URI) - Constructor for class org.forgerock.openig.tools.authentication.chf.DefaultAuthenticationService
DefaultDeclarations - Class in org.forgerock.openig.http
Configurations used as defaults in the Heap.
DefaultEnvironment - Class in org.forgerock.openig.config.env
Reify the normal environment structure with pre-configured shortcuts.
DefaultEnvironment(File) - Constructor for class org.forgerock.openig.config.env.DefaultEnvironment
Builds a new file based Environment using the given file as the base directory.
defaultHistogramConfig() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Every custom registry implementation should define a default histogram expiry.
defaultHistogramConfig() - Method in class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
 
defaultingPropertyResolver() - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Returns an empty resolver that always return the default value.
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.
defaultPolicy() - Static method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Creates a new schema validation policy 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
 
DefaultScriptFactoryManager - Class in org.forgerock.openig.script
Default implementation of ScriptFactoryManager supporting dynamic registration and un-registration of ScriptFactory.
DefaultScriptFactoryManager() - Constructor for class org.forgerock.openig.script.DefaultScriptFactoryManager
 
DefaultSecretsService - Class in org.forgerock.openig.secrets
Default Secret Service implementation.
DefaultSecretsService(SecretsProvider, Clock) - Constructor for class org.forgerock.openig.secrets.DefaultSecretsService
Constructs a new DefaultSecretsService with a given provider.
DefaultSecretsService.Builder - Class in org.forgerock.openig.secrets
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.
defaultSoTimeout() - Method in class org.forgerock.openig.handler.ClientHandler.Heaplet
Returns default soTimeout value if undefined in configuration.
defaultSoTimeout() - Method in class org.forgerock.openig.handler.ReverseProxyHandler.Heaplet
 
defaultTo(Object) - Method in class org.forgerock.json.JsonValue
Defaults the JSON value to the specified value if it is currently null.
DefaultVersionBehaviour - Enum in org.forgerock.http.routing
The default routing behaviour to use when no Accept-API-Version is set on the request.
DEFINITIONS - Static variable in class org.forgerock.json.schema.validator.Constants
The definitions field name.
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(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.opendj.ldap.AbstractAsynchronousConnection
 
delete(String) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
delete(DeleteRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Deletes an entry from the Directory Server using the provided delete request.
delete(String) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Deletes the named entry from the Directory Server.
delete(DeleteRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Deletes an entry from the Directory Server using the provided delete request.
delete(Dn) - Method in interface org.forgerock.opendj.ldap.Connection
Deletes the named entry from the Directory Server.
delete(String) - Method in interface org.forgerock.opendj.ldap.Connection
Deletes the named entry from the Directory Server.
delete(DeleteRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Deletes an entry from the Directory Server using the provided delete request.
delete(String, Object...) - Static method in class org.forgerock.opendj.ldap.Modification
Returns a new DELETE modification.
DELETE - Static variable in class org.forgerock.opendj.ldap.ModificationType
Delete the values listed in the modification from the attribute.
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.
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.
deleteAsync(DeleteRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
deleteAsync(DeleteRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously deletes an entry from the Directory Server using the provided delete request.
deleteAsync(DeleteRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously deletes an entry from the Directory Server using the provided delete request.
deleteAsync(DeleteRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
deleteAsync(DeleteRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously deletes an entry from the Directory Server using the provided delete request.
deleteAsync(DeleteRequest, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously deletes an entry from the Directory Server using the provided delete request.
deleteFiles(boolean, FileNamingPolicy) - Method in class org.forgerock.audit.retention.DiskSpaceUsedRetentionPolicy
 
deleteFiles(boolean, FileNamingPolicy) - Method in class org.forgerock.audit.retention.FreeDiskSpaceRetentionPolicy
 
deleteFiles(boolean, FileNamingPolicy) - Method in interface org.forgerock.audit.retention.RetentionPolicy
Returns all files that should be deleted according to the policy.
deleteFiles(boolean, FileNamingPolicy) - Method in class org.forgerock.audit.retention.SizeBasedRetentionPolicy
 
deleteInstance(Context, String, DeleteRequest) - Method in interface org.forgerock.json.resource.CollectionResourceProvider
Removes a resource instance from the collection.
deleteInstance(Context, String, DeleteRequest) - Method in class org.forgerock.json.resource.MemoryBackend
Removes a resource instance from the collection.
deleteInstance(Context, String, DeleteRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
DeleteRequest - Interface in org.forgerock.json.resource
A request to delete a JSON resource.
DeleteRequest - Interface in org.forgerock.opendj.ldap.messages
The Delete operation allows a client to request the removal of an entry from the Directory.
deleteSubtree(String) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
deleteSubtree(String) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Deletes the named entry and all of its subordinates from the Directory Server.
deleteSubtree(String) - Method in interface org.forgerock.opendj.ldap.Connection
Deletes the named entry and all of its subordinates from the Directory Server.
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).
deny(Predicate<Meter.Id>) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
When the given predicate is true, the meter should NOT be present in published metrics.
deny() - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Reject a meter in published metrics.
denyNameStartsWith(String) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Meters that start with the provided name should NOT be present in published metrics.
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.
DeprecatedUserProfileFilter - Class in org.forgerock.openig.openam
Deprecated.
Since 6.5. Prefer to use the UserProfileFilter that does not require a SSO Token.
DeprecatedUserProfileFilter(AmService, Expression<String>, Set<String>) - Constructor for class org.forgerock.openig.openam.DeprecatedUserProfileFilter
Deprecated.
Creates a new Access Management profile attributes filter.
DereferenceAliasesPolicy - Class in org.forgerock.opendj.ldap
A Search operation alias dereferencing policy as defined in RFC 4511 section 4.5.1.3 is used to indicate whether alias entries (as defined in RFC 4512) are to be dereferenced during stages of a Search operation.
deregisterAll() - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
Deregister all meters held by this object.
deregisterMatching(MeterFilter) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
Deregister meters matching the provided filter.
deregisterMatching(MeterFilter) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
deregisterMatching(MeterFilter) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
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 - Static variable in class org.forgerock.json.schema.validator.Constants
The type field name.
description(String) - Method in class org.forgerock.monitoring.api.instrument.Counter.Builder
Associate a description with the Counter
description(String) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
 
description(String) - Method in class org.forgerock.monitoring.api.instrument.Gauge.Builder
 
description(String) - Method in class org.forgerock.monitoring.api.instrument.Meter.Builder
 
description(String) - Method in class org.forgerock.monitoring.api.instrument.TimeGauge.Builder
 
description(String) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
 
description(String) - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
 
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.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
destroy() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Destroys the credentials contained within this bind request.
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.AmServiceHeaplet
 
destroy() - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter.Heaplet
 
destroy() - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
 
destroy() - Method in class org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet
 
destroy() - Method in class org.forgerock.openig.tools.notifications.ws.JsonValueDecoder
 
destroy() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionRequestEncoder
 
destroy() - Method in class org.forgerock.openig.websocket.grizzly.HttpUpgradeHandlerDelegate
 
destroy() - Method in class org.forgerock.secrets.GenericSecret
 
DETAIL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The detail event payload field name.
determineRequestType(Request) - Static method in class org.forgerock.json.resource.http.HttpUtils
Determines which CREST operation (CRUDPAQ) of the incoming request.
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.
diff(EntryReader, EntryReader) - Static method in class org.forgerock.opendj.ldif.Ldif
Compares the content of source to the content of target and returns the differences in a change record reader.
diff(EntryReader, EntryReader, Options) - Static method in class org.forgerock.opendj.ldif.Ldif
Compares the content of source to the content of target and returns the differences in a change record reader.
DIFF_STRATEGY - Static variable in class org.forgerock.opendj.ldap.Entries
Defines the strategy to use to compute changes.
diffEntries(Entry, Entry) - Static method in class org.forgerock.opendj.ldap.Entries
Creates a new modify request containing a list of modifications which can be used to transform fromEntry into entry toEntry.
diffEntries(Entry, Entry, Options) - Static method in class org.forgerock.opendj.ldap.Entries
Creates a new modify request containing a list of modifications which can be used to transform fromEntry into entry toEntry.
DirectEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Supports direct encryption using a shared symmetric key.
DirectEncryptionHandler(EncryptionMethod) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler
Constructs the direct encryption handler for the given content encryption method.
Directive - Class in org.forgerock.http.header
Represents the name/value pair of a HTTP header directives.
directive(String, String) - Static method in class org.forgerock.http.header.Directive
Return a Directive based on the name and value, if value was quoted then this is also captured.
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
disconnect() - Method in interface org.forgerock.opendj.ldap.LdapSession
Disconnects the client without sending a disconnect notification.
disconnect(ResultCode, CharSequence) - Method in interface org.forgerock.opendj.ldap.LdapSession
Disconnects the client and sends a disconnect notification, containing the provided result code and diagnostic message.
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.
DistributionSummary - Interface in org.forgerock.monitoring.api.instrument
Track the sample distribution of events.
DistributionSummary.Builder - Class in org.forgerock.monitoring.api.instrument
Fluent builder for distribution summaries.
distrustAll() - Static method in class org.forgerock.opendj.security.TrustManagers
Returns an X509TrustManager which does not trust any certificates.
DitContentRule - Class in org.forgerock.opendj.ldap.schema
This class defines a DIT content rule, which defines the set of allowed, required, and prohibited attributes for entries with a given structural objectclass, and also indicates which auxiliary classes may be included in the entry.
DitContentRule.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing DIT content rule.
DitStructureRule - Class in org.forgerock.opendj.ldap.schema
This class defines a DIT structure rule, which is used to indicate the types of children that entries may have.
DitStructureRule.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing DIT structure rules.
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 - Class in org.forgerock.opendj.ldap
A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.
dn(String, Object...) - Method in class org.forgerock.openig.ldap.LdapClient
Formats an LDAP distinguished name using the provided template and attribute values.
dnOfRequest(Request) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Returns the DN of the entry targeted by the provided request, or null if the target entry cannot be determined.
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.
domain(String) - Method in class org.forgerock.openig.http.CookieBuilder
Set the domain and return a new instance of this builder.
done() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder
Marks the end to the building of the JWT header.
doRedirect(Context, Request, Handler, List<AbstractConditionAdviceFilter.Advice>) - Method in class org.forgerock.openig.openam.AbstractConditionAdviceFilter
Handle redirect to the instance to verify the required advices.
doRedirect(Context, Request, Handler, List<AbstractConditionAdviceFilter.Advice>) - Method in class org.forgerock.openig.openam.CdSsoConditionAdviceFilter
 
dot - Static variable in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
This maps to identity because we suggest using dot notation everywhere in Micrometer-instrumented code
dotNotationToJsonPointer(String) - Static method in class org.forgerock.audit.events.AuditEventHelper
Converts dotted-path field identifier to JsonPointer form.
doubleGauge(String, DoubleSupplier) - Static method in interface org.forgerock.monitoring.api.instrument.Gauge
Setup a Gauge.Builder that will create a gauge that reports the size of the Map.
DropwizardMeterRegistry - Class in org.forgerock.monitoring.dropwizard
Implementation of a MeterRegistry supporting tags using dropwizard metric types.
DropwizardMeterRegistry(Clock) - Constructor for class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
Constructor for this class.
DropwizardMeterRegistry(Clock, Supplier<Reservoir>) - Constructor for class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
Constructor for this class.
DropwizardMetricsCollectionResourceProvider - Class in org.forgerock.monitoring
A CREST CollectionResourceProvider that adds queryFilter, field filtering, sorting abilities, and paging to the dropwizard json metrics data.
DropwizardMetricsCollectionResourceProvider(MeterRegistry) - Constructor for class org.forgerock.monitoring.DropwizardMetricsCollectionResourceProvider
Constructs the resource provider for the passed in Dropwizard metric set.
DropwizardMetricsCollectionResourceProvider(Supplier<MeterRegistry>) - Constructor for class org.forgerock.monitoring.DropwizardMetricsCollectionResourceProvider
Constructs the resource provider for the passed in Dropwizard metric set supplier.
DropwizardTypes - Class in org.forgerock.monitoring.dropwizard
While Dropwizard is well suited for representing hierarchical metrics, it has no support for dimensional metrics.
DropwizardTypes.DescribableCounter - Class in org.forgerock.monitoring.dropwizard
A describable counter, implementing both the dropwizard's and the monitoring-api's relevant APIs.
DropwizardTypes.DescribableGauge<T> - Class in org.forgerock.monitoring.dropwizard
A describable gauge, implementing both the dropwizard's and the monitoring-api's relevant APIs.
DropwizardTypes.DescribableMeter - Class in org.forgerock.monitoring.dropwizard
A describable meter, implementing both the dropwizard's meter and the monitoring-api's relevant APIs.
DropwizardTypes.DescribableMetric - Interface in org.forgerock.monitoring.dropwizard
A describable dropwizard metric.
DropwizardTypes.DescribableTimer - Class in org.forgerock.monitoring.dropwizard
A describable timer, implementing both the dropwizard's and the monitoring-api's relevant APIs.
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_ACCESS_DENIED - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating access denied.
E_INSUFFICIENT_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The request requires higher privileges than provided by the access token.
E_INVALID_CLIENT - Static variable in class org.forgerock.http.oauth2.OAuth2Error
Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).
E_INVALID_GRANT - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
E_INVALID_REQUEST - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed.
E_INVALID_REQUEST - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating invalid request.
E_INVALID_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
E_INVALID_TOKEN - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The access token provided is expired, revoked, malformed, or invalid for other reasons.
E_INVALID_TOKEN - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating invalid token.
E_SERVER_ERROR - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization server encountered an unexpected condition that prevented it from fulfilling the request.
E_SERVER_ERROR - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
CDSSO error indicating server error.
E_TEMPORARILY_UNAVAILABLE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
E_UNAUTHORIZED_CLIENT - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authenticated client is not authorized to use this authorization grant type.
E_UNSUPPORTED_GRANT_TYPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization grant type is not supported by the authorization server.
E_UNSUPPORTED_RESPONSE_TYPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The authorization server does not support obtaining an authorization code using this method.
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(PrivateKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler
Constructs the ECDSA signing handler for signing only.
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.
EdDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers
Signing handler for Edwards Curve DSA (EdDSA) as defined in RFC 8037.
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.
ELEMENT_READ_STATE_NEED_ADDITIONAL_LENGTH_BYTES - Static variable in class org.forgerock.opendj.io.Asn1
The ASN.1 element decoding state that indicates that the next byte read should be additional bytes of a multi-byte length.
ELEMENT_READ_STATE_NEED_FIRST_LENGTH_BYTE - Static variable in class org.forgerock.opendj.io.Asn1
The ASN.1 element decoding state that indicates that the next byte read should be the first byte for the element length.
ELEMENT_READ_STATE_NEED_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The ASN.1 element decoding state that indicates that the next byte read should be the BER type for a new element.
ELEMENT_READ_STATE_NEED_VALUE_BYTES - Static variable in class org.forgerock.opendj.io.Asn1
The ASN.1 element decoding state that indicates that the next byte read should be applied to the value of the element.
elementAvailable() - Method in interface org.forgerock.opendj.io.Asn1Reader
Indicates whether the next element can be read without blocking.
EllipticCurveJwk - Interface in org.forgerock.json.jose.jwk
Encapsulates common functionality for JWKs that represent elliptic curve keys: EcJWK and OkpJWK.
empty() - Static method in class org.forgerock.json.resource.ResourcePath
Returns the empty resource path whose string representation is the empty string and which has zero path elements.
empty() - Static method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
empty() - Static method in class org.forgerock.monitoring.api.instrument.Tags
Return a Tags instance that contains no elements.
empty() - Static method in class org.forgerock.opendj.ldap.ByteString
Returns an empty byte string.
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.
emptyAttribute(AttributeDescription) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a read-only empty attribute having the specified attribute description.
emptyAttribute(String) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a read-only empty attribute having the specified attribute description.
emptyDn() - Static method in class org.forgerock.opendj.ldap.Dn
Returns the empty DN.
enabledCipherSuites() - Method in class org.forgerock.opendj.security.SslOptions
Returns the names of the cipher suites which are currently enabled for secure connections with the Directory Server.
enabledCipherSuites(Collection<String>) - Method in class org.forgerock.opendj.security.SslOptions
Adds the cipher suites enabled for secure connections with the Directory Server.
enabledCipherSuites(String...) - Method in class org.forgerock.opendj.security.SslOptions
Adds the cipher suites enabled for secure connections with the Directory Server.
enabledProtocols() - Method in class org.forgerock.opendj.security.SslOptions
Returns the names of the protocol versions which are currently enabled for secure connections with the Directory Server.
enabledProtocols(Collection<String>) - Method in class org.forgerock.opendj.security.SslOptions
Adds the protocol versions enabled for secure connections with the Directory Server.
enabledProtocols(String...) - Method in class org.forgerock.opendj.security.SslOptions
Adds the protocol versions enabled for secure connections with the Directory Server.
enableNotifications(boolean) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Enable or disable the notifications.
enableVirtualAttributes(boolean) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Indicates whether search responses should include the hasSubordinates and numSubordinates virtual attributes if requested.
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.opendj.ldap.Base64
Encodes the provided data as a base64 string.
encode(ByteSequence) - Static method in class org.forgerock.opendj.ldap.Base64
Encodes the provided data as a base64 string.
encode(SubscriptionRequest) - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionRequestEncoder
 
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.
encodeJwtComponent(String) - Static method in class org.forgerock.json.jose.utils.Utils
Encodes the given String, converting the String to UTF-8 bytes.
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 Identity Gateway REST API endpoints.
EndpointRegistry(Router, String) - Constructor for class org.forgerock.openig.http.EndpointRegistry
Creates a registry around the given Router instance.
EndpointRegistry.Registration - Class in org.forgerock.openig.http
Handle for un-registering an endpoint.
ensureAdditionalCapacity(int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Ensures that the specified number of additional bytes will fit in this byte string builder and resizes it if necessary.
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.
Entries - Class in org.forgerock.opendj.ldap
This class contains methods for creating and manipulating entries.
Entries.DiffStrategy - Enum in org.forgerock.opendj.ldap
Defines the available strategy to compute changes.
Entries.NullEntry - Class in org.forgerock.opendj.ldap
An Entry which implements the null object pattern.
Entries.ReplaceStrategy - Enum in org.forgerock.opendj.ldap
Defines the available strategy to generate changes.
Entry - Interface in org.forgerock.opendj.ldap
An entry, comprising of a distinguished name and zero or more attributes.
ENTRY_ALREADY_EXISTS - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it would have resulted in an entry that conflicts with an entry that already exists.
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.
EntryChangeNotificationResponseControl - Class in org.forgerock.opendj.ldap.controls
The entry change notification response control as defined in draft-ietf-ldapext-psearch.
EntryGenerator - Class in org.forgerock.opendj.ldif
A template driven entry generator, as used by the makeldif tool.
EntryGenerator() - Constructor for class org.forgerock.opendj.ldif.EntryGenerator
Creates a generator using default values.
EntryGenerator(String) - Constructor for class org.forgerock.opendj.ldif.EntryGenerator
Creates a generator from the provided template path.
EntryGenerator(String...) - Constructor for class org.forgerock.opendj.ldif.EntryGenerator
Creates a generator from the provided template lines.
EntryGenerator(List<String>) - Constructor for class org.forgerock.opendj.ldif.EntryGenerator
Creates a generator from the provided template lines.
EntryGenerator(InputStream) - Constructor for class org.forgerock.opendj.ldif.EntryGenerator
Creates a generator from the provided input stream.
EntryNotFoundException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request failed because the target entry was not found by the Directory Server.
EntryReader - Interface in org.forgerock.opendj.ldif
An interface for reading entries from a data source, typically an LDIF file.
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.
EntryWriter - Interface in org.forgerock.opendj.ldif
An interface for writing entries to a data source, typically an LDIF file.
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.
EnumUtil - Class in org.forgerock.openig.util
Utility class for accessing Java enum types.
EnumValueOfHelper<E extends Enum<E>> - Class in org.forgerock.util
Provides a EnumValueOfHelper.valueOf(String) method as a replacement for the implicitly declared enum function valueOf(String), which has the advantage of not throwing exceptions when the name argument is null or cannot be found in the enum's values.
EnumValueOfHelper(E[]) - Constructor for class org.forgerock.util.EnumValueOfHelper
Constructor with null default value.
EnumValueOfHelper(E[], E) - Constructor for class org.forgerock.util.EnumValueOfHelper
Constructor with an explicit default value.
Environment - Interface in org.forgerock.openig.config
Encapsulate logic to access configuration files and other directories of the IG base directory.
ENVIRONMENT_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve an Environment instance from the Heap.
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, PropertyResolver) - Constructor for class org.forgerock.openig.heap.EnvironmentHeap
Builds a new EnvironmentHeap with the given name and environment.
environmentVariablePropertyResolver() - Static method in class org.forgerock.config.resolvers.PropertyResolvers
EnvironmentVariableResolver - Class in org.forgerock.config.resolvers
A property accessor that allows access to environment variables.
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.
equality(String, Object) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new equality match filter using the provided attribute description and assertion value.
equalityMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the matching rule that should be used for equality matching with this attribute type.
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.Directive
 
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.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.monitoring.api.instrument.ImmutableTag
 
equals(Object) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
equals(Object) - Method in class org.forgerock.monitoring.api.instrument.Tags
 
equals(Object) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
equals(Object) - Method in class org.forgerock.opendj.ldap.AbstractEntry
 
equals(Object) - Method in interface org.forgerock.opendj.ldap.Attribute
Returns true if object is an attribute which is equal to this attribute.
equals(Object) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether the provided object is an attribute description which is equal to this attribute description.
equals(Object) - Method in class org.forgerock.opendj.ldap.Ava
 
equals(byte[], int, int) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Indicates whether the provided byte array sub-sequence is equal to this byte sequence.
equals(Object) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Indicates whether the provided object is equal to this byte sequence.
equals(byte[], int, int) - Method in class org.forgerock.opendj.ldap.ByteString
 
equals(Object) - Method in class org.forgerock.opendj.ldap.ByteString
Indicates whether the provided object is equal to this byte string.
equals(byte[], int, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
equals(Object) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Indicates whether the provided object is equal to this byte string builder.
equals(Object) - Method in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
 
equals(Object) - Method in class org.forgerock.opendj.ldap.Dn
 
equals(Object) - Method in interface org.forgerock.opendj.ldap.Entry
Returns true if object is an entry which is equal to this entry.
equals(Object) - Method in class org.forgerock.opendj.ldap.Filter
This method does not perform any normalization, other than lowercasing attribute descriptions, and will only return true when two filters are identical.
equals(Object) - Method in class org.forgerock.opendj.ldap.GeneralizedTime
 
equals(Object) - Method in class org.forgerock.opendj.ldap.LdapUrl
 
equals(Object) - Method in class org.forgerock.opendj.ldap.Matcher
This method returns true when two filters are equivalent.
equals(Object) - Method in class org.forgerock.opendj.ldap.Modification
 
equals(Object) - Method in class org.forgerock.opendj.ldap.ModificationType
 
equals(Object) - Method in class org.forgerock.opendj.ldap.Rdn
 
equals(Object) - Method in class org.forgerock.opendj.ldap.ResultCode
 
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns true if the provided object is an attribute type having the same numeric OID as this attribute type.
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns true if the provided object is a DIT content rule having the same structural object class OID as this DIT content rule.
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Returns true if the provided object is a DIT structure rule having the same rule ID as this DIT structure rule.
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns true if the provided object is a matching rule having the same numeric OID as this matching rule.
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Returns true if the provided object is a matching rule use having the same numeric OID as this matching rule use.
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns true if the provided object is a name form having the same numeric OID as this name form.
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns true if the provided object is an object class having the same numeric OID as this object class.
equals(Object) - Method in class org.forgerock.opendj.ldap.schema.Syntax
Returns true if the provided object is an attribute syntax having the same numeric OID as this attribute syntax.
equals(Object) - Method in class org.forgerock.opendj.ldap.SearchScope
 
equals(Object) - Method in class org.forgerock.opendj.ldap.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.text.Separator
Indicates whether some other object is equal to this one.
equals(Object) - Method in class org.forgerock.openig.tools.am.Version
 
equals(Object) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpec
 
equals(Object) - Method in class org.forgerock.secrets.Purpose
 
equals(Object) - Method in class org.forgerock.secrets.Secret
 
equals(Object) - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
 
equals(Object) - Method in class org.forgerock.services.routing.RouteMatcher
 
equals(Object) - Method in class org.forgerock.util.i18n.LocalizableString
The default equals operation.
equals(Object) - Method in class org.forgerock.util.LazyList
Compares the specified object with this list for equality.
equals(Object) - Method in class org.forgerock.util.LazyMap
Compares the specified object with the map for equality.
equals(Object) - Method in class org.forgerock.util.ListDecorator
Compares the specified object with this list for equality.
equals(Object) - Method in class org.forgerock.util.MapDecorator
Compares the specified object with the map for equality.
equals(Object) - Method in class org.forgerock.util.Pair
equals(Object) - Method in class org.forgerock.util.query.QueryFilter
 
EQUALS - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "equals" operator.
equals(Object) - Method in class org.forgerock.util.time.Duration
 
equalTo(Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies strict equality.
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(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(LocalizableMessage) - Static method in exception org.forgerock.opendj.ldap.DecodeException
Creates a new non-fatal decode exception with the provided message.
error(LocalizableMessage, Throwable) - Static method in exception org.forgerock.opendj.ldap.DecodeException
Creates a new non-fatal decode exception with the provided message and root cause.
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
 
escapeAssertionValue(Object) - Static method in class org.forgerock.opendj.ldap.Filter
Returns the LDAP string representation of the provided filter assertion value in a form suitable for substitution directly into a filter string.
escapeAttributeValue(Object) - Static method in class org.forgerock.opendj.ldap.Dn
Returns the LDAP string representation of the provided DN attribute value in a form suitable for substitution directly into a DN string.
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(JsonValue, boolean) - Method in class org.forgerock.config.util.JsonValuePropertyEvaluator
Traverses a JsonValue and does property substitution as well as any type coercion.
evaluate(JsonValue, SubstitutionContext) - Method in class org.forgerock.config.util.JsonValuePropertyEvaluator
Traverses a JsonValue and does property substitution as well as any type coercion.
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, 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.
evaluateSaslChallenge(byte[]) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Evaluates the provided SASL credentials (challenge) returned by the server and creates the next SASL bind request that should be sent to the server in order to continue or complete the SASL authentication sequence.
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.
ExceptionHandler<E> - Interface in org.forgerock.util.promise
A completion handler for consuming exceptions which occur during the execution of asynchronous tasks.
excludeMethods(String...) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes a HTTP method from the CSRF filter.
excludePaths(String...) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes a path from the CSRF filter.
excludePaths(Collection<String>) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes the paths from the CSRF filter.
excludePathsStarting(String...) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes paths starting with the given prefixes from the CSRF filter.
excludePathsStarting(Collection<String>) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes paths starting with the given prefixes from the CSRF filter.
excludeRequests(Predicate<Request>) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes requests that match the given predicate from the CSRF filter.
excludeRequests(Predicate<Request>, String) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes requests that match the given predicate from the CSRF filter.
excludeSafeMethods() - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Excludes HTTP safe methods that are usually not susceptible to CSRF attacks: GET, HEAD, and OPTIONS.
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(Object, CsvContext) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler.ParseJsonValue
 
execute(Runnable) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
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.
expectedType(Class<T>, Function<JsonValue, T, E>) - Static method in class org.forgerock.openig.util.JsonValues
Allows to use defaultTo in an heaplet configuration to retrieve an object.
ExpiredTokenException - Exception in org.forgerock.tokenhandler
An exception generated by a TokenHandler on extraction when the token is expired.
ExpiredTokenException(String) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
Constructs a new exception with the specified detail message.
ExpiredTokenException(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.
expiresAt(Instant) - Method in class org.forgerock.secrets.SecretBuilder
Sets the secret to expire at the given time.
expiresIn(long, TemporalUnit, Clock) - Method in class org.forgerock.secrets.SecretBuilder
Sets the secret to expire in deadline units from now.
export(KeyFormat<T>) - Method in class org.forgerock.secrets.keys.CryptoKey
Exports the key material in the given format.
export(CryptoKey, Key) - Method in interface org.forgerock.secrets.keys.KeyFormat
Exports the given crypto key and raw key material.
export(CryptoKey, Key) - Method in class org.forgerock.secrets.keys.KeyFormatPem
 
export(CryptoKey, Key) - Method in enum org.forgerock.secrets.keys.KeyFormatRaw
 
exportAsKey(CryptoKey) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Exports the key material in the raw format.
exportAsKeyAndClose(CryptoKey) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Exports the key material in the raw format and close the provided key material.
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.
ExpressionPropertyResolver - Class in org.forgerock.openig.heap
Resolves Bindings-based tokens using COMMONS Config PropertyResolver.
ExpressionRequestAsyncFunction<V> - Class in org.forgerock.openig.el
This is an implementation of the AsyncFunction based on the evaluation of an Expression.
ExpressionRequestAsyncFunction(Expression<V>) - Constructor for class org.forgerock.openig.el.ExpressionRequestAsyncFunction
Constructs an AsyncFunction that evaluates the provided Expression.
Expressions - Class in org.forgerock.openig.el
Utility class for evaluating expression in some collections.
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.
extendedRequest(ExtendedRequest<R>, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractAsynchronousConnection
 
extendedRequest(ExtendedRequest<R>) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
extendedRequest(String, ByteString) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
extendedRequest(ExtendedRequest<R>) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Requests that the Directory Server performs the provided extended request.
extendedRequest(ExtendedRequest<R>, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Requests that the Directory Server performs the provided extended request, optionally listening for any intermediate responses.
extendedRequest(String, ByteString) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Requests that the Directory Server performs the provided extended request.
extendedRequest(ExtendedRequest<R>) - Method in interface org.forgerock.opendj.ldap.Connection
Requests that the Directory Server performs the provided extended request.
extendedRequest(ExtendedRequest<R>, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Requests that the Directory Server performs the provided extended request, optionally listening for any intermediate responses.
extendedRequest(String, ByteString) - Method in interface org.forgerock.opendj.ldap.Connection
Requests that the Directory Server performs the provided extended request.
extendedRequest(ExtendedRequest<R>) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Requests that the Directory Server performs the provided extended request.
ExtendedRequest<S extends ExtendedResult> - Interface in org.forgerock.opendj.ldap.messages
The Extended operation allows additional operations to be defined for services not already available in the protocol; for example, to implement an operation which installs transport layer security (see StartTlsExtendedRequest).
extendedRequestAsync(ExtendedRequest<R>) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
extendedRequestAsync(ExtendedRequest<R>) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously performs the provided extended request in the Directory Server.
extendedRequestAsync(ExtendedRequest<R>, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously performs the provided extended request in the Directory Server.
extendedRequestAsync(ExtendedRequest<R>, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
extendedRequestAsync(ExtendedRequest<R>) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously performs the provided extended request in the Directory Server.
extendedRequestAsync(ExtendedRequest<R>, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously performs the provided extended request in the Directory Server.
ExtendedRequestDecoder<R extends ExtendedRequest<S>,S extends ExtendedResult> - Interface in org.forgerock.opendj.ldap.messages
A factory interface for decoding a generic extended request as an extended request of specific type.
ExtendedResult - Interface in org.forgerock.opendj.ldap.messages
A Extended result indicates the status of an Extended operation and any additional information associated with the Extended operation, including the optional response name and value.
ExtendedResultDecoder<S extends ExtendedResult> - Interface in org.forgerock.opendj.ldap.messages
A factory interface for decoding a generic extended result as an extended result of specific type.
EXTENDS - Static variable in class org.forgerock.json.schema.validator.Constants
Deprecated.
removed in JSON schema draft 04
extensible(String, String, Object, boolean) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new extensible match filter.
EXTERNAL_KEY_WRAPPING_STRATEGY - Static variable in class org.forgerock.opendj.security.KeyStoreParameters
An alternative external mechanism for wrapping private and secret keys in the key store.
ExternalKeyWrappingStrategy - Interface in org.forgerock.opendj.security
A service provider interface for externalizing the strategy used for wrapping individual private/secret keys.
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.
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
 
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
 
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
 
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
 
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
 
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
 
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
 
extraProperties(Map<String, List<String>>) - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
 
extraProperties(String, String...) - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
 

F

F_ERROR - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the error code.
F_ERROR - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
Error field name.
F_ERROR_DESCRIPTION - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the error description.
F_ERROR_DESCRIPTION - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
Error description field name.
F_ERROR_URI - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the error uri.
F_REALM - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the realm.
F_SCOPE - Static variable in class org.forgerock.http.oauth2.OAuth2Error
The name of the field which communicates the scope.
Facility - Enum in org.forgerock.audit.handlers.syslog
Defines the standard Syslog message facilities.
FACTORIES - Static variable in class org.forgerock.http.header.HeaderFactory
A map of header names to known HeaderFactory implementations.
Factory() - Constructor for class org.forgerock.http.header.AuthorizationHeader.Factory
 
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.
FAIL_FAST - Static variable in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
A handler which terminates processing by throwing a DecodeException as soon as a change is rejected.
FAIL_FAST - Static variable in interface org.forgerock.opendj.ldif.RejectedLdifListener
The default handler which ignores skipped records but which terminates processing by throwing a DecodeException as soon as a record is found to be malformed or rejected due to a schema validation failure.
failedSubscription(String, String) - Static method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Builds a failure acknowledgement.
FailedToLoadJWKException - Exception in org.forgerock.json.jose.exceptions
Unable to load the JWK/x5u location points.
FailedToLoadJWKException() - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception.
FailedToLoadJWKException(String) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception with the given message.
FailedToLoadJWKException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception with the given message and cause.
FailedToLoadJWKException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException
Construct the exception with the given cause.
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
 
failure(String) - Static method in class org.forgerock.openig.filter.oauth2.Result
Returns a Result representing validation failure.
failure(Violation) - Static method in class org.forgerock.openig.tools.jwt.Result
Returns a Result representing validation failure.
failureHandler(Handler) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Add a handler which will be responsible of creating a response in case of missing/wrong CSRF token.
FALSE - Static variable in class org.forgerock.util.query.QueryFilterOperators
a literal "false.
fatalError(Throwable) - Static method in exception org.forgerock.opendj.io.LdapSocketClosedException
Returns a LdapSocketClosedException specifying that the socket has been closed locally as a result of a fatal error.
fatalError(LocalizableMessage) - Static method in exception org.forgerock.opendj.ldap.DecodeException
Creates a new fatal decode exception with the provided message.
fatalError(LocalizableMessage, Throwable) - Static method in exception org.forgerock.opendj.ldap.DecodeException
Creates a new fatal decode exception with the provided message and root cause.
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.
FIELD_VALUE_ALL - Static variable in interface org.forgerock.json.resource.Request
The value of the fields request parameter to request all fields.
FIELD_VALUE_ALL_PTR - Static variable in class org.forgerock.json.resource.Resources
JsonPointer used in fields to denote "all fields", i.e., no filtering.
fieldIfNotNull(String, Object) - Static method in class org.forgerock.json.JsonValue
Returns a JSON field for inclusion in a JSON object using object only if its value is not null.
file() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a File object.
FileAttributesFilter - Class in org.forgerock.openig.filter
Retrieves and exposes a record from a delimiter-separated file.
FileAttributesFilter(SeparatedValuesFile, String, Expression<String>, LeftValueExpression<Map>) - Constructor for class org.forgerock.openig.filter.FileAttributesFilter
Builds a new FileAttributesFilter extracting values from the given separated values file.
FileAttributesFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a separated values file attribute provider in a heap environment.
FileBasedEventHandlerConfiguration - Class in org.forgerock.audit.events.handlers
Configures time based or size based log file rotation.
FileBasedEventHandlerConfiguration() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
 
FileBasedEventHandlerConfiguration.FileRetention - Class in org.forgerock.audit.events.handlers
Groups the file retention config parameters.
FileBasedEventHandlerConfiguration.FileRotation - Class in org.forgerock.audit.events.handlers
Groups the file rotation config parameters.
FileBranchingStream - Class in org.forgerock.http.io
A BranchingInputStream for reading from files.
FileBranchingStream(File) - Constructor for class org.forgerock.http.io.FileBranchingStream
Creates a new stream for the specified file.
FileNamingPolicy - Interface in org.forgerock.audit.retention
An interface to declare the names of audit log files.
FileResourceSet - Class in org.forgerock.openig.handler.resources
A FileResourceSet is able to give access to file-based content within the scope of the root directory.
FileResourceSet(File) - Constructor for class org.forgerock.openig.handler.resources.FileResourceSet
Constructs a file-based ResourceSet, using the given root as root directory.
FileRetention() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention
 
FileRotation() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
 
FileSystemSecretStoreHeaplet - Class in org.forgerock.openig.secrets
This heaplet represents an instance of a PropertyResolverSecretStore resolving properties from files in a directory.
FileSystemSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.FileSystemSecretStoreHeaplet
 
fileToUrl(File) - Static method in class org.forgerock.openig.el.Functions
Returns the String representation of the URL denoting the given file.
filter(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 class org.forgerock.http.filter.CsrfFilter
 
filter(Context, Request, Handler) - Method in interface org.forgerock.http.Filter
Filters the request and/or response of an exchange.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.OptionsFilter
Handles all OPTION requests to CREST resources, all other request methods are handled by the Handler.
filter(Context, Request, Handler) - Method in class org.forgerock.http.filter.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 - Class in org.forgerock.opendj.ldap
A search filter as defined in RFC 4511.
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.JwtBuilderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.LocationHeaderFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.LogAttachedExceptionFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.MdcRouteIdFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.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.RetryFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.RuntimeExceptionFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.ScriptableFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.filter.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.AbstractConditionAdviceFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.CapturedUserPasswordFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.DeprecatedUserProfileFilter
Deprecated.
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.PolicyEnforcementFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.SessionInfoFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.SingleSignOnFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.TokenTransformationFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.openam.UserProfileFilter
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.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
 
filter(Context, Request, Handler) - Method in class org.forgerock.openig.websocket.WebSocketProxyFilter
 
Filter.FilterType - Enum in org.forgerock.opendj.ldap
This enumeration defines the set of possible filter types that may be used for search filters.
filterAction(Context, ActionRequest, RequestHandler) - Method in interface org.forgerock.json.resource.Filter
Filters an action request.
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.json.resource.ResourceApiVersionRoutingFilter
 
filterAction(Context, ActionRequest, RequestHandler) - Method in class org.forgerock.openig.tools.NotSupportedFilter
 
filterAttributes(Predicate<Attribute>) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Registers a predicate which should be applied to attributes selected by this attribute filter.
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.
filteredCopyOf(Entry) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Returns a modifiable filtered copy of the provided entry.
filteredViewOf(Entry) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Returns an unmodifiable filtered view of the provided entry.
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 interface org.forgerock.monitoring.api.instrument.MeterRegistry
Initiate a search beginning with a metric name.
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(Throwable, Class<T>) - Static method in class org.forgerock.openig.tools.notifications.ws.Throwables
Return the top-most Throwable in the exception's chain that matches the given type.
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}.
FINDING_BASE - Static variable in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
Dereference aliases in locating the base object of a Search operation, but not when searching subordinates of the base object.
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.
findOrCreateSession() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext
Returns the managed session, or create a new one if none are managed at the time of this call.
findScriptFactory(String) - Method in class org.forgerock.openig.script.DefaultScriptFactoryManager
 
findScriptFactory(String) - Method in interface org.forgerock.openig.script.ScriptFactoryManager
Finds a factory for the given MIME type.
findSession() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext
Returns the managed session, or an empty Optional if none are managed at the time of this call.
findShare(Request) - Method in class org.forgerock.openig.uma.UmaSharingService
Find a Share.
firstOf(JsonValue, String...) - Static method in class org.forgerock.openig.util.JsonValues
Returns, if the given JSON value contains one of the names, the first defined JSON value, otherwise if the given JSON value does not match any of the names, then a JsonValue encapsulating null is returned.
firstSocketAddress() - Method in class org.forgerock.opendj.ldap.LdapServer
Returns the first address that his LDAP listener is listening on.
firstValue() - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
firstValue() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns the first attribute value in this attribute.
firstValue() - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
firstValueAsString() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns the first attribute value in this attribute decoded as a UTF-8 string.
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.
FlatFileResolver - Class in org.forgerock.config.resolvers
A PropertyResolver in which each property is stored in its own file in some directory.
FlatFileResolver(Path, String) - Constructor for class org.forgerock.config.resolvers.FlatFileResolver
Initializes the resolver with the given root directory.
FlatFileResolver(Path) - Constructor for class org.forgerock.config.resolvers.FlatFileResolver
Initializes the resolver with the given root directory and an empty suffix.
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() - Method in interface org.forgerock.opendj.io.Asn1Writer
Flushes this ASN.1 writer so that any buffered elements are written immediately to their intended destination.
flush() - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Flushes this change record writer so that any buffered data is written immediately to underlying stream, flushing the stream if it is also Flushable.
flush() - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Connection change record writers do not require flushing, so this method has no effect.
flush() - Method in class org.forgerock.opendj.ldif.ConnectionEntryWriter
Connection entry writers do not require flushing, so this method has no effect.
flush() - Method in interface org.forgerock.opendj.ldif.EntryWriter
Flushes this entry writer so that any buffered data is written immediately to underlying stream, flushing the stream if it is also Flushable.
flush() - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
flush() - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
 
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.
ForbiddenException - Exception in org.forgerock.json.resource
An exception that is thrown when access to a resource is forbidden during an operation on an resource.
ForbiddenException() - Constructor for exception org.forgerock.json.resource.ForbiddenException
Constructs a new exception with null as its detail message.
ForbiddenException(String) - Constructor for exception org.forgerock.json.resource.ForbiddenException
Constructs a new exception with the specified detail message.
ForbiddenException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ForbiddenException
Constructs a new exception with the specified detail message and cause.
ForbiddenException(Throwable) - Constructor for exception org.forgerock.json.resource.ForbiddenException
Constructs a new exception with the specified cause.
forbiddenHandler() - Static method in class org.forgerock.http.handler.Handlers
A common HTTP Framework Handler responding 403 Forbidden.
forceRotation() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
Forces a rotation of the writer.
forContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets common fields from services contexts.
forEachMeter(Consumer<? super Meter>) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
Iterate over each meter in the registry.
FORGEROCK_CLIENT_HANDLER - Static variable in class org.forgerock.openig.http.DefaultDeclarations
The client handler that deals with ForgeRock platform services (AM interactions mostly).
FORGEROCK_CLIENT_HANDLER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve ForgeRock ClientHandler instance from the Heap, which chains a TransactionIdOutboundFilter to a ClientHandler.
forHttpRequest(Context, Request) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets common fields from CREST contexts and request.
forKey(Key, KeyUse) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the standard curve that matches the given (private or public) key.
forKey(Key) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the standard curve that matches the given (private or public) key.
forKeyType(Class<? extends CryptoKey>) - Static method in enum org.forgerock.secrets.keys.KeyUsage
Returns the set of all key usages that are applicable to the given key type.
Form - Class in org.forgerock.http.protocol
Form fields, a case-sensitive multi-string-valued map.
Form() - Constructor for class org.forgerock.http.protocol.Form
Constructs a new, empty form object.
format(String, Object...) - Static method in class org.forgerock.json.resource.ResourcePath
Creates a new resource path using the provided path template and unencoded path elements.
FORMAT - Static variable in class org.forgerock.json.schema.validator.Constants
The format field name.
format(String, Object...) - Static method in class org.forgerock.opendj.ldap.Dn
Creates a new DN using the provided DN template and unescaped attribute values using the default schema.
format(String, Schema, Object...) - Static method in class org.forgerock.opendj.ldap.Dn
Creates a new DN using the provided DN template and unescaped attribute values using the provided schema.
format(String, Object...) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new filter using the provided filter template and unescaped assertion values.
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.
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[], JwsAlgorithmType) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the supported curve parameters for the given signature.
forSignature(byte[]) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the supported curve parameters for the given ECDSA signature.
forSigning(byte[]) - Static method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler
Initialises a signing handler for signing.
forVerification(byte[]) - Static method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler
Initialises a signing handler for verification.
forWebCryptoName(String) - Static method in enum org.forgerock.secrets.keys.KeyUsage
Converts a Web Crypto/JWK key operation name into the equivalent key usage constant.
FOUND - Static variable in class org.forgerock.http.protocol.Status
The 302 (Found) status code indicates that the target resource resides temporarily under a different URI.
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.
fromCertificate(Certificate) - Static method in enum org.forgerock.secrets.keys.KeyUsage
Determines what usages are allowed for a public key based on the associated certificate.
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.
fromSessionInfo(Context, SessionInfo, String) - Static method in class org.forgerock.openig.openam.SsoTokenContext
Create a SsoTokenContext from a SessionInfo and SSO token.
fromString(String) - Method in class org.forgerock.http.protocol.Form
Deprecated.
fromX509KeyUsageBits(boolean[]) - Static method in enum org.forgerock.secrets.keys.KeyUsage
Converts an X.509 KeyUsage bit vector into a corresponding set of usage values.
Function<VIN,VOUT,E extends Exception> - Interface in org.forgerock.util
A synchronous function which returns a result immediately.
Functions - Class in org.forgerock.opendj.ldap
Common Function implementations which may be used when parsing attributes.
Functions - Class in org.forgerock.openig.el
Methods exposed for EL usage.
futureToPromise(CompletionStage<T>, Class<E>) - Static method in class org.forgerock.openig.tools.FutureUtils
Converts a CompletionStage to a Promise.
FutureUtils - Class in org.forgerock.openig.tools
Utility class for Futures and Promises.

G

GATEWAY_TIMEOUT - Static variable in class org.forgerock.http.protocol.Status
The 504 (Gateway Timeout) status code indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.
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 Identity Gateway.
GatewayHttpApplication(Environment, JsonValue, EndpointRegistry, RunMode, MeterRegistry, PropertyResolver) - Constructor for class org.forgerock.openig.http.GatewayHttpApplication
Gauge - Interface in org.forgerock.monitoring.api.instrument
 
gauge(Meter.Id, T, ToDoubleFunction<T>) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
gauge(Meter.Id, T, ToDoubleFunction<T>) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
gauge() - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
gauge() - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
gauge(Meter.Id, T, ToDoubleFunction<T>) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
Gauge.Builder<T> - Class in org.forgerock.monitoring.api.instrument
Fluent builder for gauges.
gaugeCollectionSize(String, T) - Static method in interface org.forgerock.monitoring.api.instrument.Gauge
Setup a Gauge.Builder that will create a gauge that reports the size of the Collection.
gaugeMapSize(String, T) - Static method in interface org.forgerock.monitoring.api.instrument.Gauge
Setup a Gauge.Builder that will create a gauge that reports the size of the Map.
GeneralizedTime - Class in org.forgerock.opendj.ldap
An LDAP generalized time as defined in RFC 4517.
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.
generateKeyPair(SupportedEllipticCurve) - Static method in class org.forgerock.json.jose.jwk.OkpJWK
Generates a fresh OKP JWK with both public and private claims on the given curve.
generateMapFromJWK(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser
Provides a Map of KeyId:Keys as indicated by the JWKSet's URL.
GenericControl - Class in org.forgerock.opendj.ldap.controls
A generic control which can be used to represent arbitrary raw request and response controls.
GenericExtendedRequest - Interface in org.forgerock.opendj.ldap.messages
A generic Extended request which should be used for unsupported extended operations.
GenericExtendedResult - Interface in org.forgerock.opendj.ldap.messages
A Generic Extended result indicates the final status of an Generic Extended operation.
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
 
GenericIntermediateResponse - Interface in org.forgerock.opendj.ldap.messages
A Generic Intermediate response provides a mechanism for communicating unrecognized or unsupported Intermediate responses to the client.
GenericSecret - Class in org.forgerock.secrets
A generic secret represented as an opaque blob of bytes, such as a password or API key.
GenericSecret(SecretBuilder) - Constructor for class org.forgerock.secrets.GenericSecret
Constructs a generic secret with the given stable identifier and secret data.
get(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(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(String) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
Initiate a search beginning with a metric name.
get(Dn) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns a deep copy of the named entry contained in this memory backend, or null if it does not exist.
get(String) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns a deep copy of the named entry contained in this memory backend, or null if it does not exist.
get(String) - Method in interface org.forgerock.opendj.security.KeyStoreObjectCache
Returns the named key store object from the cache if present, or null if the object is not present or has been removed.
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(Context) - Method in class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier
Computes (or re-computes) the value in a thread-safe manner, making sure that only 1 thread will compute the value, the other being blocked, waiting for the result to be computed.
get() - Method in class org.forgerock.secrets.SecretReference
Gets the current active secret object, refreshing it if necessary.
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(K, Function<K, V>) - Method in class org.forgerock.util.NonExpiringCache
Gets the object from the cache for the given key, or computes the value from calculation function and inserts the calculated value into the map.
get(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.
get() - Method in interface org.forgerock.util.Supplier
Supply a value.
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.
getAccountObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the account Object Class which has the OID 0.9.2342.19200300.100.4.5.
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.
getActive(Purpose<S>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
 
getActive(Purpose<S>) - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
 
getActive(Purpose<S>) - Method in interface org.forgerock.secrets.SecretStore
Returns the active secret for the given purpose.
getActive(Purpose<S>) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
getActiveSecret(Purpose<S>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService
 
getActiveSecret(Purpose<S>) - Method in interface org.forgerock.openig.secrets.SecretsService
Gets the currently active secret for the given purpose.
getActiveSecret(Purpose<S>) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
 
getActiveSecret(Purpose<S>) - Method in class org.forgerock.secrets.SecretsProvider
Gets the currently active secret for the given purpose.
getAddedHeaders() - Method in class org.forgerock.openig.filter.HeaderFilter
Returns the header fields to add to the message, represented as a MultiMap of String to a List of String, each listed value representing an expression that will be evaluated.
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.ActionRequest
 
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.CreateRequest
 
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.DeleteRequest
 
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.PatchRequest
 
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.QueryRequest
 
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.ReadRequest
 
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.Request
Returns the additional parameter which should be used to control the behavior of this action request.
getAdditionalParameter(String) - Method in interface org.forgerock.json.resource.UpdateRequest
 
getAdditionalParameters() - Method in class org.forgerock.http.header.ContentTypeHeader
Deprecated.
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).
getAfterCount() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns the number of entries after the target entry to be included in the search results.
getAgent() - Method in class org.forgerock.http.header.Warning
Gets the warning's agent name.
getAgentId() - Method in class org.forgerock.openig.tools.am.AmService
Returns the agent's ID.
getAgreementPartyUInfo() - Method in class org.forgerock.json.jose.jwe.JweHeader
Gets the Agreement PartyUInfo header parameter for this JWE.
getAgreementPartyVInfo() - Method in class org.forgerock.json.jose.jwe.JweHeader
Gets the Agreement PartyVInfo header parameter for this JWE.
getAlgorithm() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm
 
getAlgorithm() - Method in class org.forgerock.json.jose.jwe.JweHeader
Gets the Algorithm set in the JWT header.
getAlgorithm() - Method in class org.forgerock.json.jose.jwk.JWK
Deprecated.
getAlgorithm(String) - Static method in class org.forgerock.json.jose.jwk.JWK
Get the algorithm corresponding.
getAlgorithm() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
getAlgorithm() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
 
getAlgorithm() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
 
getAlgorithm() - Method in class org.forgerock.json.jose.jws.JwsHeader
Gets the Algorithm set in the JWT header.
getAlgorithm() - Method in interface org.forgerock.json.jose.jwt.Algorithm
Gets the actual name of the algorithm that is understood by Java cryptographic operations.
getAlgorithm() - Method in class org.forgerock.json.jose.jwt.JwtHeader
Gets the Algorithm set in the JWT header.
getAlgorithm() - Method in class org.forgerock.openig.tools.TlsOptions
Returns the SSL context algorithm name (never null).
getAlgorithmString() - Method in class org.forgerock.json.jose.jwt.JwtHeader
Gets the string representation of the Algorithm set in the JWT header.
getAlgorithmType() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm
Gets the JweAlgorithmType of the JweAlgorithm.
getAlgorithmType() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Gets the JwsAlgorithmType of the JwsAlgorithm.
getAlias() - Method in class org.forgerock.opendj.security.KeyStoreObject
Returns the alias associated with this key store object.
getAlias() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails
Get the alias that this key is stored using in the keystore.
getAliasedObjectNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the aliasedObjectName Attribute Type which has the OID 2.5.4.1.
getAliasObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the alias Object Class which has the OID 2.5.6.1.
getAll(String) - Method in class org.forgerock.http.protocol.Headers
Gets all the values of the header, or an empty list if the header doesn't exist.
getAll() - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns a collection containing all of the entries in this memory backend.
getAll(Class<T>) - Method in interface org.forgerock.openig.heap.Heap
Deprecated.
marked in 6.5 with no functional equivalent
getAll(Class<T>) - Method in class org.forgerock.openig.heap.HeapImpl
 
getAllAttributes() - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
getAllAttributes() - Method in class org.forgerock.opendj.ldap.Entries.NullEntry
 
getAllAttributes() - Method in interface org.forgerock.opendj.ldap.Entry
Returns an Iterable containing all of the attributes in this entry.
getAllAttributes(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.Entry
Returns an Iterable containing all the attributes in this entry having an attribute description which is a sub-type of the provided attribute description.
getAllAttributes(String) - Method in interface org.forgerock.opendj.ldap.Entry
Returns an Iterable containing all the attributes in this entry having an attribute description which is a sub-type of the provided attribute description.
getAllAttributes() - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getAllAttributes(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getAllAttributes(String) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getAllAttributes() - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getAllAttributes(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getAllAttributes(String) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getAllAttributes(AttributeDescription) - Method in class org.forgerock.opendj.ldap.TreeMapEntry
 
getAllowedAlgorithms() - Method in class org.forgerock.secrets.SecretBuilder
Returns a predicate that can be used to test whether a given algorithm can be used with this key.
getAllowedKeyUsages() - Method in class org.forgerock.secrets.SecretBuilder
The allowed key usages of this key.
getAlternativeServers() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of URIs referring to alternative Directory Servers that may be contacted when the Directory Server becomes unavailable.
getAltServerAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the altServer Attribute Type which has the OID 1.3.6.1.4.1.1466.101.120.6.
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.
getApplicationProcessObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the applicationProcess Object Class which has the OID 2.5.6.11.
getApproximateMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the matching rule that should be used for approximate matching with this attribute type.
getApproximateMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Retrieves the default approximate matching rule that will be used for attributes with this syntax.
getApproximateMatchingRule() - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Retrieves the default approximate matching rule that will be used for attributes with this syntax.
getAsn1Reader() - Method in class org.forgerock.opendj.io.LdapReader
Returns the ASN.1 reader from which LDAP messages will be read.
getAsn1Writer() - Method in class org.forgerock.opendj.io.LdapWriter
Returns the ASN.1 writer to which LDAP messages will be written.
getAssertion() - Method in class org.forgerock.opendj.ldap.Matcher
Returns the assertion for this comparison filter Matcher.
getAssertion(Schema, ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.AbstractEqualityMatchingRuleImpl
 
getAssertion(Schema, ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.AbstractOrderingMatchingRuleImpl
 
getAssertion(ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the normalized form of the provided assertion value, which is best suited for efficiently performing matching operations on that value.
getAssertion(Schema, ByteSequence) - Method in interface org.forgerock.opendj.ldap.schema.MatchingRuleImpl
Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing less than matching operations on that value.
getAssertionValue() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns the assertion value that will be used to locate the target entry, if applicable.
getAssertionValue() - Method in class org.forgerock.opendj.ldap.Filter
Returns the assertion value for this comparison filter.
getAssertionValue() - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Returns the assertion value to be compared.
getAssertionValueAsString() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns the assertion value that will be used to locate the target entry, if applicable, decoded as a UTF-8 string.
getAssertionValueAsString() - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Returns the assertion value to be compared decoded as a UTF-8 string.
getAssociatedDomainAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the associatedDomain Attribute Type which has the OID 0.9.2342.19200300.100.1.37.
getAssociatedNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the associatedName Attribute Type which has the OID 0.9.2342.19200300.100.1.38.
getAsync() - Method in class org.forgerock.secrets.SecretReference
Gets the current active secret object asynchronously, refreshing it if necessary.
getAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
getAttribute(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.Entry
Returns the named attribute contained in this entry, or null if it is not included with this entry.
getAttribute(String) - Method in interface org.forgerock.opendj.ldap.Entry
Returns the named attribute contained in this entry, or null if it is not included with this entry.
getAttribute(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getAttribute(String) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getAttribute(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getAttribute(String) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getAttribute() - Method in class org.forgerock.opendj.ldap.Modification
Returns the attribute containing the values to be modified.
getAttributeCount() - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
getAttributeCount() - Method in class org.forgerock.opendj.ldap.Entries.NullEntry
 
getAttributeCount() - Method in interface org.forgerock.opendj.ldap.Entry
Returns the number of attributes in this entry.
getAttributeCount() - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getAttributeCount() - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getAttributeDescription() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns the attribute description of this attribute, which includes its attribute type and any options.
getAttributeDescription() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
Returns the first attribute description specified in the list of sort keys that was in error, or null if the attribute description was not included with this control.
getAttributeDescription() - Method in class org.forgerock.opendj.ldap.Filter
Returns the attribute description for this comparison filter, which may be null if the filter is an extensible match filter and the extensible matching rule is specified.
getAttributeDescription() - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
getAttributeDescription() - Method in class org.forgerock.opendj.ldap.Matcher
Returns the attribute description for this comparison filter Matcher, which may be null if the filter is an extensible match filter specifying an extensible matching rule.
getAttributeDescription() - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Returns the name of the attribute to be compared.
getAttributeDescription() - Method in class org.forgerock.opendj.ldap.SortKey
Returns the name of the attribute to be sorted using this sort key.
getAttributeDescriptionAsString() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns the string representation of the attribute description of this attribute, which includes its attribute type and any options.
getAttributeFactory() - Method in class org.forgerock.opendj.ldap.DecodeOptions
Returns the function which will be used for creating new Attribute instances when decoding attributes.
getAttributeName() - Method in class org.forgerock.opendj.ldap.Ava
Returns the attribute name associated with this AVA.
getAttributes() - Method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
Returns an unmodifiable list of attributes for which effective rights are to be returned, which may be empty indicating that no attribute rights are to be returned.
getAttributes() - Method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
Returns an unmodifiable list containing the names of attributes to be included with the response control.
getAttributes() - Method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
Returns an unmodifiable list containing the names of attributes to be included with the response control.
getAttributes() - Method in class org.forgerock.opendj.ldap.LdapUrl
Returns an unmodifiable list containing the attributes to be included with each entry that matches the search criteria.
getAttributes() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Returns a List containing the list of attributes to be included with each entry that matches the search criteria.
getAttributes() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Returns an unmodifiable set containing the attributes associated with this matching rule use.
getAttributes() - Method in class org.forgerock.openig.openam.PolicyDecisionContext
Returns the unmodifiable map of attributes provided in the policy decision (can be empty, but never null).
getAttributes() - Method in class org.forgerock.services.context.AttributesContext
Returns the attributes associated with the current request.
getAttributeType() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns the attribute type associated with this attribute description.
getAttributeType() - Method in class org.forgerock.opendj.ldap.Ava
Returns the attribute type associated with this AVA.
getAttributeType(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the attribute type for the specified name or numeric OID.
getAttributeType(String, Syntax) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the attribute type for the specified name or numeric OID.
getAttributeTypeDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Attribute Type Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.3.
getAttributeTypes() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the attribute types contained in this schema.
getAttributeTypes() - Static method in class org.forgerock.opendj.security.OpenDjSecurityProviderSchema
Returns the set of LDAP attribute types required in order to support the OpenDJ security provider.
getAttributeTypesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the attributeTypes Attribute Type which has the OID 2.5.21.5.
getAttributeValue() - Method in class org.forgerock.opendj.ldap.Ava
Returns the attribute value associated with this AVA.
getAttributeValue(AttributeType) - Method in class org.forgerock.opendj.ldap.Rdn
Returns the attribute value contained in this RDN which is associated with the provided attribute type, or null if this RDN does not include such an attribute value.
getAudience() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Gets the intended audience for the JWT from the Claims Set.
getAuditEventHandlerConfigurationSchema(String, ClassLoader) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Gets the configuration schema for an audit event handler as json schema.
getAuditEventProperties(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper
Gets the Audit Event schema properties.
getAuditEventSchema(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper
Gets the Audit Event schema.
getAuthenticatedHandler() - Method in class org.forgerock.openig.tools.am.AmService
Returns a Handler that will perform automatic authentication with the provided agent credentials.
getAuthenticationId() - Method in class org.forgerock.services.context.SecurityContext
Returns the principal that the client used during authentication.
getAuthenticationPasswordSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Authentication Password Syntax which has the OID 1.3.6.1.4.1.4203.1.1.2.
getAuthenticationService() - Method in class org.forgerock.openig.tools.am.AmService
Returns the service used to authenticate subjects to AM.
getAuthenticationTag() - Method in class org.forgerock.json.jose.jwe.JweEncryption
Gets the authentication tag from the result of the encryption.
getAuthenticationType() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns the authentication mechanism identifier for this bind request as defined by the LDAP protocol.
getAuthenticationValue() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns a defensive copy of the encoded authentication value for this bind request as defined by the LDAP protocol.
getAuthority() - Method in class org.forgerock.http.MutableUri
Returns the authority compound element.
getAuthorityRevocationListAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the authorityRevocationList Attribute Type which has the OID 2.5.4.38.
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.
getAuthorizationDnName() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
Returns the distinguished name of the user whose authorization is to be used when performing the operation.
getAuthorizationId() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
Returns the authorization ID of the user.
getAuthorizationId() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
Returns the authorization ID of the user whose authorization is to be used when performing the operation.
getAuthorizationId() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
Returns the authorization ID of the user.
getAuthorizationName() - Method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
Returns the distinguished name of the user for which effective rights are to be returned, or null if the client's authentication ID is to be used.
getAuthorizeEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns the authorize end-point of this issuer.
getAuthPasswordAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the authPassword Attribute Type which has the OID 1.3.6.1.4.1.4203.1.3.4.
getAuthPasswordExactMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the authPasswordExactMatch Matching Rule which has the OID 1.3.6.1.4.1.4203.1.2.2.
getAuthPasswordObjectObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the authPasswordObject Object Class which has the OID 1.3.6.1.4.1.4203.1.4.7.
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.
getAuxiliaryClasses() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns an unmodifiable set containing the auxiliary objectclasses that may be used for entries associated with this DIT content rule.
getAvailableAuditEventHandlers() - Method in class org.forgerock.audit.AuditServiceConfiguration
Returns a list of class names of available audit event handlers.
getBackingArray() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns the byte array that backs this byte string builder.
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 IG file system.
getBaseTimeUnit() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
The registry's base TimeUnit.
getBaseTimeUnit() - Method in class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
 
getBaseUnit() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
getBaseUri() - Method in class org.forgerock.http.routing.UriRouterContext
Returns the portion of the request URI which has been routed so far.
getBaseUri() - Method in class org.forgerock.openig.tools.am.AmService
Return the base URI for this server.
getBaseUri() - Method in class org.forgerock.openig.tools.am.UriService
Return the base URI for this server.
getBatch() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
Returns the configuration used to initialize the batch publisher.
getBearerAccessToken(String) - Static method in class org.forgerock.http.oauth2.OAuth2
Extracts the bearer token from the request's authorization header.
getBeforeCount() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns the number of entries before the target entry to be included in the search results.
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.
getBinarySyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Binary Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.5.
getBitStringMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the bitStringMatch Matching Rule which has the OID 2.5.13.16.
getBitStringSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Bit String Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.6.
getBody() - Method in class org.forgerock.openig.tools.notifications.Notification
Returns the notification's payload.
getBooleanMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the booleanMatch Matching Rule which has the OID 2.5.13.13.
getBooleanSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Boolean Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.7.
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.
getBuildingNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the buildingName Attribute Type which has the OID 0.9.2342.19200300.100.1.48.
getBundleInPreferredLocale(String, ClassLoader) - Method in class org.forgerock.util.i18n.PreferredLocales
Get a ResourceBundle using the preferred locale list and using the provided ClassLoader.
getBusinessCategoryAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the businessCategory Attribute Type which has the OID 2.5.4.15.
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.
getCACertificateAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the cACertificate Attribute Type which has the OID 2.5.4.37.
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.
getCaseExactIA5MatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseExactIA5Match Matching Rule which has the OID 1.3.6.1.4.1.1466.109.114.1.
getCaseExactMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseExactMatch Matching Rule which has the OID 2.5.13.5.
getCaseExactOrderingMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseExactOrderingMatch Matching Rule which has the OID 2.5.13.6.
getCaseExactSubstringsMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseExactSubstringsMatch Matching Rule which has the OID 2.5.13.7.
getCaseIgnoreIA5MatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseIgnoreIA5Match Matching Rule which has the OID 1.3.6.1.4.1.1466.109.114.2.
getCaseIgnoreIA5SubstringsMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseIgnoreIA5SubstringsMatch Matching Rule which has the OID 1.3.6.1.4.1.1466.109.114.3.
getCaseIgnoreListMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseIgnoreListMatch Matching Rule which has the OID 2.5.13.11.
getCaseIgnoreListSubstringsMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseIgnoreListSubstringsMatch Matching Rule which has the OID 2.5.13.12.
getCaseIgnoreMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseIgnoreMatch Matching Rule which has the OID 2.5.13.2.
getCaseIgnoreOrderingMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseIgnoreOrderingMatch Matching Rule which has the OID 2.5.13.3.
getCaseIgnoreSubstringsMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the caseIgnoreSubstringsMatch Matching Rule which has the OID 2.5.13.4.
getCaseInsensitiveFields() - Method in class org.forgerock.audit.AuditServiceConfiguration
Get the list of audit event fields to treat case-insensitively when filtering.
getCAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the c Attribute Type which has the OID 2.5.4.6.
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).
getCause() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getCause() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getCause() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getCause() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getCause() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getCause() - Method in interface org.forgerock.opendj.ldap.messages.Result
Returns the throwable cause associated with this result if available.
getCause() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getCertificate(Class<T>) - Method in class org.forgerock.secrets.keys.CryptoKey
Returns the certificate of the given type if one is available.
getCertificate() - Method in class org.forgerock.secrets.keys.CryptoKey
Returns any certificate associated with this key.
getCertificate() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails
Get the Certificate instance for the public component of this key.
getCertificate() - Method in class org.forgerock.secrets.SecretBuilder
Returns the certificate associated with this secret, or null if not available.
getCertificate(String) - Method in class org.forgerock.security.keystore.KeyStoreManager
Gets the certificate from the KeyStore with the given alias.
getCertificateExactMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the certificateExactMatch Matching Rule which has the OID 2.5.13.34.
getCertificateListSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Certificate List Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.9.
getCertificatePairSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Certificate Pair Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.10.
getCertificateRevocationListAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the certificateRevocationList Attribute Type which has the OID 2.5.4.39.
getCertificates() - Method in class org.forgerock.services.context.ClientContext
Returns the collection (possibly empty) of certificate(s) provided by the client.
getCertificateSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Certificate Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.8.
getCertificationAuthorityObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the certificationAuthority Object Class which has the OID 2.5.6.16.
getCertificationAuthorityV2ObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the certificationAuthority-V2 Object Class which has the OID 2.5.6.16.2.
getChallenges(HttpHost, HttpResponse, HttpContext) - Method in class org.forgerock.http.apache.NoAuthenticationStrategy
 
getChallenges() - Method in class org.forgerock.http.header.WwwAuthenticateHeader
Return an unmodifiable view of the authentication challenges represented by this header object.
getChangeNumber() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
Returns the change number for this entry change notification control.
getChangeType() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
Returns the change type for this entry change notification control.
getChangeTypes() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
Returns an unmodifiable set containing the types of update operation for which change notifications should be returned.
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.
getCipher() - Method in class org.forgerock.secrets.keys.KeyDecryptionKey
 
getCipher() - Method in class org.forgerock.secrets.keys.KeyEncryptionKey
 
getCipherSuitesArray() - Method in class org.forgerock.openig.tools.TlsOptions
Returns the array of cipher suites to be enabled (may be null for JVM default).
getCipherSuitesList() - Method in class org.forgerock.openig.tools.TlsOptions
Returns the list of cipher suites to be enabled (may be empty for JVM default).
getCiphertext() - Method in class org.forgerock.json.jose.jwe.JweEncryption
Gets the ciphertext from the result of the encryption.
getClaim(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Gets a claim value for the specified key.
getClaim(String, Class<T>) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Gets a claim value for the specified claim name and then casts it to the specified type.
getClaimSetKey(String) - Static method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey
Gets the JwtClaimsSetKey constant that matches the given String (case-insensitive).
getClaimsSet() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt
 
getClaimsSet() - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt
 
getClaimsSet() - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
Gets the claims set object for the nested Encrypted JWT that is the payload of this JWS.
getClaimsSet() - Method in class org.forgerock.json.jose.jws.SignedJwt
Gets the claims set object for the Jwt, which contains all of the claims (name value pairs) conveyed by the JWT.
getClaimsSet() - Method in interface org.forgerock.json.jose.jwt.Jwt
Gets the claims set object for the Jwt, which contains all of the claims (name value pairs) conveyed by the JWT.
getClaimsSet() - Method in class org.forgerock.openig.openam.CdSsoContext
Get a copy of the JWT claims set.
getClass(String) - Static method in class org.forgerock.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.
getCNAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the cn Attribute Type which has the OID 2.5.4.3.
getCoAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the co Attribute Type which has the OID 0.9.2342.19200300.100.1.43.
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.
getCommonName() - Method in class org.forgerock.openig.openam.UserProfileContext
Get the user's common name (cn) or null if none.
getCommonName() - Method in class org.forgerock.openig.tools.userprofile.UserProfile
Get the common name (cn) or null if none.
getCompressionAlgorithm() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets the Compression Algorithm header parameter for this JWE.
getCompressionHandler(CompressionAlgorithm) - Method in class org.forgerock.json.jose.jwe.CompressionManager
Gets the appropriate CompressionHandler that can perform the required compression using the given compression algorithm.
getConfig() - Method in interface org.forgerock.audit.AuditService
Gets the AuditService configuration.
getConfig() - Method in class org.forgerock.audit.AuditServiceProxy
 
getConfig() - Method in interface org.forgerock.openig.decoration.Context
Returns the heap object being decorated configuration.
getConfig() - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns the config associated to that Heaplet.
getConfigDirectory() - Method in class org.forgerock.openig.config.env.DefaultEnvironment
 
getConfigDirectory() - Method in 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.
getConnection() - Method in interface org.forgerock.opendj.ldap.ConnectionFactory
Returns a connection to the Directory Server associated with this connection factory.
getConnection() - Method in class org.forgerock.opendj.ldap.LdapConnectionFactory
 
getConnectionAsync() - Method in interface org.forgerock.json.resource.ConnectionFactory
Asynchronously obtains a connection to the JSON resource provider associated with this connection factory.
getConnectionAsync() - Method in interface org.forgerock.opendj.ldap.ConnectionFactory
Asynchronously obtains a connection to the Directory Server associated with this connection factory.
getConnectionAsync() - Method in class org.forgerock.opendj.ldap.LdapConnectionFactory
 
getConnectionError() - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Returns the error that caused the connection to fail, or null if the connection has not failed.
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.
getContentCount() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns the content count returned by the server in the last virtual list view response, if applicable.
getContentCount() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
Returns the estimated total number of entries in the result set.
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.
getContextId() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns the context ID provided by the server in the last virtual list view response for the same set of criteria, or null if there was no previous virtual list view response or the server did not include a context ID in the last response.
getContextId() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
Returns a server-defined octet string which, if present, should be sent back to the server by the client in a subsequent virtual list request.
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.
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.AbandonRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.DeleteRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.IntermediateResponse
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getControl(ControlDecoder<C>) - Method in interface org.forgerock.opendj.ldap.messages.ProtocolOp
Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder using default decode options.
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.ProtocolOp
Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.Result
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultReference
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.UnbindRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
getControl(ControlDecoder<C>, DecodeOptions) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getControlOidForAlias(String) - Static method in class org.forgerock.opendj.ldap.controls.Controls
Returns the control OID associated with the provided control "friendly name" alias or the provided alias if no OID has been found.
getControls() - Method in exception org.forgerock.opendj.ldap.LdapException
Returns controls associated with the result of this LDAP exception.
getControls() - Method in interface org.forgerock.opendj.ldap.messages.AbandonRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.DeleteRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.IntermediateResponse
 
getControls() - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.ProtocolOp
Returns a List containing the controls included with this protocol-op.
getControls() - Method in interface org.forgerock.opendj.ldap.messages.Result
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.SearchResultReference
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.UnbindRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
getControls() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getConventionName(NamingConvention) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
getConventionTags(NamingConvention) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
Tags that are sorted by key and formatted
getCookie() - Method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
Returns the opaque cookie which is used by the server to track its position in the set of search results.
getCookieBuilder() - Method in class org.forgerock.openig.openam.CdSsoContext
Get the CDSSO authentication cookie builder.
getCookieJwt(Request, String) - Static method in class org.forgerock.openig.tools.JwtUtil
Get a JWT from a request, with a given cookie name.
getCookieName() - Method in class org.forgerock.openig.tools.am.AmService
Returns the cookie header name used by AM server.
getCookies() - Method in class org.forgerock.http.header.AbstractSetCookieHeader
Returns the list of Cookies from a SetCookieHeader or a SetCookie2Header.
getCookies() - Method in class org.forgerock.http.header.CookieHeader
Returns the cookies' request list.
getCookies() - Method in class org.forgerock.http.header.SetCookie2Header
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.
getCoreSchema() - Static method in class org.forgerock.opendj.ldap.schema.Schema
Returns the core schema.
getCountryObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the country Object Class which has the OID 2.5.6.2.
getCountryStringSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Country String Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.11.
getCreateTimestampAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the createTimestamp Attribute Type which has the OID 2.5.18.1.
getCreatorsNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the creatorsName Attribute Type which has the OID 2.5.18.3.
getCredentials() - Method in class org.forgerock.http.header.AuthorizationHeader
Get the credentials component of the header value.
getCriticalHeaders() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets the critical header parameters for this JWS.
getCRlDistributionPointObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the cRLDistributionPoint Object Class which has the OID 2.5.6.19.
getCrossCertificatePairAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the crossCertificatePair Attribute Type which has the OID 2.5.4.40.
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.
getCurve() - Method in interface org.forgerock.json.jose.jwk.OkpJWK.OctetECKey
The curve that the key is for.
getCurve() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
getCurve() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
 
getD() - Method in class org.forgerock.json.jose.jwk.EcJWK
Gets the unsigned big-endian base64 url encoding of the d value for the elliptical curve private key.
getD() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Returns the private key d value.
getDailyRotationTimes() - Method in class org.forgerock.audit.rotation.FixedTimeRotationPolicy
Get the list of times since midnight that rotation will occur at.
getDatabaseType() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration
Gets the type of the database.
getDataSourceClassName() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
Gets the datasource class name for the JDBC database.
getDate() - Method in class org.forgerock.http.header.Warning
Gets the warning's date.
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.
getDCAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the dc Attribute Type which has the OID 0.9.2342.19200300.100.1.25.
getDCObjectObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the dcObject Object Class which has the OID 1.3.6.1.4.1.1466.344.
getDeclaredOptionalAttributes() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns an unmodifiable set containing the optional attributes for this object class.
getDeclaredRequiredAttributes() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns an unmodifiable set containing the required attributes for this object class.
getDecorated() - Method in class org.forgerock.openig.decoration.DecorationHandle
Returns the decorated object.
getDefaultSchema() - Static method in class org.forgerock.opendj.ldap.schema.Schema
Returns the default schema which should be used by this application.
getDefaultVersionBehaviour() - Method in class org.forgerock.http.routing.ApiVersionRouterContext
Gets the default version behaviour if the request does not contain a resource API version.
getDefaultVersionBehaviour() - Method in interface org.forgerock.http.routing.ResourceApiVersionBehaviourManager
Gets the default routing behaviour to use when the request does not contain the Accept-API-Version header.
getDelimiterChar() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting
Gets the character to use to delimit the csv entries.
getDeliveryMethodSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Delivery Method Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.14.
getDeliveryMode() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
Returns the delivery mode configuration that should be used when publishing the JMS messages.
getDeltaCrlObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the deltaCRL Object Class which has the OID 2.5.6.23.
getDeltaRevocationListAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the deltaRevocationList Attribute Type which has the OID 2.5.4.53.
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.
getDereferenceAliasesPolicy() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Returns an indication as to whether alias entries are to be dereferenced during the search.
getDescription() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
getDescription() - Method in interface org.forgerock.opendj.ldap.schema.SchemaElement
Returns the description of this schema element, or the empty string if it does not have a description.
getDescription() - Method in class org.forgerock.openig.filter.oauth2.Result
Returns the failure description (null if this is a success).
getDescription() - Method in class org.forgerock.openig.openam.CdSsoFailureContext
Get a description of the CDSSO error that occurred.
getDescription() - Method in class org.forgerock.openig.tools.jwt.Violation
Returns the description of this violation.
getDescriptionAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the description Attribute Type which has the OID 2.5.4.13.
getDestinationIndicatorAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the destinationIndicator Attribute Type which has the OID 2.5.4.27.
getDetail() - Method in exception org.forgerock.json.resource.ResourceException
Returns the additional detail which can be evaluated by applications.
getDeviceObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the device Object Class which has the OID 2.5.6.14.
getDiagnosticMessage() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getDiagnosticMessage() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getDiagnosticMessage() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getDiagnosticMessage() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getDiagnosticMessage() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getDiagnosticMessage() - Method in interface org.forgerock.opendj.ldap.messages.Result
Returns the diagnostic message associated with this result.
getDiagnosticMessage() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getDiagnosticMessageAsString() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getDiagnosticMessageAsString() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getDiagnosticMessageAsString() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getDiagnosticMessageAsString() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getDiagnosticMessageAsString() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getDiagnosticMessageAsString() - Method in interface org.forgerock.opendj.ldap.messages.Result
Returns the diagnostic message associated with this result as a string.
getDiagnosticMessageAsString() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getDirectives() - Method in class org.forgerock.http.header.ContentTypeHeader
Returns all directives in the message, keyed off the directive name, or an empty map if none specified.
getDirectoryStringFirstComponentMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the directoryStringFirstComponentMatch Matching Rule which has the OID 2.5.13.31.
getDirectoryStringSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Directory String Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.15.
getDiscard() - Method in class org.forgerock.http.protocol.Cookie
Returns true if the user agent should discard the cookie unconditionally when it terminates.
getDistinguishedName() - Method in class org.forgerock.openig.openam.UserProfileContext
Get the user's distinguished name (dn) or null if none.
getDistinguishedName() - Method in class org.forgerock.openig.tools.userprofile.UserProfile
Get the user's distinguished name (dn) or null if none.
getDistinguishedNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the distinguishedName Attribute Type which has the OID 2.5.4.49.
getDistinguishedNameMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the distinguishedNameMatch Matching Rule which has the OID 2.5.13.1.
getDitContentRule(ObjectClass) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the DIT content rule associated with the provided structural object class, or null if no rule is defined.
getDitContentRule(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the DIT content rule with the specified name or numeric OID.
getDITContentRuleDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the DIT Content Rule Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.16.
getDitContentRules() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the DIT content rules contained in this schema.
getDITContentRulesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the ditContentRules Attribute Type which has the OID 2.5.21.2.
getDitStructureRule(int) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the DIT structure rule with the specified name or numeric OID.
getDitStructureRule(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the DIT structure rule with the specified name or numeric OID.
getDITStructureRuleDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the DIT Structure Rule Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.17.
getDitStructureRules(NameForm) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the DIT structure rules associated with the provided name form.
getDITStructureRulesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the ditStructureRules Attribute Type which has the OID 2.5.21.1.
getDitStuctureRules() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the DIT structure rules contained in this schema.
getDNQualifierAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the dnQualifier Attribute Type which has the OID 2.5.4.46.
getDNSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the DN Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.12.
getDocumentAuthorAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the documentAuthor Attribute Type which has the OID 0.9.2342.19200300.100.1.14.
getDocumentIdentifierAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the documentIdentifier Attribute Type which has the OID 0.9.2342.19200300.100.1.11.
getDocumentLocationAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the documentLocation Attribute Type which has the OID 0.9.2342.19200300.100.1.15.
getDocumentObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the document Object Class which has the OID 0.9.2342.19200300.100.4.6.
getDocumentPublisherAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the documentPublisher Attribute Type which has the OID 0.9.2342.19200300.100.1.56.
getDocumentSeriesObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the documentSeries Object Class which has the OID 0.9.2342.19200300.100.4.9.
getDocumentTitleAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the documentTitle Attribute Type which has the OID 0.9.2342.19200300.100.1.12.
getDocumentVersionAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the documentVersion Attribute Type which has the OID 0.9.2342.19200300.100.1.13.
getDomain() - Method in class org.forgerock.http.protocol.Cookie
Returns the domain for which the cookie is valid.
getDomainObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the domain Object Class which has the OID 0.9.2342.19200300.100.4.13.
getDomainRelatedObjectObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the domainRelatedObject Object Class which has the OID 0.9.2342.19200300.100.4.17.
getDrinkAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the drink Attribute Type which has the OID 0.9.2342.19200300.100.1.5.
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.
GetEffectiveRightsRequestControl - Class in org.forgerock.opendj.ldap.controls
A partial implementation of the get effective rights request control as defined in draft-ietf-ldapext-acl-model.
getEllipticCurve() - Method in class org.forgerock.json.jose.jwk.EcJWK
Gets the elliptic curve.
getEllipticCurve() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk
The elliptic curve this JWK is on.
getEllipticCurve() - Method in class org.forgerock.json.jose.jwk.OkpJWK
The supported elliptic curve that this key is on.
getEllipticCurveName() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Return the standard name of the elliptic curve definition.
getEmptySchema() - Static method in class org.forgerock.opendj.ldap.schema.Schema
Returns the empty schema.
getEnabledProtocolsArray() - Method in class org.forgerock.openig.tools.TlsOptions
Returns the array of protocols to be enabled (may be null for JVM default).
getEnabledProtocolsList() - Method in class org.forgerock.openig.tools.TlsOptions
Returns the list of protocols to be enabled (may be empty for JVM default).
getEncoded() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
Returns the private d-value in little-endian form.
getEncoded() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
Returns the x-coordinate in little-endian form.
getEncryptionAlgorithm() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Gets the Java Cryptographic algorithm name for the algorithm that will create the Content Encryption Key (CEK).
getEncryptionHandler(JweHeader) - Method in class org.forgerock.json.jose.jwe.EncryptionManager
Gets the appropriate EncryptionHandler that can perform the required encryption algorithm, as described by the JweAlgorithm and EncryptionMethod in the given JweHeader.
getEncryptionHandler(JweHeader, Key) - Method in class org.forgerock.json.jose.jwe.EncryptionManager
Gets the appropriate EncryptionHandler that can perform the required encryption algorithm, as described by the JweAlgorithm and EncryptionMethod in the given JweHeader.
getEncryptionMethod() - Method in class org.forgerock.json.jose.jwe.JweHeader
Gets the Encryption Method header parameter for this JWE.
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.
getEnhancedGuideSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Enhanced Guide Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.21.
getEnhancedSearchGuideAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the enhancedSearchGuide Attribute Type which has the OID 2.5.4.47.
getEntity() - Method in interface org.forgerock.http.protocol.Message
Returns the entity.
getEntity() - Method in class org.forgerock.http.protocol.MessageImpl
 
getEntry() - Method in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
Returns an unmodifiable entry whose contents reflect the state of the updated entry immediately after the update operation was performed.
getEntry() - Method in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
Returns an unmodifiable entry whose contents reflect the state of the updated entry immediately before the update operation was performed.
getEntry() - Method in class org.forgerock.opendj.ldap.RootDse
Returns the entry which backs this Root DSE instance.
getEntryDNAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the entryDN Attribute Type which has the OID 1.3.6.1.1.20.
getEntryFactory() - Method in class org.forgerock.opendj.ldap.DecodeOptions
Returns the function which will be used for creating new Entry instances when decoding entries.
getEntryUUIDAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the entryUUID Attribute Type which has the OID 1.3.6.1.1.16.4.
getEphemeralPublicKey() - Method in class org.forgerock.json.jose.jwe.JweHeader
Gets the Ephemeral Public Key header parameter for this JWE.
getEqualityMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the matching rule that should be used for equality matching with this attribute type.
getEqualityMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Retrieves the default equality matching rule that will be used for attributes with this syntax.
getEqualityMatchingRule() - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Retrieves the default equality matching rule that will be used for attributes with this syntax.
getError() - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns the error code specifying the cause of the failure.
getError() - Method in class org.forgerock.openig.openam.CdSsoFailureContext
Get the CDSSO error that occurred.
getErrorDescription() - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns the human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.
getErrorType() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
Returns the password policy error type, if available.
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.
getEtagAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the etag Attribute Type which has the OID 1.3.6.1.4.1.36733.2.1.1.59.
getEvent() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
Returns the event content.
getEvent() - Method in class org.forgerock.audit.handlers.jdbc.TableMapping
Gets the audit event the table mapping is for.
getException(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.
getExpiry() - Method in class org.forgerock.secrets.SecretBuilder
Returns the expiry time for this secret.
getExpiryTime() - Method in class org.forgerock.secrets.Secret
The expiry time of this secret.
getExtendedResultClass() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResultDecoder
Returns the type S of the ExtendedResult.
getExtensibleMatchingRule() - Method in class org.forgerock.opendj.ldap.Filter
Returns the name of the extensible matching rule which should be used for comparing values, which may be null if the attribute description is provided (in which case equality matching will be performed).
getExtensibleObjectObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the extensibleObject Object Class which has the OID 1.3.6.1.4.1.1466.101.120.111.
getExtractor() - Method in class org.forgerock.openig.filter.EntityExtractFilter
Returns the regular expression patterns extractor.
getExtraProperties() - Method in interface org.forgerock.opendj.ldap.schema.SchemaElement
Returns an unmodifiable map containing all of the extra properties associated with this schema element.
getFacility() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration
Returns the facility constant that should be applied to all Syslog messages.
getFacsimileTelephoneNumberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the facsimileTelephoneNumber Attribute Type which has the OID 2.5.4.23.
getFacsimileTelephoneNumberSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Facsimile Telephone Number Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.22.
getFailedKeys() - Method in exception org.forgerock.config.resolvers.SubstitutionException
Returns the key(s) that have caused this substitution to fail.
getFamily() - Method in class org.forgerock.http.protocol.Status
Returns the class of response of this status code.
getFaxSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Fax Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.23.
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
getFilter() - Method in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
Returns the assertion filter.
getFilter() - Method in class org.forgerock.opendj.ldap.LdapUrl
Returns the search filter associated with this LDAP URL.
getFilter() - Method in class org.forgerock.opendj.ldap.Matcher
Returns the raw Filter associated with this comparison or undefined filter Matcher.
getFilter() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Returns the filter that defines the conditions that must be fulfilled in order for an entry to be returned.
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.
getFilters() - Method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
Returns an unmodifiable collection containing the list of filters associated with this matched values control.
getFilterType() - Method in class org.forgerock.opendj.ldap.Filter
Returns the type of this filter.
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.
getFirstAva() - Method in class org.forgerock.opendj.ldap.Rdn
Returns the first AVA contained in this RDN.
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.
getFormat() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
getFormat() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
 
getFormatting() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
Returns the CSV formatting options.
getFormJwt(Request, String) - Static method in class org.forgerock.openig.tools.JwtUtil
Get the JWT from a request form parameter.
getFragment() - Method in class org.forgerock.http.MutableUri
Returns the fragment element.
getFriendlyCountryObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the friendlyCountry Object Class which has the OID 0.9.2342.19200300.100.4.18.
getFrom() - Method in class org.forgerock.json.resource.PatchOperation
Returns the source field for move and copy operations.
getFullVendorVersion() - Method in class org.forgerock.opendj.ldap.RootDse
Returns a string which represents the full version of the Directory Server implementation.
getFullVendorVersionAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the fullVendorVersion Attribute Type which has the OID 1.3.6.1.4.1.36733.2.1.1.141.
getFullyQualifiedName() - Method in class org.forgerock.openig.heap.Name
Returns a String representation of this Name that includes the full Name hierarchy.
getGeneralizedTimeMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the generalizedTimeMatch Matching Rule which has the OID 2.5.13.27.
getGeneralizedTimeOrderingMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the generalizedTimeOrderingMatch Matching Rule which has the OID 2.5.13.28.
getGeneralizedTimeSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Generalized Time Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.24.
getGeneratedPassword() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
Returns the newly generated password, but only if the password modify request succeeded and a generated password was requested.
getGenerationQualifierAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the generationQualifier Attribute Type which has the OID 2.5.4.44.
getGivenNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the givenName Attribute Type which has the OID 2.5.4.42.
getGoverningStructureRuleAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the governingStructureRule Attribute Type which has the OID 2.5.21.10.
getGreaterOrEqualAssertion(Schema, ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.AbstractOrderingMatchingRuleImpl
 
getGreaterOrEqualAssertion(ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the normalized form of the provided assertion value, which is best suited for efficiently performing greater than or equal ordering matching operations on that value.
getGreaterOrEqualAssertion(Schema, ByteSequence) - Method in interface org.forgerock.opendj.ldap.schema.MatchingRuleImpl
Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing greater than or equal matching operations on that value.
getGroupOfNamesObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the groupOfNames Object Class which has the OID 2.5.6.9.
getGroupOfUniqueNamesObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the groupOfUniqueNames Object Class which has the OID 2.5.6.17.
getGuideSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Guide Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.25.
getHandledTopics() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler
Gets the names of all audit event topics this handler is registered against.
getHandledTopics() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
 
getHandler() - Method in class org.forgerock.openig.heap.HeapImpl
Returns the Handler object referenced by the handler top-level attribute.
getHandler() - Method in class org.forgerock.openig.tools.am.AmService
Returns the handler to use with this configuration.
getHandlerForQueries() - Method in class org.forgerock.audit.AuditServiceConfiguration
Returns the name of the handler to use for querying the audit events.
getHasSubordinatesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the hasSubordinates Attribute Type which has the OID 2.5.18.9.
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.
getHeap() - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns the heap associated to that Heaplet.
getHeap() - Method in class org.forgerock.openig.http.AdminHttpApplication
Returns the heap based on the contents of the admin configuration.
getHeaplet(Class<?>) - Static method in class org.forgerock.openig.heap.Heaplets
Returns the heaplet that creates an instance of the specified class, or null if no such heaplet could be found.
getHierarchicalLeaf() - Method in class org.forgerock.openig.heap.Name
Returns a String representation of this leaf's Name that is compliant with the hierarchical naming, i.e.
getHierarchicalName() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
getHierarchicalName() - Method in class org.forgerock.openig.heap.Name
Returns a String representation of this Name that includes the full Name hierarchy, with each segment name being 'slugged'.
getHistogramBuckets(boolean) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
getHistogramBufferLength() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
getHistogramExpiry() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
getHomePhoneAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the homePhone Attribute Type which has the OID 0.9.2342.19200300.100.1.20.
getHomePostalAddressAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the homePostalAddress Attribute Type which has the OID 0.9.2342.19200300.100.1.39.
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.
getHost() - Method in class org.forgerock.opendj.ldap.LdapUrl
Returns the name or IP address in dotted format of the LDAP server referenced by this LDAP URL.
getHostAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the host Attribute Type which has the OID 0.9.2342.19200300.100.1.9.
getHouseIdentifierAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the houseIdentifier Attribute Type which has the OID 2.5.4.51.
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.
getIA5StringSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the IA5 String Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.26.
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 interface org.forgerock.monitoring.api.instrument.Meter
 
getId() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableCounter
 
getId() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableGauge
 
getId() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
getId() - Method in interface org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMetric
Returns A unique combination of name and tags identifying this metric.
getId() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
getId() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Returns the request message id.
getId() - Method in class org.forgerock.services.context.AbstractContext
 
getId() - Method in interface org.forgerock.services.context.Context
Returns the unique ID identifying this context, usually a UUID.
getIdleTimeout() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
Gets the maximum time a connection is allowed to be idle.
getIn() - Method in class org.forgerock.http.io.PipeBufferedStream
Returns the output stream which writes to the pipe.
getIncludeIf() - Method in class org.forgerock.audit.filter.FilterPolicy
Gets the includeIf list.
getIndexId() - Method in interface org.forgerock.opendj.ldap.spi.Indexer
Returns an index identifier associated with this indexer.
getIndexingOptionsOrNull(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.spi.IndexQueryFactory
Returns the indexing options for the provided attribute, or null if the attribute is not indexed.
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.SessionInfoContext
Returns the information of the SessionInfo object.
getInfo() - Method in class org.forgerock.openig.openam.SsoTokenContext
Returns the info associated with this context.
getInfo() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the session info as Map for the given SSO Token if any, or null if none.
getInfoAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the info Attribute Type which has the OID 0.9.2342.19200300.100.1.4.
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.
getInitialsAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the initials Attribute Type which has the OID 2.5.4.43.
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(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.opendj.ldap.schema.CoreSchema
Returns a reference to the singleton core schema.
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.
getIntegerFirstComponentMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the integerFirstComponentMatch Matching Rule which has the OID 2.5.13.29.
getIntegerMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the integerMatch Matching Rule which has the OID 2.5.13.14.
getIntegerOrderingMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the integerOrderingMatch Matching Rule which has the OID 2.5.13.15.
getIntegerSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Integer Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.27.
getInternationalISDNNumberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the internationalISDNNumber Attribute Type which has the OID 2.5.4.25.
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.
getInvalidRequestType() - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
Returns the LDAP protocol-op type of this request.
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 AM 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.
getIssuerUri() - Method in class org.forgerock.openig.uma.UmaSharingService
Returns the issuer's URI.
getJdbcUrl() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
Gets the JDBC database url.
getJndi() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
getJPEGSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the JPEG Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.28.
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.
getJvmSupportedLocaleNamesToOids() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchemaSupportedLocales
Returns the unmodifiable map of JVM supported locale tags to OIDs.
getJwaAlgorithm() - Method in class org.forgerock.json.jose.jwk.JWK
Gets the alg parameter of the JWK.
getJwaAlgorithmName() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm
 
getJwaAlgorithmName() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
 
getJwaAlgorithmName() - Method in interface org.forgerock.json.jose.jwt.Algorithm
Gets the name of the algorithm as defined in the JWA standard.
getJweHeader() - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt
Get the header of the encapsulated EncryptedJwt.
getJweStandardName() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Returns the JWE standard encryption method name for this encryption method.
getJWKsAsJsonValue() - Method in class org.forgerock.json.jose.jwk.JWKSet
Get the JWKs in the set.
getJWKsAsList() - Method in class org.forgerock.json.jose.jwk.JWKSet
Get the JWKs in the set.
getJwkSetUrl() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets the JWK Set URL header parameter for this JWS.
getJwksStore(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService
Returns the appropriate JWKs store.
getJwkType() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Returns the type of JWK that is used for this elliptic curve.
getJwkUrl() - Method in class org.forgerock.json.jose.jwk.store.JwksStore
The JWKs URI.
getJwsAlgorithm(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.
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.monitoring.api.instrument.ImmutableTag
 
getKey() - Method in interface org.forgerock.monitoring.api.instrument.Tag
 
getKey() - Method in class org.forgerock.openig.el.plugins.EnvironmentVariablesPlugin
 
getKey() - Method in class org.forgerock.openig.el.plugins.SystemPropertiesPlugin
 
getKey() - Method in class org.forgerock.openig.resolver.ArrayResolver
Returns null, as arrays are not resolved through type discovery.
getKey() - Method in class org.forgerock.openig.resolver.BeanResolver
Do not forget to override this method in sub-classes.
getKey() - Method in class org.forgerock.openig.resolver.HeadersResolver
 
getKey() - Method in class org.forgerock.openig.resolver.HeapResolver
 
getKey() - Method in class org.forgerock.openig.resolver.ListResolver
 
getKey() - Method in class org.forgerock.openig.resolver.MapResolver
 
getKey() - Method in class org.forgerock.openig.resolver.PrincipalResolver
 
getKey() - Method in class org.forgerock.openig.resolver.RequestResolver
 
getKey() - Method in interface org.forgerock.openig.resolver.Resolver
Returns the type of object that the resolver supports.
getKey(KeyStore, String, String) - Static method in class org.forgerock.openig.util.KeyStoreUtil
Retrieves a PrivateKey or a SecretKey from a KeyStore.
getKeyAgreement(String, AlgorithmParameterSpec) - Method in class org.forgerock.secrets.keys.KeyAgreementKey
Obtains a key agreement protocol object initialized with this key.
getKeyAgreement(String) - Method in class org.forgerock.secrets.keys.KeyAgreementKey
Obtains a key agreement protocol object initialized with this key.
getKeyAgreement() - Method in class org.forgerock.secrets.keys.KeyAgreementKey
Obtains a key agreement protocol object for this key.
getKeyAgreementAlgorithm() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the Java KeyAgreement algorithm to use for this curve.
getKeyAlgorithm() - Method in class org.forgerock.secrets.keys.CryptoKey
Returns the algorithm used by the underlying key, for instance "RSA" or "EC".
getKeyGenerationAlgorithm() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines the Java KeyPairGenerator algorithm to use for this curve.
getKeyId() - Method in class org.forgerock.json.jose.jwk.JWK
Gets the keyId parameter of the JWK.
getKeyId() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets the Key ID header parameter for this JWS.
getKeyManagers() - Method in class org.forgerock.openig.tools.TlsOptions
Returns the array of KeyManager to use (may be null).
getKeyOffset() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Gets the number of octets in each of the CEK and MAC key.
getKeyOperations() - Method in class org.forgerock.json.jose.jwk.JWK
Gets the key operations parameter of the JWK.
getKeyOperations(String) - Static method in enum org.forgerock.json.jose.jwk.KeyOperation
Get the KeyOperation.
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.
getKeyType() - Method in class org.forgerock.secrets.keys.CryptoKey
Returns an indication of the type of key this is.
getKeyType() - Method in enum org.forgerock.secrets.keys.KeyUsage
The key type corresponding to this key usage.
getKeyUsages() - Method in class org.forgerock.secrets.keys.CryptoKey
Returns the key usages that the key can be used for.
getKeyUse(String) - Static method in enum org.forgerock.json.jose.jwk.KeyUse
Get the KeyUse.
getKeywordMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the keywordMatch Matching Rule which has the OID 2.5.13.33.
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
 
getLabel() - Method in class org.forgerock.secrets.Purpose
Returns a symbolic label for this purpose that can be used in routing requests for secrets.
getLastLoadedJwkSet() - Method in class org.forgerock.json.jose.jwk.store.JwksStore
Returns the last successfully loaded JWK Set together with the time at which it was last fetched.
getLastModified() - Method in interface org.forgerock.openig.handler.resources.Resource
Returns the timestamp when the resource has been last modified (expressed in TimeUnit.MILLISECONDS).
getLastRotationTime() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
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.
getLatestAccessTime() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the latest access time as an Instant.
getLatestAccessTime() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the latest access time as an Instant.
getLatestJwkSet() - Method in class org.forgerock.json.jose.jwk.store.JwksStore
Returns the latest non expired successfully loaded JWK Set.
getLAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the l Attribute Type which has the OID 2.5.4.7.
getLDAPSyntaxDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the LDAP Syntax Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.54.
getLDAPSyntaxesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the ldapSyntaxes Attribute Type which has the OID 1.3.6.1.4.1.1466.101.120.16.
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.
getLessOrEqualAssertion(Schema, ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.AbstractOrderingMatchingRuleImpl
 
getLessOrEqualAssertion(ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the normalized form of the provided assertion value, which is best suited for efficiently performing greater than or equal ordering matching operations on that value.
getLessOrEqualAssertion(Schema, ByteSequence) - Method in interface org.forgerock.opendj.ldap.schema.MatchingRuleImpl
Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing less than or equal matching operations on that value.
getLocalAddress() - Method in interface org.forgerock.opendj.io.LdapSocket
Returns the InetSocketAddress associated with the local system.
getLocalAddress() - Method in interface org.forgerock.opendj.ldap.LdapSession
Returns the InetSocketAddress associated with the local system.
getLocalAddress() - Method in class org.forgerock.services.context.ClientContext
Returns the IP address of the interface that received the request.
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.
getLocalityObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the locality Object Class which has the OID 2.5.6.3.
getLocalPort() - Method in class org.forgerock.services.context.ClientContext
Returns the port of the interface that received the request.
getLocation() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
 
getLocation() - Method in interface org.forgerock.audit.secure.KeyStoreHandler
Returns the path to the keystore.
getLocation() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
 
getLocationUri() - Method in class org.forgerock.http.header.LocationHeader
Returns the location URI or null if empty.
getLogDirectory() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
Returns the directory where CSV file is located.
getLogDirectory() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration
Gets the directory where the JSON file is located.
getLogger(Context) - Method in class org.forgerock.openig.decoration.helper.AbstractDecorator
Builds a logger based on the pattern <decoratorClassname>.<decoratorName>.<decoratedObjectName>.
getLoginEndpoint() - Method in class org.forgerock.openig.openam.SsoTokenContext
The login endpoint URI evaluated from SingleSignOnFilter configuration.
getMacAlgorithm() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Gets the Java Cryptographic algorithm name for the algorithm that will generate the MAC key.
getMailAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the mail Attribute Type which has the OID 0.9.2342.19200300.100.1.3.
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.
getManagerAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the manager Attribute Type which has the OID 0.9.2342.19200300.100.1.10.
getMatchedDn() - Method in exception org.forgerock.opendj.ldap.LdapException
Returns the matched DN associated with this result.
getMatchedDn() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getMatchedDn() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getMatchedDn() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getMatchedDn() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getMatchedDn() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getMatchedDn() - Method in interface org.forgerock.opendj.ldap.messages.Result
Returns the matched DN associated with this result.
getMatchedDn() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getMatchedUri() - Method in class org.forgerock.http.routing.UriRouterContext
Returns the portion of the request URI which matched the URI template.
getMatcherType() - Method in class org.forgerock.opendj.ldap.Matcher
Returns the type of this filter Matcher.
getMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Returns the matching rule for this matching rule use.
getMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the matching rule with the specified name or numeric OID.
getMatchingRuleDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Matching Rule Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.30.
getMatchingRuleOid() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Returns the matching rule OID for this schema definition.
getMatchingRules() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the matching rules contained in this schema.
getMatchingRulesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the matchingRules Attribute Type which has the OID 2.5.21.4.
getMatchingRuleUse(MatchingRule) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the matching rule use associated with the provided matching rule, or null if no use is defined.
getMatchingRuleUse(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the matching rule use with the specified name or numeric OID.
getMatchingRuleUseAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the matchingRuleUse Attribute Type which has the OID 2.5.21.8.
getMatchingRuleUseDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Matching Rule Use Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.31.
getMatchingRuleUses() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the matching rule uses contained in this schema.
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.
getMaxIdleExpirationTime() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the max idle expiration time as an Instant.
getMaxIdleExpirationTime() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the max idle expiration time as an Instant.
getMaximumExpectedValue() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
getMaxLifetime() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
Gets the maximum lifetime of a connection in the connection pool.
getMaxNumberOfHistoryFiles() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention
Gets the maximum number of historical log files to retain.
getMaxPoolSize() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
Gets the maximum size of the connection pool.
getMaxSessionExpirationTime() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the max session expiration time as an Instant.
getMaxSessionExpirationTime() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the max session expiration time as an Instant.
getMaxSize() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.EventBufferingConfiguration
Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxSize() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.EventBufferingConfiguration
Returns the maximum size of the queue.
getMaxSize() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration.EventBufferingConfiguration
Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxSize() - Method in class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration.BufferingConfiguration
Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxSize() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.EventBufferingConfiguration
Gets the buffer capacity, which are the maximum number of events that can be buffered.
getMaxTimeout() - Method in class org.forgerock.util.PerItemEvictionStrategyCache
Gets the maximum timeout (can be null).
getMdAlgorithm() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Returns the Java-friendly name of the message digest algorithm implementation.
getMemberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the member Attribute Type which has the OID 2.5.4.31.
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.
getMessage() - Method in exception org.forgerock.opendj.ldap.LdapException
 
getMessage() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Returns acknowledgement message.
getMessageId() - Method in class org.forgerock.opendj.ldap.messages.LdapMessage
Returns the message-id.
getMessageId() - Method in class org.forgerock.opendj.ldap.RequestHandle
Returns the message ID used to send the request.
getMessageObject() - Method in exception org.forgerock.opendj.ldap.DecodeException
 
getMessageObject() - Method in exception org.forgerock.opendj.ldap.LdapException
 
getMessageObject() - Method in exception org.forgerock.opendj.security.LocalizedKeyStoreException
 
getMeters() - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
 
getMeters() - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
getMeters() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
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.
getMinimumExpectedValue() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
getMinor() - Method in class org.forgerock.http.routing.Version
Returns the minor version number.
getMobileAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the mobile Attribute Type which has the OID 0.9.2342.19200300.100.1.41.
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.
getModifications() - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
Returns a List containing the modifications included with this modify request.
getModificationType() - Method in class org.forgerock.opendj.ldap.Modification
Returns the type of modification to be performed.
getModifiersNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the modifiersName Attribute Type which has the OID 2.5.18.4.
getModifyTimestampAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the modifyTimestamp Attribute Type which has the OID 2.5.18.2.
getModulus() - Method in class org.forgerock.json.jose.jwk.RsaJWK
Get the RSA modulus value.
getName() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler
Gets the name of this audit event handler.
getName() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
 
getName() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration
Returns the name of this handler.
getName() - Method in class org.forgerock.http.header.AcceptApiVersionHeader
 
getName() - Method in class org.forgerock.http.header.AcceptLanguageHeader
 
getName() - Method in class org.forgerock.http.header.AuthorizationHeader
 
getName() - Method in class org.forgerock.http.header.ConnectionHeader
 
getName() - Method in class org.forgerock.http.header.ContentApiVersionHeader
 
getName() - Method in class org.forgerock.http.header.ContentEncodingHeader
 
getName() - Method in class org.forgerock.http.header.ContentLengthHeader
 
getName() - Method in class org.forgerock.http.header.ContentTypeHeader
 
getName() - Method in class org.forgerock.http.header.CookieHeader
 
getName() - Method in class org.forgerock.http.header.Directive
Represents the directive name.
getName() - Method in class org.forgerock.http.header.GenericHeader
 
getName() - Method in class org.forgerock.http.header.LocationHeader
 
getName() - Method in class org.forgerock.http.header.ReferrerHeader
 
getName() - Method in class org.forgerock.http.header.SetCookie2Header
 
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.header.WwwAuthenticateHeader
 
getName() - Method in class org.forgerock.http.protocol.Cookie
Returns name of the cookie.
getName() - Method in class org.forgerock.http.protocol.Header
Returns the name of the header, as it would canonically appear within an HTTP message.
getName() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Gets the full name of the encryption method.
getName() - Method in enum org.forgerock.json.jose.jwk.KeyOperation
Get the Value of the KeyOperation.
getName() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
getName() - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
getName() - Method in class org.forgerock.opendj.ldap.Entries.NullEntry
 
getName() - Method in interface org.forgerock.opendj.ldap.Entry
Returns the string representation of the distinguished name of this entry.
getName() - Method in class org.forgerock.opendj.ldap.LdapUrl
Returns the distinguished name of the base entry relative to which the search is to be performed.
getName() - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
getName() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns the name of the Directory object that the client wishes to bind as.
getName() - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Returns the distinguished name of the entry to be compared.
getName() - Method in interface org.forgerock.opendj.ldap.messages.DeleteRequest
Returns the distinguished name of the entry to be deleted.
getName() - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Returns the distinguished name of the entry to be renamed.
getName() - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
Returns the distinguished name of the entry to be modified.
getName() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Returns the distinguished name of the base entry relative to which the search is to be performed.
getName() - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
getName() - Method in class org.forgerock.opendj.ldap.ResultCode
Returns the short human-readable name of this result code.
getName() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Retrieves the name for this attribute syntax.
getName() - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Retrieves the common name for this attribute syntax.
getName() - Method in interface org.forgerock.opendj.ldap.spi.Provider
Returns the name of this provider.
getName() - Method in interface org.forgerock.opendj.ldif.ChangeRecord
Returns the distinguished name of the entry being modified by this ChangeRecord.
getName() - Method in interface org.forgerock.openig.decoration.Context
Returns the name of the heap object being decorated.
getName() - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration
Returns the name of this client registration.
getName() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns the name of this issuer.
getName() - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
 
getName() - Method in interface org.forgerock.openig.heap.Heap
Returns the name of this heap.
getName() - Method in class org.forgerock.openig.heap.HeapImpl
 
getName() - Method in class org.forgerock.openig.http.CookieBuilder
The name of the cookie that will be built from this CookieBuilder.
getName() - Method in class org.forgerock.openig.tools.am.Realm
Returns the fully qualified realm's name: '/finances/employees' The returned name always starts with /, and never ends with /.
getNameAndOptionalUIDSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Name and Optional UID Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.34.
getNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the name Attribute Type which has the OID 2.5.4.41.
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
 
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
 
getNamed(Purpose<S>, String) - Method in interface org.forgerock.secrets.SecretStore
Returns the named secret from this store.
getNamed(Purpose<S>, String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
getNamedOrValidSecrets(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
 
getNamedOrValidSecrets(Purpose<S>, String) - Method in class org.forgerock.secrets.SecretsProvider
If the given id is not null, then this returns the single named secret that corresponds to that stable id (or a stream of valid secrets for the given purpose if no such secret exists), otherwise it returns all valid secrets for the given purpose.
getNamedSecret(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.DefaultSecretsService
 
getNamedSecret(Purpose<S>, String) - Method in interface org.forgerock.openig.secrets.SecretsService
Gets the secret for the given purpose with the given stable secret id.
getNamedSecret(Purpose<S>, String) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
 
getNamedSecret(Purpose<S>, String) - Method in class org.forgerock.secrets.SecretsProvider
Gets the secret for the given purpose with the given stable secret id.
getNameForm() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Retrieves the name form for this DIT structure rule.
getNameForm(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the name form with the specified name or numeric OID.
getNameFormDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Name Form Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.35.
getNameForms() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the name forms contained in this schema.
getNameForms(ObjectClass) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the name forms associated with the provided structural object class.
getNameFormsAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the nameForms Attribute Type which has the OID 2.5.21.7.
getNameOrOid() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the name or OID for this schema definition.
getNameOrOid() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns the name or structural class OID for this schema definition.
getNameOrOid() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the name or OID for this schema definition.
getNameOrOid() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Returns the name or matching rule OID for this schema definition.
getNameOrOid() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns the name or numeric OID of this name form.
getNameOrOid() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns the name or OID for this schema definition.
getNameOrRuleId() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Retrieves the name or rule ID for this schema definition.
getNames() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
getNames() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
getNames() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
getNames() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
getNames() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
getNames() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns an unmodifiable list containing the user-friendly names that may be used to reference this name form.
getNames() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
getNamingContexts() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of DNs identifying the context prefixes of the naming contexts that the Directory Server masters or shadows (in part or in whole).
getNamingContextsAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the namingContexts Attribute Type which has the OID 1.3.6.1.4.1.1466.101.120.5.
getNewPassword() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Returns the desired password for the user, or null if a new password should be generated.
getNewRdn() - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Returns the new RDN of the entry to be renamed.
getNewResourceId() - Method in interface org.forgerock.json.resource.CreateRequest
Returns the client provided ID of the resource to be created.
getNewSuperior() - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Returns the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.
getNextFile() - Method in class org.forgerock.audit.rotation.RotationContext
Get the next file.
getNextName() - Method in interface org.forgerock.audit.retention.FileNamingPolicy
Gets the next name to use.
getNextName() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy
Gets the next name for this FileNamingPolicy.
getNonEmptyPath(MutableUri) - Static method in class org.forgerock.openig.websocket.UriUtils
Returns / when the given uri has no path component, returns the uri path otherwise.
getNotBeforeTime() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Gets the time the JWT is not allowed to be processed before, from the Claims Set.
getNotificationService() - Method in class org.forgerock.openig.tools.am.AmService
Returns the AM notification service.
getNotPresent(String, String) - Static method in class org.forgerock.json.resource.AdviceWarning
Convenience method to quickly generate frequently-used error type: 100.
getNotSubFilter() - Method in class org.forgerock.opendj.ldap.Filter
Returns the sub-filter for this NOT filter.
getNotSubMatcher() - Method in class org.forgerock.opendj.ldap.Matcher
Returns the sub-matcher for this NOT filter Matcher.
getNumberOfRequests() - Method in class org.forgerock.http.filter.throttling.ThrottlingRate
Returns the maximum of requests that can be filtered out during the duration.
getNumericStringMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the numericStringMatch Matching Rule which has the OID 2.5.13.8.
getNumericStringOrderingMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the numericStringOrderingMatch Matching Rule which has the OID 2.5.13.9.
getNumericStringSubstringsMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the numericStringSubstringsMatch Matching Rule which has the OID 2.5.13.10.
getNumericStringSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Numeric String Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.36.
getNumSubordinatesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the numSubordinates Attribute Type which has the OID 1.3.6.1.4.1.453.16.2.103.
getOAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the o Attribute Type which has the OID 2.5.4.10.
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
 
getObjectClass(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the object class with the specified name or numeric OID.
getObjectClassAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the objectClass Attribute Type which has the OID 2.5.4.0.
getObjectClassDescriptionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Object Class Description Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.37.
getObjectClasses(Entry) - Static method in class org.forgerock.opendj.ldap.Entries
Returns an unmodifiable set containing the object classes associated with the provided entry.
getObjectClasses(Entry, Schema) - Static method in class org.forgerock.opendj.ldap.Entries
Returns an unmodifiable set containing the object classes associated with the provided entry.
getObjectClasses() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the object classes contained in this schema.
getObjectClasses() - Static method in class org.forgerock.opendj.security.OpenDjSecurityProviderSchema
Returns the set of LDAP object classes required in order to support the OpenDJ security provider.
getObjectClassesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the objectClasses Attribute Type which has the OID 2.5.21.6.
getObjectClassType() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns the objectclass type for this objectclass.
getObjectIdentifierFirstComponentMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the objectIdentifierFirstComponentMatch Matching Rule which has the OID 2.5.13.30.
getObjectIdentifierMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the objectIdentifierMatch Matching Rule which has the OID 2.5.13.0.
getOctetStringMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the octetStringMatch Matching Rule which has the OID 2.5.13.17.
getOctetStringOrderingMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the octetStringOrderingMatch Matching Rule which has the OID 2.5.13.18.
getOctetStringSubstringsMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the octetStringSubstringsMatch Matching Rule which has the OID 2.5.13.19.
getOctetStringSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Octet String Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.40.
getOffset() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns the positional offset of the target entry in the result set, if applicable, where 1 is the first entry.
getOid() - Method in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
 
getOid() - Method in interface org.forgerock.opendj.ldap.controls.Control
Returns the numeric OID associated with this control.
getOid() - Method in interface org.forgerock.opendj.ldap.controls.ControlDecoder
Returns the numeric OID associated with this control decoder.
getOid() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.GenericControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
 
getOid() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
 
getOid() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
 
getOid() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedResult
 
getOid() - Method in class org.forgerock.opendj.ldap.messages.AbstractIntermediateResponse
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
Returns the numeric OID associated with this extended request.
getOid() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
Returns the numeric OID, if any, associated with this extended result.
getOid() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.IntermediateResponse
Returns the numeric OID, if any, associated with this intermediate response.
getOid() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
getOid() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getOid() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the OID for this schema definition.
getOid() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the OID for this schema definition.
getOid() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns the numeric OID of this name form.
getOid() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns the OID for this schema definition.
getOid() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Retrieves the OID for this attribute syntax.
getOIDSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the OID Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.38.
getOldPassword() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Returns the current password for the user, if known.
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.
getOption(Option<T>) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the value associated to the provided Option or the option default value, if there is no such option in this schema.
getOptionalAttributes() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns an unmodifiable set containing the optional attributes for this DIT content rule.
getOptionalAttributes() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns an unmodifiable set containing the optional attributes of this name form.
getOptionalAttributes() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns an unmodifiable set containing the optional attributes for this object class and any superior object classes that it might have.
getOptions() - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
getOptions() - Method in interface org.forgerock.opendj.io.LdapSocketAcceptor
Returns a copy of the options currently used by this LDAP listener.
getOptions() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an Iterable containing the options contained in this attribute description.
getOptions() - Method in class org.forgerock.opendj.ldap.LdapServer
Returns a copy of the options currently used by this LDAP listener.
getOrderingMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the matching rule that should be used for ordering with this attribute type.
getOrderingMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Retrieves the default ordering matching rule that will be used for attributes with this syntax.
getOrderingMatchingRule() - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Retrieves the default ordering matching rule that will be used for attributes with this syntax.
getOrderingMatchingRule() - Method in class org.forgerock.opendj.ldap.SortKey
Returns the name or OID of the ordering matching rule, if specified, which should be used when comparing attributes using this sort key.
getOrganizationalPersonObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the organizationalPerson Object Class which has the OID 2.5.6.7.
getOrganizationalRoleObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the organizationalRole Object Class which has the OID 2.5.6.8.
getOrganizationalStatusAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the organizationalStatus Attribute Type which has the OID 0.9.2342.19200300.100.1.45.
getOrganizationalUnitObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the organizationalUnit Object Class which has the OID 2.5.6.5.
getOrganizationObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the organization Object Class which has the OID 2.5.6.4.
getOriginalUri() - Method in class org.forgerock.http.routing.UriRouterContext
Get the original URI.
getOriginalValue() - Method in class org.forgerock.http.header.Directive
Represents the original directive value and in quotes if it was originally quoted.
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
 
getOtherMailboxSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Other Mailbox Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.39.
getOtherPrimesInfo() - Method in class org.forgerock.json.jose.jwk.RsaJWK
Get the RSA other factors value.
getOUAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the ou Attribute Type which has the OID 2.5.4.11.
getOut() - Method in class org.forgerock.http.io.PipeBufferedStream
Returns the input stream which reads from the pipe.
getOwnerAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the owner Attribute Type which has the OID 2.5.4.32.
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.
getPagerAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the pager Attribute Type which has the OID 0.9.2342.19200300.100.1.42.
getPageSize() - Method in interface org.forgerock.json.resource.QueryRequest
Returns the requested page results page size or 0 if paged results are not required.
getPairComparator() - Static method in class org.forgerock.util.Pair
Returns a comparator for Pairs of comparable objects.
getParameter(String) - Method in class org.forgerock.json.jose.jwe.JweHeader
 
getParameter(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets a header parameter for the specified key.
getParameter(String) - Method in class org.forgerock.json.jose.jwt.JwtHeader
Gets a header parameter for the specified key.
getParameter(String, 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 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.
getParameterSpec() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Gets any parameter spec associated with this algorithm.
getParams() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
getParams() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
 
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.
getPassword() - Method in class org.forgerock.http.header.authorization.BasicCredentials
Get the password.
getPasswordSecretIdOrPassword(SecretsService, JsonValue, JsonValue, Logger) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Retrieve a required password value from the given secretIdNode and deprecatedNode nodes.
getPasswordSecretIdOrPassword(SecretsService, JsonValue, JsonValue, Logger, boolean) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Retrieve a password value from the given secretIdNode and deprecatedNode nodes (can be an optional value).
getPasswordSecretIdOrPasswordAsByte(SecretsService, JsonValue, JsonValue, Logger) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Retrieve a required shared secret value (as byte[]) from the given secretIdNode and deprecatedNode nodes.
getPatchOperations() - Method in interface org.forgerock.json.resource.PatchRequest
Returns the list of patch operations which should be performed against the targeted resource.
getPath() - Method in class org.forgerock.http.MutableUri
Returns the path element.
getPath() - Method in class org.forgerock.http.protocol.Cookie
Returns the subset of URLs on the origin server to which this cookie applies.
getPath() - Method in class org.forgerock.json.resource.http.HttpContext
Returns the HTTP request path.
getPath(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.
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.
getPeerAddress() - Method in interface org.forgerock.opendj.ldap.LdapSession
Returns the InetSocketAddress associated with the remote system.
getPercentiles() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
getPeriodMillis() - Method in class org.forgerock.opendj.ldap.TimeoutScheduler
Returns the period in milliseconds between successive task invocations.
getPermissionEndpoint() - Method in class org.forgerock.openig.uma.UmaSharingService
Returns the UMA Permission Request endpoint Uri.
getPersonalTitleAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the personalTitle Attribute Type which has the OID 0.9.2342.19200300.100.1.40.
getPersonObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the person Object Class which has the OID 2.5.6.6.
getPhysicalDeliveryOfficeNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the physicalDeliveryOfficeName Attribute Type which has the OID 2.5.4.19.
getPkiCaObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the pkiCA Object Class which has the OID 2.5.6.22.
getPkiUserObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the pkiUser Object Class which has the OID 2.5.6.21.
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.
getPort() - Method in class org.forgerock.opendj.ldap.LdapUrl
Returns the port number of the LDAP server referenced by this LDAP URL.
getPort(String, int) - Static method in class org.forgerock.openig.websocket.UriUtils
Returns the default's protocol port if not set in the given URI scheme, the URI port otherwise.
getPostalAddressAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the postalAddress Attribute Type which has the OID 2.5.4.16.
getPostalAddressSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Postal Address Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.41.
getPostalCodeAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the postalCode Attribute Type which has the OID 2.5.4.17.
getPostOfficeBoxAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the postOfficeBox Attribute Type which has the OID 2.5.4.18.
getPreferredDeliveryMethodAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the preferredDeliveryMethod Attribute Type which has the OID 2.5.4.28.
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
 
getPresentationAddressMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the presentationAddressMatch Matching Rule which has the OID 2.5.13.22.
getPresentationAddressSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Presentation Address Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.43.
getPreviousName() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
Returns the distinguished name that the entry had prior to a modify DN operation, or null if the operation was not a modify DN.
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.
getPrintableStringSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Printable String Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.44.
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.
getProhibitedAttributes() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns an unmodifiable set containing the prohibited attributes for this DIT content rule.
getProperties() - Method in class org.forgerock.openig.heap.EnvironmentHeap
 
getProperties() - Method in interface org.forgerock.openig.heap.Heap
Returns the properties from this heap and its parents if any.
getProperties() - Method in class org.forgerock.openig.heap.HeapImpl
 
getProperties() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the unmodifiable map of properties bound to the session (can be empty, but never null).
getProperties() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the unmodifiable map of properties bound to the session (can be empty, but never null).
getProperties() - Method in class org.forgerock.security.keystore.MapKeyStoreParameters
Return the properties used to configure the keystore.
getProperty(String) - Method in class org.forgerock.config.resolvers.ChainedPropertyResolver
 
getProperty(String) - Method in class org.forgerock.config.resolvers.EnvironmentVariableResolver
 
getProperty(String) - Method in class org.forgerock.config.resolvers.FlatFileResolver
 
getProperty(String) - Method in class org.forgerock.config.resolvers.JsonValueResolver
 
getProperty(String) - Method in class org.forgerock.config.resolvers.ProductPathResolver
 
getProperty(String) - Method in class org.forgerock.config.resolvers.PropertiesResolver
 
getProperty(String) - Method in interface org.forgerock.config.resolvers.PropertyResolver
Returns the value of the specified property.
getProperty(String, String) - Method in interface org.forgerock.config.resolvers.PropertyResolver
Returns the value of the specified property.
getProperty(String) - Method in class org.forgerock.config.resolvers.SystemPropertyResolver
 
getProperty(String) - Method in class org.forgerock.openig.heap.ExpressionPropertyResolver
 
getPropertyType(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.events.AuditEventHelper
Gets a AuditEvent property type.
getProtectionParameter() - Method in class org.forgerock.opendj.security.KeyStoreParameters
 
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.
getProtocolInformationMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the protocolInformationMatch Matching Rule which has the OID 2.5.13.24.
getProtocolInformationSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Protocol Information Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.42.
getProtocolOp() - Method in class org.forgerock.opendj.ldap.messages.LdapMessage
Returns the protocol-op contained in this message.
getProtocolOperationType() - Method in enum org.forgerock.opendj.ldap.messages.Request.RequestType
Returns the protocol operation type.
getProtocolOpType() - Method in class org.forgerock.opendj.ldap.messages.LdapMessage
Returns the protocol-op type.
getProtocolOpType() - Method in class org.forgerock.opendj.ldap.messages.UnknownRequest
Returns the LDAP protocol-op type.
getProtocolScheme() - Method in enum org.forgerock.opendj.ldap.ConnectionSecurity
Returns the protocol scheme associated to this connection security.
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.
getProtocolVersion() - Method in class org.forgerock.opendj.io.LdapWriter
Returns the protocol version supported by this LdapWriter.
getProvider() - Method in class org.forgerock.secrets.SecretBuilder
Returns the security provider associated with this secret, or null if not specified.
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.opendj.ldap.LdapServer
Returns the name of the transport provider, which provides the implementation of this factory.
getProviderName() - Method in exception org.forgerock.opendj.ldap.ProviderNotFoundException
Returns the name of provider.
getProviderName() - Method in class org.forgerock.security.keystore.KeyStoreConfiguration
The provider string name (LDAP, JKS, etc.).
getProviderType() - Method in exception org.forgerock.opendj.ldap.ProviderNotFoundException
Returns the type of provider.
getProxyUri() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo
Returns the URI of the proxy.
getPublicExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK
Get the RSA Public Exponent.
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.EcJWK
 
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.JWK
Return a builder with all the values set for representing the public components of the JWK.
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.OctJWK
 
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.OkpJWK
 
getPublicJwkBuilder() - Method in class org.forgerock.json.jose.jwk.RsaJWK
 
getPublicKey(KeyStore, String, String) - Static method in class org.forgerock.openig.util.KeyStoreUtil
Retrieve the public key from the keystore: it could be a certificate or a symmetric key.
getPublicKey(Class<T>) - Method in class org.forgerock.secrets.keys.CryptoKey
Returns the public key associated with this secret, if one is available.
getPublicKey() - Method in class org.forgerock.secrets.keys.CryptoKey
Returns the public key associated with this secret, if one is available.
getPublicKey() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails
Get the PublicKey component of this key.
getPublicKey() - Method in class org.forgerock.secrets.SecretBuilder
Returns the public key associated with this secret, or null if not available.
getPublicKey(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.
getPurpose() - Method in exception org.forgerock.secrets.NoSuchSecretException
Returns the purpose for which no secret was found.
getQuery() - Method in class org.forgerock.http.MutableUri
Returns the path element.
getQueryExpression() - Method in interface org.forgerock.json.resource.QueryRequest
Returns the native query expression which will be used for processing the query request.
getQueryFilter() - Method in interface org.forgerock.json.resource.QueryRequest
Returns the query filter which will be used for selecting which JSON resources will be returned.
getQueryId() - Method in interface org.forgerock.json.resource.QueryRequest
Returns the query identifier for pre-defined queries.
getQuote() - Method in class org.forgerock.openig.text.Separator
Returns the character used to quote string literals, or -1 if none.
getQuoteChar() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvFormatting
Gets the character to use to quote the csv entries.
getRaw() - Method in class org.forgerock.openig.openam.CapturedUserPasswordContext
The bytes of the decrypted password.
getRawAuthority() - Method in class org.forgerock.http.MutableUri
Returns the raw (encoded) authority compound element.
getRawContentInputStream() - Method in class org.forgerock.http.protocol.Entity
Returns an input stream representing the raw content of this entity.
getRawData() - Method in class org.forgerock.secrets.SecretBuilder
Returns the raw secret data, or null if the raw data is not available.
getRawDn() - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
Returns the unparsed DN.
getRawFragment() - Method in class org.forgerock.http.MutableUri
Returns the raw (encoded) fragment element.
getRawInfo() - Method in class org.forgerock.openig.openam.UserProfileContext
Returns the unmodifiable Map of the user profile info, not null.
getRawInfo() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the session info for the given SSO Token as JsonValue if any, or null if none.
getRawPath() - Method in class org.forgerock.http.MutableUri
Returns the raw (encoded) path element.
getRawProtocolOp() - Method in class org.forgerock.opendj.ldap.messages.UnknownRequest
Returns the unparsed protocol-op bytes.
getRawQuery() - Method in class org.forgerock.http.MutableUri
Returns the raw (encoded) query element.
getRawUserInfo() - Method in class org.forgerock.http.MutableUri
Returns the raw (encoded) user info element.
getRawValue() - Method in class org.forgerock.http.header.AuthorizationHeader
Get the raw value of the header.
getReader(byte[]) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided byte array and having an unlimited maximum BER element size.
getReader(byte[], int) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided byte array and having a user defined maximum BER element size.
getReader(ByteSequence) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided byte sequence and having an unlimited maximum BER element size.
getReader(ByteSequence, int) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided byte sequence and having a user defined maximum BER element size.
getReader(ByteSequenceReader) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided byte sequence reader and having an unlimited maximum BER element size.
getReader(ByteSequenceReader, int) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided byte sequence reader and having a user defined maximum BER element size.
getReader(InputStream) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided input stream and having an unlimited maximum BER element size.
getReader(InputStream, int) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 reader whose source is the provided input stream and having a user defined maximum BER element size.
getReader(R, DecodeOptions) - Static method in class org.forgerock.opendj.io.Ldap
Creates a new LDAP reader which will read LDAP messages from an ASN.1 reader using the provided decoding options.
getRealm() - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns the scope of protection required to access the protected resource.
getRealm() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the realm as specified by Access Management.
getRealm() - Method in class org.forgerock.openig.openam.UserProfileContext
Get the user's realm or null if none.
getRealm() - Method in class org.forgerock.openig.tools.am.AmService
Returns the realm to use with this configuration.
getRealm() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the realm as specified by Access Management.
getRealm() - Method in class org.forgerock.openig.tools.userprofile.UserProfile
Get the user's realm or null if none.
getReason() - Method in exception org.forgerock.json.resource.ResourceException
Returns the short reason phrase of the exception.
getReason() - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
Returns the reason why this request is invalid.
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.
getRedirectEndpoint() - Method in class org.forgerock.openig.openam.CdSsoContext
Configured redirect endpoint URI used in AM communication.
getReference() - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
Returns the reference to the pointed schema.
getReference() - Method in exception org.forgerock.opendj.ldap.SearchResultReferenceIOException
Returns the SearchResultReference which was encountered while processing the search results.
getReferralUris() - Method in exception org.forgerock.opendj.ldap.LdapException
Returns a List containing the referral URIs included with this result.
getReferralUris() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getReferralUris() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getReferralUris() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getReferralUris() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getReferralUris() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getReferralUris() - Method in interface org.forgerock.opendj.ldap.messages.Result
Returns a List containing the referral URIs included with this result.
getReferralUris() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getRegisteredAddressAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the registeredAddress Attribute Type which has the OID 2.5.4.26.
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 interface org.forgerock.opendj.io.LdapSocket
Returns the InetSocketAddress associated with the remote system.
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.http.ContextAndRequest
Returns the request.
getRequestId() - Method in interface org.forgerock.opendj.ldap.LdapPromise
Returns the request ID of the request if appropriate.
getRequestId() - Method in interface org.forgerock.opendj.ldap.messages.AbandonRequest
Returns the request ID of the request to be abandoned.
getRequestId() - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
Returns the request ID of the request to be abandoned.
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
 
getRequiredAttributes() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns an unmodifiable set containing the required attributes for this DIT content rule.
getRequiredAttributes() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns an unmodifiable set containing the required attributes of this name form.
getRequiredAttributes() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns an unmodifiable set containing the required attributes for this object class and any superior object classes that it might have.
getRequiredScopes(Context, Request) - Method in interface org.forgerock.http.oauth2.ResourceAccess
Returns the scopes required to access the resource.
getRequiredScopes(Context, Request) - Method in class org.forgerock.openig.filter.oauth2.ScriptableResourceAccess
 
getResidentialPersonObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the residentialPerson Object Class which has the OID 2.5.6.10.
getResource(String) - Static method in class org.forgerock.http.util.Loader
Finds the resource with the given name.
getResourceApiVersion() - Method in exception org.forgerock.json.resource.ResourceException
 
getResourceApiVersion() - Method in interface org.forgerock.json.resource.Response
Gets the API version of the resource that the request was routed to.
getResourcePath() - Method in interface org.forgerock.json.resource.ActionRequest
 
getResourcePath() - Method in interface org.forgerock.json.resource.CreateRequest
Returns the path of the JSON resource container beneath which the new resource should be created.
getResourcePath() - Method in interface org.forgerock.json.resource.DeleteRequest
 
getResourcePath() - Method in interface org.forgerock.json.resource.PatchRequest
 
getResourcePath() - Method in interface org.forgerock.json.resource.QueryRequest
 
getResourcePath() - Method in interface org.forgerock.json.resource.ReadRequest
 
getResourcePath() - Method in interface org.forgerock.json.resource.Request
Returns the non-null path of the JSON resource to which this request should be targeted.
getResourcePath() - Method in interface org.forgerock.json.resource.UpdateRequest
 
getResourcePathObject() - Method in interface org.forgerock.json.resource.ActionRequest
 
getResourcePathObject() - Method in interface org.forgerock.json.resource.CreateRequest
 
getResourcePathObject() - Method in interface org.forgerock.json.resource.DeleteRequest
 
getResourcePathObject() - Method in interface org.forgerock.json.resource.PatchRequest
 
getResourcePathObject() - Method in interface org.forgerock.json.resource.QueryRequest
 
getResourcePathObject() - Method in interface org.forgerock.json.resource.ReadRequest
 
getResourcePathObject() - Method in interface org.forgerock.json.resource.Request
Returns the non-null path of the JSON resource to which this request should be targeted.
getResourcePathObject() - Method in interface org.forgerock.json.resource.UpdateRequest
 
getResourceResponse() - Method in class org.forgerock.json.resource.IdentifierQueryResourceHandler
Gets the ResourceResponse query result.
getResourceVersion() - Method in class org.forgerock.http.header.AcceptApiVersionHeader
Gets the acceptable resource version.
getResourceVersion() - Method in class org.forgerock.http.header.ContentApiVersionHeader
Gets the resource version of the returned content.
getResourceVersion() - Method in class org.forgerock.http.routing.ApiVersionRouterContext
Gets the API version of the resource that the request was routed to.
getResourceVersion() - Method in interface org.forgerock.json.resource.ActionRequest
 
getResourceVersion() - Method in interface org.forgerock.json.resource.CreateRequest
 
getResourceVersion() - Method in interface org.forgerock.json.resource.DeleteRequest
 
getResourceVersion() - Method in interface org.forgerock.json.resource.PatchRequest
 
getResourceVersion() - Method in interface org.forgerock.json.resource.QueryRequest
 
getResourceVersion() - Method in interface org.forgerock.json.resource.ReadRequest
 
getResourceVersion() - Method in interface org.forgerock.json.resource.Request
Gets the requested API version of the resource.
getResourceVersion() - Method in interface org.forgerock.json.resource.UpdateRequest
 
getResponse() - Method in exception org.forgerock.http.protocol.ResponseException
Returns the response associated to this exception.
getResult() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
Returns a result code indicating the outcome of the server-side sort request.
getResult() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
Returns result code indicating the outcome of the virtual list view request.
getResult() - Method in exception org.forgerock.opendj.ldap.LdapException
Returns the error result which caused this exception to be thrown.
getResultCode() - Method in exception org.forgerock.opendj.ldap.LdapException
Returns the result code associated with this result.
getResultCode() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
getResultCode() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
getResultCode() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
getResultCode() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getResultCode() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getResultCode() - Method in interface org.forgerock.opendj.ldap.messages.Result
Returns the result code associated with this result.
getResultCode() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getResultDecoder() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
 
getResultDecoder() - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
getResultDecoder() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
Returns a decoder which can be used to decoded responses to this extended request.
getResultDecoder() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
getResultDecoder() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
getResultDecoder() - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
getResultDecoder() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
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.
getRFc822localPartObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the rFC822localPart Object Class which has the OID 0.9.2342.19200300.100.4.14.
getRoleOccupantAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the roleOccupant Attribute Type which has the OID 2.5.4.33.
getRoomNumberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the roomNumber Attribute Type which has the OID 0.9.2342.19200300.100.1.6.
getRoomObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the room Object Class which has the OID 0.9.2342.19200300.100.4.7.
getRootId() - Method in class org.forgerock.services.context.AbstractContext
 
getRootId() - Method in interface org.forgerock.services.context.Context
Returns the unique ID of the root context, usually a UUID.
getRotationFilePrefix() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Gets the prefix to add to a log file on rotation.
getRotationFileSuffix() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Gets the suffix to add to a log file on rotation.
getRotationInterval() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Gets the interval to trigger a file rotation.
getRotationInterval() - Method in class org.forgerock.audit.rotation.TimeLimitRotationPolicy
Gets the rotation duration interval.
getRotationRetentionCheckInterval() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
Gets the interval to check time-based file rotation policies.
getRotationTimes() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Gets a list of times at which file rotation should be triggered; times should be provided as Strings that can be parsed by Duration that each specify an offset from midnight.
getRoutes() - Method in class org.forgerock.services.routing.AbstractRouter
Gets all registered routes on this router.
getRuleId() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Retrieves the rule ID for this DIT structure rule.
getS() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
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.
getSameSite() - Method in class org.forgerock.http.protocol.Cookie
Returns the value of the SameSite attribute.
getSaslClient() - Method in interface org.forgerock.opendj.io.LdapSocket
Returns the SaslClient currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.
getSaslClient() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns the SaslClient that will be responsible for continuing the SASL challenge-response sequence as well as potentially installing a SASL security layer once the bind sequence completes, or null if a no SaslClient has been provided.
getSaslCredentials() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns a defensive copy of the optional SASL credentials, or null if the authentication type is not BindRequest.AUTHENTICATION_TYPE_SASL or if the SASL credentials are not present.
getSaslMechanism() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns the name of the SASL mechanism, e.g.
getSaslServer() - Method in interface org.forgerock.opendj.io.LdapSocket
Returns the SaslServer currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.
getSaslServer() - Method in interface org.forgerock.opendj.ldap.LdapSession
Returns the SaslServer currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.
getSaslServer() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
Returns the SaslServer to use by the underlying connection, or null if SASL integrity and/or privacy protection must not be enabled.
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.
getSchemaLdifResource() - Static method in class org.forgerock.opendj.security.OpenDjSecurityProviderSchema
Returns a URL referencing a resource containing the LDIF schema that is required in order to support the OpenDJ security provider.
getSchemaName() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the user-friendly name of this schema which may be used for debugging purposes.
getSchemaResolver() - Method in class org.forgerock.opendj.ldap.DecodeOptions
Returns the strategy for selecting which Schema should be used for decoding distinguished names, attribute descriptions, and other objects which require a Schema in order to be decoded.
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.opendj.ldap.LdapUrl
Returns the search scope associated with this LDAP URL.
getScope() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Returns the scope of the search.
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.
getSearchGuideAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the searchGuide Attribute Type which has the OID 2.5.4.14.
getSecond() - Method in class org.forgerock.util.Pair
Returns the second element of this pair.
getSecondsUntilExpiration() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
Returns the length of time in seconds until the password actually expires.
getSecretaryAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the secretary Attribute Type which has the OID 0.9.2342.19200300.100.1.21.
getSecretId() - Method in exception org.forgerock.secrets.NoSuchSecretException
Returns the stable id of the secret that was not found, or null if not specified.
getSecretKey() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.KeyDetails
Get the Key instance for the secret component of this key.
getSecretKey() - Method in class org.forgerock.secrets.SecretBuilder
Returns the secret (or private) key associated with this secret, or null if not specified.
getSecretService() - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns the SecretsService from the heap.
getSecretType() - Method in class org.forgerock.secrets.Purpose
Returns the type of secrets that this purpose requires.
getSecureStorage(String) - Method in class org.forgerock.audit.providers.DefaultSecureStorageProvider
 
getSecureStorage(String) - Method in interface org.forgerock.audit.providers.SecureStorageProvider
Returns the secure storage corresponding to the given name.
getSecurity() - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration
Returns the CSV tamper evident options.
getSecurityStrengthFactor() - Method in interface org.forgerock.opendj.ldap.LdapSession
Returns the cipher strength, in bits, currently in use by the underlying connection.
getSeeAlsoAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the seeAlso Attribute Type which has the OID 2.5.4.34.
getSegments() - Method in class org.forgerock.openig.tools.am.Realm
Returns the unmodifiable list of the segments composing the realm.
getSelfApiHandler() - Method in class org.forgerock.http.routing.Router
 
getSelfApiHandler() - Method in class org.forgerock.json.resource.Router
 
getSelfApiHandler() - Method in class org.forgerock.services.routing.AbstractRouter
Return a Describable handler that returns this AbstractRouter's internal api description from the Describable.handleApiRequest(Context, Object) method.
getSeparator() - Method in enum org.forgerock.openig.text.Separators
Returns the Separator specification that the enum constant represents.
getSerialNumberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the serialNumber Attribute Type which has the OID 2.5.4.5.
getServerSaslCredentials() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
Returns the server SASL credentials associated with this bind result.
getSession() - Method in class org.forgerock.http.session.SessionContext
Returns the Session associated with the remote client.
getSessionHandle() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the session handle, which may be used to logout of the session.
getSessionHandle() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the session handle, which may be used to logout of the session.
getSessionInfo(Context, String) - Method in class org.forgerock.openig.tools.session.CacheSessionService
 
getSessionInfo(Context, String) - Method in class org.forgerock.openig.tools.session.CrestSessionService
 
getSessionInfo(Context, String) - Method in interface org.forgerock.openig.tools.session.SessionService
Returns a promise that will be completed with an optional SessionInfo or with an SessionException in case of errors.
getSessionMode() - Method in class org.forgerock.audit.handlers.jms.JmsAuditEventHandlerConfiguration
Returns the mode that the JMS session should use when publishing the JMS messages.
getSessionService() - Method in class org.forgerock.openig.tools.am.AmService
Returns the SessionService for this server.
getSessionUid() - Method in class org.forgerock.openig.openam.CdSsoContext
Get the ForgeRock session uid.
getSeverityFieldMappings() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration
Returns the configurations for mapping audit event field values to Syslog severity values.
getShare(String) - Method in class org.forgerock.openig.uma.UmaSharingService
Returns the Share with the given id.
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.
getSignature(String) - Method in class org.forgerock.secrets.keys.SigningKey
Returns s signature object initialised for signing.
getSignature() - Method in class org.forgerock.secrets.keys.SigningKey
Returns an initialised signature object for a default signature algorithm for this key type.
getSignature(String) - Method in class org.forgerock.secrets.keys.VerificationKey
Returns a signature object initialised for verification.
getSignature() - Method in class org.forgerock.secrets.keys.VerificationKey
Returns a signature object initialised for verification using a default algorithm for this key type.
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.
getSimplePassword() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns a defensive copy of the simple bind password, or null if the authentication type is not BindRequest.AUTHENTICATION_TYPE_SIMPLE.
getSimpleSecurityObjectObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the simpleSecurityObject Object Class which has the OID 0.9.2342.19200300.100.4.19.
getSize() - Method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
Returns the requested page size when used in a request control from the client, or an estimate of the result set size when used in a response control from the server (may be 0, indicating that the server does not know).
getSizeLimit() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Returns the size limit that should be used in order to restrict the maximum number of entries returned by the search.
getSlaBoundaries() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
getSNAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the sn Attribute Type which has the OID 2.5.4.4.
getSocketAddresses() - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
getSocketAddresses() - Method in interface org.forgerock.opendj.io.LdapSocketAcceptor
Returns the addresses that this LDAP socket acceptor is listening on.
getSocketAddresses() - Method in class org.forgerock.opendj.ldap.LdapServer
Returns the addresses that this LDAP listener is listening on.
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.
getSortKeys() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
Returns an unmodifiable list containing the sort keys associated with this server side sort request control.
getSslOptions() - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
Returns the SslOptions that should be used when installing the TLS layer.
getSslOptions() - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedResult
Returns the SslOptions used to install the TLS layer.
getSslSession() - Method in interface org.forgerock.opendj.io.LdapSocket
Returns the SSL session currently in use by the underlying connection, or null if SSL/TLS is not enabled.
getSslSession() - Method in interface org.forgerock.opendj.ldap.LdapSession
Returns the SSL session currently in use by the underlying connection, or null if SSL/TLS is not enabled.
getSsoToken() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the SSO Token of this SessionInfo.
getStableId() - Method in class org.forgerock.secrets.Secret
A stable identifier for this particular secret that can be used to lookup the same secret in future.
getStableId() - Method in class org.forgerock.secrets.SecretBuilder
Returns the stable id for this secret..
getStandardName() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Return the name of the curve as used for the "crv" claim in a JWK.
getStatistic() - Method in class org.forgerock.monitoring.api.instrument.Measurement
 
getSTAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the st Attribute Type which has the OID 2.5.4.8.
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
 
getStoredType() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
 
getStoredType() - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
 
getStoredType() - Method in interface org.forgerock.secrets.SecretStore
The top-level class that this store is capable of storing.
getStoredType() - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
getStreetAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the street Attribute Type which has the OID 2.5.4.9.
getString() - Method in class org.forgerock.http.protocol.Entity
Returns the content of this entity decoded as a string.
getStrongAuthenticationUserObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the strongAuthenticationUser Object Class which has the OID 2.5.6.15.
getStructuralClass() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns the structural objectclass for this DIT content rule.
getStructuralClass() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns the structural objectclass of this name form.
getStructuralClassOid() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns the structural class OID for this schema definition.
getStructuralObjectClass(Entry) - Static method in class org.forgerock.opendj.ldap.Entries
Returns the structural object class associated with the provided entry, or null if none was found.
getStructuralObjectClass(Entry, Schema) - Static method in class org.forgerock.opendj.ldap.Entries
Returns the structural object class associated with the provided entry, or null if none was found.
getStructuralObjectClassAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the structuralObjectClass Attribute Type which has the OID 2.5.21.9.
getSubFilters() - Method in class org.forgerock.opendj.ldap.Filter
Returns an unmodifiable list containing the sub-filters for this AND or OR filter.
getSubject() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Gets the subject this JWT is issued to.
getSubMatchers() - Method in class org.forgerock.opendj.ldap.Matcher
Returns an unmodifiable list containing the sub-matchers for this AND or OR filter Matcher.
getSubschemaObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the subschema Object Class which has the OID 2.5.20.1.
getSubschemaSubentry() - Method in class org.forgerock.opendj.ldap.RootDse
Returns a string which represents the DN of the subschema subentry holding the schema controlling the Root DSE.
getSubschemaSubentryAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the subschemaSubentry Attribute Type which has the OID 2.5.18.10.
getSubstringAssertion(ByteSequence, List<? extends ByteSequence>, ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the normalized form of the provided assertion substring values, which is best suited for efficiently performing matching operations on that value.
getSubstringAssertion(Schema, ByteSequence, List<? extends ByteSequence>, ByteSequence) - Method in interface org.forgerock.opendj.ldap.schema.MatchingRuleImpl
Retrieves the normalized form of the provided assertion substring values, which is best suited for efficiently performing matching operations on that value.
getSubstringAssertionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Substring Assertion Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.58.
getSubstringMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the matching rule that should be used for substring matching with this attribute type.
getSubstringMatchingRule() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Retrieves the default substring matching rule that will be used for attributes with this syntax.
getSubstringMatchingRule() - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Retrieves the default substring matching rule that will be used for attributes with this syntax.
getSubstringsAny() - Method in class org.forgerock.opendj.ldap.Filter
Returns an unmodifiable list containing any intermediate substring assertion values for this substrings filter, which may be an empty if the substrings filter did not include an intermediate substrings.
getSubstringsFinal() - Method in class org.forgerock.opendj.ldap.Filter
Returns the final substring assertion value for this substrings filter, or null if the substrings filter did not include an final substring.
getSubstringsInitial() - Method in class org.forgerock.opendj.ldap.Filter
Returns the initial substring assertion value for this substrings filter, or null if the substrings filter did not include an initial substring.
getSubTypes() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the sub-types inheriting directly or indirectly from this attribute type.
getSuperiorClasses() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns an unmodifiable set containing the superior classes for this object class.
getSuperiorRules() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Returns an unmodifiable set containing the superior rules for this DIT structure rule.
getSuperiorType() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the superior type for this attribute type.
getSupportedAlgorithmsAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the supportedAlgorithms Attribute Type which has the OID 2.5.4.52.
getSupportedAlgorithmSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Supported Algorithm Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.49.
getSupportedAuthenticationPasswordSchemes() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of supported authentication password schemes which the Directory Server supports.
getSupportedAuthPasswordSchemesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the supportedAuthPasswordSchemes Attribute Type which has the OID 1.3.6.1.4.1.4203.1.3.3.
getSupportedControlAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the supportedControl Attribute Type which has the OID 1.3.6.1.4.1.1466.101.120.13.
getSupportedControls() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of object identifiers identifying the request controls that the Directory Server supports.
getSupportedExtendedOperations() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of object identifiers identifying the extended operations that the Directory Server supports.
getSupportedExtensionAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the supportedExtension Attribute Type which has the OID 1.3.6.1.4.1.1466.101.120.7.
getSupportedFeatures() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of object identifiers identifying elective features that the Directory Server supports.
getSupportedFeaturesAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the supportedFeatures Attribute Type which has the OID 1.3.6.1.4.1.4203.1.3.5.
getSupportedLDAPVersionAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the supportedLDAPVersion Attribute Type which has the OID 1.3.6.1.4.1.1466.101.120.15.
getSupportedLdapVersions() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of the versions of LDAP that the Directory Server supports.
getSupportedSaslMechanisms() - Method in class org.forgerock.opendj.ldap.RootDse
Returns an unmodifiable list of the SASL mechanisms that the Directory Server recognizes and/or supports.
getSupportedSASLMechanismsAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the supportedSASLMechanisms Attribute Type which has the OID 1.3.6.1.4.1.1466.101.120.14.
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.
getSyntax() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the syntax for this attribute type.
getSyntax() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the OID of the assertion value syntax with which this matching rule is associated.
getSyntax(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns the syntax with the specified numeric OID.
getSyntaxes() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the syntaxes contained in this schema.
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.
getTag(String) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
getTags() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
getTagValueRepresentation() - Method in enum org.forgerock.monitoring.api.instrument.Statistic
Returns the Tag Value Representation for this Statistic
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.
getTargetPosition() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
Returns the position of the target entry in the result set.
getTelephoneNumberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the telephoneNumber Attribute Type which has the OID 2.5.4.20.
getTelephoneNumberMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the telephoneNumberMatch Matching Rule which has the OID 2.5.13.20.
getTelephoneNumberSubstringsMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the telephoneNumberSubstringsMatch Matching Rule which has the OID 2.5.13.21.
getTelephoneNumberSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Telephone Number Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.50.
getTeletexTerminalIdentifierAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the teletexTerminalIdentifier Attribute Type which has the OID 2.5.4.22.
getTeletexTerminalIdentifierSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Teletex Terminal Identifier Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.51.
getTelexNumberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the telexNumber Attribute Type which has the OID 2.5.4.21.
getTelexNumberSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the Telex Number Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.52.
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 IG (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.
getThrowable() - Method in class org.forgerock.openig.openam.CdSsoFailureContext
Get the Throwable associated with the CDSSO error that occurred.
getTimeInMillis() - Method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns the value of this generalized time in milliseconds since the epoch.
getTimeLimit() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Returns the time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.
getTimestamp() - Method in class org.forgerock.openig.tools.notifications.Notification
Returns the instant when the event happened on the AM server.
getTimeStamp() - Static method in class org.forgerock.openig.util.VersionUtil
Returns the timestamp.
getTitleAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the title Attribute Type which has the OID 2.5.4.12.
getToken() - Method in class org.forgerock.http.header.authorization.BearerToken
Get the token.
getToken() - Method in class org.forgerock.http.oauth2.AccessTokenInfo
Returns the access token identifier issued from the authorization server.
getToken() - Method in class org.forgerock.openig.openam.CdSsoContext
Get the encoded JWT.
getTokenEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns the token end-point of this issuer.
getTokenProvider() - Method in class org.forgerock.openig.tools.am.AmService
Returns the AsyncRefreshableSupplier being used as a SsoToken provider for this server.
getTokens() - Method in class org.forgerock.http.header.ConnectionHeader
Returns the list of connection tokens.
getTopic() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
Returns the topic of the event.
getTopic() - Method in interface org.forgerock.audit.handlers.jms.JmsContextManager
Gets a JMS topic.
getTopic() - Method in class org.forgerock.audit.handlers.syslog.SyslogAuditEventHandlerConfiguration.SeverityFieldMapping
Returns the name of the event topic to which this mapping applies.
getTopic() - Method in class org.forgerock.openig.tools.notifications.Notification
Returns the notification's topic.
getTopic() - Method in interface org.forgerock.openig.tools.notifications.Subscription
Returns the name of the subscribed topic.
getTopic() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Returns the name of the topic, subject of the (un-)subscription request (is null for failure).
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.
getTopObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the top Object Class which has the OID 2.5.6.0.
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.
getTrustManagers() - Method in class org.forgerock.openig.tools.TlsOptions
Returns the array of TrustManager to use (may be null).
getType() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
 
getType() - Method in interface org.forgerock.audit.secure.KeyStoreHandler
Returns the type of the keystore.
getType() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
 
getType() - Method in class org.forgerock.http.header.AuthorizationHeader
Get the type of the authorization being presented, e.g.
getType() - Method in class org.forgerock.http.header.ContentTypeHeader
Returns the media type of the underlying data or null if none specified.
getType() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Gets the type of the contents of the Claims Set.
getType() - Method in class org.forgerock.json.jose.jwt.JwtHeader
Gets the type of JWT this header represents.
getType() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
The type is used by different registry implementations to structure the exposition of metrics to different backends.
getType() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
 
getType() - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
Returns the type of this request to avoid expensive instanceof checks.
getType() - Method in interface org.forgerock.opendj.ldap.messages.Request
Returns the type of this request to avoid expensive instanceof checks.
getType() - Method in class org.forgerock.opendj.ldap.messages.UnknownRequest
 
getType() - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
Returns the type of the IG object.
getType() - Method in class org.forgerock.openig.decoration.timer.TimerDecorator.Heaplet
 
getType() - Method in class org.forgerock.openig.handler.ClientHandler.Heaplet
 
getType() - Method in interface org.forgerock.openig.handler.resources.Resource
Returns the media type of this resource.
getType() - Method in class org.forgerock.openig.handler.ReverseProxyHandler.Heaplet
 
getType() - Method in class org.forgerock.openig.handler.router.RouterHandler.Heaplet
 
getType() - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns the type of the IG object.
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.
getUIDAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the uid Attribute Type which has the OID 0.9.2342.19200300.100.1.1.
getUIDObjectObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the uidObject Object Class which has the OID 1.3.6.1.1.3.1.
getUniqueIdentifierAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the uniqueIdentifier Attribute Type which has the OID 0.9.2342.19200300.100.1.44.
getUniqueMemberAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the uniqueMember Attribute Type which has the OID 2.5.4.50.
getUniqueMemberMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the uniqueMemberMatch Matching Rule which has the OID 2.5.13.23.
getUnit() - Method in class org.forgerock.util.time.Duration
Returns the TimeUnit this duration is expressed in.
getUniversalId() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the universal id.
getUniversalId() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the universal id.
getUnrecognizedFilterBytes() - Method in class org.forgerock.opendj.ldap.Filter
Returns the ASN.1 content associated with this unrecognized filter.
getUnrecognizedFilterTag() - Method in class org.forgerock.opendj.ldap.Filter
Returns the ASN.1 tag associated with this unrecognized filter.
getUri() - Method in class org.forgerock.http.header.ReferrerHeader
Get the URI value of the Referrer header.
getUri() - Method in class org.forgerock.http.protocol.Request
Returns the fully-qualified URI of the resource being accessed.
getUris() - Method in interface org.forgerock.opendj.ldap.messages.SearchResultReference
Returns a List containing the continuation reference URIs included with this search result reference.
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.
getUsage() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the usage indicator for this attribute type.
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).
getUserCertificateAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the userCertificate Attribute Type which has the OID 2.5.4.36.
getUserClassAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the userClass Attribute Type which has the OID 0.9.2342.19200300.100.1.8.
getUserIdentity() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Returns the identity of the user whose password is to be modified, or null if the request should be applied to the user currently associated with the session.
getUserIdentityAsString() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Returns the identity of the user whose password is to be modified decoded as a UTF-8 string, or null if the request should be applied to the user currently associated with the session.
getUserInfo() - Method in class org.forgerock.http.MutableUri
Returns the user info element.
getUserInfo(Context, OAuth2Session) - Method in class org.forgerock.openig.filter.oauth2.client.ClientRegistration
Returns a Promise completed either with the json value of the user info obtained from the authorization server if the response from the authorization server has a status code of 200, or with an exception, meaning the access token may have expired.
getUserInfoEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns the user end-point of this issuer.
getUsername() - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandlerConfiguration.ConnectionConfiguration
Gets Elasticsearch username for HTTP basic authentication.
getUsername() - Method in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandlerConfiguration.ConnectionPool
Gets the username to use to connect to the JDBC database.
getUsername() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo
Returns the username to use when authenticating to the proxy.
getUsername() - Method in class org.forgerock.http.header.authorization.BasicCredentials
Get the username.
getUsername() - Method in class org.forgerock.openig.openam.SessionInfoContext
Returns the user-friendly version of the username.
getUsername() - Method in class org.forgerock.openig.openam.UserProfileContext
Get the user's username or null if none.
getUsername() - Method in class org.forgerock.openig.tools.session.SessionInfo
Returns the user-friendly version of the username.
getUsername() - Method in class org.forgerock.openig.tools.userprofile.UserProfile
Get the user's username.
getUserPasswordAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the userPassword Attribute Type which has the OID 2.5.4.35.
getUserProfile(Context, String) - Method in class org.forgerock.openig.tools.userprofile.CacheUserProfileService
 
getUserProfile(Context, String) - Method in class org.forgerock.openig.tools.userprofile.CrestUserProfileService
 
getUserProfile(Context, String) - Method in interface org.forgerock.openig.tools.userprofile.UserProfileService
Returns a promise that will be completed with an UserProfile or with an UserProfileException in case of errors.
getUserSecurityInformationObjectClass() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the userSecurityInformation Object Class which has the OID 2.5.6.18.
getUTCTimeSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the UTC Time Syntax which has the OID 1.3.6.1.4.1.1466.115.121.1.53.
getUUIDMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the uuidMatch Matching Rule which has the OID 1.3.6.1.1.16.2.
getUUIDOrderingMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the uuidOrderingMatch Matching Rule which has the OID 1.3.6.1.1.16.3.
getUUIDSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the UUID Syntax which has the OID 1.3.6.1.1.16.1.
getValid(Purpose<S>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
 
getValid(Purpose<S>) - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
 
getValid(Purpose<S>) - Method in interface org.forgerock.secrets.SecretStore
Returns all valid secrets for the given purpose from this store.
getValid(Purpose<S>) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
getValidSecrets(Purpose<S>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService
 
getValidSecrets(Purpose<S>) - Method in interface org.forgerock.openig.secrets.SecretsService
Returns all secrets for the given purpose which have not yet expired.
getValidSecrets(Purpose<S>) - Method in class org.forgerock.openig.secrets.SecretsServiceProvider
 
getValidSecrets(Purpose<S>) - Method in class org.forgerock.secrets.SecretsProvider
Returns all secrets for the given purpose which have not yet expired.
getValue() - Method in class org.forgerock.audit.events.AuditEvent
Returns the Json value of this event.
getValue() - Method in class org.forgerock.http.header.Directive
Represents directive value, won't be quoted even if the original was.
getValue() - Method in class org.forgerock.http.protocol.Cookie
Returns the value of the cookie.
getValue() - Method in class org.forgerock.json.JsonPointer
Returns the JSON pointer string value.
getValue() - Method in class org.forgerock.json.resource.PatchOperation
Returns the value for the patch operation.
getValue() - Method in class org.forgerock.monitoring.api.instrument.ImmutableTag
 
getValue() - Method in class org.forgerock.monitoring.api.instrument.Measurement
Value for the measurement.
getValue() - Method in interface org.forgerock.monitoring.api.instrument.Tag
 
getValue() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableGauge
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
 
getValue() - Method in interface org.forgerock.opendj.ldap.controls.Control
Returns the value, if any, associated with this control.
getValue() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.GenericControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
 
getValue() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
 
getValue() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
 
getValue() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedResult
 
getValue() - Method in class org.forgerock.opendj.ldap.messages.AbstractIntermediateResponse
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
Returns the value, if any, associated with this extended request.
getValue() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
Returns the value, if any, associated with this extended result.
getValue() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.IntermediateResponse
Returns the value, if any, associated with this intermediate response.
getValue() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
getValue() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
getValue() - Method in class org.forgerock.openig.filter.JwtBuilderContext
Returns the JWT as a String.
getValue() - Method in class org.forgerock.openig.openam.CapturedUserPasswordContext
Returns the decrypted password as an UTF-8 String.
getValue(Charset) - Method in class org.forgerock.openig.openam.CapturedUserPasswordContext
Returns a new String by decoding the password using the specified charset.
getValue() - Method in class org.forgerock.openig.openam.SsoTokenContext
Returns the token associated with this SsoTokenContext context.
getValue() - Method in class org.forgerock.openig.tools.authentication.SsoToken
Returns the string value of this token.
getValue() - Method in class org.forgerock.openig.tools.InternalSsoTokenContext
Returns the token associated with this InternalSsoTokenContext context.
getValue(JwtClaimsSet, JsonPointer) - Static method in class org.forgerock.openig.tools.JwtUtil
Return a value from it's well-known location on the OAuth2 authorization JWT.
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.AuthorizationHeader
 
getValues() - Method in class org.forgerock.http.header.ConnectionHeader
 
getValues() - Method in class org.forgerock.http.header.ContentApiVersionHeader
 
getValues() - Method in class org.forgerock.http.header.ContentEncodingHeader
 
getValues() - Method in class org.forgerock.http.header.ContentLengthHeader
 
getValues() - Method in class org.forgerock.http.header.ContentTypeHeader
 
getValues() - Method in class org.forgerock.http.header.CookieHeader
 
getValues() - Method in class org.forgerock.http.header.GenericHeader
Returns the header as a list of strings.
getValues() - Method in class org.forgerock.http.header.LocationHeader
 
getValues() - Method in class org.forgerock.http.header.ReferrerHeader
 
getValues() - Method in class org.forgerock.http.header.SetCookie2Header
 
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.header.WwwAuthenticateHeader
 
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
 
getVendorName() - Method in class org.forgerock.opendj.ldap.RootDse
Returns a string which represents the name of the Directory Server implementer.
getVendorNameAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the vendorName Attribute Type which has the OID 1.3.6.1.1.4.
getVendorVersion() - Method in class org.forgerock.opendj.ldap.RootDse
Returns a string which represents the version of the Directory Server implementation.
getVendorVersionAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the vendorVersion Attribute Type which has the OID 1.3.6.1.1.5.
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 interface org.forgerock.opendj.ldap.messages.BindRequest
Returns the version of the protocol to be used at the LDAP message layer.
getVersion() - Method in class org.forgerock.openig.tools.am.AmService
Return the version of the configured OpenAM Server.
getVersion() - Static method in class org.forgerock.openig.util.VersionUtil
Returns the Identity Gateway version.
getViolation() - Method in class org.forgerock.openig.tools.jwt.Result
Return the Violation if it is present, null otherwise.
getViolations() - Method in class org.forgerock.openig.tools.jwt.JwtValidatorResult
Returns the list of the Violation if this JWT is invalid.
getVisibility() - Method in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
Returns a boolean indicating whether sub-entries should be included in the search results.
getW() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
 
getWarnings() - Method in class org.forgerock.http.header.WarningHeader
Gets all Warnings.
getWarnings() - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns an unmodifiable collection containing all of the warnings that were detected when this schema was constructed.
getWarnings() - Method in class org.forgerock.opendj.ldif.EntryGenerator
Returns the warnings generated by the parsing of template file.
getWarningType() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
Returns the password policy warning type, if available.
getWarningValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
Returns the password policy warning value, if available.
getWebCryptoName() - Method in enum org.forgerock.secrets.keys.KeyUsage
The standard WebCrypto KeyUsage name for this usage.
getWellKnownEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns the well-known end-point of this issuer.
getWithDeprecation(JsonValue, Logger, String, String...) - Static method in class org.forgerock.openig.util.JsonValues
Returns the named property from the provided JSON object, falling back to zero or more deprecated property names.
getWordMatchingRule() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the wordMatch Matching Rule which has the OID 2.5.13.32.
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.
getWriter() - Method in class org.forgerock.audit.rotation.RotationContext
Get the writer.
getWriter(ByteStringBuilder) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 writer whose destination is the provided byte string builder.
getWriter(ByteStringBuilder, int) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 writer whose destination is the provided byte string builder.
getWriter(OutputStream) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 writer whose destination is the provided output stream.
getWriter(OutputStream, int) - Static method in class org.forgerock.opendj.io.Asn1
Returns an ASN.1 writer whose destination is the provided output stream.
getWriter(W, int) - Static method in class org.forgerock.opendj.io.Ldap
Creates a new LDAP writer which will write LDAP messages to the provided ASN.1 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.
getX() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Returns the x-coordinate that forms the public key.
getX121AddressAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the x121Address Attribute Type which has the OID 2.5.4.24.
getX500UniqueIdentifierAttributeType() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the x500UniqueIdentifier Attribute Type which has the OID 2.5.4.45.
getX509BitPosition() - Method in enum org.forgerock.secrets.keys.KeyUsage
The bit position of this usage in the X.509 KeyUsage extension.
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.
getX509CertificateExactAssertionSyntax() - Static method in class org.forgerock.opendj.ldap.schema.CoreSchema
Returns a reference to the X.509 Certificate Exact Assertion Syntax which has the OID 1.3.6.1.1.15.1.
getX509CertificateThumbprint() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader
Gets the X.509 Certificate Thumbprint header parameter for this JWS.
getX509Chain() - Method in class org.forgerock.json.jose.jwk.JWK
Gets a List of X509 chain certs.
getX509StandardName() - Method in enum org.forgerock.secrets.keys.KeyUsage
The standard name of this key usage in the X.509 standard.
getX509Thumbnail() - Method in class org.forgerock.json.jose.jwk.JWK
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).
GLOBAL_METER_REGISTRY_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the global MeterRegistry from the Heap.
GLOBAL_PASSWORD - Static variable in class org.forgerock.opendj.security.KeyStoreParameters
The optional password which is used to protect all private and secret keys.
GlobalDecorator - Class in org.forgerock.openig.decoration.global
A GlobalDecorator stores decorators configuration in order to re-apply them when requested to decorate a given heap object instance.
GlobalDecorator(Decorator, JsonValue, Heap, String...) - Constructor for class org.forgerock.openig.decoration.global.GlobalDecorator
Builds a new GlobalDecorator using given decorators JSON object element.
GONE - Static variable in class org.forgerock.http.protocol.Status
The 410 (Gone) status code indicates that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent.
gracefullyClosed() - Static method in exception org.forgerock.opendj.io.LdapSocketClosedException
Returns a LdapSocketClosedException specifying that the socket has been intentionally and gracefully closed locally.
GRANT_TYPE - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set grant_type key - not available in JwtClaimsSetKey.
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.
greaterOrEqual(String, Object) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new greater or equal filter using the provided attribute description and assertion value.
greaterOrEqualAssertion(String, ByteSequence) - Static method in interface org.forgerock.opendj.ldap.Assertion
Returns an assertion for greater than or equal comparisons.
greaterThan(String, Object) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new greater than filter using the provided attribute description and assertion value.
greaterThan(Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies if this version is strictly greater than the given version.
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.
greaterThanAssertion(String, ByteSequence) - Static method in interface org.forgerock.opendj.ldap.Assertion
Returns an assertion for greater than comparisons.
greaterThanOrEqualTo(Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies if this version is greater or equal to the given version.
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.
GrizzlyLdapSocketAcceptor - Class in org.forgerock.opendj.grizzly
LDAP socket acceptor implementation using Grizzly for transport.
GrizzlyLdapSocketAcceptor(Set<InetSocketAddress>, Options, Consumer<LdapSocket>) - Constructor for class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
Creates a new LDAP acceptor implementation which will accept LDAP client connections using the provided address, connection options and provided TCP transport.
GrizzlyLdapSocketConnector - Class in org.forgerock.opendj.grizzly
LDAP socket connector implementation using Grizzly for transport.
GrizzlyLdapSocketConnector(String, int, Options) - Constructor for class org.forgerock.opendj.grizzly.GrizzlyLdapSocketConnector
Creates a new LDAP socket connector based on Grizzly which can be used to create socket connected to the Directory Server at the provided host and port address using provided options.
GrizzlyTransport - Class in org.forgerock.opendj.grizzly
Provides factory methods for creating Grizzly transports.
GROOVY_MIME_TYPE - Static variable in class org.forgerock.openig.script.GroovyScriptFactory
The mime-type for Groovy scripts.
GroovyScriptFactory - Class in org.forgerock.openig.script
Provide support for scripts written in the Groovy language.
GroovyScriptFactory(Environment) - Constructor for class org.forgerock.openig.script.GroovyScriptFactory
Constructs a new factory based on the given runtime Environment.
GroovyScriptFactory(File, File) - Constructor for class org.forgerock.openig.script.GroovyScriptFactory
Constructs a new factory given two runtime directories: basedir (the root directory where file scripts are stored) and cacheDir (where inlined scripts would be stored prior to execution).
GserParser - Class in org.forgerock.opendj.ldap
This class implements a parser for strings which are encoded using the Generic String Encoding Rules (GSER) defined in RFC 3641.
GserParser(CharSequence) - Constructor for class org.forgerock.opendj.ldap.GserParser
Creates a new GSER Parser.

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.monitoring.http.PrometheusHandler
 
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.ReverseProxyHandler
 
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
 
handleAccept(FilterChainContext) - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
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.
handleAction(Context, ActionRequest) - Method in class org.forgerock.openig.tools.CachePolicyDecisionRequestHandler
 
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
 
handleCancelRequest(LocalizableMessage) - Method in interface org.forgerock.opendj.ldap.CancelRequestListener
Invoked when a cancellation request has been received and processing of the request should be aborted if possible.
handleConnectionClosed() - Method in interface org.forgerock.opendj.ldap.ConnectionEventListener
Notifies this connection event listener that the application has called close on the connection.
handleConnectionClosed(LdapSession) - Method in interface org.forgerock.opendj.ldap.LdapSessionCompletionListener
Invoked when the client closed the connection, possibly using an unbind request.
handleConnectionDisconnected(LdapSession, ResultCode, String) - Method in interface org.forgerock.opendj.ldap.LdapSessionCompletionListener
Invoked when the connection has been disconnected by the server.
handleConnectionError(boolean, LdapException) - Method in interface org.forgerock.opendj.ldap.ConnectionEventListener
Notifies this connection event listener that a fatal error has occurred and the connection can no longer be used - the server has crashed, for example.
handleConnectionError(LdapSession, Throwable) - Method in interface org.forgerock.opendj.ldap.LdapSessionCompletionListener
Invoked when the connection has been disconnected because of an error (e.g: message too big).
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.
handleDuplicateEntry(AddRequest, Entry) - Method in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
Invoked when an attempt was made to add an entry which already exists.
handleDuplicateEntry(ModifyDnRequest, Entry, Entry) - Method in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
Invoked when an attempt was made to rename an entry which already exists.
handleEntry(SearchResultEntry) - Method in interface org.forgerock.opendj.ldap.SearchResultHandler
Invoked each time a search result entry is returned from an asynchronous search operation.
handleEvent(FilterChainContext, FilterChainEvent) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingHttpClientFilter
 
handleEvent(FilterChainContext, FilterChainEvent) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingSslFilter
 
handleEvent(FilterChainContext, FilterChainEvent) - Method in class org.forgerock.openig.websocket.grizzly.WebSocketAdapterFilter
 
handleException(LdapException) - Method in interface org.forgerock.opendj.ldap.LdapResultHandler
Invoked when the asynchronous operation has failed.
handleException(LdapException) - Method in class org.forgerock.opendj.ldap.spi.LdapPromiseImpl
 
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.
handleIntermediateResponse(IntermediateResponse) - Method in interface org.forgerock.opendj.ldap.IntermediateResponseHandler
Invoked each time an intermediate response is returned from the Directory Server.
handleLdapClientOffline(LdapClient, LdapException) - Method in interface org.forgerock.opendj.ldap.LoadBalancerEventListener
Invoked when the load-balancer is unable to obtain a connection from the specified LDAP client.
handleLdapClientOnline(LdapClient) - Method in interface org.forgerock.opendj.ldap.LoadBalancerEventListener
Invoked when the load-balancer detects that a previously offline LDAP client is available for use again.
handleMalformedRecord(long, List<String>, DecodeException) - Method in interface org.forgerock.opendj.ldif.RejectedLdifListener
Invoked when a record was rejected because it was malformed in some way and could not be decoded.
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 - Interface in org.forgerock.http
Asynchronously handles an HTTP Request by producing an associated Response.
handleRead(Context, ReadRequest) - Method in interface org.forgerock.audit.AuditService
Gets an object from the audit logs by identifier.
handleRead(Context, ReadRequest) - Method in class org.forgerock.audit.AuditServiceProxy
 
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.FilterChain
 
handleRead(Context, ReadRequest) - Method in interface org.forgerock.json.resource.RequestHandler
Reads a JSON resource, returning a Promise that will be completed when the resource has been read.
handleRead(Context, ReadRequest) - Method in class org.forgerock.json.resource.Router
 
handleRead(Context, ReadRequest) - Method in interface org.forgerock.json.resource.SynchronousRequestHandler
Reads a JSON resource.
handleRead(FilterChainContext) - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
handleRead(FilterChainContext) - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketConnector
 
handleRead(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.HandshakeFilter
 
handleRead(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingHttpClientFilter
 
handleRead(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingSslFilter
 
handleRead(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.WebSocketAdapterFilter
 
handleReference(SearchResultReference) - Method in interface org.forgerock.opendj.ldap.SearchResultHandler
Invoked each time a search result reference is returned from an asynchronous search operation.
handleRejectedChangeRecord(AddRequest, LocalizableMessage) - Method in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
Invoked when an attempt to add an entry was rejected.
handleRejectedChangeRecord(DeleteRequest, LocalizableMessage) - Method in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
Invoked when an attempt to delete an entry was rejected.
handleRejectedChangeRecord(ModifyRequest, LocalizableMessage) - Method in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
Invoked when an attempt to modify an entry was rejected.
handleRejectedChangeRecord(ModifyDnRequest, LocalizableMessage) - Method in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
Invoked when an attempt to rename an entry was rejected.
handleRequest(int, Request) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns a Flowable which, when subscribed, will apply the provided request to this memory backend.
handleRequest(Request) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns a Flowable which, when subscribed, will apply the provided request to this memory backend.
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(S) - Method in interface org.forgerock.opendj.ldap.LdapResultHandler
Invoked when the asynchronous operation has completed successfully.
handleResult(S) - Method in class org.forgerock.opendj.ldap.spi.LdapPromiseImpl
 
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.
handleSchemaValidationFailure(long, List<String>, List<LocalizableMessage>) - Method in interface org.forgerock.opendj.ldif.RejectedLdifListener
Invoked when a record was rejected because it does not conform to the schema and schema validation is enabled.
handleSchemaValidationWarning(long, List<String>, List<LocalizableMessage>) - Method in interface org.forgerock.opendj.ldif.RejectedLdifListener
Invoked when a record was not rejected but contained one or more schema validation warnings.
handleSkippedRecord(long, List<String>, LocalizableMessage) - Method in interface org.forgerock.opendj.ldif.RejectedLdifListener
Invoked when a record was skipped because it did not match filter criteria defined by the reader.
handleUnsolicitedNotification(ExtendedResult) - Method in interface org.forgerock.opendj.ldap.ConnectionEventListener
Notifies this connection event listener that the connection has just received the provided unsolicited notification from the server.
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.
handleWrite(FilterChainContext) - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
handleWrite(FilterChainContext) - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketConnector
 
handleWrite(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.HandshakeFilter
 
handleWrite(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingHttpClientFilter
 
handleWrite(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingSslFilter
 
handleWrite(FilterChainContext) - Method in class org.forgerock.openig.websocket.grizzly.WebSocketAdapterFilter
 
HandshakeFilter - Class in org.forgerock.openig.websocket.grizzly
Deal with the HTTP handshake message only: building the HTTP request for downstream filters, receiving and interpreting the handshake response on upstream flow.
HandshakeFilter() - Constructor for class org.forgerock.openig.websocket.grizzly.HandshakeFilter
 
hasAttribute(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Indicates whether the provided attribute type is referenced by this matching rule use.
hasAttributeType(AttributeType) - Method in class org.forgerock.opendj.ldap.Rdn
Indicates whether this RDN includes the specified attribute type.
hasAttributeType(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains an attribute type with the specified name or numeric OID.
hasChangedSince(long) - Method in interface org.forgerock.openig.handler.resources.Resource
Returns true if the resource has changed since the given timestamp (expressed in ms).
hasClaims() - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the JWT does contain claims.
hasCredentials() - Method in class org.forgerock.http.handler.HttpClientHandler.ProxyInfo
Returns true if there is a set of username/password credentials defined.
hasDitContentRule(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains a DIT content rule with the specified name or numeric OID.
hasDitStructureRule(int) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains a DIT structure rule with the specified rule ID.
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.audit.events.handlers.AuditEventTopicState
 
hashCode() - Method in class org.forgerock.http.filter.throttling.ThrottlingRate
 
hashCode() - Method in class org.forgerock.http.header.Directive
 
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.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.monitoring.api.instrument.ImmutableTag
 
hashCode() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
hashCode() - Method in class org.forgerock.monitoring.api.instrument.Tags
 
hashCode() - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
hashCode() - Method in class org.forgerock.opendj.ldap.AbstractEntry
 
hashCode() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns the hash code for this attribute.
hashCode() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns the hash code for this attribute description.
hashCode() - Method in class org.forgerock.opendj.ldap.Ava
 
hashCode() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns a hash code for this byte sequence.
hashCode() - Method in class org.forgerock.opendj.ldap.ByteString
Returns a hash code for this byte string.
hashCode() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns a hash code for this byte string builder.
hashCode() - Method in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
 
hashCode() - Method in class org.forgerock.opendj.ldap.Dn
 
hashCode() - Method in interface org.forgerock.opendj.ldap.Entry
Returns the hash code for this entry.
hashCode() - Method in class org.forgerock.opendj.ldap.Filter
This method produces a hash-code of the literal filter representation without performing any normalization other than lowercasing attribute descriptions.
hashCode() - Method in class org.forgerock.opendj.ldap.GeneralizedTime
 
hashCode() - Method in class org.forgerock.opendj.ldap.LdapUrl
 
hashCode() - Method in class org.forgerock.opendj.ldap.Matcher
This method returns the same hash-code for any two equivalent filters.
hashCode() - Method in class org.forgerock.opendj.ldap.Modification
 
hashCode() - Method in class org.forgerock.opendj.ldap.ModificationType
 
hashCode() - Method in class org.forgerock.opendj.ldap.Rdn
 
hashCode() - Method in class org.forgerock.opendj.ldap.ResultCode
 
hashCode() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the hash code for this attribute type.
hashCode() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Returns the hash code for this DIT content rule.
hashCode() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Returns the hash code for this DIT structure rule.
hashCode() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the hash code for this matching rule.
hashCode() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Returns the hash code for this matching rule use.
hashCode() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns the hash code for this name form.
hashCode() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns the hash code for this object class.
hashCode() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Returns the hash code for this attribute syntax.
hashCode() - Method in class org.forgerock.opendj.ldap.SearchScope
 
hashCode() - Method in class org.forgerock.opendj.ldap.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.text.Separator
 
hashCode() - Method in class org.forgerock.openig.tools.am.Version
 
hashCode() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore.AliasSpec
 
hashCode() - Method in class org.forgerock.secrets.Purpose
 
hashCode() - Method in class org.forgerock.secrets.Secret
 
hashCode() - Method in class org.forgerock.services.routing.DelegatingRouteMatcher
 
hashCode() - Method in class org.forgerock.services.routing.RouteMatcher
 
hashCode() - Method in class org.forgerock.util.i18n.LocalizableString
Default hashcode implementation.
hashCode() - Method in class org.forgerock.util.LazyList
Returns the hash code value for this list.
hashCode() - Method in class org.forgerock.util.LazyMap
Returns the hash code value for the map.
hashCode() - Method in class org.forgerock.util.ListDecorator
Returns the hash code value for this list.
hashCode() - Method in class org.forgerock.util.MapDecorator
Returns the hash code value for the map.
hashCode() - Method in class org.forgerock.util.Pair
hashCode() - Method in class org.forgerock.util.query.QueryFilter
 
hashCode() - Method in class org.forgerock.util.time.Duration
 
hasMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains a matching rule with the specified name or numeric OID.
hasMatchingRuleUse(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains a matching rule use with the specified name or numeric OID.
hasMessageAvailable() - Method in class org.forgerock.opendj.io.LdapReader
Returns true if the next LDAP message can be read without blocking.
hasName() - Method in class org.forgerock.http.header.Directive
Return true if the directive name is not null or empty.
hasName(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this schema definition has the specified name.
hasName(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Indicates whether this schema definition has the specified name.
hasName(String) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Indicates whether this schema definition has the specified name.
hasName(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Indicates whether this schema definition has the specified name.
hasName(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Indicates whether this schema definition has the specified name.
hasName(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns true if this name form has the specified user-friendly name.
hasName(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether this schema definition has the specified name.
hasNameForm(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains a name form with the specified name or numeric OID.
hasNameOrOid(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this schema definition has the specified name or OID.
hasNameOrOid(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Indicates whether this schema definition has the specified name or structural class OID.
hasNameOrOid(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Indicates whether this schema definition has the specified name or OID.
hasNameOrOid(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Indicates whether this schema definition has the specified name or matching rule OID.
hasNameOrOid(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns true if this name form has the specified user-friendly name or numeric OID.
hasNameOrOid(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether this schema definition has the specified name or OID.
hasNegotiatedSaslQop() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Returns true if the SASL bind sequence has negotiated a SASL security layer using Quality of Protection (QOP).
hasNext() - Method in class org.forgerock.opendj.ldap.GserParser
Determines if the GSER String contains at least one character to be read.
hasNext() - Method in interface org.forgerock.opendj.ldif.ChangeRecordReader
Returns true if this reader contains another change record, blocking if necessary until either the next change record is available or the end of the stream is reached.
hasNext() - Method in class org.forgerock.opendj.ldif.ConnectionEntryReader
 
hasNext() - Method in class org.forgerock.opendj.ldif.EntryGenerator
 
hasNext() - Method in interface org.forgerock.opendj.ldif.EntryReader
Returns true if this reader contains another entry, blocking if necessary until either the next entry is available or the end of the stream is reached.
hasNext() - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Returns true if this reader contains another change record, blocking if necessary until either the next change record is available or the end of the stream is reached.
hasNext() - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Returns true if this reader contains another entry, blocking if necessary until either the next entry is available or the end of the stream is reached.
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.
hasNextElement() - Method in interface org.forgerock.opendj.io.Asn1Reader
Indicates whether the current stream, sequence, or set contains another element.
hasObjectClass(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains an object class with the specified name or numeric OID.
hasOption(String) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether this attribute description contains the provided option.
hasOptions() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether this attribute description has any options.
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.
hasSubordinates(String) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns true if the named entry exists and has at least one child entry.
hasSubordinates(Dn) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns true if the named entry exists and has at least one child entry.
hasSubTypes() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns whether this attribute type has sub-types, inheriting directly or indirectly from this attribute type.
hasSyntax(String) - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema contains a syntax with the specified numeric OID.
hasTargetOffset() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Returns true if this control is using a target offset, or false if this control is using a target assertion.
hasUserInfoEndpoint() - Method in class org.forgerock.openig.filter.oauth2.client.Issuer
Returns true if this issuer has a user info end-point.
hasValidSignature(SigningHandler) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Validates the signature of this SignedJwt.
hasValue() - Method in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
 
hasValue() - Method in interface org.forgerock.opendj.ldap.controls.Control
Returns true if this control has a value.
hasValue() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.GenericControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
 
hasValue() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
 
hasValue() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedResult
 
hasValue() - Method in class org.forgerock.opendj.ldap.messages.AbstractIntermediateResponse
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedRequest
Returns true if this extended request has a value.
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
Returns true if this extended result has a value.
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.IntermediateResponse
Returns true if this intermediate response has a value.
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
 
hasValue() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
hasWarnings() - Method in class org.forgerock.opendj.ldif.EntryGenerator
Checks if there are some warning(s) after parsing the template file.
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 - 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.
HeadlessAuthenticationFilter - Class in org.forgerock.openig.tools
Provides an OpenAM SSO Token in the given header name for downstream components.
HeadlessAuthenticationFilter(String, AsyncRefreshableSupplier<SsoToken, AuthenticationException>) - Constructor for class org.forgerock.openig.tools.HeadlessAuthenticationFilter
Creates a HeadlessAuthenticationFilter which will provide an AM SSO Token in the given header name for downstream components.
heap - Variable in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
Where objects should be put and where object dependencies should be retrieved.
heap - Variable in class org.forgerock.openig.heap.GenericHeaplet
Where objects should be put and where object dependencies should be retrieved.
Heap - Interface in org.forgerock.openig.heap
Manages a collection of associated objects created and initialized by Heaplet objects.
HEAP_METER_REGISTRY_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the local MeterRegistry from the Heap.
HeapException - Exception in org.forgerock.openig.heap
An exception that is thrown during heap operations.
HeapException() - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with null as its detail message.
HeapException(String) - Constructor for exception org.forgerock.openig.heap.HeapException
Constructs a new exception with the specified detail message.
HeapException(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.
HeapImpl(HeapImpl, Name, PropertyResolver) - 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.JwtBuilderFilter.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.ConfirmationKeyVerifierAccessTokenResolver.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.ScriptableAccessTokenResolver.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.ScriptableResourceAccess.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.oauth2.StatelessAccessTokenResolver.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.ScriptableFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.filter.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.ReverseProxyHandler.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.CapturedUserPasswordFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.openam.CrossDomainSingleSignOnFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.openam.PolicyEnforcementFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.openam.ScriptableResourceUriProvider.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.openam.SessionInfoFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.openam.SingleSignOnFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.openam.TokenTransformationFilter.Heaplet
 
Heaplet() - Constructor for class org.forgerock.openig.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
 
HEARTBEAT_ENABLED - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Configures the connection factory to periodically send "heart-beat" or "keep-alive" requests to the Directory Server.
HEARTBEAT_INTERVAL - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Specifies the time between successive heart-beat requests (default interval is 10 seconds).
HEARTBEAT_SCHEDULER - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Specifies the scheduler which will be used for periodically sending heart-beat requests.
HEARTBEAT_SEARCH_REQUEST - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Specifies the parameters of the search request that will be used for heart-beats.
HEARTBEAT_TIMEOUT - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Specifies the timeout for heart-beat requests, after which the remote Directory Server will be deemed to be unavailable (default timeout is 3 seconds).
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.
hierarchicalName(String) - Method in class org.forgerock.monitoring.api.instrument.Counter.Builder
 
hierarchicalName(String) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
 
hierarchicalName(String) - Method in class org.forgerock.monitoring.api.instrument.Gauge.Builder
 
hierarchicalName(String) - Method in class org.forgerock.monitoring.api.instrument.Meter.Builder
 
hierarchicalName(String) - Method in class org.forgerock.monitoring.api.instrument.TimeGauge.Builder
 
hierarchicalName(String) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
 
hierarchicalNamePrefix(String) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
Add a hierarchical name prefix for this MeterRegistryHolder.
histogramBufferLength(Integer) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Statistics emanating from a distribution summary like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
histogramBufferLength(Integer) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
histogramBufferLength(Integer) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
HistogramConfig - Class in org.forgerock.monitoring.api.instrument.histogram
ForgeRock changes: - Removed @incubating annotation
HistogramConfig() - Constructor for class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
HistogramConfig.Builder - Class in org.forgerock.monitoring.api.instrument.histogram
 
histogramCountAtValue(long) - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
 
histogramCountAtValue(long) - Method in interface org.forgerock.monitoring.api.instrument.Timer
 
histogramCountAtValue(long) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
histogramCountAtValue(long) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
histogramCounts() - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
histogramExpiry(Duration) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Statistics emanating from a distribution summary like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
histogramExpiry(Duration) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
histogramExpiry(Duration) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
HistogramSnapshot - Class in org.forgerock.monitoring.api.instrument
 
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.
HmacSigningHandler(SecretKey) - Constructor for class org.forgerock.json.jose.jws.handlers.HmacSigningHandler
Constructs a new HmacSigningHandler.
hoursToUnit(double, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
HsmKeyStoreLoader - Class in org.forgerock.secrets.keystore
A loader for the KeyStoreSecretStore that knows how to load standard PKCS#11 Hardware Security Module (HSM) providers on our supported platforms.
HsmKeyStoreLoader(Provider) - Constructor for class org.forgerock.secrets.keystore.HsmKeyStoreLoader
Initializes the HSM loader with the given PKCS#11 provider.
HsmKeyStoreLoader(String) - Constructor for class org.forgerock.secrets.keystore.HsmKeyStoreLoader
Initializes the HSM loader with a supported PKCS#11 provider for the current platform and the given PKCS#11 configuration file.
HsmSecretStoreHeaplet - Class in org.forgerock.openig.secrets
This heaplet represents an instance of a HsmSecretStoreHeaplet.
HsmSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.HsmSecretStoreHeaplet
 
HTTP - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The http event payload field name.
HTTP_VERSION_NOT_SUPPORTED - Static variable in class org.forgerock.http.protocol.Status
The 505 (HTTP Version Not Supported) status code indicates that the server does not support, or refuses to support, the major version of HTTP that was used in the request message.
HttpAccessAuditFilter - Class in org.forgerock.openig.filter
This filter aims to send some access audit events to the AuditService managed as a CREST handler.
HttpAccessAuditFilter(RequestHandler, Clock) - Constructor for class org.forgerock.openig.filter.HttpAccessAuditFilter
Constructs a new HttpAccessAuditFilter.
HttpApplication - Interface in org.forgerock.http
Configuration class to configure the HttpApplication instance.
HttpApplicationException - Exception in org.forgerock.http
An exception that is thrown during a Http Application start up when the start up of the application fails.
HttpApplicationException(String) - Constructor for exception org.forgerock.http.HttpApplicationException
Constructs a new exception with the specified detail message.
HttpApplicationException(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.
httpOnly(boolean) - Method in class org.forgerock.openig.http.CookieBuilder
Set the httpOnly flag and return a new instance of this builder.
httpRequest(boolean, String, String, Map<String, List<String>>, Map<String, List<String>>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided HTTP request fields for the event.
httpRequest(boolean, String, String, Map<String, List<String>>, Map<String, List<String>>, Map<String, String>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided HTTP request fields for the event.
httpResponse(Map<String, List<String>>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Sets the provided HTTP fields for the event.
HttpUpgradeHandlerDelegate - Class in org.forgerock.openig.websocket.grizzly
Delegate Servlet HTTP upgrade mechanism, because we can't instantiate the handler ourselves (it needs the Grizzly connection).
HttpUpgradeHandlerDelegate() - Constructor for class org.forgerock.openig.websocket.grizzly.HttpUpgradeHandlerDelegate
 
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 - Static variable in class org.forgerock.json.schema.validator.Constants
The id field name.
Id(String, Iterable<Tag>, String, String, String, Meter.Type) - Constructor for class org.forgerock.monitoring.api.instrument.Meter.Id
 
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.
identity - Static variable in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
identity(M) - Static method in class org.forgerock.opendj.ldap.Functions
Returns the provided value.
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.
IGNORE_ALL - Static variable in interface org.forgerock.opendj.ldif.RejectedLdifListener
A handler which ignores all rejected record notifications.
ignoreAll() - Static method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Creates a new schema validation policy which will not perform any schema validation.
ignoreTags(String...) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Suppress tags with a given tag key.
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.
ImmutableTag - Class in org.forgerock.monitoring.api.instrument
 
ImmutableTag(String, String) - Constructor for class org.forgerock.monitoring.api.instrument.ImmutableTag
 
implementation(MatchingRuleImpl) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Sets the matching rule implementation.
implementation(SyntaxImpl) - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
Sets the syntax implementation.
IN_SEARCHING - Static variable in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
While searching subordinates of the base object, dereference any alias within the scope of the Search operation.
INAPPROPRIATE_AUTHENTICATION - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that an authentication attempt failed because the requested type of authentication was not appropriate for the targeted entry.
INAPPROPRIATE_MATCHING - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it attempted to perform an inappropriate type of matching against an attribute.
includeAllOperationalAttributes(boolean) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Specifies whether all operational attributes should be included in filtered entries.
includeAllUserAttributes(boolean) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Specifies whether all user attributes should be included in filtered entries.
includeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Specifies that the named attribute should be included in filtered entries.
includeAttribute(String) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Specifies that the named attribute should be included in filtered entries.
includeAttribute(String, Schema) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Specifies that the named attribute should be included in filtered entries.
includeAttribute(String, Schema, boolean) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Specifies that the named attribute should be included in filtered entries.
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.
increment() - Method in interface org.forgerock.monitoring.api.instrument.Counter
Update the counter by one.
increment(double) - Method in interface org.forgerock.monitoring.api.instrument.Counter
Update the counter by amount.
increment(double) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableCounter
 
INCREMENT - Static variable in class org.forgerock.opendj.ldap.ModificationType
Increment all existing values of the attribute by the amount specified in the modification value.
Indexed<T> - Interface in org.forgerock.http.util
Interface of an object that can be indexed with a unique key.
Indexer - Interface in org.forgerock.opendj.ldap.spi
This class is registered with a Backend and it provides callbacks for indexing attribute values.
IndexingOptions - Interface in org.forgerock.opendj.ldap.spi
Contains options indicating how indexing must be performed.
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.
IndexQueryFactory<T> - Interface in org.forgerock.opendj.ldap.spi
A factory for creating arbitrarily complex index queries.
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.
init(EndpointConfig) - Method in class org.forgerock.openig.tools.notifications.ws.JsonValueDecoder
 
init(EndpointConfig) - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionRequestEncoder
 
init(WebConnection) - Method in class org.forgerock.openig.websocket.grizzly.HttpUpgradeHandlerDelegate
 
injectIn(HeapImpl) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder
Builds and configures a new DefaultSecretsService instance, and finally inject the reference in the given destination HeapImpl.
inlineCoercionFunction(Path) - Static method in class org.forgerock.config.util.JsonValuePropertyEvaluator
Creates a coercion function that inlines the content of another file that may be a relative path to a current location.
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.
INSTANCE_ENV_VARIABLE - Static variable in class org.forgerock.openig.http.GatewayEnvironment
Environment variable name.
INSTANCE_SYSTEM_PROPERTY - Static variable in class org.forgerock.openig.http.GatewayEnvironment
System property name that can be specified through command line.
instant() - Static method in class org.forgerock.json.JsonValueFunctions
Returns a Function to transform a JsonValue representing a UTC format datetime to an Instant.
instant() - Static method in class org.forgerock.openig.util.JsonValues
Returns a Function to transform a JsonValue representing a timestamp (in seconds) to an Instant.
INSUFFICIENT_ACCESS_RIGHTS - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the client does not have sufficient permission to perform the requested operation.
IntDate - Class in org.forgerock.json.jose.utils
This class provides utility methods for converting Java Date objects into and from IntDates.
integer() - Static method in class org.forgerock.json.JsonValueFunctions
Returns an Integer by converting the JsonValue using JsonValue.asInteger(), or by parsing the JsonValue string using Integer.parseInt(String).
integer(String) - Static method in class org.forgerock.openig.el.Functions
Transforms a String to an Integer.
INTEGER_TAG - Static variable in class org.forgerock.json.jose.utils.DerUtils
DER tag for integer values.
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.
IntermediateResponse - Interface in org.forgerock.opendj.ldap.messages
An Intermediate response provides a general mechanism for defining single-request/multiple-response operations.
IntermediateResponseHandler - Interface in org.forgerock.opendj.ldap
A completion handler for consuming intermediate responses returned from extended operations, or other operations for which an appropriate control was sent.
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.
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.
internalServerErrorResultCode() - Static method in class org.forgerock.opendj.ldap.ResultCode
Returns the result code that should be used when the Directory Server encounters an 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.
intValue() - Method in enum org.forgerock.opendj.ldap.controls.PasswordPolicyErrorType
Returns the integer value for this password policy error type.
intValue() - Method in enum org.forgerock.opendj.ldap.controls.PersistentSearchChangeType
Returns the integer value for this change type as defined in the internet draft.
intValue() - Method in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
Returns the integer value of this alias dereferencing policy as defined in RFC 4511 section 4.5.1.
intValue() - Method in class org.forgerock.opendj.ldap.ModificationType
Returns the integer value of this modification change type as defined in RFC 4511 section 4.6.
intValue() - Method in class org.forgerock.opendj.ldap.ResultCode
Returns the integer value of this result code.
intValue() - Method in class org.forgerock.opendj.ldap.SearchScope
Returns the integer value of this search scope as defined in RFC 4511 section 4.5.1.2.
INVALID_ATTRIBUTE_SYNTAX - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it violated the syntax for a specified attribute.
INVALID_CREDENTIALS - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that an authentication attempt failed because the user did not provide a valid set of credentials.
INVALID_DN_SYNTAX - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it would have resulted in an entry with an invalid or malformed DN.
invalidateEagerly(AsyncLoadingCache<K, V>, Promise<V, E>, K) - Static method in class org.forgerock.openig.tools.CaffeineUtils
Preemptively invalidates the cache entry on failure.
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.
InvalidRequest - Class in org.forgerock.opendj.ldap.messages
Represents a request which has been received and decoded but but is invalid according to the LDAP standard because of an invalid DN syntax or an invalid attribute syntax.
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.
invokeAll(Collection<? extends Callable<T>>) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
invokeAny(Collection<? extends Callable<T>>) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
IO - Class in org.forgerock.http.io
Utility class that can stream to and from streams.
IP - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The IP event payload field name.
is(String) - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns true if this error includes an error code and it matches the provided error code.
is(Predicate<Version>) - Method in class org.forgerock.openig.tools.am.Version
Returns true if this version satisfy the given predicate.
IS_DELETED_ATTR - Static variable in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
The name of the isDeleted attribute as defined in the Active Directory schema.
isAdd() - Method in class org.forgerock.json.resource.PatchOperation
Returns true if this is an "add" patch operation.
isAfter(Clock) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the timestamp is after the given date.
isAfter(Clock, TemporalAmount) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the timestamp is after the given date.
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.
isBefore(Clock) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the timestamp is before the given date.
isBefore(Clock, TemporalAmount) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the timestamp is before the given date.
isBerEncodingRequired() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Indicates whether this attribute syntax requires that values must be encoded using the Basic Encoding Rules (BER) used by X.500 directories and always include the binary attribute description option.
isBerEncodingRequired() - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Indicates whether this attribute syntax requires that values must be encoded using the Basic Encoding Rules (BER) used by X.500 directories and always include the binary attribute description option.
isBetterMatchThan(RouteMatch) - Method in interface org.forgerock.services.routing.RouteMatch
Determines whether this route match is better than the given rout match.
isBlank(CharSequence) - Static method in class org.forgerock.util.Strings
Check to see if a character sequence is null or blank.
isBlank(CharSequence) - Static method in class org.forgerock.util.Utils
isBoolean() - Method in class org.forgerock.json.JsonValue
Returns true if the JSON value is a Boolean.
isCancel(Request) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Checks whether the provided request is a Cancel extended request.
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
 
isChangesOnly() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
Returns true if only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation), otherwise false if the search will initially return all the existing entries which match the filter.
isChildOf(Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is an immediate child of the provided DN.
isChildOf(String) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is an immediate child of the provided DN decoded using the default schema.
isClientError() - Method in class org.forgerock.http.protocol.Status
Is the family of this status a Status.Family.CLIENT_ERROR one ?
isClientError() - Method in class org.forgerock.opendj.ldap.ResultCode
Returns true if this ResultCode corresponds to a client-side result code.
isClosed() - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Indicates whether or not this connection has been explicitly closed by calling close.
isClosed() - Method in interface org.forgerock.json.resource.Connection
Indicates whether or not this connection has been explicitly closed by calling close.
isClosed() - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Indicates whether this connection has been explicitly closed by calling close.
isClosed() - Method in interface org.forgerock.opendj.ldap.Connection
Indicates whether this connection has been explicitly closed by calling close.
isClosed() - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Indicates whether this connection has been explicitly closed by calling LdapClientSocket.close().
isClosed() - Method in interface org.forgerock.opendj.ldap.LdapSession
Returns true if the underlying connection has been closed as a result of a client disconnect, a fatal connection error, or a server-side LdapSession.disconnect().
isClosed() - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Indicates whether 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.
isCollective() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this attribute type is declared "collective".
isCompatible(Object, Object) - Static method in class org.forgerock.util.Objects
Returns whether the two objects are type-compatible.
isCompatible(Object, Object) - Static method in class org.forgerock.util.Utils
isCompatibleWith(Version) - Method in class org.forgerock.http.routing.Version
Returns false if: the MAJOR version numbers are not the same.
isControlAlias(String) - Static method in class org.forgerock.opendj.ldap.controls.Controls
Returns true if the provided alias is a known user friendly name of control.
isCopy() - Method in class org.forgerock.json.resource.PatchOperation
Returns true if this is a "copy" patch operation.
isCritical() - Method in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
 
isCritical() - Method in interface org.forgerock.opendj.ldap.controls.Control
Returns true if it is unacceptable to perform the operation without applying the semantics of this control.
isCritical() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.GenericControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
 
isCritical() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
 
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.
isDeleteOldRdn() - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Indicates whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry.
isDescendantOf(ObjectClass) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether this objectclass is a descendant of the provided class.
isDestroyed() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
isDestroyed() - Method in class org.forgerock.secrets.GenericSecret
 
isDnAttributes() - Method in class org.forgerock.opendj.ldap.Filter
Returns whether extensible matching should be performed against attributes in an entry's DN.
isDone() - Method in interface org.forgerock.util.promise.Promise
Returns true if this Promise has completed.
isDone() - Method in class org.forgerock.util.promise.PromiseImpl
 
isElasticsearchCompatible() - Method in class org.forgerock.audit.handlers.json.JsonAuditEventHandlerConfiguration
Determines if JSON format should be transformed to be compatible with ElasticSearch format restrictions.
isEmpty() - Method in class org.forgerock.http.protocol.Headers
 
isEmpty() - Method in class org.forgerock.http.protocol.RequestCookies
 
isEmpty() - Method in class org.forgerock.http.util.SetDecorator
 
isEmpty() - Method in class org.forgerock.json.JsonPointer
Returns true if this pointer identifies the root value of a JSON structure.
isEmpty() - Method in class org.forgerock.json.resource.ResourcePath
Returns true if this resource path contains no path elements.
isEmpty() - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
isEmpty() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns true if this attribute contains no attribute values.
isEmpty() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns true if this byte sequence has a length of zero.
isEmpty() - Method in class org.forgerock.opendj.ldap.ByteString
 
isEmpty() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
isEmpty() - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN contains zero RDN components.
isEmpty() - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
isEmpty() - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns true if this memory backend does not contain any entries.
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.
isEntry() - Method in class org.forgerock.opendj.ldif.ConnectionEntryReader
Waits for the next search result entry or reference to become available and returns true if it is an entry, or false if it is a reference.
isEqual(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch
Compares two JSON values, and returns whether the two objects are identical.
isEqualTo(JsonValue) - Method in class org.forgerock.json.JsonValue
Performs a deep comparison of this JSON value with another JSON value, and returns whether the two objects are identical.
isEqualTo(int) - Method in class org.forgerock.opendj.ldap.ResultCode
Returns true if the provided integer corresponds to this ResultCode.
isEqualTo(T) - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the value is equal to the one expected and fulfill the Violation with the custom error message.
isError() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Returns true if this acknowledgment message is a failure, false otherwise.
isExceptional() - Method in class org.forgerock.opendj.ldap.ResultCode
Indicates whether this result code represents an error result.
isExpired(Clock) - Method in class org.forgerock.secrets.Secret
Indicates whether the secret has expired according to the given clock.
isExtensible() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether this object class is extensibleObject class.
isExternal() - Method in class org.forgerock.services.context.ClientContext
Returns true if this client is external.
isExtractable() - Method in class org.forgerock.secrets.keys.CryptoKey
Indicates whether the raw key material can be extracted for this key.
isFailure() - Method in class org.forgerock.openig.filter.oauth2.Result
Returns true if this Result is a failure, false otherwise.
isFailure() - Method in class org.forgerock.openig.tools.jwt.Result
Returns true if this Result is a failure, false otherwise.
isFatal() - Method in exception org.forgerock.opendj.ldap.DecodeException
Indicates whether the error was fatal and the associated input source can no longer be used.
isHttpOnly() - Method in class org.forgerock.http.protocol.Cookie
Returns true if the user agent should make the cookie inaccessible to client side script.
isHumanReadable() - Method in class org.forgerock.opendj.ldap.schema.Syntax
Indicates whether this attribute syntax would likely be a human readable string.
isHumanReadable() - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Indicates whether this attribute syntax would likely be a human readable string.
isIgnore() - Method in enum org.forgerock.opendj.ldap.schema.SchemaValidationPolicy.Action
Returns true if this policy is IGNORE.
isIncrement() - Method in class org.forgerock.json.resource.PatchOperation
Returns true if this is an "increment" patch operation.
isInformational() - Method in class org.forgerock.http.protocol.Status
Is the family of this status a Status.Family.INFORMATIONAL one ?
isInScopeOf(Dn, SearchScope) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN matches the provided base DN and search scope.
isInScopeOf(String, SearchScope) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN matches the provided base DN and search scope.
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.
isMultiValued() - Method in class org.forgerock.opendj.ldap.Rdn
Returns true if this RDN contains more than one AVA.
isNotNull() - Method in class org.forgerock.json.JsonValue
Returns true if the value is not null.
isNotNull() - Static method in class org.forgerock.openig.tools.jwt.Constraints
Returns empty if the value is present.
isNoUserModification() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this attribute type is declared "no-user-modification".
isNull() - Method in class org.forgerock.json.JsonValue
Returns true if the value is null.
isNullOrEmpty(String) - Static method in class org.forgerock.util.Strings
Check to see if the provided String is null or empty.
isNullOrEmpty(String) - Static method in class org.forgerock.util.Utils
isNumber() - Method in class org.forgerock.json.JsonValue
Returns true if the JSON value is a Number.
isObjectClass() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether this attribute description is the objectClass attribute description with no options.
isObjectClass() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this attribute type is the objectClass attribute type having the OID 2.5.4.0.
isObsolete() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this schema definition is declared "obsolete".
isObsolete() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Indicates whether this schema definition is declared "obsolete".
isObsolete() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule
Indicates whether this schema definition is declared "obsolete".
isObsolete() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Indicates whether this schema definition is declared "obsolete".
isObsolete() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse
Indicates whether this schema definition is declared "obsolete".
isObsolete() - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns true if this name form is "obsolete".
isObsolete() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether this schema definition is declared "obsolete".
isOperational() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this is an operational attribute.
isOperational() - Method in enum org.forgerock.opendj.ldap.schema.AttributeUsage
Determine whether attributes having this attribute usage are operational.
isOptional(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Indicates whether the provided attribute type is included in the optional attribute list for this DIT content rule.
isOptional(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns true if the provided attribute type is included in the list of optional attributes for this name form.
isOptional(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether the provided attribute type is included in the optional attribute list for this or any of its superior objectclasses.
isParentOf(Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is the immediate parent of the provided DN.
isParentOf(String) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is the immediate parent of the provided DN.
isPercentileHistogram() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
isPersistentSearch(Request) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Returns whether the provided request is a persistent search request.
isPkcs11(String) - Static method in class org.forgerock.opendj.security.KeyManagers
Returns true if the PKCS#11 keystore type can be associated to the provided keystore path.
isPlaceHolder() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether this attribute description is a temporary place-holder allocated dynamically by a non-strict schema when no corresponding registered attribute type was found.
isPlaceHolder() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this attribute type is a temporary place-holder allocated dynamically by a non-strict schema when no registered attribute type was found.
isPlaceHolder() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Returns whether this object class is a placeholder, i.e.
isPrefixOf(JsonPointer) - Method in class org.forgerock.json.JsonPointer
Checks whether candidate is an extension of this JSON Pointer.
isPrivate() - Method in class org.forgerock.json.jose.jwk.EcJWK
 
isPrivate() - Method in class org.forgerock.json.jose.jwk.JWK
Indicates if any private key attributes are present in the JWK.
isPrivate() - Method in class org.forgerock.json.jose.jwk.OctJWK
 
isPrivate() - Method in class org.forgerock.json.jose.jwk.OkpJWK
 
isPrivate() - Method in class org.forgerock.json.jose.jwk.RsaJWK
 
isPropertyRequired(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.events.AuditEventHelper
Gets whether a AuditEvent property is required.
isPublicKeyValid() - Method in class org.forgerock.json.jose.jwk.EcJWK
Checks for validity of the public key portion of this JWK as per EcJWK.isPublicKeyValid(ECPublicKey, SupportedEllipticCurve).
isPublicKeyValid(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.
isPublicKeyValid() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk
Determines whether the public key is a valid point on the underlying elliptic curve.
isPublicKeyValid() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Determines whether the public key is valid.
isPublishingHistogram() - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
isQuoted() - Method in class org.forgerock.http.header.Directive
Return true if the original directive value was enclosed in quotes.
isRawContentEmpty() - Method in class org.forgerock.http.protocol.Entity
Returns true if this entity's raw content is empty.
isReal() - Method in interface org.forgerock.opendj.ldap.Attribute
Indicates whether this is a real attribute (persisted) rather than a virtual attribute (dynamically computed).
isRedirection() - Method in class org.forgerock.http.protocol.Status
Is the family of this status a Status.Family.REDIRECTION one ?
isReference() - Method in class org.forgerock.opendj.ldif.ConnectionEntryReader
Waits for the next search result entry or reference to become available and returns true if it is a reference, or false if it is an entry.
isReferral() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
isReferral() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
isReferral() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
isReferral() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
isReferral() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
isReferral() - Method in interface org.forgerock.opendj.ldap.messages.Result
Indicates whether a referral needs to be chased in order to complete the operation.
isReferral() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
isReject() - Method in enum org.forgerock.opendj.ldap.schema.SchemaValidationPolicy.Action
Returns true if this policy is REJECT.
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.json.schema.validator.validators.Validator
Returns whether the schema represented by this validator is required.
isRequired(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Indicates whether the provided attribute type is included in the required attribute list for this DIT content rule.
isRequired(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns true if the provided attribute type is included in the list of required attributes for this name form.
isRequired(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether the provided attribute type is included in the required attribute list for this or any of its superior objectclasses.
isRequiredOrOptional(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule
Indicates whether the provided attribute type is in the list of required or optional attributes for this DIT content rule.
isRequiredOrOptional(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.NameForm
Returns true if the provided attribute type is included in the list of optional or required attributes for this name form.
isRequiredOrOptional(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass
Indicates whether the provided attribute type is in the list of required or optional attributes for this objectclass or any of its superior classes.
isResult() - Method in interface org.forgerock.util.promise.Promise
Returns true if this Promise has completed and contains a value.
isResult() - Method in class org.forgerock.util.promise.PromiseImpl
 
isReturnEcs() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
Returns true if the entry change notification control should be included in updated entries that match the associated search criteria.
isReverseDnsLookupEnabled() - Method in class org.forgerock.audit.events.AccessAuditEventBuilder
Whether the client.host should be looked up from client.ip.
isReverseOrder() - Method in class org.forgerock.opendj.ldap.SortKey
Returns true if this sort key should be evaluated in reverse (descending) order.
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.
isRootDn() - Method in class org.forgerock.opendj.ldap.Dn
Deprecated.
use Dn.isEmpty() instead
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.
isSaslBindInProgress() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
Indicates whether the server requires the client to send a new SASL Bind request with the same SASL mechanism in order to continue the authentication process.
isSaslBindRequest() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Return true if this bind request's authentication type is BindRequest.AUTHENTICATION_TYPE_SASL.
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 enum org.forgerock.opendj.ldap.ConnectionSecurity
Returns whether this connection security is considered secure.
isSecure() - Method in class org.forgerock.opendj.ldap.LdapUrl
Returns true if this LDAP URL should use LDAPS or false if it should use LDAP.
isSecure(String) - Static method in class org.forgerock.openig.websocket.UriUtils
Returns true if the given URI scheme is for a secure (TLS) connection.
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.
isShutdown() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
isSimpleBindRequest() - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Return true if this bind request's authentication type is BindRequest.AUTHENTICATION_TYPE_SIMPLE.
isSingleEntrySearch() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Indicates whether search result is expected to be limited to a single entry.
isSingleValue() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this attribute type is declared "single-value".
isSslHostNameValidationEnabled() - Static method in class org.forgerock.opendj.security.SslOptions
Returns whether server host name validation against the SSL certificate's subject must be performed.
isStrict() - Method in class org.forgerock.opendj.ldap.schema.Schema
Indicates whether this schema is strict.
isString() - Method in class org.forgerock.json.JsonValue
Returns true if the JSON value is a String.
isSubEntry(Entry) - Static method in class org.forgerock.opendj.ldap.Entries
Returns whether the provided entry is a sub entry.
isSubordinateOrEqualTo(Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is subordinate to or equal to the provided DN.
isSubordinateOrEqualTo(String) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is subordinate to or equal to the provided DN.
isSubordinateTo(String) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is subordinate to, but not equal to the provided DN.
isSubordinateTo(Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is subordinate to, but not equal to the provided DN.
isSubTypeOf(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether this attribute description is a sub-type of the provided attribute description as defined in RFC 4512 section 2.5.
isSubTypeOf(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this attribute type is a sub-type of the provided attribute type.
isSuccess() - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
isSuccess() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
isSuccess() - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
isSuccess() - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
isSuccess() - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
isSuccess() - Method in interface org.forgerock.opendj.ldap.messages.Result
Indicates whether the request succeeded or not.
isSuccess() - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
isSuccess() - Method in class org.forgerock.openig.filter.oauth2.Result
Returns true if this Result is a success, false otherwise.
isSuccess() - Method in class org.forgerock.openig.tools.jwt.Result
Returns true if this Result is a success, false otherwise.
isSuccess() - Method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Returns true if this acknowledgment message is a success, false otherwise.
isSuccessful() - Method in class org.forgerock.http.protocol.Status
Is the family of this status a Status.Family.SUCCESSFUL one ?
Issuer - Class in org.forgerock.openig.filter.oauth2.client
A configuration for an OpenID Connect Issuer.
Issuer(String, JsonValue) - Constructor for class org.forgerock.openig.filter.oauth2.client.Issuer
Creates an issuer with the specified name and configuration.
Issuer.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.
isSuperiorOrEqualTo(Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is superior to or equal to the provided DN.
isSuperiorOrEqualTo(String) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is superior to or equal to the provided DN.
isSuperiorTo(String) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is superior to, but not equal to the provided DN.
isSuperiorTo(Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns true if this DN is superior to, but not equal to the provided DN.
isSuperTypeOf(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether this attribute description is a super-type of the provided attribute description as defined in RFC 4512 section 2.5.
isSuperTypeOf(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Indicates whether this attribute type is a super-type of the provided attribute type.
isTerminated() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
isTransform() - Method in class org.forgerock.json.resource.PatchOperation
Returns true if this is a "transform" patch operation.
isTransientError() - Method in class org.forgerock.opendj.ldap.ResultCode
Returns whether an exceptional result code represents a transient error.
isTypesOnly() - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Indicates whether search results are to contain both attribute descriptions and values, or just attribute descriptions.
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.
isValid() - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Returns true if this connection has not been closed and no fatal errors have been detected.
isValid() - Method in interface org.forgerock.opendj.ldap.Connection
Returns true if this connection has not been closed and no fatal errors have been detected.
isValid() - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Returns true if this connection has not been closed and no fatal errors have been detected.
isValid() - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Returns true if the associated connection has not been closed and no fatal errors have been detected.
isValid() - Method in class org.forgerock.openig.tools.jwt.JwtValidatorResult
Returns true if the JWT is valid, false otherwise.
isValueOfType(Object, Class<?>) - Method in class org.forgerock.json.jose.jwt.JWObject
Checks to see if the given value is of an assignable type from the required class.
isVirtual() - Method in interface org.forgerock.opendj.ldap.Attribute
Indicates whether this is a virtual attribute (dynamically computed) rather than a real attribute (persisted).
isVirtual() - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
isWarn() - Method in enum org.forgerock.opendj.ldap.schema.SchemaValidationPolicy.Action
Returns true if this policy is WARN.
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.
isXDHCurve() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Determines whether this curve is intended for use with X-Diffie-Hellman (XDH) key agreement (X25519 or X448).
isXDHSupported() - Static method in class org.forgerock.json.jose.utils.XECUtils
Indicates whether XDH (Diffie-Hellman using the X25519/X448 curves) is supported by this JDK.
isXecKey(Key) - Static method in class org.forgerock.json.jose.utils.XECUtils
Determines whether the given key is a XECKey.
isZero() - Method in class org.forgerock.util.time.Duration
Returns true if this Duration represents a zero-length duration.
ITEMS - Static variable in class org.forgerock.json.schema.validator.Constants
The items field name.
iterator() - Method in class org.forgerock.http.util.SetDecorator
 
iterator() - Method in class org.forgerock.json.JsonPointer
Returns an iterator over the pointer's reference tokens.
iterator() - Method in class org.forgerock.json.JsonValue
Returns an iterator over the child values that this JSON value contains.
iterator() - Method in class org.forgerock.json.resource.ResourcePath
Returns an iterator over the path elements in this resource path.
iterator() - Method in class org.forgerock.monitoring.api.instrument.Tags
 
iterator() - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
iterator() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns an iterator over the attribute values in this attribute.
iterator() - Method in class org.forgerock.opendj.ldap.Dn
Returns an iterator of the RDNs contained in this DN.
iterator() - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
iterator() - Method in class org.forgerock.opendj.ldap.Rdn
Returns an iterator of the AVAs contained in this RDN.
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

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 - Static variable in class org.forgerock.opendj.security.KeyManagers
JCEKS keystore type.
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.
JKS - Static variable in class org.forgerock.opendj.security.KeyManagers
JKS keystore type.
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.Strings
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.Strings
Returns a string whose content is the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
joinAsString(StringBuilder, String, Object...) - Static method in class org.forgerock.util.Strings
Appends into the provided StringBuilder the string representation of the provided objects concatenated together using the provided separator.
joinAsString(StringBuilder, String, Iterable<?>) - Static method in class org.forgerock.util.Strings
Appends into the provided StringBuilder the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
joinAsString(String, Object...) - Static method in class org.forgerock.util.Utils
joinAsString(String, Iterable<?>) - Static method in class org.forgerock.util.Utils
joinAsString(StringBuilder, String, Object...) - Static method in class org.forgerock.util.Utils
joinAsString(StringBuilder, String, Iterable<?>) - Static method in class org.forgerock.util.Utils
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.
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.am.AmService
Build the endpoint URI for an endpoint located in the /json namespace.
json(String) - Method in class org.forgerock.openig.tools.am.AmService
Build the endpoint URI for an endpoint located in the /json namespace.
json() - Method in class org.forgerock.openig.tools.am.UriService
Build the endpoint URI for an endpoint located in the /json namespace.
json(String) - Method in class org.forgerock.openig.tools.am.UriService
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.
jsonResolver(String) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Construct a new JsonValueResolver using the given filename.
jsonResolver(Path) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Construct a new JsonValueResolver using a file at the given path.
jsonResolver(File) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Construct a new JsonValueResolver using a given file.
jsonResolver(JsonValue) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Construct a new JsonValueResolver using a given a JsonValue.
jsonResolver(String, JsonValue) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Construct a new JsonValueResolver using a given a JsonValue.
JsonSchemaUtils - Class in org.forgerock.audit.util
Contains Utility methods for dealing with JsonSchema data.
jsonUri() - Method in class org.forgerock.openig.tools.am.AmService
Build the endpoint URI for an endpoint located in the /json namespace.
jsonUri(String) - Method in class org.forgerock.openig.tools.am.AmService
Build the endpoint URI for an endpoint located in the /json namespace.
jsonUri() - Method in class org.forgerock.openig.tools.am.UriService
Build the endpoint URI for an endpoint located in the /json namespace.
jsonUri(String) - Method in class org.forgerock.openig.tools.am.UriService
Build the endpoint URI for an endpoint located in the /json namespace.
jsonValue - Variable in class org.forgerock.audit.events.AuditEventBuilder
Represents the event as a JSON value.
JsonValue - Class in org.forgerock.json
Represents a value in a JSON object model structure.
JsonValue(Object) - Constructor for class org.forgerock.json.JsonValue
Constructs a JSON value object with a given object.
JsonValue(Object, JsonPointer) - Constructor for class org.forgerock.json.JsonValue
Constructs a JSON value object with a given object and pointer.
JsonValueDecoder - Class in org.forgerock.openig.tools.notifications.ws
Transforms a JSON content to a JsonValue instance.
JsonValueDecoder() - Constructor for class org.forgerock.openig.tools.notifications.ws.JsonValueDecoder
 
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.
JsonValueFunctions - Class in org.forgerock.json.resource
This class contains the utility functions to convert a JsonValue to CREST (json-resource) types.
JsonValueModule() - Constructor for class org.forgerock.http.util.Json.JsonValueModule
 
JsonValuePropertyEvaluator - Class in org.forgerock.config.util
A utility that traverses a JsonValue and does property substitution as well as type coercion.
JsonValuePropertyEvaluator(SubstitutionService, List<JsonValuePropertyEvaluator.CoercionFunctionSpec>) - Constructor for class org.forgerock.config.util.JsonValuePropertyEvaluator
Constructs a JsonValuePropertyEvaluator which traverses a JsonValue and does property substitution as well as type coercion.
JsonValuePropertyEvaluator.CoercionFunctionSpec - Class in org.forgerock.config.util
The specification for a coercion function.
JsonValuePropertyEvaluator.CoercionFunctionSpecBuilder - Class in org.forgerock.config.util
JsonValueResolver - Class in org.forgerock.config.resolvers
A configuration property resolver that uses a JsonValue to resolve properties.
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.
jvmDefaultKeyStore() - Static method in class org.forgerock.opendj.security.KeyManagers
Returns the JVM default keystore.
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.
JwksStore(Duration, Duration, URL, JWKSetParser, Clock) - Constructor for class org.forgerock.json.jose.jwk.store.JwksStore
Create a new JWKs store.
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(JwtConstraint) - Method in class org.forgerock.openig.tools.jwt.JwtValidator.Builder
Adds a JwtConstraint on the JWT.
JwtBuilder - Interface in org.forgerock.json.jose.builders
The base interface for all JwtBuilders for each type of JWT (plaintext, signed or encrypted).
JwtBuilderContext - Class in org.forgerock.openig.filter
Used by the JwtBuilderFilter to make the JWT available in the context.
JwtBuilderException - Exception in org.forgerock.json.jose.exceptions
Represents an exception that occurs when creating/rebuilding JWTs.
JwtBuilderException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException
Constructs a new JwtBuilderException with the provided exception message.
JwtBuilderException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException
Constructs a new JwtBuilderException with the provided exception message and underlying throwable.
JwtBuilderException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException
Constructs a new JwtBuilderException with the provided underlying throwable.
JwtBuilderFactory - Class in org.forgerock.json.jose.builders
A factory for getting builders for plaintext, signed and encrypted JWTs and reconstructing JWT strings back into their relevant JWT objects.
JwtBuilderFactory() - Constructor for class org.forgerock.json.jose.builders.JwtBuilderFactory
 
JwtBuilderFilter - Class in org.forgerock.openig.filter
The JwtBuilderFilter collects data from template and puts the name-value pairs into a JWT structure.
JwtBuilderFilter(JsonValue, JwtFactory) - Constructor for class org.forgerock.openig.filter.JwtBuilderFilter
Creates a new JwtBuilderFilter which will create a JWT based on the given JSON template and place it into the context JwtBuilderContext.
JwtBuilderFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes an JwtBuilderFilter in a heap environment.
JwtClaimConstraint<T> - Interface in org.forgerock.openig.tools.jwt
A JwtClaimConstraint represents an individual check that can applied to test a claim from a JWT.
JwtClaimsSet - Class in org.forgerock.json.jose.jwt
An implementation that holds a JWT's Claims Set.
JwtClaimsSet() - Constructor for class org.forgerock.json.jose.jwt.JwtClaimsSet
Constructs a new, empty JwtClaimsSet.
JwtClaimsSet(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwt.JwtClaimsSet
Constructs a new JwtClaimsSet, with its claims set to the contents of the given Map.
JwtClaimsSetBuilder - Class in org.forgerock.json.jose.builders
An implementation of a JWT Claims Set builder that provides a fluent builder pattern to creating JWT Claims Sets.
JwtClaimsSetBuilder() - Constructor for class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
 
JwtClaimsSetKey - Enum in org.forgerock.json.jose.jwt
An Enum for the JWT Claims Set names.
JwtConstraint - Interface in org.forgerock.openig.tools.jwt
A JwtConstraint represents an individual check that can applied to test a JWT.
JwtCookieSession - Class in org.forgerock.openig.jwt
Represents an Identity Gateway Session that will be stored as an encrypted and signed JSON Web Token in a Cookie.
JwtCookieSession(Request, KeyPair, CookieBuilder, Clock, Duration, boolean, SigningHandler) - Constructor for class org.forgerock.openig.jwt.JwtCookieSession
Builds a new JwtCookieSession that will manage the given Request's session.
JwtFactory - Interface in org.forgerock.openig.filter
A JwtFactory encapsulates JWT production strategy into a re-usable and testable design.
JwtHeader - Class in org.forgerock.json.jose.jwt
A base implementation class for JWT Headers.
JwtHeader() - Constructor for class org.forgerock.json.jose.jwt.JwtHeader
Constructs a new JwtHeader, with the "typ" parameter set to "JWT".
JwtHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwt.JwtHeader
Constructs a new JwtHeader, with its parameters set to the contents of the given Map.
JwtHeaderBuilder<T extends JwtBuilder,B extends JwtHeaderBuilder<T,B>> - Class in org.forgerock.json.jose.builders
A base implementation of a JWT header builder that provides a fluent builder pattern to creating JWT headers.
JwtHeaderBuilder(T) - Constructor for class org.forgerock.json.jose.builders.JwtHeaderBuilder
Constructs a new JwtHeaderBuilder, parented by the given JwtBuilder.
JwtHeaderKey - Enum in org.forgerock.json.jose.jwt
An Enum for the JWT Header parameter names.
JwtReconstruction - Class in org.forgerock.json.jose.common
A service that provides a method for reconstruct a JWT string back into its relevant JWT object, (SignedJwt, EncryptedJwt, 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, CookieBuilder, Clock, 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.
JwtUtil - Class in org.forgerock.openig.tools
Utility methods supporting JWTs.
JwtValidator - Class in org.forgerock.openig.tools.jwt
The JwtValidator is responsible for the JWT validation.
JwtValidator.Builder - Class in org.forgerock.openig.tools.jwt
Builder for the JwtValidator.
JwtValidatorResult - Class in org.forgerock.openig.tools.jwt
A class that handles the results for the JWT validation.

K

KEY_AGREEMENT - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for an interactive key agreement protocol, such as Diffie-Hellman (DH) or the elliptic curve equivalent (ECDH).
KEY_DECRYPTION - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for decrypting ("unwrapping") other keys.
KEY_ENCRYPTION - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for encrypting ("wrapping") other keys.
KeyAgreementKey - Class in org.forgerock.secrets.keys
A key that is used in a key-agreement protocol (such as Diffie-Hellman) to agree another key.
KeyAgreementKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.KeyAgreementKey
Initialises the key with the given secret data.
KeyDecryptionKey - Class in org.forgerock.secrets.keys
A key that is used to decrypt (or "unwrap") other keys that have been encrypted with a KeyEncryptionKey.
KeyDecryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.KeyDecryptionKey
Initialises the key with the given secret data.
KeyEncryptionKey - Class in org.forgerock.secrets.keys
A key that is used to encrypt ("wrap") other keys.
KeyEncryptionKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.KeyEncryptionKey
Initialises the key with the given secret data.
KeyFormat<T> - Interface in org.forgerock.secrets.keys
A format that can be used for exporting key material.
KeyFormatPem - Class in org.forgerock.secrets.keys
Exports a key in the PEM (Privacy Enhanced Mail) format.
KeyFormatPem(boolean, SecretReference<GenericSecret>) - Constructor for class org.forgerock.secrets.keys.KeyFormatPem
Constructs a new PEM key format that encrypts private keys using the given password.
KeyFormatPem(boolean) - Constructor for class org.forgerock.secrets.keys.KeyFormatPem
Constructs a new PEM key format that does not encrypt private keys.
KeyFormatRaw - Enum in org.forgerock.secrets.keys
Exports the raw key.
keyId - Variable in class org.forgerock.json.jose.jwk.JWK.Builder
The key ID, optional.
keyId(String) - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Sets the keyId parameter of the JWK.
KeyManagerHeaplet - Class in org.forgerock.openig.security
Represents an SSL Java KeyManager.
KeyManagerHeaplet() - Constructor for class org.forgerock.openig.security.KeyManagerHeaplet
 
KeyManagers - Class in org.forgerock.opendj.security
This class contains methods for creating common types of key manager.
keyMatch(Object, String) - Static method in class org.forgerock.openig.el.Functions
Returns the first key found in a map that matches the specified regular expression pattern, or null if no such match is found.
KeyOperation - Enum in org.forgerock.json.jose.jwk
Represents the Possible key operations values.
keyOperations - Variable in class org.forgerock.json.jose.jwk.JWK.Builder
The key operations, optional.
keyOperations(Set<KeyOperation>) - Method in class org.forgerock.json.jose.jwk.JWK.Builder
Set the key operations parameter of the JWK.
keyPair(KeyPair) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the public and private values from the given key pair, which must consist of an OkpJWK.OctetECPublicKey and OkpJWK.OctetECPrivateKey.
keys() - Method in class org.forgerock.config.resolvers.JsonValueResolver
 
keys() - Method in class org.forgerock.config.resolvers.PropertiesResolver
 
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.
KeyStoreObject - Class in org.forgerock.opendj.security
An in memory representation of a LDAP key store object.
KeyStoreObjectCache - Interface in org.forgerock.opendj.security
A service provider interface for implementing key store caches.
KeyStoreParameters - Class in org.forgerock.opendj.security
The parameters which configure how the LDAP key store will be accessed.
KeyStoreSecretStore - Class in org.forgerock.secrets.keystore
A secret store for cryptographic keys based on a standard Java KeyStore.
KeyStoreSecretStore(Function<char[], KeyStore, KeyStoreException>, SecretReference<GenericSecret>, SecretReference<GenericSecret>, Options, KeyStoreSecretStore.StableIdProvider) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore
Initialises the key store.
KeyStoreSecretStore(Function<char[], KeyStore, KeyStoreException>, SecretReference<GenericSecret>, Options) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore
Initialises the keystore using the same password for the keystore and all keys.
KeyStoreSecretStore(Function<char[], KeyStore, KeyStoreException>, SecretReference<GenericSecret>) - Constructor for class org.forgerock.secrets.keystore.KeyStoreSecretStore
Initialises the keystore using the same password for the keystore and all keys and default configuration options.
KeyStoreSecretStore.AliasSpec - Class in org.forgerock.secrets.keystore
Specifies an alias with its validity for use in the store.
KeyStoreSecretStore.KeyDetails - Class in org.forgerock.secrets.keystore
Details of a key that comes from the keystore.
KeyStoreSecretStore.StableIdProvider - Interface in org.forgerock.secrets.keystore
An interface to allow the consuming application to provide the stable ID for the secret.
KeyStoreSecretStoreHeaplet - Class in org.forgerock.openig.secrets
This heaplet represents an instance of a KeyStoreSecretStore.
KeyStoreSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.KeyStoreSecretStoreHeaplet
 
KeyStoreSecureStorage - Class in org.forgerock.audit.secure
Implementation of a secure storage using a keystore.
KeyStoreSecureStorage(KeyStoreHandler, PrivateKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage
Creates the storage with a keystore handler, initialized to verify only.
KeyStoreSecureStorage(KeyStoreHandler, PublicKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage
Creates the storage with a keystore handler, initialized to verify only.
KeyStoreSecureStorage(KeyStoreHandler, PublicKey, PrivateKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage
Creates the storage with a keystore handler, initialized to verify only.
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
KeyStoreUtil - Class in org.forgerock.openig.util
Utility class to retrieve private keys from KeyStore.
keyToHumanReadableString(ByteSequence) - Method in interface org.forgerock.opendj.ldap.spi.Indexer
Returns a human readable representation of the key.
keyType - Variable in class org.forgerock.json.jose.jwk.JWK.Builder
The key type, required.
KeyType - Enum in org.forgerock.json.jose.jwk
Enum representing the possible KeyTypes.
KeyType - Enum in org.forgerock.secrets.keys
Indicates the type of key.
KeyUsage - Enum in org.forgerock.secrets.keys
Indicates the allowed usages for a particular key.
keyUsages(Set<KeyUsage>) - Method in class org.forgerock.secrets.SecretBuilder
Sets the allowed key usages for this key.
keyUse(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

LABEL_PATTERN - Static variable in class org.forgerock.secrets.Purpose
The regular expression to use when validating purpose labels.
LambdaExceptionUtils - Class in org.forgerock.util
Utility methods for interacting with lambdas that throw exceptions.
lastIndexOf(Object) - Method in class org.forgerock.util.LazyList
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
lastIndexOf(Object) - Method in class org.forgerock.util.ListDecorator
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
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.
Ldap - Class in org.forgerock.opendj.io
This class contains various static utility methods encoding and decoding LDAP protocol elements.
LDAP_CLIENT_AUTHN_BIND_REQUEST - Static variable in class org.forgerock.opendj.ldap.LdapClients
Configures the connection factory to return pre-authenticated connections using the specified BindRequest.
LDAP_CLIENT_AUTHN_BIND_REQUEST_FACTORY - Static variable in class org.forgerock.opendj.ldap.LdapClients
Configures the connection factory to return pre-authenticated connections using BindRequest provided by the specified Supplier.
LDAP_CLIENT_CONNECT_TIMEOUT - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the connect timeout specified.
LDAP_CLIENT_HEARTBEAT_ENABLED - Static variable in class org.forgerock.opendj.ldap.LdapClients
Configures the connection factory to periodically send "heart-beat" or "keep-alive" requests to the Directory Server.
LDAP_CLIENT_HEARTBEAT_INTERVAL - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the time between successive heart-beat requests (default interval is 10 seconds).
LDAP_CLIENT_HEARTBEAT_SCHEDULER - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the scheduler which will be used for periodically sending heart-beat requests.
LDAP_CLIENT_HEARTBEAT_SEARCH_REQUEST - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the parameters of the search request that will be used for heart-beats.
LDAP_CLIENT_HEARTBEAT_TIMEOUT - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the timeout for heart-beat requests, after which the remote Directory Server will be deemed to be unavailable (default timeout is 3 seconds).
LDAP_CLIENT_MAX_CONCURRENT_REQUESTS - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the maximum number of concurrent requests per connection.
LDAP_CLIENT_REQUEST_TIMEOUT - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the operation timeout.
LDAP_CLIENT_SSL_USE_STARTTLS - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.
LdapClient - Interface in org.forgerock.opendj.ldap
An LDAP client provides an interface for obtaining a connection to a Directory Server.
LdapClient - Class in org.forgerock.openig.ldap
This class acts as a simplified access point into the OpenDJ LDAP SDK.
LdapClients - Class in org.forgerock.opendj.ldap
This class contains methods for creating and manipulating LDAP clients and connections.
LdapClientSocket - Interface in org.forgerock.opendj.ldap
A connection with a Directory Server over which read and update operations may be performed.
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.
LdapConnectionFactory - Class in org.forgerock.opendj.ldap
A factory class which can be used to obtain connections to an LDAP Directory Server.
LdapConnectionFactory(String, int) - Constructor for class org.forgerock.opendj.ldap.LdapConnectionFactory
Creates a new LDAP connection factory which can be used to create LDAP connections to the Directory Server at the provided host and port number.
LdapConnectionFactory(String, int, Options) - Constructor for class org.forgerock.opendj.ldap.LdapConnectionFactory
Creates a new LDAP connection factory which can be used to create LDAP connections to the Directory Server at the provided host and port number.
LdapConnectionFactory(LdapClient) - Constructor for class org.forgerock.opendj.ldap.LdapConnectionFactory
Creates a new LDAP connection factory which can be used to create LDAP connections to the Directory Server at the provided host and port number.
LdapException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request was unsuccessful.
LdapException(Result) - Constructor for exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception using the provided result.
LdapMessage - Class in org.forgerock.opendj.ldap.messages
Encapsulates a ProtocolOp with LDAP specific message information.
LdapPromise<S> - Interface in org.forgerock.opendj.ldap
A handle which can be used to retrieve the Result of an asynchronous Request.
LdapPromiseImpl<S> - Class in org.forgerock.opendj.ldap.spi
This class provides an implementation of the LdapPromise.
LdapPromises - Class in org.forgerock.opendj.ldap.spi
Utility methods for creating and composing LdapPromises.
LdapReader<R extends Asn1Reader> - Class in org.forgerock.opendj.io
Reads LDAP messages from an underlying ASN.1 reader.
LdapResultHandler<S> - Interface in org.forgerock.opendj.ldap
A completion handler for consuming the result of an asynchronous operation or connection attempts.
LdapServer - Class in org.forgerock.opendj.ldap
An LDAP server connection listener which waits for LDAP connection requests to come in over the network and binds them to a server connection created using the provided server connection factory.
LdapServer(int, Function<LdapSession, BiFunction<Integer, Request, Flowable<Response>>>) - Constructor for class org.forgerock.opendj.ldap.LdapServer
Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
LdapServer(int, Function<LdapSession, BiFunction<Integer, Request, Flowable<Response>>>, Options) - Constructor for class org.forgerock.opendj.ldap.LdapServer
Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
LdapServer(Set<InetSocketAddress>, Function<LdapSession, BiFunction<Integer, Request, Flowable<Response>>>) - Constructor for class org.forgerock.opendj.ldap.LdapServer
Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
LdapServer(Set<InetSocketAddress>, Function<LdapSession, BiFunction<Integer, Request, Flowable<Response>>>, Options) - Constructor for class org.forgerock.opendj.ldap.LdapServer
Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
LdapServer(String, int, Function<LdapSession, BiFunction<Integer, Request, Flowable<Response>>>) - Constructor for class org.forgerock.opendj.ldap.LdapServer
Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
LdapServer(String, int, Function<LdapSession, BiFunction<Integer, Request, Flowable<Response>>>, Options) - Constructor for class org.forgerock.opendj.ldap.LdapServer
Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
LdapSession - Interface in org.forgerock.opendj.ldap
Server side representation of a connected LDAP client.
LdapSessionCompletionListener - Interface in org.forgerock.opendj.ldap
A listener interface for handling LdapSession termination.
LdapSocket - Interface in org.forgerock.opendj.io
A socket implementation representing a stream of LDAP messages.
LdapSocketAcceptor - Interface in org.forgerock.opendj.io
An LDAP socket acceptor listens for incoming connections and binds them to an LdapSocket.
LdapSocketClosedException - Exception in org.forgerock.opendj.io
Thrown when a LdapSocket has been closed locally.
LdapSocketConnector - Interface in org.forgerock.opendj.io
An LDAP socket connector provides a new LdapSocket connected to a peer each time it is subscribed.
LdapUrl - Class in org.forgerock.opendj.ldap
An LDAP URL as defined in RFC 4516.
LdapUrl(boolean, String, Integer, Dn) - Constructor for class org.forgerock.opendj.ldap.LdapUrl
Creates a new LDAP URL referring to a single entry on the specified server.
LdapUrl(boolean, String, Integer, Dn, SearchScope, Filter, String...) - Constructor for class org.forgerock.opendj.ldap.LdapUrl
Creates a new LDAP URL including the full set of parameters for a search request.
LdapWriter<W extends Asn1Writer> - Class in org.forgerock.opendj.io
Writes LDAP messages to an underlying ASN.1 writer.
Ldif - Class in org.forgerock.opendj.ldif
This class contains common utility methods for creating and manipulating readers and writers.
LdifChangeRecordReader - Class in org.forgerock.opendj.ldif
An LDIF change record reader reads change records using the LDAP Data Interchange Format (LDIF) from a user defined source.
LdifChangeRecordReader(InputStream) - Constructor for class org.forgerock.opendj.ldif.LdifChangeRecordReader
Creates a new LDIF change record reader whose source is the provided input stream.
LdifChangeRecordReader(List<String>) - Constructor for class org.forgerock.opendj.ldif.LdifChangeRecordReader
Creates a new LDIF change record reader which will read lines of LDIF from the provided list of LDIF lines.
LdifChangeRecordReader(Reader) - Constructor for class org.forgerock.opendj.ldif.LdifChangeRecordReader
Creates a new LDIF change record reader whose source is the provided character stream reader.
LdifChangeRecordReader(String...) - Constructor for class org.forgerock.opendj.ldif.LdifChangeRecordReader
Creates a new LDIF change record reader which will read lines of LDIF from the provided array of LDIF lines.
LdifChangeRecordWriter - Class in org.forgerock.opendj.ldif
An LDIF change record writer writes change records using the LDAP Data Interchange Format (LDIF) to a user defined destination.
LdifChangeRecordWriter(List<String>) - Constructor for class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Creates a new LDIF change record writer which will append lines of LDIF to the provided list.
LdifChangeRecordWriter(OutputStream) - Constructor for class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Creates a new LDIF change record writer whose destination is the provided output stream.
LdifChangeRecordWriter(Writer) - Constructor for class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Creates a new LDIF change record writer whose destination is the provided character stream writer.
LdifEntryReader - Class in org.forgerock.opendj.ldif
An LDIF entry reader reads attribute value records (entries) using the LDAP Data Interchange Format (LDIF) from a user defined source.
LdifEntryReader(InputStream) - Constructor for class org.forgerock.opendj.ldif.LdifEntryReader
Creates a new LDIF entry reader whose source is the provided input stream.
LdifEntryReader(List<String>) - Constructor for class org.forgerock.opendj.ldif.LdifEntryReader
Creates a new LDIF entry reader which will read lines of LDIF from the provided list of LDIF lines.
LdifEntryReader(Reader) - Constructor for class org.forgerock.opendj.ldif.LdifEntryReader
Creates a new LDIF entry reader whose source is the provided character stream reader.
LdifEntryReader(String...) - Constructor for class org.forgerock.opendj.ldif.LdifEntryReader
Creates a new LDIF entry reader which will read lines of LDIF from the provided array of LDIF lines.
LdifEntryWriter - Class in org.forgerock.opendj.ldif
An LDIF entry writer writes attribute value records (entries) using the LDAP Data Interchange Format (LDIF) to a user defined destination.
LdifEntryWriter(List<String>) - Constructor for class org.forgerock.opendj.ldif.LdifEntryWriter
Creates a new LDIF entry writer which will append lines of LDIF to the provided list.
LdifEntryWriter(OutputStream) - Constructor for class org.forgerock.opendj.ldif.LdifEntryWriter
Creates a new LDIF entry writer whose destination is the provided output stream.
LdifEntryWriter(Writer) - Constructor for class org.forgerock.opendj.ldif.LdifEntryWriter
Creates a new LDIF entry writer whose destination is the provided character stream writer.
leaf() - Method in class org.forgerock.json.JsonPointer
Returns the last (leaf) reference token of the JSON pointer, or null if the pointer contains no reference tokens (i.e.
leaf() - Method in class org.forgerock.json.resource.ResourcePath
Returns the last path element in this resource path.
LEASE_EXPIRY_DURATION - Static variable in interface org.forgerock.secrets.SecretStore
Option used to specify how long secrets from a store should be used before being refreshed.
LeftValueExpression<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 interface org.forgerock.opendj.ldap.ByteSequence
Returns the length of this byte sequence.
length() - Method in class org.forgerock.opendj.ldap.ByteString
 
length() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
length(Object) - Static method in class org.forgerock.openig.el.Functions
Returns the number of items in a collection, or the number of characters in a string.
LENGTH_REQUIRED - Static variable in class org.forgerock.http.protocol.Status
The 411 (Length Required) status code indicates that the server refuses to accept the request without a defined Content-Length (Section 3.3.2 of [RFC7230]).
LESS_EQUAL - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "less-than-or-equal" operator.
LESS_THAN - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "less-than" operator.
lessOrEqual(String, Object) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new less or equal filter using the provided attribute description and assertion value.
lessOrEqualAssertion(String, ByteSequence) - Static method in interface org.forgerock.opendj.ldap.Assertion
Returns an assertion for less than or equal comparisons.
lessThan(String, Object) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new less than filter using the provided attribute description and assertion value.
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.
lessThanAssertion(String, ByteSequence) - Static method in interface org.forgerock.opendj.ldap.Assertion
Returns an assertion for less than comparisons.
lessThanOrEqualTo(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new less than or equal to filter using the provided field name and value assertion.
LifeCycle - Interface in org.forgerock.openig.tools
Manages Lifecycle on an object.
LinkedAttribute - Class in org.forgerock.opendj.ldap
An implementation of the Attribute interface with predictable iteration order.
LinkedAttribute(Attribute) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the same attribute description and attribute values as attribute.
LinkedAttribute(AttributeDescription) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and no attribute values.
LinkedAttribute(AttributeDescription, Object) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and single attribute value.
LinkedAttribute(AttributeDescription, Object...) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and attribute values.
LinkedAttribute(AttributeDescription, Collection<?>) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and attribute values.
LinkedAttribute(String) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and no attribute values.
LinkedAttribute(String, Collection<?>) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and attribute values.
LinkedAttribute(String, Object) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and single attribute value.
LinkedAttribute(String, Object...) - Constructor for class org.forgerock.opendj.ldap.LinkedAttribute
Creates a new attribute having the specified attribute description and attribute values.
LinkedHashMapEntry - Class in org.forgerock.opendj.ldap
An implementation of the Entry interface which uses a LinkedHashMap for storing attributes.
LinkedHashMapEntry() - Constructor for class org.forgerock.opendj.ldap.LinkedHashMapEntry
Creates an entry with an empty (root) distinguished name and no attributes.
LinkedHashMapEntry(Dn) - Constructor for class org.forgerock.opendj.ldap.LinkedHashMapEntry
Creates an empty entry using the provided distinguished name and no attributes.
LinkedHashMapEntry(String) - Constructor for class org.forgerock.opendj.ldap.LinkedHashMapEntry
Creates an empty entry using the provided distinguished name decoded using the default schema.
LinkedHashMapEntry(String...) - Constructor for class org.forgerock.opendj.ldap.LinkedHashMapEntry
Creates a new entry using the provided lines of LDIF decoded using the default schema.
list - Variable in class org.forgerock.util.ListDecorator
The list wrapped by this decorator.
listAll() - Method in class org.forgerock.openig.ui.record.RecordService
List all persisted records from the file system.
ListDecorator<E> - Class in org.forgerock.util
Wraps another map.
ListDecorator(List<E>) - Constructor for class org.forgerock.util.ListDecorator
Constructs a new list decorator, wrapping the specified list.
listFiles() - Method in interface org.forgerock.audit.retention.FileNamingPolicy
Lists all the archived files.
listFiles() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy
List the files in the initial file directory that match the prefix, name and suffix format.
listIterator() - Method in class org.forgerock.util.LazyList
Returns a list iterator over the elements in this list (in proper sequence).
listIterator(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.
listOf(Function<JsonValue, T, E>) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function that transform a JSON node value into a list of adapted instances.
ListResolver - Class in org.forgerock.openig.resolver
Resolves List objects.
ListResolver() - Constructor for class org.forgerock.openig.resolver.ListResolver
 
Lists - Class in org.forgerock.http.util
Provides helper methods for List.
listShares() - Method in class org.forgerock.openig.uma.UmaSharingService
Returns a copy of the list of currently managed shares.
load(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
 
LOAD_BALANCER_EVENT_LISTENER - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the event listener which should be notified whenever a load-balanced LDAP client changes state from online to offline or vice-versa.
LOAD_BALANCER_IDLE_SERVER_SELECTOR - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies a function to chose a server when all servers are idle.
LOAD_BALANCER_MONITORING_INTERVAL - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the interval between successive attempts to reconnect to offline load-balanced LDAP clients.
LOAD_BALANCER_PARTITION_BASE_DNS - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies partition base DNs.
LOAD_BALANCER_SCHEDULER - Static variable in class org.forgerock.opendj.ldap.LdapClients
Specifies the scheduler which will be used for periodically reconnecting to offline LDAP clients.
LoadBalancerEventListener - Interface in org.forgerock.opendj.ldap
An object that registers to be notified when an LDAP client associated with a load-balancer changes state from offline to online or vice-versa.
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, char[], String, String) - Static method in class org.forgerock.opendj.security.KeyManagers
Loads and then returns a new key store object created with the provided path, password, type and provider.
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.
loadNoOverwrite(EntryReader) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Reads all of the entries from the provided entry reader and adds them to the content of this memory backend.
loadOverwrite(EntryReader) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Reads all of the entries from the provided entry reader and adds them to the content of this memory backend replacing any existing entries having the same name.
localAddress(String) - Method in class org.forgerock.services.context.ClientContext.Builder
Sets the local server's address.
LocalHostNameProvider - Interface in org.forgerock.audit.providers
Strategy for obtaining the server's local hostname.
LocalizableString - Class in org.forgerock.util.i18n
Represents a String which could be localizable.
LocalizableString(String) - Constructor for class org.forgerock.util.i18n.LocalizableString
String only constructor for non-localizable String values.
LocalizableString(String, Class<?>) - Constructor for class org.forgerock.util.i18n.LocalizableString
Constructor for potentially localizable String.
LocalizableString(String, ClassLoader) - Constructor for class org.forgerock.util.i18n.LocalizableString
Constructor for potentially localizable String.
LocalizableString(String, ClassLoader, LocalizableString) - Constructor for class org.forgerock.util.i18n.LocalizableString
Constructor for potentially localizable String.
LocalizableStringModule() - Constructor for class org.forgerock.http.util.Json.LocalizableStringModule
Default constructor.
LocalizedKeyStoreException - Exception in org.forgerock.opendj.security
A localized KeyStoreException.
localName(int) - Method in class org.forgerock.opendj.ldap.Dn
Returns the DN whose content is the specified number of RDNs from this DN.
localPort(int) - Method in class org.forgerock.services.context.ClientContext.Builder
Sets the local server's port.
LocationHeader - Class in org.forgerock.http.header
Processes the Location message header.
LocationHeader() - Constructor for class org.forgerock.http.header.LocationHeader
Constructs a new empty header whose location is null.
LocationHeader(String) - Constructor for class org.forgerock.http.header.LocationHeader
Constructs a new header with the provided location URI.
LocationHeaderFilter - Class in org.forgerock.openig.filter
Rewrites Location headers on responses that generate a redirect that would take the user directly to the application being proxied rather than taking the user through the Identity Gateway.
LocationHeaderFilter() - Constructor for class org.forgerock.openig.filter.LocationHeaderFilter
 
LocationHeaderFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a LocationHeaderFilter in a heap environment.
LOG_EVENTS - Static variable in interface org.forgerock.opendj.ldap.LoadBalancerEventListener
An event listener implementation which logs events to the LoadBalancingAlgorithm logger.
LogAttachedExceptionFilter - Class in org.forgerock.openig.filter
A LogAttachedExceptionFilter prints attached exceptions to filtered responses.
LogAttachedExceptionFilter() - Constructor for class org.forgerock.openig.filter.LogAttachedExceptionFilter
 
logout(Context, String) - Method in class org.forgerock.openig.tools.session.CacheSessionService
 
logout(Context, String) - Method in class org.forgerock.openig.tools.session.CrestSessionService
 
logout(Context, String) - Method in interface org.forgerock.openig.tools.session.SessionService
Returns a promise that will be completed with a Void or with an SessionException in case of errors.
lookup(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.
LOOP_DETECT - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a referral or chaining loop was detected while processing the request.
lowerThan(Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies if this version is strictly lower than the given version.
lowerThanOrEqualTo(Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies if this version is lower or equal to the given version.

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.
major() - Method in class org.forgerock.openig.tools.am.Version
Returns major component of the version.
makeChangeRecord(String...) - Static method in class org.forgerock.opendj.ldif.Ldif
Parses the provided array of LDIF lines as a single LDIF change record.
makeEntries(String...) - Static method in class org.forgerock.opendj.ldap.Entries
Builds a list of entries from the provided lines of LDIF.
makeEntries(String...) - Static method in class org.forgerock.opendj.ldif.Ldif
Builds a list of entries from the provided lines of LDIF.
makeEntries(List<String>) - Static method in class org.forgerock.opendj.ldif.Ldif
Builds a list of entries from the provided lines of LDIF.
makeEntry(String...) - Static method in class org.forgerock.opendj.ldap.Entries
Builds an entry from the provided lines of LDIF.
makeEntry(String...) - Static method in class org.forgerock.opendj.ldif.Ldif
Builds an entry from the provided lines of LDIF.
makeEntry(List<String>) - Static method in class org.forgerock.opendj.ldif.Ldif
Builds an entry from the provided lines of LDIF.
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.
ManageDsaItRequestControl - Class in org.forgerock.opendj.ldap.controls
The ManageDsaIT request control as defined in RFC 3296.
map(Meter.Id) - Method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
 
map - Variable in class org.forgerock.util.MapDecorator
The map wrapped by this decorator.
mapAttributes(Function<Attribute, Attribute>) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Registers a mapping function which should be applied to attributes selected by this attribute filter.
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
 
matched() - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
Indicates whether the attribute value assertion in the Compare request matched a value of the attribute or sub-type according to the attribute's equality matching rule.
matchedUri(String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder
Set the matchedUri value.
MatchedValuesRequestControl - Class in org.forgerock.opendj.ldap.controls
The matched values request control as defined in RFC 3876.
matcher() - Method in class org.forgerock.opendj.ldap.Filter
Returns a Matcher which can be used to compare this Filter against entries using the default schema.
matcher(Schema) - Method in class org.forgerock.opendj.ldap.Filter
Returns a Matcher which can be used to compare this Filter against entries using the provided Schema.
Matcher - Class in org.forgerock.opendj.ldap
A compiled search Filter which may be used for matching against entries.
Matcher.MatcherType - Enum in org.forgerock.opendj.ldap
The types of compiled matcher.
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(InetAddress) - Method in class org.forgerock.opendj.ldap.AddressMask
Returns true if this address mask matches the provided address.
matches(ByteSequence) - Method in interface org.forgerock.opendj.ldap.Assertion
Indicates whether the provided attribute value should be considered a match for this assertion value according to the matching rule.
matches(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Indicates whether the provided attribute description matches this attribute description.
matches(Entry) - Method in class org.forgerock.opendj.ldap.Filter
Indicates whether this Filter matches the provided Entry using the default schema.
matches(Entry) - Method in class org.forgerock.opendj.ldap.Matcher
Indicates whether this filter Matcher matches the provided Entry.
matches(AttributeType) - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Implements a place-holder tolerant version of AttributeType.equals(java.lang.Object).
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.
matchesAllAttributes() - Method in class org.forgerock.opendj.ldap.AttributeFilter
Returns true if this attribute filter matches all attributes, regardless of whether they are user or operational attributes.
matchesAllOperationalAttributes() - Method in class org.forgerock.opendj.ldap.AttributeFilter
Returns true if this attribute filter matches all operational attributes.
matchesAllUserAttributes() - Method in class org.forgerock.opendj.ldap.AttributeFilter
Returns true if this attribute filter matches all user attributes.
matchesAny(Collection<AddressMask>, InetAddress) - Static method in class org.forgerock.opendj.ldap.AddressMask
Returns true if an address matches any of the provided address masks.
matchesAny(Set<? extends ByteSequence>) - Method in interface org.forgerock.opendj.ldap.Assertion
Indicates whether the provided attribute values should be considered a match for this assertion value according to the matching rule.
matchesAnyAttributes() - Method in class org.forgerock.opendj.ldap.AttributeFilter
Returns true if this attribute filter may match some attributes, or false if it will never match any attributes.
matchesApproximateAssertion(Assertion, ByteSequence) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
matchesApproximateAssertion(Assertion, ByteSequence) - Method in interface org.forgerock.opendj.ldap.Attribute
Indicates whether this attribute matches the specified assertion using the attribute's default approximate matching rule.
matchesAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Returns true if this attribute filter matches the provided attribute description.
matchesEqualityAssertion(Assertion, ByteSequence) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
matchesEqualityAssertion(Assertion, ByteSequence) - Method in interface org.forgerock.opendj.ldap.Attribute
Indicates whether this attribute matches the specified assertion using the attribute's default equality matching rule.
matchesEqualityAssertion(Assertion, ByteSequence) - Method in class org.forgerock.opendj.ldap.LinkedAttribute
NOTE: it is only possible to optimize for the equality matching rule because the other matching rules may not be compatible with the equality matching rule's normalized representation.
matchesGreaterOrEqualAssertion(Assertion, ByteSequence) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
matchesGreaterOrEqualAssertion(Assertion, ByteSequence) - Method in interface org.forgerock.opendj.ldap.Attribute
Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.
matchesLessOrEqualAssertion(Assertion, ByteSequence) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
matchesLessOrEqualAssertion(Assertion, ByteSequence) - Method in interface org.forgerock.opendj.ldap.Attribute
Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.
matchesSubstringAssertion(Assertion, ByteSequence, List<? extends ByteSequence>, ByteSequence) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
matchesSubstringAssertion(Assertion, ByteSequence, List<? extends ByteSequence>, ByteSequence) - Method in interface org.forgerock.opendj.ldap.Attribute
Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.
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.
MatchingRule - Class in org.forgerock.opendj.ldap.schema
This class defines a data structure for storing and interacting with matching rules, which are used by servers to compare attribute values against assertion values when performing Search and Compare operations.
MatchingRule.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing matching rules.
MatchingRuleImpl - Interface in org.forgerock.opendj.ldap.schema
This interface defines the set of methods that must be implemented to define a new matching rule.
MatchingRuleUse - Class in org.forgerock.opendj.ldap.schema
This class defines a data structure for storing and interacting with a matching rule use definition, which may be used to restrict the set of attribute types that may be used for a given matching rule.
MatchingRuleUse.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing matching rule uses.
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() - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
The maximum time of a single event.
max() - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
max(TimeUnit) - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
max(TimeUnit) - Method in interface org.forgerock.monitoring.api.instrument.Timer
The maximum time of a single event.
max() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
max(TimeUnit) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
MAX_COMPACT_SIZE - Static variable in class org.forgerock.opendj.ldap.ByteStringBuilder
Maximum size in bytes of a compact encoded value.
MAX_CONCURRENT_REQUESTS - Static variable in class org.forgerock.opendj.ldap.LdapServer
Specifies the maximum number of concurrent requests per connection.
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.
maximumAllowableMetrics(int) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Useful for cost-control in monitoring systems which charge directly or indirectly by the total number of time series you generate.
maximumAllowableTags(String, String, int, MeterFilter) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Places an upper bound on the number of tags produced by matching metrics.
maximumExpectedValue(Long) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Sets the maximum value that this distribution summary is expected to observe.
maximumExpectedValue(Long) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
maximumExpectedValue(Duration) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Sets the maximum value that this timer is expected to observe.
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.
maxKey(AttributeType) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an attribute description having the provided attribute type and a set of options which sorts after any other set of options.
MAXLENGTH - Static variable in class org.forgerock.json.schema.validator.Constants
The maxLength field name.
maxValue() - Static method in class org.forgerock.opendj.ldap.Rdn
Returns a constant containing a special RDN which sorts after any RDN other than itself.
MdcExecutorServiceDelegate - Class in org.forgerock.util.thread
Store SLF4J Mapped Diagnosed Context (aka MDC) when tasks are submitted, and re-inject it when tasks are executed.
MdcExecutorServiceDelegate(ExecutorService) - Constructor for class org.forgerock.util.thread.MdcExecutorServiceDelegate
Constructs an instance of ExecutorService that will forward the SLF4J Mapped Diagnosed Context to submitted tasks, and will execute these on the provided delegate.
MdcRouteIdFilter - Class in org.forgerock.openig.filter
A MdcRouteIdFilter aims to prepare the current thread with SLF4J MDC information about the current route.
MdcRouteIdFilter(String) - Constructor for class org.forgerock.openig.filter.MdcRouteIdFilter
Constructs a filter for preparing MDC for the given routeId.
MdcScheduledExecutorServiceDelegate - Class in org.forgerock.util.thread
Store SLF4J Mapped Diagnosed Context (aka MDC) when tasks are submitted, and re-inject it when tasks are executed.
MdcScheduledExecutorServiceDelegate(ScheduledExecutorService) - Constructor for class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
Constructs an instance of ScheduledExecutorService that will forward the SLF4J Mapped Diagnosed Context to submitted tasks, and will execute these on the provided delegate.
mean() - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
 
mean() - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
mean(TimeUnit) - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
mean(TimeUnit) - Method in interface org.forgerock.monitoring.api.instrument.Timer
 
measure() - Method in interface org.forgerock.monitoring.api.instrument.Counter
 
measure() - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
 
measure() - Method in interface org.forgerock.monitoring.api.instrument.Gauge
 
measure() - Method in interface org.forgerock.monitoring.api.instrument.Meter
Get a set of measurements.
measure() - Method in interface org.forgerock.monitoring.api.instrument.Timer
 
Measurement - Class in org.forgerock.monitoring.api.instrument
A measurement sampled from a meter.
Measurement(Supplier<Double>, Statistic) - Constructor for class org.forgerock.monitoring.api.instrument.Measurement
 
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.
MemoryBackend - Class in org.forgerock.opendj.ldap
A simple in-memory back-end which can be used for testing.
MemoryBackend() - Constructor for class org.forgerock.opendj.ldap.MemoryBackend
Creates a new empty memory backend which will use the default schema.
MemoryBackend(EntryReader) - Constructor for class org.forgerock.opendj.ldap.MemoryBackend
Creates a new memory backend which will use the default schema, and will contain the entries read from the provided entry reader.
MemoryBackend(Schema) - Constructor for class org.forgerock.opendj.ldap.MemoryBackend
Creates a new empty memory backend which will use the provided schema.
MemoryBackend(Schema, EntryReader) - Constructor for class org.forgerock.opendj.ldap.MemoryBackend
Creates a new memory backend which will use the provided schema, and will contain the entries read from the provided entry reader.
merge(List<D>) - Method in interface org.forgerock.http.ApiProducer
Merge the provided descriptors into a single descriptor.
merge(List<Swagger>) - Method in class org.forgerock.http.swagger.SwaggerApiProducer
 
merge(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch
Creates a new JSON value which combines the contents two JSON values.
merge(JsonValue) - Method in class org.forgerock.json.JsonValue
Creates a new JSON value which combines the contents this JSON value with another.
merge(HistogramConfig) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
mergeAttribute(Attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute>) - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
mergeAttribute(Attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute>) - Method in interface org.forgerock.opendj.ldap.Entry
Adds the provided attribute if it is not already present in this Entry.
Message<M extends Message<M>> - 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, int) - Constructor for class org.forgerock.openig.decoration.capture.MessageCapture
Builds a new MessageCapture.
MessageCapture(Logger, boolean, boolean, int) - 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.
Meter - Interface in org.forgerock.monitoring.api.instrument
A counter, gauge, timer, or distribution summary that results collects one or more metrics.
meter() - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
meter() - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
Meter.Builder - Class in org.forgerock.monitoring.api.instrument
Fluent builder for custom meters.
Meter.Id - Class in org.forgerock.monitoring.api.instrument
A meter is uniquely identified by its combination of name and tags.
Meter.Type - Enum in org.forgerock.monitoring.api.instrument
Custom meters may emit metrics like one of these types without implementing the corresponding interface.
MeterBinder - Interface in org.forgerock.monitoring.api.instrument.binder
Binders register one or more metrics to provide information about the state of some aspect of the application or its container.
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.
MeterFilter - Interface in org.forgerock.monitoring.api.instrument.config
As requests are made of a MeterRegistry to create new metrics, allow for filtering out the metric altogether, transforming its ID (name or tags) in some way, and transforming its configuration.
meterFilter(MeterFilter) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Add a meter filter to the registry.
meterFilter(MeterFilter) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
MeterFilterReply - Enum in org.forgerock.monitoring.api.instrument.config
 
MeterNotFoundException - Exception in org.forgerock.monitoring.api.instrument.search
 
MeterNotFoundException(String, List<Tag>, Class<? extends Meter>) - Constructor for exception org.forgerock.monitoring.api.instrument.search.MeterNotFoundException
 
MeterRegistry - Interface in org.forgerock.monitoring.api.instrument
Creates and manages your application's set of meters.
MeterRegistry.Config - Interface in org.forgerock.monitoring.api.instrument
Access to configuration options for this registry.
MeterRegistry.More - Interface in org.forgerock.monitoring.api.instrument
Additional, less commonly used meter types.
MeterRegistryHolder - Class in org.forgerock.monitoring.api.instrument
Decorator for a meter registry.
MeterRegistryHolder(String, MeterRegistry) - Constructor for class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
Constructor for this class.
meterRegistryHolder() - Method in class org.forgerock.openig.decoration.helper.DecoratorHeaplet
Returns this object's MeterRegistry, creating it lazily when requested for the first time.
meterRegistryHolder() - Method in class org.forgerock.openig.heap.GenericHeaplet
Returns this object's MeterRegistry, creating it lazily when requested for the first time.
meters() - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
meters() - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
METHOD - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The method event payload field name.
METHOD_DELETE - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP DELETE method.
METHOD_GET - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP GET method.
METHOD_HEAD - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP HEAD method.
METHOD_NOT_ALLOWED - Static variable in class org.forgerock.http.protocol.Status
The 405 (Method Not Allowed) status code indicates that the method received in the request-line is known by the origin server but not supported by the target resource.
METHOD_OPTIONS - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP OPTIONS method.
METHOD_PATCH - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP PATCH method.
METHOD_POST - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP POST method.
METHOD_PUT - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP PUT method.
METHOD_TRACE - Static variable in class org.forgerock.http.filter.OptionsFilter
The HTTP TRACE method.
METRICS_PROTECTION_FILTER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a Filter instance from the Heap of config.json to protect the metrics endpoint.
micro() - Method in class org.forgerock.openig.tools.am.Version
Returns micro component of the version.
microsToUnit(double, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
millisToUnit(double, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
MIN_GENERALIZED_TIME - Static variable in class org.forgerock.opendj.ldap.GeneralizedTime
The smallest time representable using the generalized time syntax.
MIN_GENERALIZED_TIME_MS - Static variable in class org.forgerock.opendj.ldap.GeneralizedTime
The smallest time in milli-seconds representable using the generalized time syntax.
MINIMUM - Static variable in class org.forgerock.json.schema.validator.Constants
The minimum field name.
minimumExpectedValue(Long) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Sets the minimum value that this distribution summary is expected to observe.
minimumExpectedValue(Long) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
minimumExpectedValue(Duration) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Sets the minimum value that this timer is expected to observe.
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.
minor() - Method in class org.forgerock.openig.tools.am.Version
Returns minor component of the version.
minutesToUnit(double, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
minValue() - Static method in class org.forgerock.opendj.ldap.Rdn
Returns a constant containing a special RDN which sorts before any RDN other than itself.
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.
Modification - Class in org.forgerock.opendj.ldap
A modification to be performed on an entry during a Modify operation.
Modification(ModificationType, Attribute) - Constructor for class org.forgerock.opendj.ldap.Modification
Creates a new modification having the provided modification type and attribute values to be updated.
ModificationType - Class in org.forgerock.opendj.ldap
A Modify operation change type as defined in RFC 4511 section 4.6 is used to specify the type of modification being performed on an attribute.
ModificationType.Enum - Enum in org.forgerock.opendj.ldap
Contains equivalent values for the ModificationType values.
modify(ModifyRequest) - Method in class org.forgerock.opendj.ldap.AbstractAsynchronousConnection
 
modify(String...) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
modify(ModifyRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Modifies an entry in the Directory Server using the provided modify request.
modify(String...) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Modifies an entry in the Directory Server using the provided lines of LDIF.
modify(ModifyRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Modifies an entry in the Directory Server using the provided modify request.
modify(String...) - Method in interface org.forgerock.opendj.ldap.Connection
Modifies an entry in the Directory Server using the provided lines of LDIF.
modify(ModifyRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Modifies an entry in the Directory Server using the provided modify request.
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.
modifyAsync(ModifyRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
modifyAsync(ModifyRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously modifies an entry in the Directory Server using the provided modify request.
modifyAsync(ModifyRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously modifies an entry in the Directory Server using the provided modify request.
modifyAsync(ModifyRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
modifyAsync(ModifyRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously modifies an entry in the Directory Server using the provided modify request.
modifyAsync(ModifyRequest, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously modifies an entry in the Directory Server using the provided modify request.
modifyDn(ModifyDnRequest) - Method in class org.forgerock.opendj.ldap.AbstractAsynchronousConnection
 
modifyDn(String, String) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
modifyDn(ModifyDnRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Renames an entry in the Directory Server using the provided modify DN request.
modifyDn(String, String) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Renames the named entry in the Directory Server using the provided new RDN.
modifyDn(ModifyDnRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Renames an entry in the Directory Server using the provided modify DN request.
modifyDn(String, String) - Method in interface org.forgerock.opendj.ldap.Connection
Renames the named entry in the Directory Server using the provided new RDN.
modifyDn(ModifyDnRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Renames an entry in the Directory Server using the provided modify DN request.
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.
modifyDnAsync(ModifyDnRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
modifyDnAsync(ModifyDnRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously renames an entry in the Directory Server using the provided modify DN request.
modifyDnAsync(ModifyDnRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously renames an entry in the Directory Server using the provided modify DN request.
modifyDnAsync(ModifyDnRequest, IntermediateResponseHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
modifyDnAsync(ModifyDnRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously renames an entry in the Directory Server using the provided modify DN request.
modifyDnAsync(ModifyDnRequest, IntermediateResponseHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously renames an entry in the Directory Server using the provided modify DN request.
ModifyDnRequest - Interface in org.forgerock.opendj.ldap.messages
The Modify DN operation allows a client to change the Relative Distinguished Name (RDN) of an entry in the Directory and/or to move a subtree of entries to a new location in the Directory.
modifyEntry(Entry, Modification) - Static method in class org.forgerock.opendj.ldap.Entries
Applies the provided modification to an entry.
modifyEntry(Entry, Modification, Collection<? super ByteString>) - Static method in class org.forgerock.opendj.ldap.Entries
Applies the provided modification to an entry.
modifyEntry(Entry, ModifyRequest) - Static method in class org.forgerock.opendj.ldap.Entries
Applies the provided modification request to an entry.
modifyEntryPermissive(Entry, Collection<Modification>) - Static method in class org.forgerock.opendj.ldap.Entries
Applies the provided modifications to an entry using "permissive" modify semantics.
modifyEntryStrict(Entry, Collection<Modification>) - Static method in class org.forgerock.opendj.ldap.Entries
Applies the provided modifications to an entry using "strict" modify semantics.
modifyHeaders(Consumer<Headers>) - Method in interface org.forgerock.http.protocol.Message
Interact with the Headers object from the Message.getHeaders() in a fluent way.
modifyHeaders(Consumer<Headers>) - Method in class org.forgerock.http.protocol.MessageImpl
 
ModifyRequest - Interface in org.forgerock.opendj.ldap.messages
The Modify operation allows a client to request that a modification of an entry be performed on its behalf by a server.
monotonicTime() - Method in interface org.forgerock.monitoring.api.instrument.Clock
Current time from a monotonic clock source.
more() - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
Access to less frequently used meter types and patterns.
more() - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
more() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
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.
MultipleEntriesFoundException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the requested single entry search operation or read operation failed because the Directory Server returned multiple matching entries (or search references) when only a single matching entry was expected.
MULTIPLEOF - Static variable in class org.forgerock.json.schema.validator.Constants
The multipleOf field name.
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).
MYSQL - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler
The name used for a MySQL database.

N

NAME - Static variable in class org.forgerock.http.header.AcceptApiVersionHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.AcceptLanguageHeader
The name of the header.
NAME - Static variable in class org.forgerock.http.header.authorization.BasicCredentials
The name of the Basic challenge scheme.
NAME - Static variable in class org.forgerock.http.header.authorization.BearerToken
The name of the Bearer challenge scheme.
NAME - Static variable in class org.forgerock.http.header.AuthorizationHeader
A constant for the name of the Authorization header.
NAME - Static variable in class org.forgerock.http.header.ConnectionHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentApiVersionHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentEncodingHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentLengthHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.ContentTypeHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.CookieHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.LocationHeader
The name of this header.
NAME - Static variable in class org.forgerock.http.header.ReferrerHeader
The name of the header in the HTTP message.
NAME - Static variable in class org.forgerock.http.header.SetCookie2Header
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 - Static variable in class org.forgerock.http.header.WwwAuthenticateHeader
A constant for the name of the WWW-Authenticate header.
name(String, Meter.Type) - Method in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
name(String, Meter.Type, String) - Method in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
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.JwtBuilderContext
Context's name.
NAME - Static variable in class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
The name of the header that this object represents.
name - 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.CapturedUserPasswordContext
Context's name.
NAME - Static variable in class org.forgerock.openig.openam.CdSsoContext
Context name.
NAME - Static variable in class org.forgerock.openig.openam.CdSsoFailureContext
Context name.
NAME - Static variable in class org.forgerock.openig.openam.PolicyDecisionContext
Context's name.
NAME - Static variable in class org.forgerock.openig.openam.SessionInfoContext
The @{code SessionInfoContext}'s name.
NAME - Static variable in class org.forgerock.openig.openam.StsContext
Context's name.
NAME - Static variable in class org.forgerock.openig.openam.UserProfileContext
Context's name.
namedCurveParams(Key) - Static method in class org.forgerock.json.jose.utils.XECUtils
Returns the NamedCurveParameters for this key.
namedCurveParams(String, AlgorithmParameterSpec) - Static method in class org.forgerock.json.jose.utils.XECUtils
Tries to construct a NamedParameterSpec for a given curve name (currently either "X25519" or "X448").
nameForm(String) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Sets the name form associated with the DIT structure rule.
NameForm - Class in org.forgerock.opendj.ldap.schema
This class defines a data structure for storing and interacting with a name form, which defines the attribute type(s) that must and/or may be used in the RDN of an entry with a given structural objectclass.
NameForm.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing name forms.
names(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Adds the provided user friendly names.
names(String...) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Adds the provided user friendly names.
names(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided user friendly names.
names(String...) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided user friendly names.
names(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Adds the provided user friendly names.
names(String...) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Adds the provided user friendly names.
names(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Adds the provided user friendly names.
names(String...) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Adds the provided user friendly names.
names(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Adds the provided user friendly names.
names(String...) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Adds the provided user friendly names.
names(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds the provided user friendly names.
names(String...) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds the provided user friendly names.
names(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided user friendly names.
names(String...) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided user friendly names.
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.
NAMING_VIOLATION - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it would have violated the server's naming configuration.
NamingConvention - Interface in org.forgerock.monitoring.api.instrument.config
Monitoring systems make different recommendations regarding naming convention.
namingConvention(NamingConvention) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Use the provided naming convention, overriding the default for your monitoring system.
namingConvention() - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Returns the associated Naming Convention.
namingConvention(NamingConvention) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
namingConvention() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
nanosToUnit(double, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
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.
needsChecking() - Method in enum org.forgerock.opendj.ldap.schema.SchemaValidationPolicy.Action
Returns true if this policy is WARN or REJECT.
NEVER - Static variable in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
Do not dereference aliases in searching or in locating the base object of a Search operation.
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.
newAbandonRequest(int) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new abandon request using the provided message ID.
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.
newAddRequest(Dn) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new add request using the provided distinguished name.
newAddRequest(Entry) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new add request backed by the provided entry.
newAddRequest(String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new add request using the provided distinguished name decoded using the default schema.
newAddRequest(String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new add request using the provided lines of LDIF decoded using the default schema.
newAdviceWarning(String, String, Object...) - Static method in class org.forgerock.json.resource.AdviceWarning
Generate a warning using the builder provided.
newAffinityRequestLoadBalancer(Collection<? extends LdapClient>, Options) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new "affinity" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests targeting a given DN will always be routed to the same replica.
newAnnotatedRequestHandler(Object) - Static method in class org.forgerock.json.resource.Resources
Deprecated.
newAnonymousBindRequest() - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new anonymous bind request initialized with an empty distinguished name, SIMPLE authentication type, and an empty password.
newAnonymousSaslBindRequest(String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new anonymous SASL bind request as defined in RFC 4505.
newApiRequest(ResourcePath) - Static method in class org.forgerock.json.resource.Requests
Returns a new API request with the provided path.
newAssertionControl(boolean, ByteString, int, int, ByteString) - Static method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Creates a new virtual list view request control that will identify the target entry by an assertion value.
newAuditService() - Static method in class org.forgerock.audit.AuditServiceBuilder
Factory method for new instances of this builder.
newAuthorizationServerError(String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error
Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.
newAuthorizationServerError(String, String, String) - Static method in class org.forgerock.http.oauth2.OAuth2Error
Returns an OAuth 2.0 error suitable for inclusion in authorization call-back responses and access token and refresh token responses.
newBase64SysEnvSecretStore() - Static method in class org.forgerock.openig.secrets.SystemAndEnvSecretStoreHeaplet
Returns a new instance of a SecretStore that reads base64-encoded secrets (passwords or symmetric keys) from system properties and environment variables.
newBindRequest() - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new bind request initialized with an empty distinguished name, SIMPLE authentication type, and an empty password.
newBindResult(ResultCode) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new bind result using the provided result code.
newBranchingInputStream(byte[]) - Static method in class org.forgerock.http.io.IO
Creates a new branching input stream that wraps a byte array.
newBranchingInputStream(InputStream, Factory<Buffer>) - Static method in class org.forgerock.http.io.IO
Creates a new branching input stream to wrap another input stream.
newBufferedPublisher(BatchConsumer) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisherFactory
Provides a new instance of a buffered batch publisher.
newBufferedPublisher(BatchConsumer) - Method in class org.forgerock.audit.events.handlers.buffering.BatchPublisherFactoryImpl
 
newBuilder(BatchConsumer) - Static method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher
Provides a new builder.
newCachedConnectionPool(LdapClient) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
newCachedConnectionPool(LdapClient, int, int, long, TimeUnit) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
newCachedConnectionPool(LdapClient, int, int, long, TimeUnit, ScheduledExecutorService) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new connection pool which creates new connections as needed using the provided LDAP client, but will reuse previously allocated connections when they are available.
newCancelExtendedRequest(int) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new cancel extended request using the provided message ID.
newCapacityBasedKeyStoreObjectCache(int) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a new fixed capacity key store object cache which will evict objects once it reaches the provided capacity.
newChangeRecord(String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new change record (an add, delete, modify, or modify DN request) using the provided lines of LDIF decoded using the default schema.
newChangeRecordPublisher(Callable<? extends ChangeRecordReader>) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns a Flowable view of a ChangeRecordReader, creating a new reader for each subscriber.
newChangeRecordReader(Iterable<? extends ChangeRecord>) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns a change record reader over the provided change record collection.
newChangeRecordReader(Iterator<? extends ChangeRecord>) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns a change record reader over the provided change record iterator.
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
 
newClearTextPasswordFactory(char[]) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Returns a password factory which will return a copy of the provided password for each invocation of Factory.newInstance(), and which does not provide any protection of the in memory representation of the password.
newClientSslEngine(SslOptions) - Static method in class org.forgerock.opendj.security.SslOptions
Creates a new SSLEngine configured to be used by a client application.
newCollection(Object) - Static method in class org.forgerock.json.resource.Resources
Deprecated.
newCompareRequest(Dn, AttributeDescription, Object) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new compare request using the provided distinguished name, attribute name, and assertion value.
newCompareRequest(String, String, Object) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new compare request using the provided distinguished name, attribute name, and assertion value decoded using the default schema.
newCompareResult(ResultCode) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new compare result using the provided result code.
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.
newControl(boolean) - Static method in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
Creates a new Active Directory change notification request control.
newControl(boolean, Filter) - Static method in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
Creates a new assertion using the provided criticality and assertion filter.
newControl(boolean) - Static method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
Creates a new authorization identity request control having the provided criticality.
newControl(String) - Static method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
Creates a new authorization identity response control using the provided authorization ID.
newControl(Dn) - Static method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
Creates a new authorization identity response control using the provided authorization ID.
newControl(PersistentSearchChangeType, Dn, long) - Static method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
Creates a new entry change notification response control with the provided change type and optional previous distinguished name and change number.
newControl(PersistentSearchChangeType, String, long) - Static method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
Creates a new entry change notification response control with the provided change type and optional previous distinguished name and change number.
newControl(Control) - Static method in class org.forgerock.opendj.ldap.controls.GenericControl
Creates a new control having the same OID, criticality, and value as the provided control.
newControl(String) - Static method in class org.forgerock.opendj.ldap.controls.GenericControl
Creates a new non-critical control having the provided OID and no value.
newControl(String, boolean) - Static method in class org.forgerock.opendj.ldap.controls.GenericControl
Creates a new control having the provided OID and criticality, but no value.
newControl(String, boolean, Object) - Static method in class org.forgerock.opendj.ldap.controls.GenericControl
Creates a new control having the provided OID, criticality, and value.
newControl(boolean, Dn, Collection<AttributeType>) - Static method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
Creates a new get effective rights request control with the provided criticality, optional authorization name and attribute list.
newControl(boolean, String, String...) - Static method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
Creates a new get effective rights request control with the provided criticality, optional authorization name and attribute list.
newControl(boolean) - Static method in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
Creates a new ManageDsaIT request control having the provided criticality.
newControl(boolean, Collection<Filter>) - Static method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
Creates a new matched values request control with the provided criticality and list of filters.
newControl(boolean, String...) - Static method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
Creates a new matched values request control with the provided criticality and list of filters.
newControl() - Static method in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
Creates a new Netscape password expired response control.
newControl(int) - Static method in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
Creates a new Netscape password expiring response control with the provided amount of time until expiration.
newControl(boolean) - Static method in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
Creates a new password policy request control having the provided criticality.
newControl() - Static method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
Creates a new password policy response control with no error nor warning.
newControl(PasswordPolicyErrorType) - Static method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
Creates a new password policy response control with the provided error.
newControl(PasswordPolicyWarningType, int) - Static method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
Creates a new password policy response control with the provided warning.
newControl(PasswordPolicyWarningType, int, PasswordPolicyErrorType) - Static method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
Creates a new password policy response control with the provided warning and error.
newControl(boolean) - Static method in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
Creates a new permissive modify request control having the provided criticality.
newControl(boolean, boolean, boolean, Collection<PersistentSearchChangeType>) - Static method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
Creates a new persistent search request control.
newControl(boolean, boolean, boolean, PersistentSearchChangeType...) - Static method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
Creates a new persistent search request control.
newControl(boolean, Collection<String>) - Static method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
Creates a new post-read request control.
newControl(boolean, String...) - Static method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
Creates a new post-read request control.
newControl(Entry) - Static method in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
Creates a new post-read response control.
newControl(boolean, Collection<String>) - Static method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
Creates a new pre-read request control.
newControl(boolean, String...) - Static method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
Creates a new pre-read request control.
newControl(Entry) - Static method in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
Creates a new pre-read response control.
newControl(Dn) - Static method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
Creates a new proxy authorization v1 request control with the provided authorization name.
newControl(String) - Static method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
Creates a new proxy authorization v1 request control with the provided authorization name decoded using the default schema.
newControl(String) - Static method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
Creates a new proxy authorization v2 request control with the provided authorization ID.
newControl() - Static method in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
Creates a new permissive modify request control.
newControl(boolean, Collection<SortKey>) - Static method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
Creates a new server side sort request control with the provided criticality and list of sort keys.
newControl(boolean, SortKey...) - Static method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
Creates a new server side sort request control with the provided criticality and list of sort keys.
newControl(boolean, String) - Static method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
Creates a new server side sort request control with the provided criticality and string representation of a list of sort keys.
newControl(ResultCode) - Static method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
Creates a new server-side response control with the provided sort result and no attribute description.
newControl(ResultCode, AttributeDescription) - Static method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
Creates a new server-side response control with the provided sort result and attribute description.
newControl(ResultCode, String) - Static method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
Creates a new server-side response control with the provided sort result and attribute description.
newControl(boolean, int, ByteString) - Static method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
Creates a new simple paged results control with the provided criticality, size, and cookie.
newControl(boolean, boolean) - Static method in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
Creates a new sub-entries request control having the provided criticality and sub-entry visibility.
newControl(boolean) - Static method in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
Creates a new tree delete request control having the provided criticality.
newControl(int, int, ResultCode, ByteString) - Static method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
Creates a new virtual list view response control.
newCounter(Meter.Id) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Build a new counter to be added to the registry.
newCounter(Meter.Id) - Method in class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
 
newCramMd5SaslBindRequest(String, char[]) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new CRAM-MD5 SASL bind request as defined in draft-ietf-sasl-crammd5.
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.
newCsrfFilter(String) - Static method in class org.forgerock.http.filter.Filters
Creates a filter that protects against cross-site request forgery (CSRF) attacks when using cookies for authentication.
newDecodedContentInputStream() - Method in class org.forgerock.http.protocol.Entity
Returns a branched input stream representing the decoded content of this entity.
newDecodedContentReader(Charset) - Method in class org.forgerock.http.protocol.Entity
Returns a branched reader representing the decoded content of this entity.
newDefaultCsrfFilter(String) - Static method in class org.forgerock.http.filter.Filters
Creates a filter that protects against cross-site request forgery (CSRF) attacks when using cookies for authentication.
newDeleteRequest(String) - Static method in class org.forgerock.json.resource.Requests
Returns a new delete request with the provided resource path.
newDeleteRequest(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.
newDeleteRequest(Dn) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new delete request using the provided distinguished name.
newDeleteRequest(String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new delete request using the provided distinguished name decoded using the default schema.
newDigestMd5SaslBindRequest(String, String, char[], String, String, Map<String, ?>) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new DIGEST-MD5 SASL bind request as defined in RFC 2831.
newDistributionSummary(Meter.Id, HistogramConfig) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Build a new distribution summary to be added to the registry.
newDistributionSummary(Meter.Id, HistogramConfig) - Method in class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
 
newEcdsaSigningHandler(PrivateKey) - Method in class org.forgerock.json.jose.jws.SigningManager
Constructs a new handler for signing ES256 signatures.
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.
newEdDsaSigningHandler(byte[]) - Method in class org.forgerock.json.jose.jws.SigningManager
Constructs a new handler for signing EdDSA signatures.
newEdDsaVerificationHandler(byte[]) - Method in class org.forgerock.json.jose.jws.SigningManager
Constructs a new handler for verifying EdDSA signatures.
newEntryPublisher(Callable<? extends EntryReader>) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns a Flowable view of a EntryReader, creating a new reader for each subscriber.
newEntryReader(Iterable<? extends Entry>) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns an entry reader over the provided entry collection.
newEntryReader(Iterator<? extends Entry>) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns an entry reader over the provided entry iterator.
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.
newExtendedErrorResult(ResultCode, String, CharSequence) - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedResultDecoder
 
newExtendedErrorResult(ResultCode, String, CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResultDecoder
Creates a new extended error result using the provided result code, matched DN, and diagnostic message.
newExternalSaslBindRequest(String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new External SASL bind request as defined in RFC 4422.
newFailedLdapPromise(E) - Static method in class org.forgerock.opendj.ldap.spi.LdapPromises
Returns a LdapPromise representing an asynchronous task which has already failed with the provided error.
newFailedLdapPromise(E, int) - Static method in class org.forgerock.opendj.ldap.spi.LdapPromises
Returns a LdapPromise representing an asynchronous task, identified by the provided requestId, which has already failed with the provided error.
newFailoverLoadBalancer(Collection<? extends LdapClient>, Options) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new "fail-over" load-balancer which will load-balance connections across the provided set of LDAP clients.
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.
newFixedConnectionPool(LdapClient, int) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new connection pool which will maintain poolSize connections created using the provided LDAP client.
newFixedSizeDistributionLoadBalancer(Set<Dn>, ConsistentHashMap<? extends LdapClient>, Options) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a distribution load balancer which uses consistent hashing to distributes requests across a set of partitions based on a hash of each request's target DN.
newForbidden() - Static method in class org.forgerock.http.protocol.Responses
Generates an empty Forbidden response (403).
newGauge(Meter.Id, T, ToDoubleFunction<T>) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Build a new gauge to be added to the registry.
newGauge(Meter.Id, T, ToDoubleFunction<T>) - Method in class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
 
newGenericExtendedRequest(String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new generic extended request using the provided name and no value.
newGenericExtendedRequest(String, Object) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new generic extended request using the provided name and optional value.
newGenericExtendedResult(ResultCode) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new generic extended result using the provided result code.
newGenericIntermediateResponse() - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new generic intermediate response with no name or value.
newGenericIntermediateResponse(String, Object) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new generic intermediate response using the provided response name and value.
newGssapiSaslBindRequest(String, Subject, String, Map<String, ?>) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new GSSAPI SASL bind request as defined in RFC 2831.
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.
newHmacSigningHandler(SecretKey) - 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.oauth2.ScriptableResourceAccess.Heaplet
 
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.ScriptableFilter.Heaplet
 
newInstance(Script, Heap) - Method in class org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy.Heaplet
 
newInstance(Script, Heap) - Method in class org.forgerock.openig.handler.ScriptableHandler.Heaplet
 
newInstance(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.openam.ScriptableResourceUriProvider.Heaplet
 
newInstance(Script, Heap) - Method in class org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet
Creates the new heap object instance using the provided script.
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.
newInternalConnection(BiFunction<Integer, Request, Flowable<Response>>) - Static method in class org.forgerock.opendj.ldap.Connections
Creates a new Connection which will route requests to the provided requestHandler.
newInternalConnectionFactory(RequestHandler) - Static method in class org.forgerock.json.resource.Resources
Creates a new connection factory which binds internal client connections to RequestHandlers.
newInternalConnectionFactory(BiFunction<Integer, Request, Flowable<Response>>) - Static method in class org.forgerock.opendj.ldap.Connections
Creates a new ConnectionFactory which will route requests to the provided requestHandler.
newInternalLdapClient(BiFunction<Integer, Request, Flowable<Response>>) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new LdapClient which will route requests to the provided requestHandler.
newInternalLdapClientSocket(BiFunction<Integer, Request, Flowable<Response>>) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new LdapClientSocket which will route requests to the provided requestHandler.
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.
newInvalidRequest(Request.RequestType, String, LdapException) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new invalid request using the provided reason.
newKeyStoreObjectCacheFromMap(Map<String, KeyStoreObject>) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a new key store object cache which will delegate to the provided Map.
newKeyStoreParameters(ConnectionFactory, Dn) - Static method in class org.forgerock.opendj.security.KeyStoreParameters
Creates a set of LDAP key store parameters with default options.
newKeyStoreParameters(ConnectionFactory, Dn, Options) - Static method in class org.forgerock.opendj.security.KeyStoreParameters
Creates a set of LDAP key store parameters with custom options.
newLdapClient(String, int) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new LDAP client which can be used to create LDAP connections to the Directory Server at the provided host and port number, and using default options.
newLdapClient(String, int, Options) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new LDAP client which can be used to create LDAP connections to the Directory Server at the provided host and port number and custom options.
newLdapClientException(Throwable) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP client exception with the provided cause and a result code depending on the class cause original cause.
newLdapException(ResultCode) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception with the provided result code and an empty diagnostic message.
newLdapException(ResultCode, CharSequence) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception with the provided result code and diagnostic message.
newLdapException(ResultCode, Throwable) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception with the provided result code and cause.
newLdapException(ResultCode, CharSequence, Throwable) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception with the provided result code, diagnostic message, and cause.
newLdapException(ResultCode, CharSequence, Dn, Throwable) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception with the provided resultCode, diagnosticMessage, matched DN and cause.
newLdapException(Throwable) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception with the provided cause and a result code depending on the class cause original cause.
newLdapException(Result) - Static method in exception org.forgerock.opendj.ldap.LdapException
Creates a new LDAP exception using the provided result.
newLdapKeyStore(ConnectionFactory, Dn) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a new LDAP key store with default options.
newLdapKeyStore(ConnectionFactory, Dn, Options) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a new LDAP key store with custom options.
newLdapMessage(int, byte, ProtocolOp) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Creates a new ProtocolOp containing a fully decoded LDAP message.
newLdapPromiseImpl(int) - Static method in class org.forgerock.opendj.ldap.spi.LdapPromiseImpl
Creates a new LdapPromiseImpl with a requestId.
newLdapSocketAcceptor(Set<InetSocketAddress>, Options, Consumer<LdapSocket>) - Method in interface org.forgerock.opendj.ldap.spi.TransportProvider
Returns an implementation of LdapSocketAcceptor.
newLdapSocketConnector(String, int, Options) - Method in interface org.forgerock.opendj.ldap.spi.TransportProvider
Returns an implementation of LdapSocketConnector.
newLdifKeyStore(File, Dn) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a new LDIF based key store which will read and write key store objects to the provided key store file.
newLdifKeyStore(File, Dn, Options) - Static method in class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a new LDIF based key store which will read and write key store objects to the provided key store file.
newLeastRequestsLoadBalancer(Collection<? extends LdapClient>, Options) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new "least requests" load-balancer which will load-balance individual requests across the provided set of LDAP clients, each typically representing a single replica, using an algorithm that ensures that requests are routed to the replica which has the minimum number of active requests.
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.
newMeter(Meter.Id, Meter.Type, Iterable<Measurement>) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Build a new custom meter to be added to the registry.
newMeter(Meter.Id, Meter.Type, Iterable<Measurement>) - Method in class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
 
newModifyDnRequest(Dn, Rdn) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify DN request using the provided distinguished name and new RDN.
newModifyDnRequest(String, String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify DN request using the provided distinguished name and new RDN decoded using the default schema.
newModifyRequest(Dn) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify request using the provided distinguished name.
newModifyRequest(Entry, Entry) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify request containing a list of modifications which can be used to transform fromEntry into entry toEntry.
newModifyRequest(String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify request using the provided distinguished name decoded using the default schema.
newModifyRequest(String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new modify request using the provided lines of LDIF decoded using the default schema.
newMurmur3ConsistentHashMap() - Static method in class org.forgerock.opendj.ldap.ConsistentHashMap
Creates a new consistent hash map which will hash keys using Murmur3.
newNamedLdapClient(LdapClient, String) - Static method in class org.forgerock.opendj.ldap.LdapClients
Creates a new LDAP client which forwards connection requests to the provided client, but whose toString method will always return name.
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).
newNullLdapClient() - Static method in class org.forgerock.opendj.ldap.LdapClients
Returns an LDAP client which always throws ResultCode.CLIENT_SIDE_CONNECT_ERROR, without any error message.
newNullLdapClient(String, LocalizableMessage) - Static method in class org.forgerock.opendj.ldap.LdapClients
Returns an LDAP client which always throws ResultCode.CLIENT_SIDE_CONNECT_ERROR using the provided error message.
newOffsetControl(boolean, int, int, int, int, ByteString) - Static method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
Creates a new virtual list view request control that will identify the target entry by a positional offset within the complete result set.
newOptionsFilter(String...) - Static method in class org.forgerock.http.filter.Filters
Creates a Filter which handles HTTP OPTIONS method requests.
newPasswordModifyExtendedRequest() - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new password modify extended request, with no user identity, old password, or new password.
newPasswordModifyExtendedResult(ResultCode) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new password modify extended result using the provided result code, and no generated password.
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.
newPlainSaslBindRequest(String, char[], String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new Plain SASL bind request as defined in RFC 4616.
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.
newReferenceCountedTransportFromOptions(Options) - Static method in class org.forgerock.opendj.grizzly.GrizzlyTransport
Creates a new transport.
newRemainingResultsResponse(String, int) - Static method in class org.forgerock.json.resource.Responses
newRequestHandle() - Static method in class org.forgerock.opendj.ldap.RequestHandle
Creates a new RequestHandle instance.
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.
newRequestMessage(int, Request) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a Request.
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.
newResponseMessage(int, Request, Response) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a Response.
newResponseMessage(int, SearchResultEntry) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a SearchResultEntry.
newResponseMessage(int, SearchResultReference) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a SearchResultReference.
newResponseMessage(int, IntermediateResponse) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a IntermediateResponse.
newResponseMessage(int, BindResult) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a BindResult.
newResponseMessage(int, ExtendedResult) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a ExtendedResult.
newResponseMessage(int, CompareResult) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage containing a CompareResult.
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.
newResult(ResultCode) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new result using the provided result code.
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.
newSaslBindRequest(SaslClient) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new SASL bind request configured to use the provided SaslClient.
newSearchRequest(Dn, SearchScope, Filter, String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new search request using the provided distinguished name, scope, and filter.
newSearchRequest(String, SearchScope, String, String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new search request using the provided distinguished name, scope, and filter, decoded using the default schema.
newSearchRequest(Dn, SearchScope) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new search request using the provided distinguished name and scope.
newSearchRequest(String, SearchScope) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new search request using the provided distinguished name and scope.
newSearchResultDoneMessage(int, Result) - Static method in class org.forgerock.opendj.ldap.messages.LdapMessage
Builds and returns an LdapMessage for a search result done operation type.
newSearchResultEntry(Dn) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result entry using the provided distinguished name.
newSearchResultEntry(Entry) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result entry backed by the provided entry.
newSearchResultEntry(String) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result entry using the provided distinguished name decoded using the default schema.
newSearchResultEntry(String...) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result entry using the provided lines of LDIF decoded using the default schema.
newSearchResultReference(String) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result reference using the provided continuation reference URI.
newSearchResultReference(List<String>) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new search result reference using the provided continuation reference URIs.
newServerSslEngine(SslOptions) - Static method in class org.forgerock.opendj.security.SslOptions
Creates a new SSLEngine configured to be used by a server application.
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.
newSimpleBindRequest(String, byte[]) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new simple bind request having the provided name and password suitable for name/password authentication.
newSimpleBindRequest(Dn, byte[]) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new simple bind request having the provided name and password suitable for name/password authentication.
newSimpleBindRequest(String, char[]) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new simple bind request having the provided name and password suitable for name/password authentication.
newSimpleBindRequest(String, String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new simple bind request having the provided name and password suitable for name/password authentication.
newSimpleBindRequest(Dn, char[]) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new simple bind request having the provided name and password suitable for name/password authentication.
newSimpleBindRequest(Dn, String) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new simple bind request having the provided name and password suitable for name/password authentication.
newSingleEntrySearchRequest(Dn, SearchScope, Filter, String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new search request for a single entry, using the provided distinguished name, scope, and filter.
newSingleEntrySearchRequest(String, SearchScope, String, String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new search request for a single entry, using the provided distinguished name, scope, and filter, decoded using the default schema.
newSingleton(Object) - Static method in class org.forgerock.json.resource.Resources
Deprecated.
newSslOptions(KeyManager, TrustManager) - Static method in class org.forgerock.opendj.security.SslOptions
Creates a new SslOptions for the provided key manager and trust manager.
newSslOptions(KeyManager[], TrustManager[]) - Static method in class org.forgerock.opendj.security.SslOptions
Creates a new SslOptions for the provided key managers and trust managers.
newStartTlsExtendedRequest(SslOptions) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new start TLS extended request which will use the provided SSL context.
newStartTlsExtendedResult(ResultCode) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new start TLS extended result which will use the provided SSL context.
newSuccessfulLdapPromise(R) - Static method in class org.forgerock.opendj.ldap.spi.LdapPromises
Returns a LdapPromise representing an asynchronous task which has already succeeded with the provided result.
newTemporaryBuffer(int, int, int, File) - Static method in class org.forgerock.http.io.IO
Creates a new temporary buffer that first uses memory, then a temporary file for data storage.
newTemporaryStorage() - Static method in class org.forgerock.http.io.IO
Creates a new storage using the system dependent default temporary directory and default sizes.
newTemporaryStorage(File) - Static method in class org.forgerock.http.io.IO
Builds a storage using the given directory (may be null) and default sizes.
newTemporaryStorage(File, int, int, int) - Static method in class org.forgerock.http.io.IO
Builds a storage using the given directory (may be null) and provided sizes.
newThreadFactory(ThreadGroup, String, boolean) - Static method in class org.forgerock.util.Threads
Creates a new thread factory which will create threads using the specified thread group, naming template, and daemon status.
newThreadFactory(ThreadGroup, String, boolean) - Static method in class org.forgerock.util.Utils
newTimeGauge(Meter.Id, T, TimeUnit, ToDoubleFunction<T>) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Build a new time gauge to be added to the registry.
newTimer(Meter.Id, HistogramConfig, PauseDetector) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
Build a new timer to be added to the registry.
newTimer(Meter.Id, HistogramConfig, PauseDetector) - Method in class org.forgerock.monitoring.dropwizard.DropwizardMeterRegistry
 
newTransport(Options) - Static method in class org.forgerock.opendj.grizzly.GrizzlyTransport
Creates a new transport.
newUnbindRequest() - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new unbind request.
newUnknownRequest(byte, ByteString) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new unknown request backed by the provided bytes.
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.
newWhoAmIExtendedRequest() - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new Who Am I extended request.
newWhoAmIExtendedResult(ResultCode) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates a new who am I extended result with the provided result code and no authorization ID.
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.
nextBigInteger() - Method in class org.forgerock.opendj.ldap.GserParser
Returns the next element as a BigInteger.
nextChoiceValueIdentifier() - Method in class org.forgerock.opendj.ldap.GserParser
Return the identifier of the next IdentifiedChoiceValue element.
nextInteger() - Method in class org.forgerock.opendj.ldap.GserParser
Returns the next element as an Integer.
nextNamedValueIdentifier() - Method in class org.forgerock.opendj.ldap.GserParser
Returns the identifier of the next NamedValue element.
nextString() - Method in class org.forgerock.opendj.ldap.GserParser
Returns the next element as a String.
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.
NO_OP - Static variable in interface org.forgerock.opendj.ldap.LoadBalancerEventListener
An event listener implementation which ignores all events.
NO_OPERATION - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that should be used if the server did not actually complete processing on the associated operation because the request included the LDAP No-Op control.
NO_SUCH_ATTRIBUTE - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it targeted an attribute or attribute value that did not exist in the specified entry.
NO_SUCH_OBJECT - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it referenced an entry that does not exist.
NO_SUCH_OPERATION - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a cancel request was unsuccessful because the targeted operation did not exist or had already completed.
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]).
NONCE - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set nonce key - not available in JwtClaimsSetKey.
NONE - Static variable in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig
 
NONE - Static variable in interface org.forgerock.opendj.security.KeyStoreObjectCache
A cache implementation that does not cache anything.
NonExpiringCache<K,V> - Class in org.forgerock.util
Allows the Caching of an object.
NonExpiringCache() - Constructor for class org.forgerock.util.NonExpiringCache
 
NOOP_ROLLOVER_LIFECYCLE_HOOK - Static variable in class org.forgerock.audit.events.handlers.writers.RotatableWriter
A 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
 
normalizeAttributeValue(ByteSequence) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule
Returns the normalized form of the provided attribute value, which is best suited for efficiently performing matching operations on that value.
normalizeAttributeValue(Schema, ByteSequence) - Method in interface org.forgerock.opendj.ldap.schema.MatchingRuleImpl
Retrieves the normalized form of the provided attribute value, which is best suited for efficiently performing matching operations on that value.
NORMALIZED_FIELD - Static variable in class org.forgerock.audit.util.ElasticsearchUtil
JSON field-name of metadata to assist in de-normalization.
normalizeJson(JsonValue) - Static method in class org.forgerock.audit.util.ElasticsearchUtil
Normalizes JSON to conform to Elasticsearch data-format restrictions.
normalizeJsonPointer(JsonPointer) - Static method in class org.forgerock.audit.util.ElasticsearchUtil
Replaces periods in JsonPointer keys with underscore.
NoSuchSecretException - Exception in org.forgerock.secrets
Indicates that no secret was configured for the given purpose, or the named secret is not available.
NoSuchSecretException(Purpose<?>, String) - Constructor for exception org.forgerock.secrets.NoSuchSecretException
Constructs the exception for the given purpose and secret stable id.
NoSuchSecretException(Purpose<?>) - Constructor for exception org.forgerock.secrets.NoSuchSecretException
Constructs the exception for the given purpose.
NoSuchSecretException(String) - Constructor for exception org.forgerock.secrets.NoSuchSecretException
Constructs the exception for the given purpose and secret stable id.
not(FilterCondition) - Static method in class org.forgerock.json.resource.Filters
Returns a FilterCondition which will match requests which do not match the provided condition.
not(ConditionResult) - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical NOT of the provided condition result, which is TRUE if the provided condition result is FALSE, TRUE if it is FALSE, and UNDEFINED otherwise.
not() - Method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical NOT of this condition result, which is TRUE if this condition result is FALSE, TRUE if it is FALSE, and UNDEFINED otherwise.
not(Filter) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new not filter using the provided sub-filter.
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_ALLOWED_ON_NONLEAF - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation is not allowed for non-leaf entries.
NOT_ALLOWED_ON_RDN - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation is not allowed on an RDN attribute.
NOT_FOUND - Static variable in class org.forgerock.http.protocol.Status
The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
NOT_FOUND - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the resource could not be found.
NOT_IMPLEMENTED - Static variable in class org.forgerock.http.protocol.Status
The 501 (Not Implemented) status code indicates that the server does not support the functionality required to fulfill the request.
NOT_PRESENT - Static variable in class org.forgerock.http.header.WarningHeader
100 Indicates that there is data missing from the request.
NOT_PRESENT - Static variable in class org.forgerock.json.resource.AdviceWarning
100 Indicates that there is data missing from the request.
NOT_SUPPORTED - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the resource does not implement/support the feature to fulfill the request HTTP status: 501 Not Implemented.
NotFoundException - Exception in org.forgerock.json.resource
An exception that is thrown when a specified resource cannot be found.
NotFoundException() - Constructor for exception org.forgerock.json.resource.NotFoundException
Constructs a new exception with null as its detail message.
NotFoundException(String) - Constructor for exception org.forgerock.json.resource.NotFoundException
Constructs a new exception with the specified detail message.
NotFoundException(String, Throwable) - Constructor for exception org.forgerock.json.resource.NotFoundException
Constructs a new exception with the specified detail message and cause.
NotFoundException(Throwable) - Constructor for exception org.forgerock.json.resource.NotFoundException
Constructs a new exception with the specified cause.
Notification - Class in org.forgerock.openig.tools.notifications
A Notification is a special message that AM send to its "agents" to notify the occurrence of an event.
Notification(Instant, String, JsonValue) - Constructor for class org.forgerock.openig.tools.notifications.Notification
Creates a notification that happened at timestamp, on the given topic with the given body.
NotificationListener - Interface in org.forgerock.openig.tools.notifications
Listen to topic notification.
notificationService(NotificationService) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Bind a NotificationService instance to this builder.
NotificationService - Interface in org.forgerock.openig.tools.notifications
Represents a source of notifications.
NotificationService.Registration - Interface in org.forgerock.openig.tools.notifications
Represents the connection event listener registration.
notificationServiceReconnectDelay(Duration) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Specifies the delay to wait between connection re-establishments when web-socket connection is lost (or cannot be acquired at startup).
notificationServiceTls(TlsOptions) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Specifies the TLS options to use for establishing a connection to the Web-socket endpoint.
notifyConnectionClosed() - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Attempts to transition this connection state to closed and invokes event listeners if successful.
notifyConnectionError(boolean, LdapException) - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Attempts to transition this connection state to error and invokes event listeners if successful.
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
 
notifyUnsolicitedNotification(ExtendedResult) - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Notifies event listeners of the provided unsolicited notification if the state is valid.
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.
noUserModification(boolean) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Specifies whether this attribute type is "no-user-modification".
now() - Method in class org.forgerock.audit.util.DateUtil
Generate a formatted timestamp for the current time.
now() - Method in class org.forgerock.opendj.ldap.TimeoutScheduler
Returns the current time in milliseconds from the Clock of this TimeoutScheduler.
now() - Method in class org.forgerock.util.time.ClockTimeService
Deprecated.
 
now() - Method in interface org.forgerock.util.time.TimeService
Deprecated.
Returns a value that represents "now" since the epoch.
Nullable - Annotation Type in org.forgerock.monitoring.api.lang
A common annotation to declare that annotated elements can be null under some circumstance.
nullEntry(Dn) - Static method in class org.forgerock.opendj.ldap.Entries
Returns a read-only empty entry having the provided distinguished name.
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
 
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_OF_SELECTORS - Static variable in class org.forgerock.openig.websocket.WebSocketProxyFilter
Option allowing configuration of the number of selector threads.
NUMBER_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper
Json number value type.
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.
numSubordinates(String) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns the number of entries which are immediately subordinate to the named entry, or 0 if the named entry does not exist.
numSubordinates(Dn) - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns the number of entries which are immediately subordinate to the named entry, or 0 if the named entry does not exist.

O

OAuth2 - Class in org.forgerock.http.oauth2
OAuth2 utility class.
oauth2(String) - Method in class org.forgerock.openig.tools.am.AmService
Build the endpoint URI for an endpoint located in the /oauth2 namespace.
oauth2(String) - Method in class org.forgerock.openig.tools.am.UriService
Build the endpoint URI for an endpoint located in the /oauth2 namespace.
OAuth2BearerWWWAuthenticateHeader - Class in org.forgerock.openig.filter.oauth2.client
Processes the OAuth 2.0 Bearer WWW-Authenticate message header.
OAuth2BearerWWWAuthenticateHeader() - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
Constructs a new empty header.
OAuth2BearerWWWAuthenticateHeader(OAuth2Error) - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2BearerWWWAuthenticateHeader
Constructs a new header with the provided error.
OAuth2ClassAliasResolver - Class in org.forgerock.openig.filter.oauth2
Register all the aliases supported by the openig-oauth2 module.
OAuth2ClassAliasResolver() - Constructor for class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
 
OAuth2ClientFilter - Class in org.forgerock.openig.filter.oauth2.client
A filter which is responsible for authenticating the end-user using OAuth 2.0 delegated authorization.
OAuth2ClientFilter(ClientRegistrationRepository, PerItemEvictionStrategyCache<String, Promise<Map<String, Object>, OAuth2ErrorException>>, UriValidationService, Clock, Handler, Expression<String>) - Constructor for class org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter
Constructs an OAuth2ClientFilter.
OAuth2ClientFilter.Heaplet - Class in org.forgerock.openig.filter.oauth2.client
Creates and initializes the filter in a heap environment.
OAuth2Context - Class in org.forgerock.http.oauth2
An OAuth2Context could be used to store and retrieve an AccessTokenInfo.
OAuth2Context(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
 
OAuth2SessionContext - Class in org.forgerock.openig.filter.oauth2.client
This context helps to manage the OAuth2Session when used with OAuth2ClientFilter.
oauth2Uri(String) - Method in class org.forgerock.openig.tools.am.AmService
Build the endpoint URI for an endpoint located in the /oauth2 namespace.
oauth2Uri(String) - Method in class org.forgerock.openig.tools.am.UriService
Build the endpoint URI for an endpoint located in the /oauth2 namespace.
object(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_GUID_ATTR - Static variable in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
The name of the objectGUID attribute as defined in the Active Directory schema.
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.
objectClass() - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an attribute description representing the object class attribute type with no options.
ObjectClass - Class in org.forgerock.opendj.ldap.schema
This class defines a data structure for storing and interacting with an objectclass, which contains a collection of attributes that must and/or may be present in an entry with that objectclass.
ObjectClass.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing object classes.
OBJECTCLASS_MODS_PROHIBITED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the operation could not be processed because it would have modified the objectclasses associated with an entry in an illegal manner.
OBJECTCLASS_VIOLATION - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it would have resulted in an entry that violated the server schema.
objectClassPresent() - Static method in class org.forgerock.opendj.ldap.Filter
Returns the objectClass presence filter (objectClass=*).
ObjectClassType - Enum in org.forgerock.opendj.ldap.schema
This enumeration defines the set of possible objectclass types that may be used, as defined in RFC 2252.
Objects - Class in org.forgerock.util
Common utility methods for Objects.
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.
obsolete(boolean) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Specifies whether this schema element is obsolete.
obsolete(boolean) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Specifies whether this schema element is obsolete.
obsolete(boolean) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Specifies whether this schema element is obsolete.
obsolete(boolean) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Specifies whether this schema element is obsolete.
obsolete(boolean) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Specifies whether this schema element is obsolete.
obsolete(boolean) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Specifies whether this schema element is obsolete.
obsolete(boolean) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Specifies whether this schema element is obsolete.
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.
OctetECPrivateKey(byte[], SupportedEllipticCurve) - Constructor for class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
Constructs the private key with the given values.
OctetECPublicKey(byte[], SupportedEllipticCurve) - Constructor for class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
Constructs the public key with the given parameters.
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(PropertyResolver...) - Static method in class org.forgerock.config.resolvers.ChainedPropertyResolver
Constructs a ChainedPropertyResolver given a a list of PropertyResolvers.
of(long, double) - Static method in class org.forgerock.monitoring.api.instrument.CountAtValue
 
of(long, double, double, ValueAtPercentile[], CountAtValue[]) - Static method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
of(String, String) - Static method in interface org.forgerock.monitoring.api.instrument.Tag
 
of(Iterable<? extends Tag>) - Static method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance containing tags constructed from the specified source tags.
of(String, String) - Static method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance containing tags constructed from the specified name value pair.
of(String...) - Static method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance containing tags constructed from the specified key value pairs.
of(Tag...) - Static method in class org.forgerock.monitoring.api.instrument.Tags
Return a new Tags instance containing tags constructed from the specified tags.
of(double, double) - Static method in class org.forgerock.monitoring.api.instrument.ValueAtPercentile
 
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(String) - Static method in class org.forgerock.openig.tools.am.Version
Parse an input string, decomposing it in its base elements (major, minor, micro).
of(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.
OFFSET_RANGE_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a search request included a VLV request control with an invalid offset.
ofKey(Key) - Static method in enum org.forgerock.secrets.keys.KeyType
Returns the type of the given key, or null if the input is null or not recognised.
OID - Static variable in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
The OID for the Microsoft Active Directory persistent search request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
The IANA-assigned OID for the LDAP assertion request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
The OID for the authorization identity request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
The OID for the authorization identity response control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
The OID for the entry change notification response control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
The OID for the get effective rights request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
The OID for the ManageDsaIT request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
The OID for the matched values request control used to specify which particular attribute values should be returned in a search result entry.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
The OID for the Netscape password expired response control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
The OID for the Netscape password expiring response control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
The OID for the password policy control from draft-behera-ldap-password-policy.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
The OID for the password policy control from draft-behera-ldap-password-policy.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
The OID for the permissive modify request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
The OID for the persistent search request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
The IANA-assigned OID for the LDAP post-read request control used for retrieving an entry in the state it had immediately after an update was applied.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
The IANA-assigned OID for the LDAP post-read response control used for retrieving an entry in the state it had immediately after an update was applied.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
The IANA-assigned OID for the LDAP pre-read request control used for retrieving an entry in the state it had immediately before an update was applied.
OID - Static variable in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
The IANA-assigned OID for the LDAP pre-read response control used for retrieving an entry in the state it had immediately before an update was applied.
OID - Static variable in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
The OID for the proxied authorization v1 control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
The OID for the proxied authorization v2 control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
The OpenLDAP OID for the Relax Rules request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
The OID for the server-side sort request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
The OID for the server-side sort response control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
The OID for the paged results request/response control defined in RFC 2696.
OID - Static variable in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
The OID for the sub-entries request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
The OID for the subtree delete request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
The OID for the virtual list view request control.
OID - Static variable in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
The OID for the virtual list view request control.
OID - Static variable in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
The OID for the cancel extended operation request.
OID - Static variable in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
The OID for the password modify extended operation request.
OID - Static variable in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
The OID for the start TLS extended operation request.
OID - Static variable in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedRequest
The OID for the who am I extended operation request.
oid(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the numeric OID which uniquely identifies this attribute type.
oid(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Sets the numeric OID which uniquely identifies this matching rule.
oid(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Sets the numeric OID which uniquely identifies this matching rule use definition.
oid(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Sets the numeric OID which uniquely identifies this name form.
oid(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Sets the numeric OID which uniquely identifies this object class.
oid(String) - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
Sets the numeric OID which uniquely identifies this syntax.
OID_GSSAPI_KERBEROS_V - Static variable in class org.forgerock.opendj.io.Ldap
The OID for the Kerberos V GSSAPI mechanism.
OID_NOTICE_OF_DISCONNECTION - Static variable in class org.forgerock.opendj.io.Ldap
The OID for the LDAP notice of disconnection extended operation.
OK - Static variable in class org.forgerock.http.protocol.Status
The 200 (OK) status code indicates that the request has succeeded.
OkpJWK - Class in org.forgerock.json.jose.jwk
An Octet Key-Pair (OKP) JWK as defined in RFC 8037.
OkpJWK.Builder - Class in org.forgerock.json.jose.jwk
Builder object for Octet Key-Pair (OKP) JWKs.
OkpJWK.OctetECKey - Interface in org.forgerock.json.jose.jwk
Super interface of keys represented as raw octet sequences.
OkpJWK.OctetECPrivateKey - Class in org.forgerock.json.jose.jwk
An EC private key represented by a scalar octet value.
OkpJWK.OctetECPublicKey - Class in org.forgerock.json.jose.jwk
An EC public key represented by a compressed x-coordinate.
onAdded(FilterChain) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingSslFilter
 
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.
onMeterAdded(Consumer<Meter>) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Register an event listener for each meter added to the registry.
onMeterAdded(Consumer<Meter>) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
onNotification(Notification) - Method in interface org.forgerock.openig.tools.notifications.NotificationListener
Receive the notifications as soon as they arrive.
onRemoved(FilterChain) - Method in class org.forgerock.openig.websocket.grizzly.SwitchingSslFilter
 
OP_PTR - Static variable in class org.forgerock.json.JsonPatch
Path to the "op" attribute of a patch entry.
OP_TYPE_ABANDON_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for abandon requests.
OP_TYPE_ADD_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for add requests.
OP_TYPE_ADD_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for add responses.
OP_TYPE_BIND_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for bind requests.
OP_TYPE_BIND_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for bind responses.
OP_TYPE_COMPARE_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for compare requests.
OP_TYPE_COMPARE_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for compare responses.
OP_TYPE_DELETE_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for delete requests.
OP_TYPE_DELETE_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for delete responses.
OP_TYPE_EXTENDED_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for extended requests.
OP_TYPE_EXTENDED_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for extended responses.
OP_TYPE_INTERMEDIATE_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for intermediate responses.
OP_TYPE_MODIFY_DN_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for modify DN requests.
OP_TYPE_MODIFY_DN_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for modify DN responses.
OP_TYPE_MODIFY_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for modify requests.
OP_TYPE_MODIFY_RESPONSE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for modify responses.
OP_TYPE_SEARCH_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for search requests.
OP_TYPE_SEARCH_RESULT_DONE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for search result done elements.
OP_TYPE_SEARCH_RESULT_ENTRY - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for search result entries.
OP_TYPE_SEARCH_RESULT_REFERENCE - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for search result references.
OP_TYPE_UNBIND_REQUEST - Static variable in class org.forgerock.opendj.io.Ldap
The protocol op type for unbind requests.
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, Clock, 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
 
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
 
OpenDjSecurityProvider - Class in org.forgerock.opendj.security
The OpenDJ LDAP security provider which exposes an LDAP/LDIF based KeyStore service, as well as providing utility methods facilitating construction of LDAP/LDIF based key stores.
OpenDjSecurityProvider() - Constructor for class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a default LDAP security provider with no default key store configuration.
OpenDjSecurityProvider(String) - Constructor for class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a LDAP security provider with provided default key store configuration.
OpenDjSecurityProvider(URI) - Constructor for class org.forgerock.opendj.security.OpenDjSecurityProvider
Creates a LDAP security provider with provided default key store configuration.
OpenDjSecurityProviderSchema - Class in org.forgerock.opendj.security
Utility methods for accessing the LDAP schema elements required in order to support the OpenDJ security provider.
OPENIG_JWT_SESSION - Static variable in class org.forgerock.openig.jwt.JwtCookieSession
Name of the cookie that will store the JWT session.
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_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_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the operation is not properly sequenced with relation to other operations (of same or different type).
Option<T> - Class in org.forgerock.util
A configuration option whose value can be stored in a set of Options.
OPTION_ASYNC_BEHAVIOUR - Static variable in class org.forgerock.http.apache.async.AsyncHttpClientProvider
Specify async client behaviour (promise's completion time).
OPTION_BUFFER_SIZE - Static variable in class org.forgerock.http.apache.async.AsyncHttpClientProvider
Specify the size of the buffer used to consume to HTTP response body.
OPTION_CONNECT_TIMEOUT - Static variable in class org.forgerock.http.handler.HttpClientHandler
The TCP connect timeout for new HTTP connections.
OPTION_DISABLE_CONNECTION_STATE - Static variable in class org.forgerock.http.handler.HttpClientHandler
This option is only taken into account when OPTION_REUSE_CONNECTIONS is also set to true.
OPTION_HOSTNAME_VERIFIER - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies the SSL host name verification policy.
OPTION_KEY_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_POOLED_CONNECTION_TTL - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies the time to live (expiry time) in milliseconds of connections from the pool.
OPTION_PROXY - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies a proxy to use for requests by the HTTP Client.
OPTION_PROXY_SYSTEM - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies that the system defined proxy should be used for requests by the HTTP Client.
OPTION_RETRY_REQUESTS - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies whether requests should be retried if a failure is detected.
OPTION_REUSE_CONNECTIONS - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies whether HTTP connections should be kept alive and reused for additional requests.
OPTION_SO_TIMEOUT - Static variable in class org.forgerock.http.handler.HttpClientHandler
The TCP socket timeout when waiting for HTTP responses.
OPTION_SSL_CIPHER_SUITES - Static variable in class org.forgerock.http.handler.HttpClientHandler
List of JSSE ciphers to be enabled on the HttpClient.
OPTION_SSL_ENABLED_PROTOCOLS - Static variable in class org.forgerock.http.handler.HttpClientHandler
List of SSL protocols to be enabled on the HttpClient.
OPTION_SSLCONTEXT_ALGORITHM - Static variable in class org.forgerock.http.handler.HttpClientHandler
SSLContext algorithm to be used when making SSL/TLS connections.
OPTION_TEMPORARY_STORAGE - Static variable in class org.forgerock.http.handler.HttpClientHandler
Specifies the temporary storage that should be used for storing HTTP responses.
OPTION_TRUST_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.
optional() - Static method in class org.forgerock.openig.util.JsonValues
Returns a function returning an Optional JsonValue if the value is null or undefined.
optionalAttributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided optional attributes to the list of attribute types that entries subject to this DIT content rule may contain.
optionalAttributes(String...) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided optional attributes to the list of attribute types that entries subject to this DIT content rule may contain.
optionalAttributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds the provided optional attributes.
optionalAttributes(String...) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds the provided optional attributes.
optionalAttributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided optional attributes.
optionalAttributes(String...) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided optional attributes.
optionalHeapObject(Heap, Class<T>) - Static method in class org.forgerock.openig.util.JsonValues
Returns a Function to transform a list of String-based JsonValues into a list of optional heap objects.
optionalOf(Function<JsonValue, T, JsonValueException>) - Static method in class org.forgerock.openig.util.JsonValues
Returns a wrapping function returning an Optional result of the given delegate function.
Options - Class in org.forgerock.util
A set of options which can be used for customizing the behavior of HTTP clients and servers.
OptionsFilter - Class in org.forgerock.http.filter
Filter which handles OPTION HTTP requests to CREST resources.
or(Collection<FilterCondition>) - Static method in class org.forgerock.json.resource.Filters
Returns a FilterCondition which will match requests which match any of the provided conditions.
or(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() - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical OR of zero condition results, which is always FALSE.
or(ConditionResult...) - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical OR of the provided condition results, which is FALSE if all of the provided condition results are FALSE, TRUE if at least one of them is TRUE, and UNDEFINED otherwise.
or(ConditionResult, ConditionResult) - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical OR of the provided condition results, which is FALSE if both of the provided condition results are FALSE , TRUE if at least one of them is TRUE , and UNDEFINED otherwise.
or(ConditionResult) - Method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the logical OR of the this condition result with the provided condition result, which is FALSE if both of the condition results are FALSE, TRUE if at least one of them is TRUE, and UNDEFINED otherwise.
or(Collection<Filter>) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new or filter using the provided list of sub-filters.
or(Filter...) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new or filter using the provided list of sub-filters.
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.
orderingMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the matching rule that should be used for ordering with this attribute type.
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.config.resolvers - package org.forgerock.config.resolvers
This package contains the common config property resolvers.
org.forgerock.config.util - package org.forgerock.config.util
Contains utility classes for commons config.
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.header.authorization - package org.forgerock.http.header.authorization
Credentials classes for use with the AuthorizationHeader.
org.forgerock.http.io - package org.forgerock.http.io
Provides stream buffering, branching, and storage functions.
org.forgerock.http.oauth2 - package org.forgerock.http.oauth2
This package provides APIs for OAuth 2.0 services implementations.
org.forgerock.http.oauth2.resolver - package org.forgerock.http.oauth2.resolver
This package defines OpenAM specific logic needed to retrieve an AccessTokenInfo.
org.forgerock.http.protocol - package org.forgerock.http.protocol
Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.routing - package org.forgerock.http.routing
Provides routing functionality for HTTP requests.
org.forgerock.http.servlet - package org.forgerock.http.servlet
Integrates with the Java Enterprise Edition Servlet API.
org.forgerock.http.session - package org.forgerock.http.session
Provides interfaces for managing and interacting with HTTP Sessions.
org.forgerock.http.spi - package org.forgerock.http.spi
HTTP service provider API.
org.forgerock.http.swagger - package org.forgerock.http.swagger
Classes to support OpenAPI API Descriptions using Swagger.
org.forgerock.http.util - package org.forgerock.http.util
Miscellaneous utility classes.
org.forgerock.json - package org.forgerock.json
Provides an API for the traversal and manipulation of JSON object model structures in Java.
org.forgerock.json.jose.builders - package org.forgerock.json.jose.builders
Classes and interfaces for builder to build JWTs using a fluent API.
org.forgerock.json.jose.common - package org.forgerock.json.jose.common
Common classes and interfaces for all types of JWTs.
org.forgerock.json.jose.exceptions - package org.forgerock.json.jose.exceptions
Exceptions for all possible JWT exception scenarios.
org.forgerock.json.jose.jwe - package org.forgerock.json.jose.jwe
Classes and interfaces for JWT encryption and JWEs.
org.forgerock.json.jose.jwe.handlers.compression - package org.forgerock.json.jose.jwe.handlers.compression
Compression Handler classes for each possible compression algorithm.
org.forgerock.json.jose.jwe.handlers.encryption - package org.forgerock.json.jose.jwe.handlers.encryption
Encryption Handler classes for each possible encryption algorithm.
org.forgerock.json.jose.jwk - package org.forgerock.json.jose.jwk
Classes and interfaces for creating and manipulating JWKs.
org.forgerock.json.jose.jwk.store - package org.forgerock.json.jose.jwk.store
This package contains classes to manage a JWKs URI.
org.forgerock.json.jose.jws - package org.forgerock.json.jose.jws
Classes and interfaces for JWT signing and JWS'.
org.forgerock.json.jose.jws.handlers - package org.forgerock.json.jose.jws.handlers
Signing Handler classes for each possible signing algorithm.
org.forgerock.json.jose.jwt - package org.forgerock.json.jose.jwt
Classes and interfaces for JWTs.
org.forgerock.json.jose.tokenhandler - package org.forgerock.json.jose.tokenhandler
JWT implementation(s) of TokenHandler.
org.forgerock.json.jose.utils - package org.forgerock.json.jose.utils
Utility classes for JWT creation and manipulation.
org.forgerock.json.resource - package org.forgerock.json.resource
Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.json.resource.http - package org.forgerock.json.resource.http
JSON resource Commons HTTP Framework integration.
org.forgerock.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.monitoring - package org.forgerock.monitoring
Common utility classes for monitoring.
org.forgerock.monitoring.api.annotation - package org.forgerock.monitoring.api.annotation
Common Monitoring API Annotations based on MicroMeter
org.forgerock.monitoring.api.instrument - package org.forgerock.monitoring.api.instrument
Common Monitoring API Core based on MicroMeter
org.forgerock.monitoring.api.instrument.binder - package org.forgerock.monitoring.api.instrument.binder
 
org.forgerock.monitoring.api.instrument.config - package org.forgerock.monitoring.api.instrument.config
Common Monitoring API Config functionality based on MicroMeter
org.forgerock.monitoring.api.instrument.histogram - package org.forgerock.monitoring.api.instrument.histogram
Common Monitoring API Histogram based on MicroMeter
org.forgerock.monitoring.api.instrument.histogram.pause - package org.forgerock.monitoring.api.instrument.histogram.pause
Common Monitoring API Histogram Pause Detector based on MicroMeter
org.forgerock.monitoring.api.instrument.search - package org.forgerock.monitoring.api.instrument.search
Common Monitoring API Search functionality based on MicroMeter
org.forgerock.monitoring.api.instrument.util - package org.forgerock.monitoring.api.instrument.util
Common Monitoring API Utilities based on MicroMeter
org.forgerock.monitoring.api.lang - package org.forgerock.monitoring.api.lang
Common Monitoring API Annotations based on MicroMeter
org.forgerock.monitoring.dropwizard - package org.forgerock.monitoring.dropwizard
Implementation for Common Monitoring API based on DropWizard.
org.forgerock.monitoring.http - package org.forgerock.monitoring.http
Common utility classes for monitoring.
org.forgerock.opendj.grizzly - package org.forgerock.opendj.grizzly
Provides an implementation of a transport provider using Grizzly as transport.
org.forgerock.opendj.io - package org.forgerock.opendj.io
Classes and interfaces providing I/O functionality.
org.forgerock.opendj.ldap - package org.forgerock.opendj.ldap
Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.controls - package org.forgerock.opendj.ldap.controls
Classes and interfaces for common LDAP controls.
org.forgerock.opendj.ldap.messages - package org.forgerock.opendj.ldap.messages
Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.ldap.schema - package org.forgerock.opendj.ldap.schema
Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.ldap.spi - package org.forgerock.opendj.ldap.spi
Interfaces and classes for service providers.
org.forgerock.opendj.ldif - package org.forgerock.opendj.ldif
Classes and interfaces for reading and writing LDIF.
org.forgerock.opendj.security - package org.forgerock.opendj.security
An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based KeyStore service.
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
Identity Gateway SAML support.
org.forgerock.openig.heap - package org.forgerock.openig.heap
Manages collections or "heaps" of associated objects, initialized from declarative configuration artifacts.
org.forgerock.openig.http - package org.forgerock.openig.http
Integrates with the ForgeRock HTTP Framework.
org.forgerock.openig.io - package org.forgerock.openig.io
Provides stream buffering, branching, and storage functions.
org.forgerock.openig.jwt - package org.forgerock.openig.jwt
Provides JWT capabilities to the Identity Gateway.
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
Integration classes specifically for ForgeRock Access Management.
org.forgerock.openig.regex - package org.forgerock.openig.regex
Matches, extracts and transforms text with regular expression patterns.
org.forgerock.openig.resolver - package org.forgerock.openig.resolver
Performs object resolution for dynamic expression and script integration.
org.forgerock.openig.script - package org.forgerock.openig.script
Scripting support.
org.forgerock.openig.secrets - package org.forgerock.openig.secrets
Provides the Common Secrets API for accessing secrets of various kinds.
org.forgerock.openig.security - package org.forgerock.openig.security
Provides heap objects for security related types (KeyStore, KeyManagerFactory, ...).
org.forgerock.openig.text - package org.forgerock.openig.text
Processes structured text in streams and files.
org.forgerock.openig.thread - package org.forgerock.openig.thread
Provides heaplets for creating thread pools.
org.forgerock.openig.tools - package org.forgerock.openig.tools
Common tools used in policy service.
org.forgerock.openig.tools.am - package org.forgerock.openig.tools.am
Access Management Server.
org.forgerock.openig.tools.authentication - package org.forgerock.openig.tools.authentication
AM authentication service.
org.forgerock.openig.tools.authentication.chf - package org.forgerock.openig.tools.authentication.chf
HTTP-based authentication service.
org.forgerock.openig.tools.jwt - package org.forgerock.openig.tools.jwt
This package contains classes used to perform JWT validation.
org.forgerock.openig.tools.notifications - package org.forgerock.openig.tools.notifications
AM notifications service.
org.forgerock.openig.tools.notifications.ws - package org.forgerock.openig.tools.notifications.ws
Web socket notifications service implementation.
org.forgerock.openig.tools.session - package org.forgerock.openig.tools.session
This package contains classes to call AM to retrieve user's session info.
org.forgerock.openig.tools.userprofile - package org.forgerock.openig.tools.userprofile
This package contains classes to call AM to retrieve user's profile info.
org.forgerock.openig.ui.record - package org.forgerock.openig.ui.record
Defines a storage service to be used by the UI to persist its component model.
org.forgerock.openig.uma - package org.forgerock.openig.uma
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
org.forgerock.openig.util - package org.forgerock.openig.util
Miscellaneous utility classes.
org.forgerock.openig.websocket - package org.forgerock.openig.websocket
WebSocket proxy support.
org.forgerock.openig.websocket.grizzly - package org.forgerock.openig.websocket.grizzly
Grizzly filters for WebSocket proxy support.
org.forgerock.secrets - package org.forgerock.secrets
Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.keys - package org.forgerock.secrets.keys
Contains cryptographic key related API objects.
org.forgerock.secrets.keystore - package org.forgerock.secrets.keystore
Implementations of SecretStore for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.
org.forgerock.secrets.propertyresolver - package org.forgerock.secrets.propertyresolver
Provides a SecretStore implementation that loads secrets from a Common Configuration PropertyResolver and then decodes it with a SecretPropertyFormat.
org.forgerock.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).
OTHER - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that should be used if no other result code is appropriate.
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.
OVERWRITE - Static variable in interface org.forgerock.opendj.ldif.RejectedChangeRecordListener
The default handler which ignores changes applied to missing entries and tolerates duplicate entries by overwriting the existing entry with the new entry.

P

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.
parameters - Variable in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge
Any additional options that the type requires.
parent() - Method in class org.forgerock.http.io.BranchingInputStream
Returns the parent branching input stream from which this branch was created, or null if this is the trunk.
parent() - Method in class org.forgerock.json.JsonPointer
Returns a pointer to the parent of the JSON value identified by this JSON pointer, or null if the pointer has no parent JSON value (i.e.
parent() - Method in class org.forgerock.json.resource.ResourcePath
Returns the resource path which is the immediate parent of this resource path, or null if this resource path is empty.
parent() - Method in class org.forgerock.opendj.ldap.Dn
Returns the DN which is the immediate parent of this DN, or null if this DN is the Root DN.
parent(int) - Method in class org.forgerock.opendj.ldap.Dn
Returns the DN which is equal to this DN with the specified number of RDNs removed.
parse(String) - Method in interface org.forgerock.http.header.authorization.CredentialsParser
Parse the provided credentials into a rich representation.
parse(String) - Method in class org.forgerock.http.header.AuthorizationHeader.Factory
 
parse(String) - Method in class org.forgerock.http.header.HeaderFactory
Create a header instance from String representation, which may contain multiple values if the header supports them.
parse(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 enum org.forgerock.http.protocol.Cookie.SameSite
Parses the given SameSite value.
parse(String) - Static method in class org.forgerock.json.jose.jwk.EcJWK
Parses a JWK from a string json object.
parse(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(JsonValue) - Static method in class org.forgerock.json.jose.jwk.OkpJWK
Parses a JWK from a JsonValue json 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.
parse() - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
parse() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns a parser for this attribute which can be used for decoding values as different types of object.
parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm
Parses the given algorithm string to find the matching CompressionAlgorithm enum constant.
parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm
Parses the given algorithm string to find the matching Jwe algorithm enum constant.
parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Parses the given algorithm string to find the matching JwsAlgorithm enum constant.
parseAttribute(Attribute) - Static method in class org.forgerock.opendj.ldap.AttributeParser
Returns an attribute parser for the provided attribute.
parseAttribute(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.Entry
Returns a parser for the named attribute contained in this entry.
parseAttribute(String) - Method in interface org.forgerock.opendj.ldap.Entry
Returns a parser for the named attribute contained in this entry.
parseAuditEventHandlerConfiguration(Class<C>, JsonValue) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Returns the audit event handler configuration from the provided JSON string.
parseAuditServiceConfiguration(InputStream) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Returns the audit service configuration from the provided input stream.
parseAuditServiceConfiguration(String) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Returns the audit service configuration from the provided JSON string.
parseAuditServiceConfiguration(JsonValue) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Returns the audit service configuration from the provided JSON value.
parseBoolean() - Static method in class org.forgerock.json.JsonValueFunctions
Returns a Boolean by converting the JsonValue using JsonValue.asLong(), or by parsing the JsonValue string using Boolean.parseBoolean(String).
parseCredentials(CredentialsParser<C>) - Method in class org.forgerock.http.header.AuthorizationHeader
Parse the credentials to a rich type.
parseCryptographicAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Parses the given algorithm string to find the matching Java Cryptographic algorithm name.
parseDate(String) - Static method in class org.forgerock.http.header.HeaderUtil
Parses the supported HTTP-date formats as specified in RFC 2616.
parseDirective(String) - Static method in class org.forgerock.http.header.HeaderUtil
Splits a single HTTP directive name and value from an input string value.
parseDirectives(Collection<String>) - Static method in class org.forgerock.http.header.HeaderUtil
Parses a set of HTTP directives from a collection of values.
parseDirectivesAsDirectiveMap(Collection<String>) - Static method in class org.forgerock.http.header.HeaderUtil
Parses a set of HTTP directives from a collection of values.
parseField(String) - Method in class org.forgerock.util.query.QueryFilterParser
Parses the field description from the current filter token into the type of field description the QueryFilter uses.
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
 
parseLong() - Static method in class org.forgerock.json.JsonValueFunctions
Returns a Long by converting the JsonValue using JsonValue.asLong(), or by parsing the JsonValue string using Long.parseLong(String).
parseMethod(String) - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Parses the given algorithm string to find the matching EncryptionMethod enum constant.
parseMultiValuedHeader(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.
PARSER - Static variable in class org.forgerock.http.header.authorization.BasicCredentials
The parser for Basic credentials.
PARSER - Static variable in class org.forgerock.http.header.authorization.BearerToken
The parser for Bearer credentials.
parseRealm(String) - Static method in class org.forgerock.openig.tools.am.Realm
Creates a new Realm by parsing the given name.
parseSingleValuedHeader(Message<?>, String) - Static method in class org.forgerock.http.header.HeaderUtil
Parses the named single-valued header from the message.
parseTimestamp(String) - Method in class org.forgerock.audit.util.DateUtil
Parses an ISO8601 compliant timestamp into a DateTime object.
password(String, char[], Clock) - Static method in class org.forgerock.secrets.GenericSecret
A helper utility for constructing a Generic Secret from a password with a default expiry time.
PASSWORD - Static variable in class org.forgerock.secrets.Purpose
Indicates a secret intended to be used as a password for authentication to some service.
password(char[]) - Method in class org.forgerock.secrets.SecretBuilder
Sets the raw data of this secret object to the UTF-8 bytes of the given password.
PasswordExpiredResponseControl - Class in org.forgerock.opendj.ldap.controls
The Netscape password expired response control as defined in draft-vchu-ldap-pwd-policy.
PasswordExpiringResponseControl - Class in org.forgerock.opendj.ldap.controls
The Netscape password expiring response control as defined in draft-vchu-ldap-pwd-policy.
PasswordModifyExtendedRequest - Interface in org.forgerock.opendj.ldap.messages
The password modify extended request as defined in RFC 3062.
PasswordModifyExtendedResult - Interface in org.forgerock.opendj.ldap.messages
The password modify extended result as defined in RFC 3062.
PasswordPolicyErrorType - Enum in org.forgerock.opendj.ldap.controls
A password policy error type as defined in draft-behera-ldap-password-policy is used to indicate problems concerning a user's account or password.
PasswordPolicyRequestControl - Class in org.forgerock.opendj.ldap.controls
The password policy request control as defined in draft-behera-ldap-password-policy.
PasswordPolicyResponseControl - Class in org.forgerock.opendj.ldap.controls
The password policy response control as defined in draft-behera-ldap-password-policy.
PasswordPolicyWarningType - Enum in org.forgerock.opendj.ldap.controls
A password policy warning type as defined in draft-behera-ldap-password-policy is used to indicate the current state of a user's password.
PasswordReplayFilterHeaplet - Class in org.forgerock.openig.filter
Supports password replay feature in a composite filter.
PasswordReplayFilterHeaplet() - Constructor for class org.forgerock.openig.filter.PasswordReplayFilterHeaplet
 
patch(JsonValue, 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(EntryReader, ChangeRecordReader) - Static method in class org.forgerock.opendj.ldif.Ldif
Applies the set of changes contained in patch to the content of input and returns the result in an entry reader.
patch(EntryReader, ChangeRecordReader, RejectedChangeRecordListener) - Static method in class org.forgerock.opendj.ldif.Ldif
Applies the set of changes contained in patch to the content of input and returns the result in an entry reader.
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 - 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 - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The path event payload field name.
path(String) - Method in class org.forgerock.openig.http.CookieBuilder
Set the path and return a new instance of this builder.
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.
pathPropertyResolver(Map<String, Path>) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Constructs a path resolver to expose paths and associated URLs.
Paths - Class in org.forgerock.http.util
Utilities for manipulating paths.
pathToUrl(String) - Static method in class org.forgerock.openig.el.Functions
Returns the String representation of the URL denoting the given path.
pattern() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a regular expression pattern.
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.
PauseDetector - Interface in org.forgerock.monitoring.api.instrument.histogram.pause
 
pauseDetector(PauseDetector) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Sets the default pause detector to use for all timers in this registry.
pauseDetector() - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.Config
Returns the associated Pause Detector.
pauseDetector(PauseDetector) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Sets the pause detector implementation to use for this timer.
pauseDetector(PauseDetector) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
pauseDetector() - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry.ConfigImpl
 
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.
PBKDF2_ITERATIONS - Static variable in class org.forgerock.opendj.security.KeyStoreParameters
The number of iterations to use when deriving encryption keys from passwords using PBKDF2.
PBKDF2_SALT_SIZE - Static variable in class org.forgerock.opendj.security.KeyStoreParameters
The number of random bytes to use as the salt when deriving encryption keys from passwords using PBKDF2.
peek() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Returns the byte situated at the current position.
peek(int) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Returns the byte situated at the given offset from current position.
peekLength() - Method in interface org.forgerock.opendj.io.Asn1Reader
Returns the data length of the next element without actually reading it.
peekType() - Method in interface org.forgerock.opendj.io.Asn1Reader
Returns the type of the next element without actually reading it.
percentile(double) - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
The value at a specific percentile.
percentile(double, TimeUnit) - Method in interface org.forgerock.monitoring.api.instrument.Timer
The latency at a specific percentile.
percentile() - Method in class org.forgerock.monitoring.api.instrument.ValueAtPercentile
 
percentile(double) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
percentile(double, TimeUnit) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
PercentileHistogramBuckets - Class in org.forgerock.monitoring.api.instrument.histogram
Generator for a set of histogram buckets intended for use by a monitoring system that supports aggregable percentile approximations such as Prometheus' histogram_quantiles or Atlas' :percentiles.
PercentileHistogramBuckets() - Constructor for class org.forgerock.monitoring.api.instrument.histogram.PercentileHistogramBuckets
 
percentiles(double...) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
percentilesHistogram(Boolean) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
percentileValues() - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
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.
PermissiveModifyRequestControl - Class in org.forgerock.opendj.ldap.controls
The Microsoft defined permissive modify request control.
PersistentSearchChangeType - Enum in org.forgerock.opendj.ldap.controls
A persistent search change type as defined in draft-ietf-ldapext-psearch is used to indicate the type of update operation that caused an entry change notification to occur.
PersistentSearchRequestControl - Class in org.forgerock.opendj.ldap.controls
The persistent search request control as defined in draft-ietf-ldapext-psearch.
pimpl - Variable in class org.forgerock.util.query.QueryFilter
the filter implementation.
PipeBufferedStream - Class in org.forgerock.http.io
Represents a pipe for transferring bytes from an OutputStream to a InputStream.
PipeBufferedStream() - Constructor for class org.forgerock.http.io.PipeBufferedStream
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.
PKCS11 - Static variable in class org.forgerock.opendj.security.KeyManagers
PKCS11 keystore type.
PKCS12 - Static variable in class org.forgerock.opendj.security.KeyManagers
PKCS12 keystore type.
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.
PolicyDecisionContext - Class in org.forgerock.openig.openam
A PolicyDecisionContext convey policy decision information to downstream filters and handlers.
PolicyEnforcementFilter - Class in org.forgerock.openig.openam
This filter requests policy decisions from Access Management which evaluates the original URI based on the context and the policies configured, and according to the decisions, allows or denies the current request.
PolicyEnforcementFilter(RequestHandler, Handler, SessionService, ResourceUriProvider) - Constructor for class org.forgerock.openig.openam.PolicyEnforcementFilter
Creates a new enforcement filter.
PolicyEnforcementFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initializes a policy enforcement filter in a heap environment.
POLLING_INTERVAL - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration
Common Audit Batch log records queue polling timeout as Duration.
POLLING_TIMEOUT - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration
Common Audit Batch log records queue polling timeout.
POLLING_TIMEOUT_UNIT - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration
Common Audit Batch log records queue polling timeout unit.
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.
position() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Returns this reader's position.
position(int) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Sets this reader's position.
POSTGRES - Static variable in class org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler
The name used for a Postgres database.
PostReadRequestControl - Class in org.forgerock.opendj.ldap.controls
The post-read request control as defined in RFC 4527.
PostReadResponseControl - Class in org.forgerock.opendj.ldap.controls
The post-read response control as defined in RFC 4527.
postRetentionAction() - Method in class org.forgerock.audit.retention.RetentionHooks.NullRetentionHooks
 
postRetentionAction() - Method in interface org.forgerock.audit.retention.RetentionHooks
Method to run an action just before the file is run through the RetentionPolicy's.
postRotationAction(RotationContext) - Method in class org.forgerock.audit.rotation.RotationHooks.NoOpRotatationHooks
 
postRotationAction(RotationContext) - Method in interface org.forgerock.audit.rotation.RotationHooks
Method to run an action just after file has been rotated.
PreconditionFailedException - Exception in org.forgerock.json.resource
An exception that is thrown to indicate that a resource's current version does not match the version provided.
PreconditionFailedException() - Constructor for exception org.forgerock.json.resource.PreconditionFailedException
Constructs a new exception with null as its detail message.
PreconditionFailedException(String) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException
Constructs a new exception with the specified detail message.
PreconditionFailedException(String, Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException
Constructs a new exception with the specified detail message and cause.
PreconditionFailedException(Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionFailedException
Constructs a new exception with the specified cause.
PreconditionRequiredException - Exception in org.forgerock.json.resource
An exception that is thrown to indicate that a resource requires a version, but no version was supplied in the request.
PreconditionRequiredException() - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException
Constructs a new exception with null as its detail message.
PreconditionRequiredException(String) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException
Constructs a new exception with the specified detail message.
PreconditionRequiredException(String, Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException
Constructs a new exception with the specified detail message and cause.
PreconditionRequiredException(Throwable) - Constructor for exception org.forgerock.json.resource.PreconditionRequiredException
Constructs a new exception with the specified cause.
Predicate<T,E extends Exception> - Interface in org.forgerock.util
A Predicate functional interface which can thrown a checked Exception.
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.
prefixed(String, PropertyResolver) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Constructs a prefixed PropertyResolver.
PreReadRequestControl - Class in org.forgerock.opendj.ldap.controls
The pre-read request control as defined in RFC 4527.
PreReadResponseControl - Class in org.forgerock.opendj.ldap.controls
The pre-read response control as defined in RFC 4527.
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(String) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new present filter using the provided attribute description.
present(FF) - Static method in class org.forgerock.util.query.QueryFilter
Creates a new presence filter using the provided field name.
PRESENT - Static variable in class org.forgerock.util.query.QueryFilterOperators
the "present" operator.
PRESERVE_ORIGINAL_QUERY_STRING_INIT_PARAM - Static variable in class org.forgerock.http.servlet.HttpFrameworkServlet
Servlet init-param for configuring how strict CHF is in regard to invalid characters in query string.
primeP(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Set the RSA First Prime Factor value.
primePExponent(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Set the RSA First Factor CRT Exponent value.
primeQ(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Set the RSA Second Prime Factor value.
primeQExponent(String) - Method in class org.forgerock.json.jose.jwk.RsaJWK.Builder
Set the RSA Second factor CRT Exponent value.
PrimesInfo(String, String, String) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo
Creates the other prime factors.
PrimesInfo(RSAOtherPrimeInfo) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo
Create other prime factors.
PRINCIPAL - 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.
privateKey(OkpJWK.OctetECPrivateKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the private key d-value from the given private key.
privateScalarValue(PrivateKey) - Static method in class org.forgerock.json.jose.utils.XECUtils
Returns the private scalar value for the given XECPrivateKey.
ProductInfoProvider - Interface in org.forgerock.audit.providers
Strategy for obtaining the information relating to the product in which the AuditService is deployed.
productPathPropertyResolver(String, Path) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Constructs a path resolver to expose a product instance directory.
ProductPathResolver - Class in org.forgerock.config.resolvers
A property accessor for product paths.
prohibitedAttributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided prohibited attributes to the list of attribute types that entries subject to this DIT content rule must not contain.
prohibitedAttributes(String...) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided prohibited attributes to the list of attribute types that entries subject to this DIT content rule must not contain.
PrometheusHandler - Class in org.forgerock.monitoring.http
An HTTP Handler from which Prometheus can scrap monitoring information.
prometheusHandler(String, Supplier<MeterRegistry>) - Static method in class org.forgerock.monitoring.http.PrometheusHandler
Returns a new Prometheus Handler.
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.
promiseToFuture(Promise<T, E>) - Static method in class org.forgerock.openig.tools.FutureUtils
Converts a Promise to a CompletableFuture.
PROPERTIES - Static variable in class org.forgerock.json.schema.validator.Constants
The properties field name.
PropertiesResolver - Class in org.forgerock.config.resolvers
Given a file path this will load the properties within the file as a PropertyResolver.
propertiesResolver(Path) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Creates a PropertiesResolver given a file location.
propertiesResolver(String) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Creates a PropertiesResolver given a file location.
propertiesResolver(File) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Creates a PropertiesResolver given a file object.
propertiesResolver(Properties) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Creates a PropertiesResolver given a Properties object.
propertiesResolver(String, Properties) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Creates a PropertiesResolver given a Properties object.
PropertyFormat - Enum in org.forgerock.openig.secrets
Supported property formats for secrets exposed in unsecure context, such as file-based and system/environment variables.
PropertyFormatBase64 - Enum in org.forgerock.secrets.propertyresolver
Decodes secrets in raw base64 format.
PropertyResolver - Interface in org.forgerock.config.resolvers
A property resolver attempt to get the value of a given config property.
propertyResolver - Variable in class org.forgerock.openig.heap.HeapImpl
Resolves tokens.
PropertyResolvers - Class in org.forgerock.config.resolvers
A utility class that gives access to the default property resolvers for a product.
PropertyResolverSecretStore - Class in org.forgerock.secrets.propertyresolver
A SecretStore implementation that resolves secrets as base64-encoded strings from an underlying PropertyResolver.
PropertyResolverSecretStore(PropertyResolver, SecretPropertyFormat) - Constructor for class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
Initialises the property resolver secret store.
PropertyResolverSecretStore(PropertyResolver) - Constructor for class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
Initialises the property resolver secret store using base64-encoded properties.
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_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the client sent a malformed or illegal request to the server.
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.
ProtocolOp - Interface in org.forgerock.opendj.ldap.messages
The base class of all requests and responses provides methods for querying and manipulating the set of Controls.
Provider - Interface in org.forgerock.opendj.ldap.spi
Interface for providers, which provide an implementation of one or more interfaces.
ProviderNotFoundException - Exception in org.forgerock.opendj.ldap
Exception thrown when a provider of a service can't be found.
ProviderNotFoundException(Class<? extends Provider>, String, String) - Constructor for exception org.forgerock.opendj.ldap.ProviderNotFoundException
Creates the exception with a provider type, provider name and a message.
ProxiedAuthV1RequestControl - Class in org.forgerock.opendj.ldap.controls
The proxy authorization v1 request control as defined in draft-weltman-ldapv3-proxy-04.
ProxiedAuthV2RequestControl - Class in org.forgerock.opendj.ldap.controls
The proxy authorization v2 request control as defined in RFC 4370.
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.
PTR_AUD - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set audience JSON pointer.
PTR_EXP - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set expiry JSON pointer.
PTR_ISS - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set issuer JSON pointer.
PTR_NONCE - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set nonce JSON pointer.
PTR_TOKEN_NAME - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set tokenName JSON pointer.
publicKey(PublicKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the public x-coordinate from the given public key.
publicKey(ECPublicKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the public x-coordinate from the given public key.
publicKey(PublicKey) - Method in class org.forgerock.secrets.SecretBuilder
Sets the public key associated with this secret.
publicUCoordinate(PublicKey) - Static method in class org.forgerock.json.jose.utils.XECUtils
Returns the little-endian bytes of the public u-coordinate of the given XECPublicKey.
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.
publishPercentileHistogram() - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Adds histogram buckets usable for generating aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
publishPercentileHistogram(Boolean) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Adds histogram buckets usable for generating aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
publishPercentileHistogram() - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Adds histogram buckets usable for generating aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
publishPercentileHistogram(Boolean) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Adds histogram buckets usable for generating aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
publishPercentiles(double...) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Produces an additional time series for each requested percentile.
publishPercentiles(double...) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Produces an additional time series for each requested percentile.
publishSingleEvent(String, JsonValue) - Method in class org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler
Publishes a single event to the provided topic.
Purpose<T extends Secret> - Class in org.forgerock.secrets
A purpose encapsulates both a name for a function that requires access to secrets, together with a hint as to the intended usage of those secrets.
purpose(String, Class<T>) - Static method in class org.forgerock.secrets.Purpose
Constructs a purpose object.
PURPOSE_KEY - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the purpose of the key used to crypt the data.
purposeOf(Class<S>) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function returning a Purpose from the given String value representing the purpose label.
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, 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, P) - Method in class org.forgerock.opendj.ldap.ConsistentHashMap
Puts a partition into this consistent hash map using the default weight which is sufficiently high to ensure a reasonably uniform distribution among all partitions having the same weight.
put(String, P, int) - Method in class org.forgerock.opendj.ldap.ConsistentHashMap
Puts a partition into this consistent hash map using the specified weight.
put(KeyStoreObject) - Method in interface org.forgerock.opendj.security.KeyStoreObjectCache
Puts a key store object in the cache replacing any existing key store object with the same alias.
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<String, P>) - Method in class org.forgerock.opendj.ldap.ConsistentHashMap
Copies all the partitions from the specified map to this consistent hash map..
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.
putHeaders(Header...) - Method in interface org.forgerock.http.protocol.Message
Put one or more headers to the request.
putHeaders(Header...) - Method in class org.forgerock.http.protocol.MessageImpl
 
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.
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_PARAMETERS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The query parameters event payload field name.
queryAsync(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Asynchronously searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
queryAsync(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.Connection
Asynchronously searches for all JSON resources matching a user specified set of criteria, and returns a Promise that will be completed with the results of the search.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.json.resource.CollectionResourceProvider
Searches the collection for all resources which match the query request criteria.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.json.resource.MemoryBackend
Searches the collection for all resources which match the query request criteria.
queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.monitoring.DropwizardMetricsCollectionResourceProvider
 
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.
QueryRequest - Interface in org.forgerock.json.resource
A request to search for all JSON resources matching a user specified set of criteria.
QueryResourceHandler - Interface in org.forgerock.json.resource
A completion handler for consuming the results of a query request.
QueryResponse - Interface in org.forgerock.json.resource
The final result of a query request returned after all resources matching the request have been returned.
quote(String) - Static method in class org.forgerock.http.header.HeaderUtil
Encloses a string in quotation marks.

R

RangeSet - Class in org.forgerock.util
Exposes a range of integer values as a set.
RangeSet(int) - Constructor for class org.forgerock.util.RangeSet
Constructs a range set for a sequence of numbers, starting at 0 with the value to stop.
RangeSet(int, int) - Constructor for class org.forgerock.util.RangeSet
Constructs a range set for the specified range of integers with a step of 1.
RangeSet(int, int, int) - Constructor for class org.forgerock.util.RangeSet
Constructs a range set for the specified range of integers and increment.
rawData(byte[]) - Method in class org.forgerock.secrets.SecretBuilder
Sets the raw data of the secret object.
rawInfo() - Method in class org.forgerock.openig.tools.userprofile.UserProfile
Returns the unmodifiable Map of the user profile info, not null.
rdn() - Method in class org.forgerock.opendj.ldap.Dn
Returns the RDN of this DN, or null if this DN is the Root DN.
rdn(int) - Method in class org.forgerock.opendj.ldap.Dn
Returns the RDN at the specified index for this DN, or null if no such RDN exists.
Rdn - Class in org.forgerock.opendj.ldap
A relative distinguished name (RDN) as defined in RFC 4512 section 2.3 is the name of an entry relative to its immediate superior.
Rdn(AttributeType, Object) - Constructor for class org.forgerock.opendj.ldap.Rdn
Creates a new RDN using the provided attribute type and value.
Rdn(String, Object) - Constructor for class org.forgerock.opendj.ldap.Rdn
Creates a new RDN using the provided attribute type and value decoded using the default schema.
Rdn(Ava...) - Constructor for class org.forgerock.opendj.ldap.Rdn
Creates a new RDN using the provided AVAs.
Rdn(Collection<Ava>) - Constructor for class org.forgerock.opendj.ldap.Rdn
Creates a new RDN using the provided AVAs.
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.
readAsync(Context, ReadRequest) - Method in class org.forgerock.json.resource.AbstractConnectionWrapper
Asynchronously reads a JSON resource.
readAsync(Context, ReadRequest) - Method in interface org.forgerock.json.resource.Connection
Asynchronously reads a JSON resource.
readAtMost(InputStream, int) - Static method in class org.forgerock.util.Streams
Reads at most the given number of bytes from the input stream.
readAttribute(Asn1Reader, DecodeOptions, Schema) - Static method in class org.forgerock.opendj.io.Ldap
Reads the next ASN.1 element from the provided ASN1Reader as an Attribute.
readBerLength() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method for reading a multi-byte BER length.
readBoolean(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readBoolean() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a boolean having the Universal Boolean ASN.1 type tag.
readBoolean(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a boolean having the provided type tag.
readByte() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method.
readBytes(byte[]) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative bulk read method.
readBytes(byte[], int, int) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative bulk read method.
readByteSequence(int) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative bulk read method.
readByteString(int) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative bulk read method.
readChangeRecord() - Method in interface org.forgerock.opendj.ldif.ChangeRecordReader
Reads the next change record, blocking if necessary until a change record is available.
readChangeRecord() - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Reads the next change record, blocking if necessary until a change record is available.
readCompactUnsignedInt() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method for reading a compacted int value.
readCompactUnsignedLong() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method for reading a compacted long value.
readControl(Asn1Reader) - Static method in class org.forgerock.opendj.io.Ldap
Reads the next ASN.1 element from the provided ASN1Reader as a Control.
readCurrentKey() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
 
readCurrentKey() - Method in interface org.forgerock.audit.secure.SecureStorage
Reads the current key.
readEndExplicitTag() - Method in interface org.forgerock.opendj.io.Asn1Reader
Finishes reading an explicit tag and discards any unread elements.
readEndSequence() - Method in interface org.forgerock.opendj.io.Asn1Reader
Finishes reading a sequence and discards any unread elements.
readEndSequence() - Method in class org.forgerock.opendj.ldap.GserParser
Skips the input matching the end of a sequence and preceding space characters.
readEndSet() - Method in interface org.forgerock.opendj.io.Asn1Reader
Finishes reading a set and discards any unread elements.
readEntry(Asn1Reader, DecodeOptions) - Static method in class org.forgerock.opendj.io.Ldap
Reads the next ASN.1 element from the provided ASN1Reader as an Entry.
readEntry(Dn, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
readEntry(String, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
readEntry(Dn, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Reads the named entry from the Directory Server.
readEntry(String, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Reads the named entry from the Directory Server.
readEntry(Dn, String...) - Method in interface org.forgerock.opendj.ldap.Connection
Reads the named entry from the Directory Server.
readEntry(String, String...) - Method in interface org.forgerock.opendj.ldap.Connection
Reads the named entry from the Directory Server.
readEntry(Dn, String...) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Reads the named entry from the Directory Server.
readEntry() - Method in class org.forgerock.opendj.ldif.ConnectionEntryReader
Waits for the next search result entry or reference to become available and, if it is an entry, returns it as a SearchResultEntry.
readEntry() - Method in class org.forgerock.opendj.ldif.EntryGenerator
 
readEntry() - Method in interface org.forgerock.opendj.ldif.EntryReader
Reads the next entry, blocking if necessary until an entry is available.
readEntry() - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Reads the next entry, blocking if necessary until an entry is available.
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.
readEntryAsync(Dn, Collection<String>) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
readEntryAsync(Dn, Collection<String>) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously reads the named entry from the Directory Server.
readEntryAsync(Dn, Collection<String>) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously reads the named entry from the Directory Server.
readEnumerated(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readEnumerated() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an enumerated having the Universal Enumerated ASN.1 type tag.
readEnumerated(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an enumerated having the provided type tag.
reader() - Method in interface org.forgerock.opendj.io.LdapSocket
Returns a Flowable of LDAP messages read from the network.
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
 
readFilter(Asn1Reader) - Static method in class org.forgerock.opendj.io.Ldap
Reads the next ASN.1 element from the provided ASN1Reader as a Filter using a maximum filter depth of 100.
readFilter(Asn1Reader, int) - Static method in class org.forgerock.opendj.io.Ldap
Reads the next ASN.1 element from the provided ASN1Reader as a Filter using the provided maximum filter depth.
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, String, ReadRequest) - Method in class org.forgerock.monitoring.DropwizardMetricsCollectionResourceProvider
 
readInstance(Context, ReadRequest) - Method in class org.forgerock.openig.http.ServerInfoSingletonProvider
 
readInstance(Context, String, ReadRequest) - Method in class org.forgerock.openig.ui.record.RecordProvider
 
readInt() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method for reading an integer value.
readInteger(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readInteger() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an integer having the Universal Integer ASN.1 type tag.
readInteger(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an integer having the provided type tag.
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.
readLdapRequestMessage() - Method in class org.forgerock.opendj.io.LdapReader
Reads the next LDAP request message from the underlying ASN.1 reader.
readLdapResponseMessage() - Method in class org.forgerock.opendj.io.LdapReader
Reads the next LDAP response message from the underlying ASN.1 reader.
readLength(ByteBuffer) - Static method in class org.forgerock.json.jose.utils.DerUtils
Reads a DER-encoded length field from the given byte buffer.
readLong() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method for reading a long value.
readModification(Asn1Reader, DecodeOptions, Schema) - Static method in class org.forgerock.opendj.io.Ldap
Reads the next ASN.1 element from the provided ASN1Reader as a Modification.
readNull(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readNull() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a null element having the Universal Null ASN.1 type tag.
readNull(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a null element having the provided type tag.
readOctetString(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readOctetString(byte, ByteStringBuilder) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readOctetString() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an octet string having the Universal Octet String ASN.1 type tag.
readOctetString(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an octet string having the provided type tag.
readOctetString(byte, ByteStringBuilder) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an octet string having the provided type tag and appends it to the provided ByteStringBuilder.
readOctetString(ByteStringBuilder) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an octet string having the Universal Octet String ASN.1 type tag and appends it to the provided ByteStringBuilder.
readOctetStringAsString(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readOctetStringAsString() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an octet string having the Universal Octet String ASN.1 type tag and decodes the value as a UTF-8 encoded string.
readOctetStringAsString(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an octet string having the provided type tag and decodes the value as a UTF-8 encoded string.
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.
readReference() - Method in class org.forgerock.opendj.ldif.ConnectionEntryReader
Waits for the next search result entry or reference to become available and, if it is a reference, returns it as a SearchResultReference.
ReadRequest - Interface in org.forgerock.json.resource
A request to read a single identified JSON resource.
readResult() - Method in class org.forgerock.opendj.ldif.ConnectionEntryReader
Waits for the next search response to become available and returns it if it is a search result indicating that the search completed successfully.
readRootDse(Connection) - Static method in class org.forgerock.opendj.ldap.RootDse
Reads the Root DSE from the Directory Server using the provided connection.
readRootDse(LdapClientSocket) - Static method in class org.forgerock.opendj.ldap.RootDse
Reads the Root DSE from the Directory Server using the provided socket.
readRootDseAsync(Connection) - Static method in class org.forgerock.opendj.ldap.RootDse
Asynchronously reads the Root DSE from the Directory Server using the provided connection.
readSchema(Connection, Dn) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Reads the schema contained in the named subschema sub-entry.
readSchema(LdapClientSocket, Dn) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Reads the schema contained in the named subschema sub-entry.
readSchemaAsync(Connection, Dn) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Asynchronously reads the schema contained in the named subschema sub-entry.
readSchemaForEntry(Connection, Dn) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Reads the schema contained in the subschema sub-entry which applies to the named entry.
readSchemaForEntry(LdapClientSocket, Dn) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Reads the schema contained in the subschema sub-entry which applies to the named entry.
readSchemaForEntryAsync(Connection, Dn) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Asynchronously reads the schema contained in the subschema sub-entry which applies to the named entry.
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.
readShort() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method for reading an short value.
readStartExplicitTag(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readStartExplicitTag() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an explicit ignoring the ASN.1 type tag.
readStartExplicitTag(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as an explicit tag having the provided tag type.
readStartSequence(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readStartSequence() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a sequence having the Universal Sequence ASN.1 type tag.
readStartSequence(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a sequence having the provided type tag.
readStartSequence() - Method in class org.forgerock.opendj.ldap.GserParser
Skips the input matching the start of a sequence and subsequent space characters.
readStartSet(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
readStartSet() - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a set having the Universal Set ASN.1 type tag.
readStartSet(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Reads the next element as a set having the provided type tag.
readStringUtf8(int) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Relative read method for reading a UTF-8 encoded string.
readUnsignedInteger(ByteBuffer, byte[], int, int) - Static method in class org.forgerock.json.jose.utils.DerUtils
Reads an unsigned integer value into the given byte array.
readWithCharset(String, Charset) - Static method in class org.forgerock.openig.el.Functions
Returns the content of the given file as a plain String using a specific Charset.
realm - Variable in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge
The realm of the authentication option.
realm(String) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Set the realm and returns this builder.
realm(Realm) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Set the realm and returns this builder.
Realm - Class in org.forgerock.openig.tools.am
This class defines a Realm as it is used in OpenAM.
REALM - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set realm key - not available in JwtClaimsSetKey.
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.
reconstructJwt(String, Class<T>) - Static method in class org.forgerock.openig.tools.JwtUtil
Reconstruct a JWT from a {code String} representation.
record() - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
Updates the statistics kept by the summary.
record(double) - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
Updates the statistics kept by the summary with the specified amount.
record(long, TimeUnit) - Method in interface org.forgerock.monitoring.api.instrument.Timer
Updates the statistics kept by the counter with the specified amount.
record(Duration) - Method in interface org.forgerock.monitoring.api.instrument.Timer
Updates the statistics kept by the counter with the specified amount.
record(Supplier<T>) - Method in interface org.forgerock.monitoring.api.instrument.Timer
Executes the Supplier `f` and records the time taken.
record(Runnable) - Method in interface org.forgerock.monitoring.api.instrument.Timer
Executes the runnable `f` and records the time taken.
record(double) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
record(long, TimeUnit) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
record(Supplier<T>) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
record(Runnable) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
recordCallable(Callable<T>) - Method in interface org.forgerock.monitoring.api.instrument.Timer
Executes the callable `f` and records the time taken.
recordCallable(Callable<T>) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
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.
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.
REFERRAL - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a referral was encountered.
ReferralException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request could not be processed by the Directory Server because the target entry is located on another server.
ReferrerHeader - Class in org.forgerock.http.header
A Header representation of the Referrer HTTP header.
ReferrerHeader() - Constructor for class org.forgerock.http.header.ReferrerHeader
 
refresh(Context) - Method in class org.forgerock.openig.tools.authentication.chf.AsyncRefreshableSupplier
Refresh (and returns) the value, in a thread-safe manner.
refresh() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
 
refresh() - Method in class org.forgerock.secrets.propertyresolver.PropertyResolverSecretStore
 
refresh() - Method in interface org.forgerock.secrets.SecretStore
Indicates that the store should refresh its secrets from the backing storage mechanism.
refresh() - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
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(Class<T>, T) - Method in class org.forgerock.audit.DependencyProviderBase
Register a new provided dependency.
register(MeterRegistry) - Method in class org.forgerock.monitoring.api.instrument.Counter.Builder
Add the counter to a single registry, or return an existing counter in that registry.
register(MeterRegistry) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Add the distribution summary to a single registry, or return an existing distribution summary in that registry.
register(MeterRegistry) - Method in class org.forgerock.monitoring.api.instrument.Gauge.Builder
Add the gauge to a single registry, or return an existing gauge in that registry.
register(MeterRegistry) - Method in class org.forgerock.monitoring.api.instrument.Meter.Builder
Add the meter to a single registry, or return an existing meter in that registry.
register(Meter.Id, Meter.Type, Iterable<Measurement>) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
Register a custom meter type.
register(Meter.Id, Meter.Type, Iterable<Measurement>) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
register(MeterRegistry) - Method in class org.forgerock.monitoring.api.instrument.TimeGauge.Builder
Add the time gauge to a single registry, or return an existing time gauge in that registry.
register(MeterRegistry) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Add the timer to a single registry, or return an existing timer in that registry.
register(Meter.Id, Meter.Type, Iterable<Measurement>) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
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.
registerFactory(String, ScriptFactory) - Method in class org.forgerock.openig.script.DefaultScriptFactoryManager
Registers a given mimeType for the given ScriptFactory.
registerHandlerToService(JsonValue, AuditServiceBuilder) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Configures and registers the audit event handler corresponding to the provided JSON configuration to the provided audit service.
registerHandlerToService(JsonValue, AuditServiceBuilder, ClassLoader) - Static method in class org.forgerock.audit.json.AuditJsonConfig
Configures and registers the audit event handler corresponding to the provided JSON configuration to the provided audit service, using a specific class loader.
registerKeyStoreHandler(String, KeyStoreHandler) - Method in class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider
Register a storage with the given name.
registerRotationHooks(RotationHooks) - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
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:
RejectedChangeRecordListener - Interface in org.forgerock.opendj.ldif
A listener interface which is notified whenever a change record cannot be applied to an entry.
RejectedLdifListener - Interface in org.forgerock.opendj.ldif
A listener interface which is notified whenever LDIF records are skipped, malformed, or fail schema validation.
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.
RelaxRulesRequestControl - Class in org.forgerock.opendj.ldap.controls
The internet-draft defined Relax Rules control.
releaseReadLock() - Method in class org.forgerock.audit.AuditServiceProxy
Release the read lock.
releaseWriteLock() - Method in class org.forgerock.audit.AuditServiceProxy
Release the write lock.
reloadJwks() - Method in class org.forgerock.json.jose.jwk.store.JwksStore
Communicates with the configured server, attempting to download the latest JWKs for use.
remaining() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Returns the number of bytes between the current position and the end of the underlying byte sequence.
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(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 interface org.forgerock.opendj.ldap.Attribute
Removes value from this attribute if it is present (optional operation).
remove(String) - Method in class org.forgerock.opendj.ldap.ConsistentHashMap
Removes the partition that was previously added using the provided partition ID.
remove(Object) - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
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.opendj.ldap.AbstractAttribute
 
removeAll(Collection<T>, Collection<? super T>) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
removeAll(Collection<?>) - Method in interface org.forgerock.opendj.ldap.Attribute
Removes all of the attribute values contained in values from this attribute if they are present (optional operation).
removeAll(Collection<T>, Collection<? super T>) - Method in interface org.forgerock.opendj.ldap.Attribute
Removes all of the attribute values contained in values from this attribute if they are present (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.
removeAllAttributes() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Removes all attribute types the matching rule applies to.
removeAllAuxiliaryObjectClasses() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Clears the list of auxiliary object classes that entries subject to this DIT content rule may belong to.
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
 
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
 
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
 
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
 
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
 
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
 
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
 
removeAllExtraProperties() - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
 
removeAllNames() - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Removes all user defined names.
removeAllNames() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Removes all user defined names.
removeAllNames() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Removes all user defined names.
removeAllNames() - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Removes all user friendly names.
removeAllNames() - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Removes all user defined names.
removeAllNames() - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Removes all user friendly names.
removeAllNames() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes all user defined names.
removeAllOptionalAttributes() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Clears the list of attribute types that entries subject to this DIT content rule may contain.
removeAllOptionalAttributes() - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Removes all optional attributes.
removeAllOptionalAttributes() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes all optional attributes.
removeAllProhibitedAttributes() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Clears the list of attribute types that entries subject to this DIT content rule must not contain.
removeAllRequiredAttributes() - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Clears the list of attribute types that entries subject to this DIT content rule must contain.
removeAllRequiredAttributes() - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Removes all required attributes.
removeAllRequiredAttributes() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes all required attributes.
removeAllRoutes() - Method in class org.forgerock.services.routing.AbstractRouter
Removes all of the routes from this router.
removeAllSuperiorObjectClass() - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes all superior object class.
removeAllSuperiorRules() - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Removes all superior rules.
removeAttribute(Attribute, Collection<? super ByteString>) - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
removeAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.Entry
Removes all of the attribute values contained in attribute from this entry if it is present (optional operation).
removeAttribute(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.Entry
Removes the named attribute from this entry if it is present (optional operation).
removeAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.Entry
Removes all of the attribute values contained in values from the named attribute in this entry if it is present (optional operation).
removeAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
removeAttribute(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
removeAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
removeAttribute(Attribute, Collection<? super ByteString>) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
removeAttribute(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
removeAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
removeAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Removes the provided attribute type.
removeAttributeType(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the named attribute type from this schema builder.
removeAuxiliaryObjectClass(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Removes the provided object class in the list of auxiliary object classes that entries subject to this DIT content rule may belong to.
removeConnectionEventListener(ConnectionEventListener) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Removes the provided connection event listener from this connection so that it will no longer be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
removeConnectionEventListener(ConnectionEventListener) - Method in interface org.forgerock.opendj.ldap.Connection
Removes the provided connection event listener from this connection so that it will no longer be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
removeConnectionEventListener(ConnectionEventListener) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Removes the provided connection event listener from this connection so that it will no longer be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
removeConnectionEventListener(ConnectionEventListener) - Method in class org.forgerock.opendj.ldap.spi.ConnectionState
Removes the provided connection event listener from this connection so that it will no longer be notified when this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
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
 
removeDitContentRule(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the named DIT content rule from this schema builder.
removeDitStructureRule(int) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the specified DIT structure rule from this schema builder.
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
 
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
 
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
 
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
 
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
 
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
 
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
 
removeExtraProperty(String, String...) - Method in class org.forgerock.opendj.ldap.schema.Syntax.Builder
 
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.
removeMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the named matching rule from this schema builder.
removeMatchingRuleUse(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the named matching rule use from this schema builder.
removeName(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Removes the provided user defined name.
removeName(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Removes the provided user defined name.
removeName(String) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Removes the provided user defined name.
removeName(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Removes the provided user friendly name.
removeName(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRuleUse.Builder
Removes the provided user defined name.
removeName(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Removes the provided user friendly name.
removeName(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes the provided user defined name.
removeNameForm(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the named name form from this schema builder.
removeObjectClass(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the named object class from this schema builder.
removeOptionalAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Removes the provided optional attribute in the list of attribute types that entries subject to this DIT content rule may contain.
removeOptionalAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Removes the specified optional attribute.
removeOptionalAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes the provided optional attribute.
removeProhibitedAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Removes the provided prohibited attribute in the list of attribute types that entries subject to this DIT content rule must not contain.
removeRequiredAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Removes the provided required attribute in the list of attribute types that entries subject to this DIT content rule must contain.
removeRequiredAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Removes the specified required attribute.
removeRequiredAttribute(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes the provided required attribute.
removeRoute(RouteMatcher<R>...) - Method in class org.forgerock.services.routing.AbstractRouter
Removes one or more routes from this router.
removeScheduledTask(TimeoutScheduler.TimeoutEventListener) - Method in class org.forgerock.opendj.ldap.TimeoutScheduler
De-registers a task for periodic invocation.
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.
removeSuperiorObjectClass(String) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Removes the provided superior object class.
removeSuperiorRule(int) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Removes the provided superior rule.
removeSyntax(String) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Removes the named syntax from this schema builder.
removeTrailingSlash(String) - Static method in class org.forgerock.http.util.Paths
Removes trailing slash (if there is any), returns the same value otherwise.
rename(Dn, Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns a copy of this DN whose parent DN, fromDN, has been renamed to the new parent DN, toDN.
rename(Rdn, Dn) - Method in class org.forgerock.opendj.ldap.Dn
Returns a DN whose value is the result of applying LDAP modify DN semantics to this DN.
renameAttribute(Attribute, AttributeDescription) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a view of attribute having a different attribute description.
renameAttribute(Attribute, String) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a view of attribute having a different attribute description.
renameField(JsonValue, String, String) - Static method in class org.forgerock.audit.util.ElasticsearchUtil
Renames a field within the given JsonValue.
renameTag(String, String, String) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Rename a tag key for every metric beginning with a given prefix.
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).
replace(String, Object...) - Static method in class org.forgerock.opendj.ldap.Modification
Returns a new modification for replacing all the values of the provided attribute with the provided values.
REPLACE - Static variable in class org.forgerock.opendj.ldap.ModificationType
Replace all existing values of the attribute with the new values listed in the modification, creating the attribute if it did not already exist.
REPLACE_STRATEGY - Static variable in class org.forgerock.opendj.ldap.Entries
Defines the strategy to use to generate changes.
replaceAttribute(Attribute) - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
replaceAttribute(Attribute) - Method in interface org.forgerock.opendj.ldap.Entry
Adds all of the attribute values contained in attribute to this entry, replacing any existing attribute values (optional operation).
replaceAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.Entry
Adds all of the attribute values contained in values to this entry, replacing any existing attribute values (optional operation).
replaceAttribute(Attribute) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
replaceAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
replaceAttribute(Attribute) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
replaceAttribute(String, Object...) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
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.
replaceTagValues(String, Function<String, String>, String...) - Static method in interface org.forgerock.monitoring.api.instrument.config.MeterFilter
Replace tag values according to the provided mapping for all matching tag keys.
report(Jwt) - Method in class org.forgerock.openig.tools.jwt.JwtValidator
Returns the list of the violations, if any, raised by the validation of the JWT.
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 - Interface in org.forgerock.opendj.ldap.messages
The base class of all Requests provides methods for querying and manipulating the set of Controls included with a Request.
Request.RequestType - Enum in org.forgerock.opendj.ldap.messages
The type of this request.
REQUEST_MAX_SIZE_IN_BYTES - Static variable in class org.forgerock.opendj.ldap.LdapServer
Specifies the maximum request size in bytes for incoming LDAP requests.
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 - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Specifies the operation timeout.
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, Clock) - 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.
RequestHandle - Class in org.forgerock.opendj.ldap
Provides the ability to terminate an asynchronous LDAP request.
RequestHandler - Interface in org.forgerock.json.resource
Represents the contract with a set of resources.
RequestResolver - Class in org.forgerock.openig.resolver
Resolves Request objects.
RequestResolver() - Constructor for class org.forgerock.openig.resolver.RequestResolver
 
requestResourceApiVersionMatcher(Version) - Static method in class org.forgerock.http.routing.RouteMatchers
Creates a RouteMatcher instance that matches the request resource API version with the provided version.
requestResourceApiVersionMatcher(Version) - Static method in class org.forgerock.json.resource.RouteMatchers
Creates a RouteMatcher instance that matches the request resource API version with the provided version.
RequestResourceUriProvider - Class in org.forgerock.openig.openam
The RequestResourceUriProvider has the following configuration:
RequestResourceUriProvider() - Constructor for class org.forgerock.openig.openam.RequestResourceUriProvider
Create a new RequestResourceUriProvider based on the defaults.
RequestResourceUriProvider(boolean, boolean) - Constructor for class org.forgerock.openig.openam.RequestResourceUriProvider
Create a new RequestResourceUriProvider based on the passed parameters.
Requests - Class in org.forgerock.json.resource
A utility class containing various factory methods for creating and manipulating requests.
Requests - Class in org.forgerock.opendj.ldap.messages
This class contains various methods for creating and manipulating requests.
requestToResponseProtocolOpType(byte) - Static method in class org.forgerock.opendj.io.Ldap
Returns the response protocol operation type associated to the given request protocol op.
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.
RequestVisitor<R,P,E extends Exception> - Interface in org.forgerock.opendj.ldap.messages
A visitor of Requests, in the style of the visitor design pattern.
required() - Method in class org.forgerock.json.JsonValue
Throws a JsonValueException if the JSON value is null.
REQUIRED - 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.
required(String) - Static method in class org.forgerock.openig.util.JsonValues
Displays a custom message when the required attribute is not present in the configuration.
requiredAttributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided attribute to the list of attribute types that entries subject to this DIT content rule must contain.
requiredAttributes(String...) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Adds the provided attribute to the list of attribute types that entries subject to this DIT content rule must contain.
requiredAttributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds the provided required attributes.
requiredAttributes(String...) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Adds the provided required attributes.
requiredAttributes(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided required attributes.
requiredAttributes(String...) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided required attributes.
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.
RequiredSearch - Class in org.forgerock.monitoring.api.instrument.search
Search that requires the search terms are satisfiable, or an MeterNotFoundException is thrown.
RequiredSearch(MeterRegistry, String) - Constructor for class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
requireField(String) - Method in class org.forgerock.audit.events.AuditEventBuilder
Helper method to be used when overriding AuditEventBuilder.validate().
requireSingleStructuralObjectClass() - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Returns the policy for verifying that entries have only a single structural object class.
requireSingleStructuralObjectClass(SchemaValidationPolicy.Action) - Method in class org.forgerock.opendj.ldap.schema.SchemaValidationPolicy
Specifies the policy for verifying that entries have only a single structural object class.
requireValue() - Method in class org.forgerock.opendj.ldap.AttributeParser
Throws a LocalizedIllegalArgumentException if the attribute referenced by this parser is null or empty.
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(Context, String) - Method in class org.forgerock.openig.filter.oauth2.ConfirmationKeyVerifierAccessTokenResolver
 
resolve(String) - Method in class org.forgerock.openig.filter.oauth2.OAuth2ClassAliasResolver
 
resolve(Context, String) - Method in class org.forgerock.openig.filter.oauth2.ScriptableAccessTokenResolver
 
resolve(Context, String) - Method in class org.forgerock.openig.filter.oauth2.StatelessAccessTokenResolver
 
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.heap.TokenResolver
Resolves the given token, returning null if resolution failed.
resolve(String, String) - Method in class org.forgerock.openig.heap.TokenResolver
Resolves the given token, returning def value if resolution failed.
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.
resolveSchema(String) - Method in interface org.forgerock.opendj.ldap.SchemaResolver
Finds the appropriate schema for use with the provided distinguished name.
resolveSchemaReferences() - Method in class org.forgerock.json.schema.validator.validators.Validator
Resolves schema references for this validator.
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.
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.
resourcePath() - Static method in class org.forgerock.json.resource.JsonValueFunctions
Returns the JSON string value as a ResourcePath.
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.
ResourceServerFilter - Class in org.forgerock.http.oauth2
Validates a Request that contains an OAuth 2.0 access token.
ResourceServerFilter(AccessTokenResolver, Clock, ResourceAccess, String) - Constructor for class org.forgerock.http.oauth2.ResourceServerFilter
Creates a new OAuth2Filter.
ResourceSet - Interface in org.forgerock.openig.handler.resources
A ResourceSet abstracts Resource lookup mechanism.
resourceUri(Context, Request) - Method in class org.forgerock.openig.openam.RequestResourceUriProvider
 
resourceUri(Context, Request) - Method in interface org.forgerock.openig.openam.ResourceUriProvider
Returns the resource URI as a String to be used when making policy requests.
resourceUri(Context, Request) - Method in class org.forgerock.openig.openam.ScriptableResourceUriProvider
 
ResourceUriProvider - Interface in org.forgerock.openig.openam
Used to obtain the resource URI to include in policy requests.
RESPONSE - 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 - Interface in org.forgerock.opendj.ldap.messages
The base class of all Responses provides methods for querying and manipulating the set of Controls included with a Response.
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.
Responses - Class in org.forgerock.opendj.ldap.messages
This class contains various 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.
Result - Interface in org.forgerock.opendj.ldap.messages
A Result is used to indicate the status of an operation performed by the server.
Result - Class in org.forgerock.openig.filter.oauth2
A Result represents the result of a validation operation: either a success or a failure (with an associated description).
Result - Class in org.forgerock.openig.tools.jwt
A Result of a JWT validation.
ResultCode - Class in org.forgerock.opendj.ldap
An operation result code as defined in RFC 4511 section 4.1.9 is used to indicate the final status of an operation.
ResultCode.Enum - Enum in org.forgerock.opendj.ldap
Contains equivalent values for the ResultCode values.
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.opendj.ldap.AbstractAttribute
 
retainAll(Collection<T>, Collection<? super T>) - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
retainAll(Collection<?>) - Method in interface org.forgerock.opendj.ldap.Attribute
Retains only the attribute values in this attribute which are contained in values (optional operation).
retainAll(Collection<T>, Collection<? super T>) - Method in interface org.forgerock.opendj.ldap.Attribute
Retains only the attribute values in this attribute which are contained in values (optional operation).
retainAll(Collection<T>, Collection<? super T>) - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
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(BiFunction<T, U, R, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a BiFunction to comply with BiFunction's no checked exception signature.
rethrowConsumer(Consumer<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a Consumer to comply with Consumer's no checked exception signature.
rethrowFunction(Function<T, R, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a throwing Function to comply with Function's no checked exception signature.
rethrowPredicate(Predicate<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a Predicate to comply with Predicate's no checked exception signature.
rethrowSupplier(Supplier<T, E>) - Static method in class org.forgerock.util.LambdaExceptionUtils
Wrap a Supplier to comply with Supplier's no checked exception signature.
retire(Purpose<? extends CryptoKey>, String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
Retires a key previously used for a given purpose.
retire(Purpose<? extends T>, String) - Method in interface org.forgerock.secrets.SecretStore
Retires the given secret for the given purpose.
retire(Purpose<? extends T>, String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
retrieveCryptoKeyFromSecretId(SecretsService, JsonValue, Class<S>) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Retrieves a CryptoKey from the given node.
retrieveKeyFromSecretId(SecretsService, JsonValue, Class<S>) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Retrieves a Key from the given node.
retrievePasswordAsReference(SecretsService, JsonValue, JsonValue, Clock) - Static method in class org.forgerock.openig.secrets.SecretsUtils
Retrieve a required password as a SecretReference from the given secretIdNode and deprecatedNode nodes.
RetryableException - Exception in org.forgerock.json.resource
An exception that indicates that a failure may be temporary, and that retrying the same request may be able to succeed in the future.
RetryableException(int, String, Throwable) - Constructor for exception org.forgerock.json.resource.RetryableException
Constructs a new exception with the specified detail message and cause.
RetryFilter - Class in org.forgerock.openig.filter
A RetryFilter is responsible for re-executing the incoming request should it fail with a runtime exception.
RetryFilter(ScheduledExecutorService, int, Duration) - Constructor for class org.forgerock.openig.filter.RetryFilter
Constructs a retry filter with the given executor, number of retries and delay between retries.
REVALIDATION_FAILED - Static variable in class org.forgerock.http.header.WarningHeader
111 Revalidation failed MUST be included if a cache returns a stale response because an attempt to revalidate the response failed, due to an inability to reach the server.
REVALIDATION_FAILED - Static variable in class org.forgerock.json.resource.AdviceWarning
111 Revalidation failed MUST be included if a cache returns a stale response because an attempt to revalidate the response failed, due to an inability to reach the server.
reveal(Function<byte[], T, E>) - Method in class org.forgerock.secrets.GenericSecret
Reveals the secret temporarily, allowing it to be used for its intended purpose.
revealAndDestroy(Function<byte[], T, E>) - Method in class org.forgerock.secrets.GenericSecret
Reveals the secret temporarily and then scrubs the secret material from memory.
revealAsText(Charset, Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret
Reveals the secret temporarily as characters in the given character set.
revealAsTextAndDestroy(Charset, Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret
Reveals the secret temporarily as characters in the given character set and then scrubs the secret material from memory.
revealAsUtf8(Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret
Reveals the secret temporarily as characters in UTF-8.
revealAsUtf8AndDestroy(Function<char[], T, E>) - Method in class org.forgerock.secrets.GenericSecret
Reveals the secret temporarily as characters in UTF-8 and then scrubs the secret from memory.
reverse(byte[]) - Static method in class org.forgerock.json.jose.utils.Utils
Reverses the given array and returns the reversed copy.
REVERSE_PROXY_HANDLER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a default ReverseProxyHandler instance from the Heap.
reverseOrder(SortKey) - Static method in class org.forgerock.json.resource.SortKey
Creates a new sort key having the same field as the provided key, but in reverse sort order.
ReverseProxyHandler - Class in org.forgerock.openig.handler
A ReverseProxyHandler is a ClientHandler that is also responsible to turn RuntimeException into Status.BAD_GATEWAY response, as expected on the normal flow of request reaching the application when the proxy fails to connect to the backend application.
ReverseProxyHandler.Heaplet - Class in org.forgerock.openig.handler
Creates a reverse proxy handler in a heap environment.
revoke(String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
Revokes a key from all purposes.
revoke(String) - Method in interface org.forgerock.secrets.SecretStore
Revokes the given secret for all purposes in this store.
revoke(String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
rewind() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Rewinds this reader's position to zero.
ROOT_REALM - Static variable in class org.forgerock.openig.tools.am.Realm
The root realm, known as "/".
RootContext - Class in org.forgerock.services.context
A Context which has an a globally unique ID but no parent.
RootContext() - Constructor for class org.forgerock.services.context.RootContext
Construct a new RootContext with the default IdGenerator.
RootContext(String) - Constructor for class org.forgerock.services.context.RootContext
Construct a new RootContext with the given id (uniqueness is not verified).
RootContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.services.context.RootContext
Restore from JSON representation.
rootDn() - Static method in class org.forgerock.opendj.ldap.Dn
Deprecated.
use Dn.emptyDn() instead
RootDse - Class in org.forgerock.opendj.ldap
The root DSE is a DSA-specific Entry (DSE) and not part of any naming context (or any subtree), and which is uniquely identified by the empty DN.
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(Purpose<? extends CryptoKey>, String) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
Rotates the key associated with a given purpose.
rotate(Purpose<? extends T>, String) - Method in interface org.forgerock.secrets.SecretStore
Rotates the active secret for the given purpose.
rotate(Purpose<? extends T>, String) - Method in class org.forgerock.secrets.ThreadPoolSecretStore
 
ROTATE_FILE_ACTION_NAME - Static variable in class org.forgerock.audit.handlers.csv.CsvAuditEventHandler
Name of action to force file rotation.
ROTATE_FILE_ACTION_NAME - Static variable in class org.forgerock.audit.handlers.json.JsonAuditEventHandler
Name of action to force file rotation.
rotateIfNeeded() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
Rotate the log file if any of the configured rotation policies determine that rotation is required.
rotateIfNeeded() - Method in interface org.forgerock.audit.rotation.RotatableObject
Checks the rotatable file for rotation then retention.
RotationContext - Class in org.forgerock.audit.rotation
This class holds some information while a file is being rotated.
RotationContext() - Constructor for class org.forgerock.audit.rotation.RotationContext
 
RotationHooks - Interface in org.forgerock.audit.rotation
Callback hooks to allow custom action to be taken before and after file rotation occurs.
RotationHooks.NoOpRotatationHooks - Class in org.forgerock.audit.rotation
RotationHooks that do nothing.
RotationPolicy - Interface in org.forgerock.audit.rotation
Interface to decide if a file should be rotated or not.
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, MeterRegistry) - 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.
RSA15AES128CBCHS256EncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Deprecated.
Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.
RSA15AES128CBCHS256EncryptionHandler(SigningManager) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler
Deprecated.
Constructs a new RSA15AES128CBCHS256EncryptionHandler.
RSA15AES256CBCHS512EncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Deprecated.
Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.
RSA15AES256CBCHS512EncryptionHandler(SigningManager) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler
Deprecated.
Constructs a new RSA15AES256CBCHS512EncryptionHandler.
RSAEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption
Abstract base class for implementations of the RSAES-PKCS1-v1_5 and RSA-OAEP encryption schemes.
RSAEncryptionHandler(EncryptionMethod, JweAlgorithm) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler
Constructs a new RSAEncryptionHandler instance.
RSAEncryptionHandler(EncryptionMethod, JweAlgorithm, Options) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler
Constructs a new RSAEncryptionHandler instance with the given options.
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) - Constructor for class org.forgerock.json.jose.jws.handlers.RSASigningHandler
Constructs a new RSASigningHandler.
RSASigningHandler(Key, SignatureUtil) - Constructor for class org.forgerock.json.jose.jws.handlers.RSASigningHandler
ruleId(int) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Sets the the numeric ID which uniquely identifies this structure rule.
run(Map<String, Object>) - Method in interface org.forgerock.openig.script.Script
Runs this script with the provided bindings.
run() - Method in interface org.forgerock.util.Action
Runs the action, throwing the Exception if necessary.
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

sameSite(Cookie.SameSite) - Method in class org.forgerock.openig.http.CookieBuilder
Set the SameSite enum and return a new instance of this builder.
SamlClassAliasResolver - Class in org.forgerock.openig.handler.saml
Register all the aliases supported by the openig-saml module.
SamlClassAliasResolver() - Constructor for class org.forgerock.openig.handler.saml.SamlClassAliasResolver
 
SamlFederationHandler - Class in org.forgerock.openig.handler.saml
The SAML federation handler.
SamlFederationHandler.Heaplet - Class in org.forgerock.openig.handler.saml
Reads the actual federation servlet from the JSON configuration file.
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.
SASL_BIND_IN_PROGRESS - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that should be used for intermediate responses in multi-stage SASL bind operations.
SASL_MECHANISM_NAME_ANONYMOUS - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The name of the SASL mechanism that uses anonymous access and having the name "ANONYMOUS".
SASL_MECHANISM_NAME_CRAM_MD5 - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The name of the SASL mechanism that uses CRAM-MD5 authentication and having the name "CRAM-MD5".
SASL_MECHANISM_NAME_DIGEST_MD5 - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The name of the SASL mechanism that uses DIGEST-MD5 authentication and having the name "DIGEST-MD5".
SASL_MECHANISM_NAME_EXTERNAL - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The name of the SASL mechanism that uses external authentication and having the name "EXTERNAL".
SASL_MECHANISM_NAME_GSSAPI - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The name of the SASL mechanism that uses GSS-API authentication and having the name "GSSAPI".
SASL_MECHANISM_NAME_PLAIN - Static variable in interface org.forgerock.opendj.ldap.messages.BindRequest
The name of the SASL mechanism that uses PLAIN authentication and having the name "PLAIN".
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
 
schedule(Runnable, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
 
schedule(Callable<V>, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
 
scheduleAtFixedRate(TimeoutScheduler.TimeoutEventListener) - Method in class org.forgerock.opendj.ldap.TimeoutScheduler
Schedules the task for periodic invocation.
scheduleAtFixedRate(Runnable, long, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
 
SCHEDULED_EXECUTOR_SERVICE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the default ScheduledExecutorService instance from the Heap.
ScheduledExecutorServiceHeaplet - Class in org.forgerock.openig.thread
Heaplet for building ScheduledExecutorService instances.
ScheduledExecutorServiceHeaplet() - Constructor for class org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet
 
scheduleWithFixedDelay(Runnable, long, long, TimeUnit) - Method in class org.forgerock.util.thread.MdcScheduledExecutorServiceDelegate
 
SCHEMA - Static variable in class org.forgerock.json.schema.validator.Constants
The $schema field name.
Schema - Class in org.forgerock.opendj.ldap.schema
This class defines a data structure that holds information about the components of the LDAP schema.
SchemaBuilder - Class in org.forgerock.opendj.ldap.schema
Schema builders should be used for incremental construction of new schemas.
SchemaBuilder() - Constructor for class org.forgerock.opendj.ldap.schema.SchemaBuilder
Creates a new schema builder with no schema elements and default compatibility options.
SchemaBuilder(Entry) - Constructor for class org.forgerock.opendj.ldap.schema.SchemaBuilder
Creates a new schema builder containing all of the schema elements contained in the provided subschema subentry.
SchemaBuilder(Schema) - Constructor for class org.forgerock.opendj.ldap.schema.SchemaBuilder
Creates a new schema builder containing all of the schema elements from the provided schema and its compatibility options.
SchemaBuilder(String) - Constructor for class org.forgerock.opendj.ldap.schema.SchemaBuilder
Creates a new schema builder with no schema elements and default compatibility options.
SchemaBuilder.SchemaBuilderHook - Interface in org.forgerock.opendj.ldap.schema
Allows to perform modifications on element's builders before adding the result to this schema builder.
SchemaElement - Interface in org.forgerock.opendj.ldap.schema
Interface for schema elements.
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.
SchemaOptions - Class in org.forgerock.opendj.ldap.schema
Common options for LDAP schemas.
SchemaResolver - Interface in org.forgerock.opendj.ldap
Schema resolvers are included with a set of DecodeOptions in order to allow application to control how Schema instances are selected when decoding requests and responses.
SchemaValidationPolicy - Class in org.forgerock.opendj.ldap.schema
This class provides various schema validation policy options for controlling how entries should be validated against the directory schema.
SchemaValidationPolicy.Action - Enum in org.forgerock.opendj.ldap.schema
An enumeration of the possible actions which can be performed when a schema validation failure is encountered.
scheme - Variable in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge
The type of the authentication option.
SCOPE - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set scope key - not available in JwtClaimsSetKey.
Script - Interface in org.forgerock.openig.script
Encapsulate an executable script.
SCRIPT_FACTORY_MANAGER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the global ScriptFactoryManager from the Heap.
ScriptableAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2
A Scriptable access token resolver.
ScriptableAccessTokenResolver.Heaplet - Class in org.forgerock.openig.filter.oauth2
Creates and initializes a scriptable access token resolver in a heap environment.
ScriptableFilter - Class in org.forgerock.openig.filter
A scriptable filter.
ScriptableFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a scriptable filter in a heap environment.
ScriptableHandler - Class in org.forgerock.openig.handler
A scriptable handler.
ScriptableHandler.Heaplet - Class in org.forgerock.openig.handler
Creates and initializes a scriptable handler in a heap environment.
ScriptableResourceAccess - Class in org.forgerock.openig.filter.oauth2
A scriptable resource access.
ScriptableResourceAccess.Heaplet - Class in org.forgerock.openig.filter.oauth2
Creates and initializes a scriptable object in a heap environment.
ScriptableResourceUriProvider - Class in org.forgerock.openig.openam
A scriptable resource URI provider.
ScriptableResourceUriProvider.Heaplet - Class in org.forgerock.openig.openam
Creates and initializes a scriptable resource url provider in a heap environment.
ScriptableThrottlingPolicy - Class in org.forgerock.openig.filter.throttling
A scriptable throttling datasource.
ScriptableThrottlingPolicy.Heaplet - Class in org.forgerock.openig.filter.throttling
Creates and initializes a scriptable object in a heap environment.
ScriptFactory - Interface in org.forgerock.openig.script
A factory for Scripts.
ScriptFactoryManager - Interface in org.forgerock.openig.script
A ScriptFactoryManager is the plug-in point where ScriptFactory implementations need to be registered in order to be available to the runtime.
Search - Class in org.forgerock.monitoring.api.instrument.search
ForgeRock changes: - Removed support for FunctionCounter, FunctionCounter, TimeGauge, LongTaskTimer
Search(MeterRegistry, String) - Constructor for class org.forgerock.monitoring.api.instrument.search.Search
 
search(SearchRequest, SearchResultHandler) - Method in class org.forgerock.opendj.ldap.AbstractAsynchronousConnection
 
search(SearchRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
search(SearchRequest, Collection<? super SearchResultEntry>) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
search(SearchRequest, Collection<? super SearchResultEntry>, Collection<? super SearchResultReference>) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
search(String, SearchScope, String, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
search(SearchRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Searches the Directory Server using the provided search parameters.
search(SearchRequest, Collection<? super SearchResultEntry>) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Searches the Directory Server using the provided search request.
search(SearchRequest, Collection<? super SearchResultEntry>, Collection<? super SearchResultReference>) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Searches the Directory Server using the provided search request.
search(SearchRequest, SearchResultHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Searches the Directory Server using the provided search request.
search(String, SearchScope, String, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Searches the Directory Server using the provided search parameters.
search(SearchRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Searches the Directory Server using the provided search parameters.
search(SearchRequest, Collection<? super SearchResultEntry>) - Method in interface org.forgerock.opendj.ldap.Connection
Searches the Directory Server using the provided search request.
search(SearchRequest, Collection<? super SearchResultEntry>, Collection<? super SearchResultReference>) - Method in interface org.forgerock.opendj.ldap.Connection
Searches the Directory Server using the provided search request.
search(SearchRequest, SearchResultHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Searches the Directory Server using the provided search request.
search(String, SearchScope, String, String...) - Method in interface org.forgerock.opendj.ldap.Connection
Searches the Directory Server using the provided search parameters.
search(SearchRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Searches the Directory Server using the provided search request.
search(EntryReader, SearchRequest) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns a filtered view of input containing only those entries which match the search base DN, scope, and filtered defined in search.
search(EntryReader, SearchRequest, Schema) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns a filtered view of input containing only those entries which match the search base DN, scope, and filtered defined in search.
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.
searchAsync(SearchRequest, SearchResultHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
searchAsync(SearchRequest, SearchResultHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously searches the Directory Server using the provided search request.
searchAsync(SearchRequest, IntermediateResponseHandler, SearchResultHandler) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously searches the Directory Server using the provided search request.
searchAsync(SearchRequest, IntermediateResponseHandler, SearchResultHandler) - Method in class org.forgerock.opendj.ldap.AbstractSynchronousConnection
 
searchAsync(SearchRequest, SearchResultHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously searches the Directory Server using the provided search request.
searchAsync(SearchRequest, IntermediateResponseHandler, SearchResultHandler) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously searches the Directory Server using the provided search request.
SearchRequest - Interface in org.forgerock.opendj.ldap.messages
The Search operation is used to request a server to return, subject to access controls and other restrictions, a set of entries matching a complex search criterion.
SearchResultEntry - Interface in org.forgerock.opendj.ldap.messages
A Search Result Entry represents an entry found during a Search operation.
SearchResultHandler - Interface in org.forgerock.opendj.ldap
A completion handler for consuming the results of a Search operation.
SearchResultReference - Interface in org.forgerock.opendj.ldap.messages
A Search Result Reference represents an area not yet explored during a Search operation.
SearchResultReferenceIOException - Exception in org.forgerock.opendj.ldap
Thrown when an iteration over a set of search results using a ConnectionEntryReader encounters a SearchResultReference.
SearchResultReferenceIOException(SearchResultReference) - Constructor for exception org.forgerock.opendj.ldap.SearchResultReferenceIOException
Creates a new referral result IO exception with the provided SearchResultReference.
SearchScope - Class in org.forgerock.opendj.ldap
A Search operation search scope as defined in RFC 4511 section 4.5.1.2 is used to specify the scope of a Search operation.
SearchScope.Enum - Enum in org.forgerock.opendj.ldap
Contains equivalent values for the SearchScope values.
searchSingleEntry(SearchRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
searchSingleEntry(String, SearchScope, String, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
searchSingleEntry(SearchRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Searches the Directory Server for a single entry using the provided search request.
searchSingleEntry(String, SearchScope, String, String...) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Searches the Directory Server for a single entry using the provided search parameters.
searchSingleEntry(SearchRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Searches the Directory Server for a single entry using the provided search request.
searchSingleEntry(String, SearchScope, String, String...) - Method in interface org.forgerock.opendj.ldap.Connection
Searches the Directory Server for a single entry using the provided search parameters.
searchSingleEntry(SearchRequest) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Searches the Directory Server for a single entry using the provided search request.
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.
searchSingleEntryAsync(SearchRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnection
 
searchSingleEntryAsync(SearchRequest) - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
Asynchronously searches the Directory Server for a single entry using the provided search request.
searchSingleEntryAsync(SearchRequest) - Method in interface org.forgerock.opendj.ldap.Connection
Asynchronously searches the Directory Server for a single entry using the provided search request.
secondsToUnit(double, TimeUnit) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
Secret - Class in org.forgerock.secrets
A secret is any piece of data that should be kept confidential.
Secret(SecretBuilder) - Constructor for class org.forgerock.secrets.Secret
Constructs the secret using the given builder.
SecretBuilder - Class in org.forgerock.secrets
Provides a uniform way for secrets providers to construct secrets and keys.
SecretBuilder() - Constructor for class org.forgerock.secrets.SecretBuilder
 
secretKey(Key) - Method in class org.forgerock.secrets.SecretBuilder
Sets the secret key for this object.
SecretKeyPropertyFormat - Class in org.forgerock.secrets.propertyresolver
Wraps a property format that decodes raw bytes and converts it into a property format for extracting secret keys using some algorithm.
SecretKeyPropertyFormat(SecretPropertyFormat, String) - Constructor for class org.forgerock.secrets.propertyresolver.SecretKeyPropertyFormat
Initialises the format with the given raw generic secret format and the given key algorithm.
SecretPropertyFormat - Interface in org.forgerock.secrets.propertyresolver
Defines the format of secrets loaded from configuration properties.
SecretReference<T extends Secret> - Class in org.forgerock.secrets
A long-lived reference to an active secret.
SecretReference(SecretsProvider, Purpose<T>, Clock) - Constructor for class org.forgerock.secrets.SecretReference
Constructs the secret reference from the given provider and purpose.
SecretReference(SecretsProvider, Purpose<T>) - Constructor for class org.forgerock.secrets.SecretReference
Constructs the secret reference from the given provider and purpose using the system clock to check for expiry.
SECRETS_SERVICE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve the default SecretsService instance from the Heap.
SecretsProvider - Class in org.forgerock.secrets
The secrets provider is used to get hold of active, named or valid secret objects.
SecretsProvider() - Constructor for class org.forgerock.secrets.SecretsProvider
 
SecretsProviderHeaplet - Class in org.forgerock.openig.secrets
Creates and initializes a SecretsProvider in a heap environment.
SecretsProviderHeaplet() - Constructor for class org.forgerock.openig.secrets.SecretsProviderHeaplet
 
SecretsService - Interface in org.forgerock.openig.secrets
Interface for the SecretsService.
SecretsServiceProvider - Class in org.forgerock.openig.secrets
Adapter class to present an instance of SecretsService as a SecretsProvider.
SecretsServiceProvider(SecretsService) - Constructor for class org.forgerock.openig.secrets.SecretsServiceProvider
Constructs an adapter around SecretsService so we can use it as a SecretProvider.
SecretStore<T extends Secret> - Interface in org.forgerock.secrets
A backend storage mechanism for certain kinds of secrets.
SecretsUtils - Class in org.forgerock.openig.secrets
Utility class to use the Commons Secret API.
SECURE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder
The secure event payload field name.
secure(boolean) - Method in class org.forgerock.openig.http.CookieBuilder
Set the secure flag and return a new instance of this builder.
secure(boolean) - Method in class org.forgerock.services.context.ClientContext.Builder
Sets whether if the client connection is secure.
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
 
SELECTOR_THREAD_COUNT - Static variable in class org.forgerock.opendj.ldap.LdapServer
Specifies the number of threads which will be used to handle incoming network events.
SELECTOR_THREAD_NAME - Static variable in class org.forgerock.opendj.ldap.LdapServer
Specifies the thread name used for selector threads.
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.
send(Request, RequestHandle) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Sends a request to the Directory Server.
send(Request) - Method in interface org.forgerock.opendj.ldap.LdapClientSocket
Sends a request to the Directory Server.
sendAsync(Request) - Method in class org.forgerock.http.apache.async.AsyncResponseHttpClient
 
sendAsync(Request) - Method in class org.forgerock.http.apache.async.AsyncStreamingHttpClient
 
sendAsync(Request) - Method in interface org.forgerock.http.spi.HttpClient
Returns a Promise representing the asynchronous Response of the given request.
sendUnsolicitedNotification(ExtendedResult) - Method in interface org.forgerock.opendj.ldap.LdapSession
Sends an unsolicited notification to the client.
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.config.resolvers.SubstitutionException
 
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
 
ServerSideSortRequestControl - Class in org.forgerock.opendj.ldap.controls
The server-side sort request control as defined in RFC 2891.
ServerSideSortResponseControl - Class in org.forgerock.opendj.ldap.controls
The server-side sort response control as defined in RFC 2891.
service(HttpServletRequest, HttpServletResponse) - Method in class org.forgerock.http.servlet.HttpFrameworkServlet
 
SERVICE_LOADER - Static variable in interface org.forgerock.http.spi.Loader
The default Loader implementation used throughout the HTTP framework.
SERVICE_UNAVAILABLE - Static variable in class org.forgerock.http.protocol.Status
The 503 (Service Unavailable) status code indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
SERVICES - Static variable in interface org.forgerock.http.decoder.Decoder
Mapping of supported codings to associated decoders.
SERVICES - Static variable in class org.forgerock.openig.resolver.Resolvers
Mapping of supported classes to associated resolvers.
ServiceUnavailableException - Exception in org.forgerock.json.resource
An exception that is thrown during an operation on a resource when the server is temporarily unable to handle the request.
ServiceUnavailableException() - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException
Constructs a new exception with null as its detail message.
ServiceUnavailableException(String) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException
Constructs a new exception with the specified detail message.
ServiceUnavailableException(String, Throwable) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException
Constructs a new exception with the specified detail message and cause.
ServiceUnavailableException(Throwable) - Constructor for exception org.forgerock.json.resource.ServiceUnavailableException
Constructs a new exception with the specified cause.
Session - 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.
sessionCache(Caffeine<Object, Object>, Duration, CacheSessionService.DisconnectionStrategy) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Specifies the Caffeine cache for the CacheSessionService.
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.
SessionException - Exception in org.forgerock.openig.tools.session
Represents an exception whilst performing Session Service.
SessionException(String) - Constructor for exception org.forgerock.openig.tools.session.SessionException
Builds an SessionException with a given message.
SessionException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.session.SessionException
Builds an SessionException with a given message and cause.
SessionInfo - Class in org.forgerock.openig.tools.session
The SessionInfo class is responsible to store session info for a given SSO Token.
SessionInfo(String, JsonValue) - Constructor for class org.forgerock.openig.tools.session.SessionInfo
Builds a new SessionInfo.
SessionInfoContext - Class in org.forgerock.openig.openam
Context to store Access Management session info and properties.
SessionInfoFilter - Class in org.forgerock.openig.openam
This filter requests user session info from Access Management and stores it on the context for later use.
SessionInfoFilter(SessionService, Expression<String>) - Constructor for class org.forgerock.openig.openam.SessionInfoFilter
Creates a new OpenAM session info filter.
SessionInfoFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initialises a session info filter in a heap environment.
SessionManager - Interface in org.forgerock.http.session
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.
sessionService(SessionService) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Bind a SessionService instance to this builder.
SessionService - Interface in org.forgerock.openig.tools.session
The SessionService is responsible to perform interactions with AM sessions endpoint, such as session info or logout, etc.
set - Variable in class org.forgerock.http.util.SetDecorator
The set wrapped by this decorator.
set(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.
setActiveStore(SecretStore<? super T>, Purpose<? extends T>...) - Method in class org.forgerock.secrets.SecretsProvider
Sets the active store to use for the given purpose.
setActiveStore(SecretStore<? super T>, Purpose<? extends T>) - Method in class org.forgerock.secrets.SecretsProvider
Sets the active store to use for the given purpose.
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.ActionRequest
 
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.CreateRequest
 
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.DeleteRequest
 
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.PatchRequest
 
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.QueryRequest
 
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.ReadRequest
 
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.Request
Sets an additional parameter which should be used to control the behavior of this action request.
setAdditionalParameter(String, String) - Method in interface org.forgerock.json.resource.UpdateRequest
 
setAddUserFriendlyComments(boolean) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Specifies whether user-friendly comments should be added whenever distinguished names or UTF-8 attribute values are encountered which contained non-ASCII characters.
setAddUserFriendlyComments(boolean) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Specifies whether user-friendly comments should be added whenever distinguished names or UTF-8 attribute values are encountered which contained non-ASCII characters.
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.
setAssertionValue(Object) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Sets the assertion value to be compared.
setAttributeDescription(AttributeDescription) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Sets the name of the attribute to be compared.
setAttributeDescription(String) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Sets the name of the attribute to be compared.
setAttributeFactory(Function<AttributeDescription, Attribute>) - Method in class org.forgerock.opendj.ldap.DecodeOptions
Sets the function which will be used for creating new Attribute instances when decoding attributes.
setAuthenticationTypeAndValue(byte, byte[]) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Sets the authentication type and value.
setAuthorizationId(String) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
Sets the authorization ID of the user.
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.
setByte(int, byte) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Sets the byte value at the specified index.
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.
setCause(Throwable) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
setCause(Throwable) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
setCause(Throwable) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
setCause(Throwable) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
setCause(Throwable) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
setCause(Throwable) - Method in interface org.forgerock.opendj.ldap.messages.Result
Sets the throwable cause associated with this result if available.
setCause(Throwable) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
setCharset(Charset) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
The Charset to use to encrypt/decrypt values.
setClaim(String, Object) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Sets a claim with the specified name and value.
setClaims(Map<String, Object>) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet
Sets claims using the values contained in the specified map.
setClaimsSubject(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.
setConstant(String, Object) - Method in class org.forgerock.opendj.ldif.EntryGenerator
Sets a constant to use in template file.
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.
setDefaultSchema(Schema) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Sets the default schema which should be used by this application.
setDefaultStores(SecretStore<?>, SecretStore<?>...) - Method in class org.forgerock.secrets.SecretsProvider
Sets the default store(s) to use if there is no specific store configured for a particular purpose.
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.
setDeleteOldRdn(boolean) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Specifies whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry.
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.
setDereferenceAliasesPolicy(DereferenceAliasesPolicy) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the alias dereferencing policy to be used during the search.
setDetail(JsonValue) - Method in exception org.forgerock.json.resource.ResourceException
Sets the additional detail which can be evaluated by applications.
setDiagnosticMessage(CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
setDiagnosticMessage(CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
setDiagnosticMessage(CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
setDiagnosticMessage(CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
setDiagnosticMessage(CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
setDiagnosticMessage(CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.Result
Sets the diagnostic message associated with this result.
setDiagnosticMessage(CharSequence) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
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.
setEntryFactory(Function<Dn, Entry>) - Method in class org.forgerock.opendj.ldap.DecodeOptions
Sets the function which will be used for creating new Entry instances when decoding entries.
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.
setEvent(String) - Method in class org.forgerock.audit.handlers.jdbc.TableMapping
Sets the audit event the table mapping is for.
setExcludeAllOperationalAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Specifies whether all operational attributes should be excluded from any change records that are read from LDIF.
setExcludeAllOperationalAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Specifies whether all operational attributes should be excluded from any change records that are written to LDIF.
setExcludeAllOperationalAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Specifies whether all operational attributes should be excluded from any entries that are read from LDIF.
setExcludeAllOperationalAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Specifies whether all operational attributes should be excluded from any entries that are written to LDIF.
setExcludeAllUserAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Specifies whether all user attributes should be excluded from any change records that are read from LDIF.
setExcludeAllUserAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Specifies whether all user attributes should be excluded from any change records that are written to LDIF.
setExcludeAllUserAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Specifies whether all user attributes should be excluded from any entries that are read from LDIF.
setExcludeAllUserAttributes(boolean) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Specifies whether all user attributes should be excluded from any entries that are written to LDIF.
setExcludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Excludes the named attribute from any change records that are read from LDIF.
setExcludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Excludes the named attribute from any change records that are written to LDIF.
setExcludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Excludes the named attribute from any entries that are read from LDIF.
setExcludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Excludes the named attribute from any entries that are written to LDIF.
setExcludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Excludes all change records which target entries beneath the named entry (inclusive) from being read from LDIF.
setExcludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Excludes all change records which target entries beneath the named entry (inclusive) from being written to LDIF.
setExcludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Excludes all entries beneath the named entry (inclusive) from being read from LDIF.
setExcludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Excludes all entries beneath the named entry (inclusive) from being written to LDIF.
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
setFilter(Filter) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the filter that defines the conditions that must be fulfilled in order for an entry to be returned.
setFilter(String) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the filter that defines the conditions that must be fulfilled in order for an entry to be returned.
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.
setGenerateBranches(boolean) - Method in class org.forgerock.opendj.ldif.EntryGenerator
Sets the flag which indicates whether branch entries should be generated.
setGeneratedPassword(byte[]) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
Sets the generated password.
setGeneratedPassword(char[]) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
Sets the generated password.
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.
setIncludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Ensures that the named attribute is not excluded from any change records that are read from LDIF.
setIncludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Ensures that the named attribute is not excluded from any change records that are written to LDIF.
setIncludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Ensures that the named attribute is not excluded from any entries that are read from LDIF.
setIncludeAttribute(AttributeDescription) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Ensures that the named attribute is not excluded from any entries that are written to LDIF.
setIncludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Ensures that all change records which target entries beneath the named entry (inclusive) are read from LDIF.
setIncludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Ensures that all change records which target entries beneath the named entry (inclusive) are written to LDIF.
setIncludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Ensures that all entries beneath the named entry (inclusive) are read from LDIF.
setIncludeBranch(Dn) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Ensures that all entries beneath the named entry (inclusive) are written to LDIF.
setIncludeExcludeFilters(Collection<Filter>, Collection<Filter>) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Sets the filters to include / exclude entries.
setIncludeExcludeFilters(Collection<Filter>, Collection<Filter>) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Sets the filters to include / exclude entries.
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.
setKeysForPurposes(Map<String, List<KeyStoreSecretStore.AliasSpec>>) - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
Set the keys that are used for different purposes.
setKeyStoreHandler(KeyStoreHandler) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
Set the key store handler.
setKeyStoreHandlerName(String) - Method in class org.forgerock.audit.handlers.csv.CsvAuditEventHandlerConfiguration.CsvSecurity
Set the key store handler name.
setLength(int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Sets the length of this byte string builder.
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.
setMatchedDn(String) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
setMatchedDn(Dn) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
setMatchedDn(String) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
setMatchedDn(Dn) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
setMatchedDn(String) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
setMatchedDn(Dn) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
setMatchedDn(String) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
setMatchedDn(Dn) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
setMatchedDn(String) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
setMatchedDn(Dn) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
setMatchedDn(String) - Method in interface org.forgerock.opendj.ldap.messages.Result
Sets the matched DN associated with this result.
setMatchedDn(Dn) - Method in interface org.forgerock.opendj.ldap.messages.Result
Sets the matched DN associated with this result.
setMatchedDn(String) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
setMatchedDn(Dn) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
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.
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.
setName(Dn) - Method in class org.forgerock.opendj.ldap.AbstractMapEntry
 
setName(Dn) - Method in class org.forgerock.opendj.ldap.Entries.NullEntry
 
setName(Dn) - Method in interface org.forgerock.opendj.ldap.Entry
Sets the distinguished name of this entry (optional operation).
setName(String) - Method in interface org.forgerock.opendj.ldap.Entry
Sets the distinguished name of this entry (optional operation).
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
setName(String) - Method in interface org.forgerock.opendj.ldap.messages.AddRequest
 
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Sets the name of the Directory object that the client wishes to bind as.
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Sets the distinguished name of the entry to be compared.
setName(String) - Method in interface org.forgerock.opendj.ldap.messages.CompareRequest
Sets the distinguished name of the entry to be compared.
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.DeleteRequest
Sets the distinguished name of the entry to be deleted.
setName(String) - Method in interface org.forgerock.opendj.ldap.messages.DeleteRequest
Sets the distinguished name of the entry to be deleted.
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Sets the distinguished name of the entry to be renamed.
setName(String) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Sets the distinguished name of the entry to be renamed.
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
Sets the distinguished name of the entry to be modified.
setName(String) - Method in interface org.forgerock.opendj.ldap.messages.ModifyRequest
Sets the distinguished name of the entry to be modified.
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the distinguished name of the base entry relative to which the search is to be performed.
setName(String) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the distinguished name of the base entry relative to which the search is to be performed.
setName(Dn) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
setName(String) - Method in interface org.forgerock.opendj.ldap.messages.SearchResultEntry
 
setName(Dn) - Method in interface org.forgerock.opendj.ldif.ChangeRecord
Sets the distinguished name of the entry to be updated.
setName(String) - Method in interface org.forgerock.opendj.ldif.ChangeRecord
Sets the distinguished name of the entry to be updated.
setNewPassword(byte[]) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Sets the desired password for the user.
setNewPassword(char[]) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Sets the desired password for the user.
setNewRdn(Rdn) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Sets the new RDN of the entry to be renamed.
setNewRdn(String) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Sets the new RDN of the entry to be renamed.
setNewResourceId(String) - Method in interface org.forgerock.json.resource.CreateRequest
Sets the client provided ID of the resource to be created.
setNewSuperior(Dn) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.
setNewSuperior(String) - Method in interface org.forgerock.opendj.ldap.messages.ModifyDnRequest
Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.
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.
setOid(String) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
Sets the numeric OID associated with this extended request.
setOid(String) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
Sets the numeric OID, if any, associated with this extended result.
setOid(String) - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
Sets the numeric OID, if any, associated with this intermediate response.
setOldPassword(byte[]) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Sets the current password for the user.
setOldPassword(char[]) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Sets the current password for the user.
setOperation(CryptoHeaderFilter.Operation) - Method in class org.forgerock.openig.filter.CryptoHeaderFilter
Sets the operation (encryption/decryption) to apply to the headers.
setOption(Option<T>, T) - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Sets a schema option overriding any previous values for the option.
setOptions(Options) - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
setOptions(Options) - Method in interface org.forgerock.opendj.io.LdapSocketAcceptor
Updates the options of this LDAP socket acceptor.
setOptions(Options) - Method in class org.forgerock.opendj.ldap.LdapServer
Updates the options of this LDAP listener.
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
 
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.
setRandomSeed(int) - Method in class org.forgerock.opendj.ldif.EntryGenerator
Sets the random seed to use when generating 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.
setRawValue(String) - Method in class org.forgerock.http.header.AuthorizationHeader
Set the raw value of the header.
setReason(String) - Method in exception org.forgerock.json.resource.ResourceException
Sets/overrides the short reason phrase of the exception.
setReferencedValidator(Validator) - Method in class org.forgerock.json.schema.validator.validators.ReferenceTypeValidator
Sets the validator being referenced by this object.
setRejectedLdifListener(RejectedLdifListener) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Sets the rejected record listener which should be notified whenever an LDIF record is skipped, malformed, or fails schema validation.
setRejectedLdifListener(RejectedLdifListener) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Sets the rejected record listener which should be notified whenever an LDIF record is skipped, malformed, or fails schema validation.
setRequestId(int) - Method in interface org.forgerock.opendj.ldap.messages.AbandonRequest
Sets the request ID of the request to be abandoned.
setRequestId(int) - Method in interface org.forgerock.opendj.ldap.messages.CancelExtendedRequest
Sets the request ID of the request to be abandoned.
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
 
setResourcePath(String) - Method in class org.forgerock.opendj.ldif.EntryGenerator
Sets the resource path, used to looks for resources files like first names, last names, or other custom resources.
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
 
setResultCode(ResultCode) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
 
setResultCode(ResultCode) - Method in interface org.forgerock.opendj.ldap.messages.CompareResult
 
setResultCode(ResultCode) - Method in interface org.forgerock.opendj.ldap.messages.ExtendedResult
 
setResultCode(ResultCode) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
 
setResultCode(ResultCode) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedResult
 
setResultCode(ResultCode) - Method in interface org.forgerock.opendj.ldap.messages.Result
Sets the result code associated with this result.
setResultCode(ResultCode) - Method in interface org.forgerock.opendj.ldap.messages.WhoAmIExtendedResult
 
setRevision(String) - Method in interface org.forgerock.json.resource.DeleteRequest
Sets the expected version information associated with the JSON resource to be deleted.
setRevision(String) - Method in interface org.forgerock.json.resource.PatchRequest
Sets the expected version information associated with the JSON resource to be patched.
setRevision(String) - Method in interface org.forgerock.json.resource.UpdateRequest
Sets the expected version information associated with the JSON resource to be updated.
setRotationEnabled(boolean) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Sets log rotation enabled state.
setRotationFilePrefix(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Sets the prefix to add to a log file on rotation.
setRotationFileSuffix(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Sets the suffix to add to a log file on rotation.
setRotationInterval(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Sets the interval to trigger a file rotation.
setRotationRetentionCheckInterval(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
Sets the interval to check time-based file rotation policies.
setRotationTimes(List<String>) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
Sets a list of times at which file rotation should be triggered; times should be provided as Strings that can be parsed by Duration that each specify an offset from midnight.
setSameSite(Cookie.SameSite) - Method in class org.forgerock.http.protocol.Cookie
Sets the value of the SameSite attribute.
setSaslMechanismAndCredentials(String, byte[]) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Sets the authentication type to BindRequest.AUTHENTICATION_TYPE_SASL, the SASL mechanism name, and the optional SASL credentials.
setSaslMechanismAndCredentials(SaslClient) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Configures this bind request for SASL authentication using the provided SaslClient.
setSaslServer(SaslServer) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
Sets the SaslServer to use by the underlying connection.
setSchema(Schema) - Method in class org.forgerock.opendj.ldap.DecodeOptions
Sets the Schema which will be used for decoding distinguished names, attribute descriptions, and other objects which require a schema in order to be decoded.
setSchema(Schema) - Method in class org.forgerock.opendj.ldif.EntryGenerator
Sets the schema which should be when generating entries.
setSchema(Schema) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Sets the schema which should be used for decoding change records that are read from LDIF.
setSchema(Schema) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Sets the schema which should be used for decoding entries that are read from LDIF.
setSchemaResolver(SchemaResolver) - Method in class org.forgerock.opendj.ldap.DecodeOptions
Sets the strategy for selecting which Schema should be used for decoding distinguished names, attribute descriptions, and other objects which require a Schema in order to be decoded.
setSchemaValidationPolicy(SchemaValidationPolicy) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordReader
Specifies the schema validation which should be used when reading LDIF change records.
setSchemaValidationPolicy(SchemaValidationPolicy) - Method in class org.forgerock.opendj.ldif.LdifEntryReader
Specifies the schema validation which should be used when reading LDIF entry records.
setScheme(String) - Method in class org.forgerock.http.MutableUri
Update the scheme of this MutableUri.
setScope(SearchScope) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the scope of the search.
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.
setServerSaslCredentials(ByteString) - Method in interface org.forgerock.opendj.ldap.messages.BindResult
Sets the server SASL credentials associated with this bind result.
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.
setSimplePassword(byte[]) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Sets the authentication type to BindRequest.AUTHENTICATION_TYPE_SIMPLE and the authentication value to a copy of the provided password.
setSizeLimit(int) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the size limit that should be used in order to restrict the maximum number of entries returned by the search.
setSslOptions(SslOptions) - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedRequest
Sets the SslOptions that should be used when installing the TLS layer.
setSslOptions(SslOptions) - Method in interface org.forgerock.opendj.ldap.messages.StartTlsExtendedResult
Sets the SslOptions used to install the TLS layer.
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.
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.
setTimeLimit(int) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Sets the time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.
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.
setTypesOnly(boolean) - Method in interface org.forgerock.opendj.ldap.messages.SearchRequest
Specifies whether search results are to contain both attribute descriptions and values, or just attribute descriptions.
setupModule(Module.SetupContext) - Method in class org.forgerock.http.util.Json.JsonValueModule
 
setUri(MutableUri) - Method in class org.forgerock.http.header.ReferrerHeader
Set the URI value of the Referrer header.
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.
setUserIdentity(Object) - Method in interface org.forgerock.opendj.ldap.messages.PasswordModifyExtendedRequest
Sets the identity of the user whose password is to be modified.
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.
setValue(Object) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedRequest
Sets the value, if any, associated with this extended request.
setValue(Object) - Method in interface org.forgerock.opendj.ldap.messages.GenericExtendedResult
Sets the value, if any, associated with this extended result.
setValue(Object) - Method in interface org.forgerock.opendj.ldap.messages.GenericIntermediateResponse
Sets the value, if any, associated with this intermediate response.
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(int) - Method in interface org.forgerock.opendj.ldap.messages.BindRequest
Sets the version of the protocol to be used at the LDAP message layer.
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.
setWrapColumn(int) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Specifies the column at which long lines should be wrapped.
setWrapColumn(int) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
Specifies the column at which long lines should be wrapped.
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.
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.
shallowCopyOfEntry(Entry) - Static method in class org.forgerock.opendj.ldap.LinkedHashMapEntry
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
shallowCopyOfEntry(Entry) - Static method in class org.forgerock.opendj.ldap.TreeMapEntry
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
shallowCopyOfRequest(R, String...) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new request that is a shallow copy of the provided request, except for controls list which is a new list containing the original controls (and not the original list of controls) possibly filtered by the provided exclusion parameter.
shallowCopyOfRequest(R, Collection<String>) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates a new request that is a shallow copy of the provided request, except for controls list which is a new list containing the original controls (and not the original list of controls) possibly filtered by the provided exclusion parameter.
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.
shutdown() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
ShutdownListener - Interface in org.forgerock.util.thread.listener
Any component which needs to be shut down should implement this interface and use the function to shut down the component.
ShutdownManager - Interface in org.forgerock.util.thread.listener
Interface used by shutdown managers to allow for thread safe adding and removing of shutdown listeners.
shutdownNow() - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
ShutdownPriority - Enum in org.forgerock.util.thread.listener
This class defines the shutdown priorities that are consumed by com.sun.identity.common.ShutdownManager.
shutdownPublisher() - Method in class org.forgerock.audit.handlers.jms.BatchPublisher
This is invoked by BatchPublisher.shutdown().
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, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.EdDSASigningHandler
 
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 - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for creating digital signatures or message authentication codes (MACs).
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.
SigningKey - Class in org.forgerock.secrets.keys
A key that is used for signing digital signatures.
SigningKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.SigningKey
Initialises the key with the given secret data.
SigningManager - Class in org.forgerock.json.jose.jws
A service to get the appropriate SigningHandler for a specific Java Cryptographic signing algorithm.
SigningManager() - Constructor for class org.forgerock.json.jose.jws.SigningManager
 
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.
SimplePagedResultsControl - Class in org.forgerock.opendj.ldap.controls
The simple paged results request and response control as defined in RFC 2696.
simpleParse(String) - Static method in class org.forgerock.monitoring.api.instrument.util.TimeUtils
 
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
Deprecated.
Computes the elapsed time between now and past.
SINGLE_LEVEL - Static variable in class org.forgerock.opendj.ldap.SearchScope
The scope is constrained to the immediate subordinates of the search base entry.
singleKeyWithName(String) - Static method in class org.forgerock.config.util.JsonValuePropertyEvaluator
Create a predicate for a JSON coercion function as used in the Map argument to JsonValuePropertyEvaluator.JsonValuePropertyEvaluator(SubstitutionService, List).
SingleSignOnFilter - Class in org.forgerock.openig.openam
This filter verifies the presence of a SSOToken in the given cookie name.
SingleSignOnFilter(AmService, Realm, Expression<Boolean>, String, Expression<String>) - Constructor for class org.forgerock.openig.openam.SingleSignOnFilter
Creates a new SingleSignOnFilter.
SingleSignOnFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initialises an authentication filter in a heap environment.
singletonAttribute(AttributeDescription, Object) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a read-only single-valued attribute having the specified attribute description and value.
singletonAttribute(String, Object) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a read-only single-valued attribute having the specified attribute description.
singletonPropertyResolver(String, String) - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Returns a resolver that knows only to resolve the given key.
SingletonResourceProvider - Interface in org.forgerock.json.resource
An implementation interface for resource providers which exposes a single permanent resource instance.
singleValue(boolean) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Specifies whether this attribute type is declared "single-value".
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.opendj.ldap.AbstractAttribute
 
size() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns the number of attribute values in this attribute.
size() - Method in class org.forgerock.opendj.ldap.Dn
Returns the number of RDN components in this DN.
size() - Method in class org.forgerock.opendj.ldap.LinkedAttribute
 
size() - Method in class org.forgerock.opendj.ldap.MemoryBackend
Returns the number of entries contained in this memory backend.
size() - Method in class org.forgerock.opendj.ldap.Rdn
Returns the number of AVAs in this RDN.
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.NonExpiringCache
Gets the size of the cache.
size() - Method in class org.forgerock.util.PerItemEvictionStrategyCache
Returns the number of cached values.
size() - Method in class org.forgerock.util.RangeSet
Returns the number of elements in this set.
SIZE_LIMIT_EXCEEDED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a size limit was exceeded while attempting to process the request.
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.
SKEW_ALLOWANCE - Static variable in class org.forgerock.openig.tools.jwt.Constraints
Based on the EXP claim concept from rfc7519: The amount of time allowance between JWT expiring and current time when using EXP claim.
skip(int) - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
Skips the given number of bytes.
skipElement(byte) - Method in class org.forgerock.opendj.io.AbstractAsn1Reader
 
skipElement() - Method in interface org.forgerock.opendj.io.Asn1Reader
Skips the next element without decoding it.
skipElement(byte) - Method in interface org.forgerock.opendj.io.Asn1Reader
Skips the next element having the provided type tag without decoding it.
skipMsp() - Method in class org.forgerock.opendj.ldap.GserParser
Skips the input matching one or more space characters.
skipSeparator() - Method in class org.forgerock.opendj.ldap.GserParser
Skips the input matching the separator pattern (",") and subsequenct space characters.
skipSp() - Method in class org.forgerock.opendj.ldap.GserParser
Skips the input matching zero, one or more space characters.
sla(long...) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
Publish at a minimum a histogram containing your defined SLA boundaries.
sla(long...) - Method in class org.forgerock.monitoring.api.instrument.histogram.HistogramConfig.Builder
 
sla(Duration...) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
Publish at a minimum a histogram containing your defined SLA boundaries.
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).
snakeCase - Static variable in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
SORT_CONTROL_MISSING - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a search request included a VLV request control without a server-side sort control.
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.
SortKey - Class in org.forgerock.opendj.ldap
A search result sort key as defined in RFC 2891 is used to specify how search result entries should be ordered.
SortKey(AttributeDescription, boolean, MatchingRule) - Constructor for class org.forgerock.opendj.ldap.SortKey
Creates a new sort key using the provided attribute description.
SortKey(String) - Constructor for class org.forgerock.opendj.ldap.SortKey
Creates a new sort key using the provided attribute description.
SortKey(String, boolean) - Constructor for class org.forgerock.opendj.ldap.SortKey
Creates a new sort key using the provided attribute description.
SortKey(String, boolean, String) - Constructor for class org.forgerock.opendj.ldap.SortKey
Creates a new sort key using the provided attribute description.
SortKeyComparator - Class in org.forgerock.json.resource
This comparator iterates through the provided sortKeys and finds the first comparative difference between the left and right side JsonValues.
SortKeyComparator(List<SortKey>) - Constructor for class org.forgerock.json.resource.SortKeyComparator
Construct a Comparator that will compare two JsonValue objects based on the provided list of SortKeys.
SortKeyComparator(List<SortKey>, SortKeyComparator.NullPosition) - Constructor for class org.forgerock.json.resource.SortKeyComparator
Construct a Comparator that will compare two JsonValue objects based on the provided list of SortKeys and options.
SortKeyComparator.NullPosition - Enum in org.forgerock.json.resource
Defines possible positions for JsonValue that wraps a null object.
split(String, char) - Static method in class org.forgerock.http.header.HeaderUtil
Parses an HTTP header value, splitting it into multiple values around the specified separator.
split(String, String) - Static method in class org.forgerock.openig.el.Functions
Splits a string into an array of substrings around matches of the given regular expression.
SplunkAuditEventHandler - Class in org.forgerock.audit.handlers.splunk
Audit event handler that writes out to Splunk's HTTP event collector RAW endpoint.
SplunkAuditEventHandler(SplunkAuditEventHandlerConfiguration, EventTopicsMetaData, BatchPublisherFactory, Client) - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandler
Constructs a new Splunk audit event handler.
SplunkAuditEventHandlerConfiguration - Class in org.forgerock.audit.handlers.splunk
Configuration for the splunk audit event handler.
SplunkAuditEventHandlerConfiguration() - Constructor for class org.forgerock.audit.handlers.splunk.SplunkAuditEventHandlerConfiguration
 
SplunkAuditEventHandlerConfiguration.BufferingConfiguration - Class in org.forgerock.audit.handlers.splunk
Configuration of event buffering.
SplunkAuditEventHandlerConfiguration.ConnectionConfiguration - Class in org.forgerock.audit.handlers.splunk
Configuration of connection to Splunk.
SqlAttributesFilter - Class in org.forgerock.openig.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.
SSL_HOST_NAME_VALIDATION_DISABLED_PROPERTY - Static variable in class org.forgerock.opendj.security.SslOptions
The name of the property which, when true, will disable SSL host name validation.
SSL_USE_STARTTLS - Static variable in class org.forgerock.opendj.ldap.LdapConnectionFactory
Specifies whether SSL or StartTLS should be used for securing connections when an SSL context is specified.
sslContext() - Method in class org.forgerock.opendj.security.SslOptions
Returns the SSLContext that should be used when installing the SSL layer.
SslOptions - Class in org.forgerock.opendj.security
Encapsulates options for configuring SSL based security as well as providing methods for building SSLEngines.
SslOptions.ClientAuthPolicy - Enum in org.forgerock.opendj.security
Represents the client authentication policy option.
SsoToken - Class in org.forgerock.openig.tools.authentication
Represents the successful result of an authentication against the AM server.
SsoToken(String) - Constructor for class org.forgerock.openig.tools.authentication.SsoToken
Constructs a new token with the given value.
SsoTokenConfigurator - Class in org.forgerock.openig.tools.notifications.ws
Add an agent's SSO Token into the initial HTTP request.
SsoTokenConfigurator(String, String) - Constructor for class org.forgerock.openig.tools.notifications.ws.SsoTokenConfigurator
Constructs a ClientEndpointConfig.Configurator that would inject the given token value in the provided headerName.
SsoTokenContext - Class in org.forgerock.openig.openam
An SsoTokenContext could be used to store and retrieve an token.
SsoTokenContext(Context, JsonValue, String, 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'.
STABLE_ID_KEY - Static variable in class org.forgerock.util.crypto.CryptoConstants
key for the id of the key used to crypt the data when purposes are in use.
stableId(String) - Method in class org.forgerock.secrets.SecretBuilder
Sets the stable id of this secret.
stableIdFor(KeyStoreSecretStore.KeyDetails, Class<? extends Secret>) - Method in interface org.forgerock.secrets.keystore.KeyStoreSecretStore.StableIdProvider
Produce the secret's stable ID.
start() - Method in interface org.forgerock.http.HttpApplication
Gets the root Handler that will handle all HTTP requests.
start(MeterRegistry) - Static method in interface org.forgerock.monitoring.api.instrument.Timer
 
start(Clock) - Static method in interface org.forgerock.monitoring.api.instrument.Timer
 
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.heap.HeapImpl
Allocate all objects using each heaplet instance's configuration.
start() - Method in class org.forgerock.openig.http.AdminHttpApplication
 
start() - Method in class org.forgerock.openig.http.GatewayHttpApplication
 
start() - Method in class org.forgerock.openig.openam.AmServiceHeaplet
 
start() - Method in class org.forgerock.openig.tools.am.AmService
Starts this server instance (and associated services).
start() - Method in interface org.forgerock.openig.tools.LifeCycle
Starts this object.
start() - Method in class org.forgerock.openig.tools.notifications.ws.TyrusNotificationService
Start the client, connecting the web-socket to the server.
start() - Method in class org.forgerock.openig.tools.session.CacheSessionService
 
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(ByteSequence) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Tests if this ByteSequence starts with the specified prefix.
startsWith(ByteSequence) - Method in class org.forgerock.opendj.ldap.ByteString
 
startsWith(ByteSequence) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
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.
StartTlsExtendedRequest - Interface in org.forgerock.opendj.ldap.messages
The start TLS extended request as defined in RFC 4511.
StartTlsExtendedResult - Interface in org.forgerock.opendj.ldap.messages
The start tls extended result as defined in RFC 4511.
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().
StatelessAccessTokenResolver - Class in org.forgerock.openig.filter.oauth2
A StatelessAccessTokenResolver that locally resolves and validates stateless access_tokens issued by AM.
StatelessAccessTokenResolver.Heaplet - Class in org.forgerock.openig.filter.oauth2
Creates and initializes a stateless access token resolver in the heap environment.
StaticRequestFilter - Class in org.forgerock.openig.filter
Creates a new request and send it down the next handler (effectively replacing the previous request).
StaticRequestFilter(String) - Constructor for class org.forgerock.openig.filter.StaticRequestFilter
Builds a new StaticRequestFilter that will uses the given HTTP method on the resource.
StaticRequestFilter.Heaplet - Class in org.forgerock.openig.filter
Creates and initializes a request filter in a heap environment.
StaticResponseHandler - Class in org.forgerock.openig.handler
Creates a static HTTP response.
StaticResponseHandler(Status) - Constructor for class org.forgerock.openig.handler.StaticResponseHandler
Constructor.
StaticResponseHandler(Status, 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.
Statistic - Enum in org.forgerock.monitoring.api.instrument
A description of the value contained in a measurement.
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(Timer) - Method in class org.forgerock.monitoring.api.instrument.Timer.Sample
Records the duration of the operation
stop() - Method in class org.forgerock.openig.decoration.DecorationHandle
Notifies the handle to stop the decoration.
stop() - Method in class org.forgerock.openig.handler.router.RouterHandler
Stops this handler, shutting down and clearing all the managed routes.
stop() - Method in class org.forgerock.openig.http.AdminHttpApplication
 
stop() - Method in class org.forgerock.openig.http.GatewayHttpApplication
 
stop() - Method in class org.forgerock.openig.tools.am.AmService
Stops this server instance (and associated services).
stop() - Method in interface org.forgerock.openig.tools.LifeCycle
Stops this object.
stop() - Method in class org.forgerock.openig.tools.notifications.ws.TyrusNotificationService
 
stop() - Method in class org.forgerock.openig.tools.session.CacheSessionService
 
STORAGE_TYPE_HASH - Static variable in class org.forgerock.util.crypto.CryptoConstants
A salted hash encryption storage type.
store() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
 
store() - Method in interface org.forgerock.audit.secure.KeyStoreHandler
Saves the keystore.
store() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
 
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.
stream() - Method in class org.forgerock.monitoring.api.instrument.Tags
Return a stream of the contained tags.
streamOf(Function<JsonValue, V, E>) - Static method in class org.forgerock.openig.util.JsonValues
Returns the JSON value as a Stream containing objects whose type (and value) is specified by a transformation function.
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.
Streams - Class in org.forgerock.util
Utility methods for operating on IO streams.
STRICT_FORMAT_FOR_COUNTRY_STRINGS - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Indicates whether country code values are required to strictly comply with the standard definition for this syntax.
strictlyBetween(Version, Version) - Static method in class org.forgerock.openig.tools.am.Version
Returns a predicate that verifies if this version is in between the given minExclusive and maxExclusive versions (exclusive).
STRING_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper
Json String value type.
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.
Strings - Class in org.forgerock.util
Common utility methods for Strings.
stringToBoolean(String) - Static method in class org.forgerock.opendj.ldap.Functions
Parses a String as a boolean.
stringToInteger(String) - Static method in class org.forgerock.opendj.ldap.Functions
Parses a String as an int.
stringToLong(String) - Static method in class org.forgerock.opendj.ldap.Functions
Parses a String as a long.
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.
STRIP_UPPER_BOUND_FOR_ATTRIBUTE_TYPE - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Indicates whether the minimum upper bound value should be stripped from the Attribute Type Syntax Description.
STRONG_AUTH_REQUIRED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation could not be processed because it requires that the client has completed a strong form of authentication.
structuralClassOid(String) - Method in class org.forgerock.opendj.ldap.schema.DitContentRule.Builder
Sets the structural class OID which uniquely identifies this DIT content rule.
structuralObjectClassOid(String) - Method in class org.forgerock.opendj.ldap.schema.NameForm.Builder
Sets the structural object class.
sts() - Method in class org.forgerock.openig.tools.am.AmService
Returns the transformation endpoint located in the /rest-sts namespace.
sts(String) - Method in class org.forgerock.openig.tools.am.AmService
Returns the transformation endpoint located in the /rest-sts namespace.
sts() - Method in class org.forgerock.openig.tools.am.UriService
Returns the transformation endpoint located in the /rest-sts namespace.
sts(String) - Method in class org.forgerock.openig.tools.am.UriService
Returns the transformation endpoint located in the /rest-sts namespace.
StsContext - Class in org.forgerock.openig.openam
A StsContext convey the token transformation results to downstream filters and handlers.
stsUri(String) - Method in class org.forgerock.openig.tools.am.AmService
Returns the URI of the transformation endpoint located in the /rest-sts namespace.
stsUri(String) - Method in class org.forgerock.openig.tools.am.UriService
Returns the URI of the transformation endpoint located in the /rest-sts namespace.
STUDIO_PROTECTION_FILTER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a Filter instance from the Heap of admin.json.
sub(String) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets the subject this JWT is issued to.
sub(URI) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets the subject this JWT is issued to.
SubentriesRequestControl - Class in org.forgerock.opendj.ldap.controls
The sub-entries request control as defined in RFC 3672.
subList(int, int) - Method in class org.forgerock.util.LazyList
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
subList(int, int) - Method in class org.forgerock.util.ListDecorator
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
submit(Callable<T>) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
submit(Runnable, T) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
submit(Runnable) - Method in class org.forgerock.util.thread.MdcExecutorServiceDelegate
 
SUBORDINATES - Static variable in class org.forgerock.opendj.ldap.SearchScope
The scope is constrained to all the subordinates of the search base entry, but does not include the search base entry itself (as wholeSubtree does).
subscribe(String, NotificationListener) - Method in interface org.forgerock.openig.tools.notifications.NotificationService
Subscribes (asynchronously) to a given topic, providing a listener that will be invoked at notification reception time.
subscribe(String, NotificationListener) - Method in class org.forgerock.openig.tools.notifications.ws.TyrusNotificationService
 
Subscription - Interface in org.forgerock.openig.tools.notifications
Represents a managed subscription to a given topic.
SubscriptionAck - Class in org.forgerock.openig.tools.notifications.ws
A SubscriptionAck is a response message to a SubscriptionRequest.
SubscriptionException - Exception in org.forgerock.openig.tools.notifications
Represents a subscription (or un-subscription) failure.
SubscriptionException(String) - Constructor for exception org.forgerock.openig.tools.notifications.SubscriptionException
Builds a subscription (or un-subscription) failure.
SubscriptionException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.notifications.SubscriptionException
Builds a subscription (or un-subscription) failure.
SubscriptionRequestEncoder - Class in org.forgerock.openig.tools.notifications.ws
Web-socket encoder for SubscriptionRequest.
SubscriptionRequestEncoder() - Constructor for class org.forgerock.openig.tools.notifications.ws.SubscriptionRequestEncoder
 
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.
subSequence(int, int) - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns a new byte sequence that is a subsequence of this byte sequence.
subSequence(int, int) - Method in class org.forgerock.opendj.ldap.ByteString
 
subSequence(int, int) - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns a new byte sequence that is a subsequence of this byte sequence.
substitute(String) - Method in class org.forgerock.config.resolvers.SubstitutionService
Perform variable substitution on the source String.
substitute(String, boolean) - Method in class org.forgerock.config.resolvers.SubstitutionService
Perform variable substitution on the source String.
substitute(String, SubstitutionContext) - Method in class org.forgerock.config.resolvers.SubstitutionService
Perform variable substitution on the source String.
SubstitutionContext - Class in org.forgerock.config.resolvers
A SubstitutionContext holds both runtime and config time values for the substitution process.
SubstitutionContext(boolean) - Constructor for class org.forgerock.config.resolvers.SubstitutionContext
Creates a SubstitutionContext with default (no-op) notifiers and escaping support as dictated by escaping.
SubstitutionContext(Consumer<String>, Consumer<List<String>>, boolean) - Constructor for class org.forgerock.config.resolvers.SubstitutionContext
Creates a SubstitutionContext with given unresolved and cycle functions.
SubstitutionException - Exception in org.forgerock.config.resolvers
Exception thrown during substitution process.
SubstitutionException(String, SubstitutionContext) - Constructor for exception org.forgerock.config.resolvers.SubstitutionException
Creates a SubstitutionException with the given message.
SubstitutionException(String, Throwable, SubstitutionContext) - Constructor for exception org.forgerock.config.resolvers.SubstitutionException
Creates a SubstitutionException with the given message and parent cause.
SubstitutionService - Class in org.forgerock.config.resolvers
Substitute tokens in the source String with their resolved value.
SubstitutionService(PropertyResolver) - Constructor for class org.forgerock.config.resolvers.SubstitutionService
Creates a new substitution service that will resolve variables using the given resolver.
substringKeySize() - Method in interface org.forgerock.opendj.ldap.spi.IndexingOptions
Returns the maximum size to use when building the keys for the "substring" index.
substringMatchingRule(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the matching rule that should be used for substring matching with this attribute type.
substrings(String, Object, Collection<?>, Object) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new substrings filter using the provided attribute description, initial, final, and any sub-strings.
SubtreeDeleteRequestControl - Class in org.forgerock.opendj.ldap.controls
The tree delete request control as defined in draft-armijo-ldap-treedelete.
SUCCESS - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the operation completed successfully.
success() - Static method in class org.forgerock.openig.filter.oauth2.Result
Returns a Result representing validation success.
success() - Static method in class org.forgerock.openig.tools.jwt.Result
Returns a Result representing validation success.
successfulSubscription(String, String, String) - Static method in class org.forgerock.openig.tools.notifications.ws.SubscriptionAck
Builds a successful acknowledgement.
summary(Meter.Id, HistogramConfig) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
summary(Meter.Id, HistogramConfig) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
summary() - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
summary() - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
summary(Meter.Id, HistogramConfig) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
superiorObjectClasses(Collection<String>) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided superior object classes.
superiorObjectClasses(String...) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Adds the provided superior object classes.
superiorRules(int...) - Method in class org.forgerock.opendj.ldap.schema.DitStructureRule.Builder
Adds the provided superior rule identifiers.
superiorType(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the superior type for this attribute type.
Supplier<T,E extends Exception> - Interface in org.forgerock.util
A Supplier functional interface which can throw a checked Exception.
SUPPORTED_HTTP_METHODS - Static variable in class org.forgerock.monitoring.http.PrometheusHandler
List of HTTP methods supported by a Prometheus Handler.
supportedCipherSuites() - Static method in class org.forgerock.opendj.security.SslOptions
Returns a List of TLS cipher suites names reported as supported by the running JVM.
SupportedEllipticCurve - Enum in org.forgerock.json.jose.jws
Enumerates all supported elliptic curve parameters for ESXXX signature formats.
supportedProtocols() - Static method in class org.forgerock.opendj.security.SslOptions
Returns a List of TLS protocol names reported as supported by the running JVM.
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.
SwitchingHttpClientFilter - Class in org.forgerock.openig.websocket.grizzly
Manage runtime deactivation of the HTTP filter.
SwitchingHttpClientFilter() - Constructor for class org.forgerock.openig.websocket.grizzly.SwitchingHttpClientFilter
 
SwitchingSslFilter - Class in org.forgerock.openig.websocket.grizzly
The SSLFilter implementation, which might be activated/deactivated at runtime.
SwitchingSslFilter(SSLEngineConfigurator, boolean) - Constructor for class org.forgerock.openig.websocket.grizzly.SwitchingSslFilter
Constructs a new SSL filter (client side).
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.
syntax(String) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the syntax for this attribute type.
Syntax - Class in org.forgerock.opendj.ldap.schema
This class defines a data structure for storing and interacting with an LDAP syntaxes, which constrain the structure of attribute values stored in an LDAP directory, and determine the representation of attribute and assertion values transferred in the LDAP protocol.
Syntax.Builder - Class in org.forgerock.opendj.ldap.schema
A fluent API for incrementally constructing syntaxes.
SyntaxImpl - Interface in org.forgerock.opendj.ldap.schema
This interface defines the set of methods and structures that must be implemented to define a new attribute syntax.
syntaxOid(String) - Method in class org.forgerock.opendj.ldap.schema.MatchingRule.Builder
Sets the syntax OID of this matching rule.
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.monitoring.api.instrument.Clock
 
SYSTEM - Static variable in interface org.forgerock.util.time.TimeService
Deprecated.
TimeService implementation based on System.
SystemAndEnvSecretStoreHeaplet - Class in org.forgerock.openig.secrets
This heaplet represents an instance of a PropertyResolverSecretStore resolving properties in system then in environment variables.
SystemAndEnvSecretStoreHeaplet() - Constructor for class org.forgerock.openig.secrets.SystemAndEnvSecretStoreHeaplet
 
SystemPropertiesPlugin - Class in org.forgerock.openig.el.plugins
An ELContext node plugin that provides read-only access to system properties.
SystemPropertiesPlugin() - Constructor for class org.forgerock.openig.el.plugins.SystemPropertiesPlugin
 
systemPropertyResolver() - Static method in class org.forgerock.config.resolvers.PropertyResolvers
Construct a new SystemPropertyResolver.
SystemPropertyResolver - Class in org.forgerock.config.resolvers
A SystemPropertyResolver resolves a config token using system properties.

T

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
 
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.Counter.Builder
Add String-value pair of tags to a Counter
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
 
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.Gauge.Builder
 
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.Meter.Builder
 
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
Adds a tag that will be automatically added to all meters registered against this meter registry.
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
Tag - Interface in org.forgerock.monitoring.api.instrument
Key/value pair representing a dimension of a meter used to classify and drill into measurements.
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.TimeGauge.Builder
 
tag(String, String) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
 
tagKey(String) - Method in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.Counter.Builder
Add tags to a Counter as an ellipsis of Tag
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.Counter.Builder
Add tags to a Counter in Iterable form
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
 
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.DistributionSummary.Builder
 
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.Gauge.Builder
 
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.Gauge.Builder
 
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.Meter.Builder
 
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.Meter.Builder
 
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
Tags - Class in org.forgerock.monitoring.api.instrument
An immutable collection of Tags.
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.TimeGauge.Builder
 
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.TimeGauge.Builder
 
tags(String...) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
 
tags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.Timer.Builder
 
tagValue(String) - Method in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
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.
takeSnapshot(boolean) - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
 
takeSnapshot(boolean) - Method in interface org.forgerock.monitoring.api.instrument.Timer
 
takeSnapshot(boolean) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
takeSnapshot(boolean) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
taskCount() - Method in class org.forgerock.opendj.ldap.TimeoutScheduler
Returns the number of TimeoutScheduler.TimeoutEventListener registered.
TEAPOT - Static variable in class org.forgerock.http.protocol.Status
Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot".
templateVariable(String, String) - Method in class org.forgerock.http.routing.UriRouterContext.Builder
Add the given name:value pair in the variables map.
templateVariables(Map<String, String>) - Method in class org.forgerock.http.routing.UriRouterContext.Builder
Set the variables value.
TEMPORARY_REDIRECT - Static variable in class org.forgerock.http.protocol.Status
The 307 (Temporary Redirect) status code indicates that the target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI.
TEMPORARY_STORAGE_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve an implementation of a Factory of Buffer instance from the Heap.
TemporaryStorageHeaplet - Class in org.forgerock.openig.io
A Heaplet to call IO.newTemporaryStorage() within a heaplet environment.
TemporaryStorageHeaplet() - Constructor for class org.forgerock.openig.io.TemporaryStorageHeaplet
 
test(String) - Method in class org.forgerock.util.BlackAndWhitelistFilter
Returns true if the provided string is accepted by this filter, false otherwise.
test(T) - Method in interface org.forgerock.util.Predicate
Test a value.
TextWriter - Interface in org.forgerock.audit.events.handlers.writers
A TextWriter provides a character-based stream which can be queried for number of bytes written.
TextWriter.Stream - Class in org.forgerock.audit.events.handlers.writers
A TextWriter implementation which writes to a given output stream.
TextWriterAdapter - Class in org.forgerock.audit.events.handlers.writers
Wraps a TextWriter in a Writer.
TextWriterAdapter(TextWriter) - Constructor for class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
Creates the writer.
then(Function<? super S, VOUT, LdapException>) - Method in interface org.forgerock.opendj.ldap.LdapPromise
 
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.opendj.ldap.LdapPromise
 
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 S, VOUT, LdapException>) - Method in interface org.forgerock.opendj.ldap.LdapPromise
 
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.opendj.ldap.LdapPromise
 
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 LdapException>) - Method in interface org.forgerock.opendj.ldap.LdapPromise
 
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 S>) - Method in interface org.forgerock.opendj.ldap.LdapPromise
 
thenOnResult(ResultHandler<? super V>) - Method in interface org.forgerock.util.promise.Promise
Registers the provided completion handler for notification once this Promise has completed with a result.
thenOnResult(ResultHandler<? super V>) - Method in class org.forgerock.util.promise.PromiseImpl
 
thenOnResultOrException(Runnable) - Method in interface org.forgerock.opendj.ldap.LdapPromise
 
thenOnResultOrException(ResultHandler<? super S>, ExceptionHandler<? super LdapException>) - Method in interface org.forgerock.opendj.ldap.LdapPromise
 
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.
ThreadPoolSecretStore<T extends Secret> - Class in org.forgerock.secrets
A secret store that wraps another secret store and performs all query operations in a background thread using a thread pool.
Threads - Class in org.forgerock.util
Common utility methods for Threads.
throttle(String, ThrottlingRate) - Method in interface org.forgerock.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.
Throwables - Class in org.forgerock.openig.tools.notifications.ws
Throwable utilities class.
TICKER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a Ticker instance from the Heap.
TIME_LIMIT_EXCEEDED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a time limit was exceeded while attempting to process the request.
Timed - Annotation Type in org.forgerock.monitoring.api.annotation
 
TimedSet - Annotation Type in org.forgerock.monitoring.api.annotation
 
timeGauge(String, Iterable<Tag>, T, TimeUnit, ToDoubleFunction<T>) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.More
A gauge that tracks a time value, to be scaled to the monitoring system's base time unit.
timeGauge(Meter.Id, T, TimeUnit, ToDoubleFunction<T>) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry.More
A gauge that tracks a time value, to be scaled to the monitoring system's base time unit.
TimeGauge - Interface in org.forgerock.monitoring.api.instrument
 
TimeGauge.Builder<T> - Class in org.forgerock.monitoring.api.instrument
Fluent builder for time gauges.
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.
TimeoutResultException - Exception in org.forgerock.opendj.ldap
Thrown when the result code returned in a Result indicates that the Request was aborted because it did not complete in the required time out period.
TimeoutScheduler - Class in org.forgerock.opendj.ldap
Invokes TimeoutScheduler.TimeoutEventListener at a regular interval.
TimeoutScheduler(ReferenceCountedObject.Reference<ScheduledExecutorService>, long, TimeUnit) - Constructor for class org.forgerock.opendj.ldap.TimeoutScheduler
Creates a new TimeoutScheduler.
TimeoutScheduler(ReferenceCountedObject.Reference<ScheduledExecutorService>, Clock, long, TimeUnit) - Constructor for class org.forgerock.opendj.ldap.TimeoutScheduler
Creates a new TimeoutScheduler.
TimeoutScheduler.TimeoutEventListener - Interface in org.forgerock.opendj.ldap
Listener on timeout events.
timer(Meter.Id, HistogramConfig, PauseDetector) - Method in interface org.forgerock.monitoring.api.instrument.MeterRegistry
Only used by Timer.builder(String).
timer(Meter.Id, HistogramConfig, PauseDetector) - Method in class org.forgerock.monitoring.api.instrument.MeterRegistryHolder
 
timer() - Method in class org.forgerock.monitoring.api.instrument.search.RequiredSearch
 
timer() - Method in class org.forgerock.monitoring.api.instrument.search.Search
 
Timer - Interface in org.forgerock.monitoring.api.instrument
Timer intended to track of a large number of short running events.
timer(Meter.Id, HistogramConfig, PauseDetector) - Method in class org.forgerock.monitoring.dropwizard.AbstractMeterRegistry
 
Timer.Builder - Class in org.forgerock.monitoring.api.instrument
Fluent builder for timers.
Timer.Sample - Class in org.forgerock.monitoring.api.instrument
 
TIMER_HEAP_KEY - Static variable in class org.forgerock.openig.heap.Keys
Key to retrieve a TimerDecorator instance from the Heap.
TimerDecorator - Class in org.forgerock.openig.decoration.timer
The timer decorator can decorate both Filter and Handler instances.
TimerDecorator.Heaplet - Class in org.forgerock.openig.decoration.timer
Creates and initializes a TimerDecorator in a heap environment.
TimeService - Interface in org.forgerock.util.time
Deprecated.
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.
TimeUtils - Class in org.forgerock.monitoring.api.instrument.util
Modification on TimeUnit.convert(long, TimeUnit) that accepts and preserves precision from a double argument.
TITLE - Static variable in class org.forgerock.json.schema.validator.Constants
The type field name.
TlsOptions - Class in org.forgerock.openig.tools
TLS Options value object.
TlsOptions(String, KeyManager[], TrustManager[], List<String>, List<String>) - Constructor for class org.forgerock.openig.tools.TlsOptions
Constructs TLS options with provided values.
TlsOptionsHeaplet - Class in org.forgerock.openig.security
Creates and initializes TLS options in a heap environment.
TlsOptionsHeaplet() - Constructor for class org.forgerock.openig.security.TlsOptionsHeaplet
 
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.opendj.ldap.AbstractAttribute
 
toArray() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns an array containing all of the attribute values contained in this attribute.
toArray(T[]) - Method in interface org.forgerock.opendj.ldap.Attribute
Returns an array containing all of the attribute values in this attribute; the runtime type of the returned array is that of the specified array.
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.
toAsciiString() - Method in class org.forgerock.opendj.ldap.ByteString
Returns a 7-bit ASCII string representation.
toAttribute() - Method in class org.forgerock.opendj.ldap.Ava
Returns a single valued attribute having the same attribute type and value as this AVA.
toAttributeDescription() - Method in class org.forgerock.opendj.ldap.schema.AttributeType
Returns the option-less attribute description corresponding to this attribute type.
toBase64String() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns the Base64 encoded string representation of this byte string.
toBase64String() - Method in class org.forgerock.opendj.ldap.ByteString
 
toBase64String() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
toBoolean() - Method in enum org.forgerock.opendj.ldap.ConditionResult
Converts this condition result to a boolean value.
toByteArray() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns a byte array containing the bytes in this sequence in the same order as this sequence.
toByteArray() - Method in class org.forgerock.opendj.ldap.ByteString
 
toByteArray() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
toByteBuffer() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns the read-only ByteBuffer representation of this byte sequence.
toByteBuffer() - Method in class org.forgerock.opendj.ldap.ByteString
 
toByteBuffer() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns the read-only ByteBuffer representation of this byte string builder.
toByteString() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns the ByteString representation of this byte sequence.
toByteString() - Method in class org.forgerock.opendj.ldap.ByteString
 
toByteString() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Returns the ByteString representation of this byte string builder.
toBytesUnsigned(BigInteger) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils
Returns the magnitude big-endian byte array of a big integer.
toCalendar() - Method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a Calendar representation of this generalized time.
toCharArray() - Method in class org.forgerock.opendj.ldap.ByteString
Returns the UTF-8 decoded char array representation of this byte sequence.
toDate() - Method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a Date representation of this generalized time.
toECPrivateKey() - Method in class org.forgerock.json.jose.jwk.EcJWK
Converts the JWK to a ECPrivateKey.
toECPublicKey() - Method in class org.forgerock.json.jose.jwk.EcJWK
Converts the JWK to a ECPublicKey.
toECPublicKey() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk
Converts the public claims in the JWK into a public key object.
toECPublicKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Converts the JWK to a public key object.
toEntry(Entry) - Method in class org.forgerock.opendj.ldap.schema.Schema
Adds the definitions of all the schema elements contained in this schema to the provided subschema subentry.
toEvent() - Method in class org.forgerock.audit.events.AuditEventBuilder
Generates the audit event.
toForm() - Method in class org.forgerock.http.oauth2.OAuth2Error
Returns the form representation of this error suitable for inclusion in an authorization call-back query.
toFormString() - Method in class org.forgerock.http.protocol.Form
Returns this form in a form URL-encoded string.
toHexPlusAsciiString(int) - Method in class org.forgerock.opendj.ldap.ByteString
Returns a string representation of the data in this byte sequence using the specified indent.
toHexString() - Method in class org.forgerock.opendj.ldap.ByteString
Returns a string representation of the contents of this byte sequence using hexadecimal characters and a space between each byte.
toIndex(String) - Static method in class org.forgerock.json.JsonValue
Returns the key as an list index value.
toInt() - Method in class org.forgerock.opendj.ldap.ByteString
Returns the integer value represented by the first four bytes of this byte string in big-endian order.
toIntDate(Date) - Static method in class org.forgerock.json.jose.utils.IntDate
Converts a Java Date object into an IntDate.
toJson(String) - Static method in class org.forgerock.openig.el.Functions
Parse/Un-marshal the input String into a JSON structure.
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.OkpJWK
 
toJsonValue() - Method in class org.forgerock.json.jose.jwk.RsaJWK.PrimesInfo
Returns a json representation of the other factors.
toJsonValue() - Method in class org.forgerock.json.jose.jwk.RsaJWK
 
toJsonValue() - Method in class org.forgerock.json.jose.jwt.JWObject
Returns a json representation of the JWObject.
toJsonValue() - Method in interface org.forgerock.json.resource.ActionRequest
 
toJsonValue() - Method in interface org.forgerock.json.resource.CreateRequest
 
toJsonValue() - Method in interface org.forgerock.json.resource.DeleteRequest
 
toJsonValue() - Method in class org.forgerock.json.resource.PatchOperation
Returns a JSON value representation of this patch operation.
toJsonValue() - Method in interface org.forgerock.json.resource.PatchRequest
 
toJsonValue() - Method in interface org.forgerock.json.resource.QueryRequest
 
toJsonValue() - Method in interface org.forgerock.json.resource.ReadRequest
 
toJsonValue() - Method in interface org.forgerock.json.resource.Request
Return a JsonValue representation of this request.
toJsonValue() - Method in exception org.forgerock.json.resource.ResourceException
Returns the exception in a JSON object structure, suitable for inclusion in the entity of an HTTP error response.
toJsonValue() - Method in interface org.forgerock.json.resource.UpdateRequest
 
toJsonValue() - Method in class org.forgerock.services.context.AbstractContext
 
toJsonValue() - Method in interface org.forgerock.services.context.Context
Return this Context as a JsonValue (for persistence).
toJsonValue() - Method in class org.forgerock.services.context.TransactionIdContext
Updates the data object to have the current transactionId state.
TOKEN_NAME - Static variable in class org.forgerock.openig.tools.JwtUtil
Claim-set token name key - not available in JwtClaimsSetKey.
TokenBucketThrottlingStrategy - Class in org.forgerock.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.
tokenHeader(String) - Method in class org.forgerock.http.filter.CsrfFilter.Builder
Sets the header to use to receive the anti-CSRF token.
TokenIntrospectionAccessTokenResolver - Class in org.forgerock.http.oauth2.resolver
An AccessTokenResolver which is RFC 7662 compliant.
TokenIntrospectionAccessTokenResolver(Handler, URI) - Constructor for class org.forgerock.http.oauth2.resolver.TokenIntrospectionAccessTokenResolver
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
 
tokenized(PropertyResolver) - Static method in class org.forgerock.openig.util.JsonValues
Returns a function performing deep token substitution and object coercion ($ "functions").
TokenResolver - Class in org.forgerock.openig.heap
Offers a user-friendly API to the COMMONS config property resolvers.
TokenTransformationFilter - Class in org.forgerock.openig.openam
A TokenTransformationFilter is responsible for transforming a token issued by Access Management into a token of another type.
TokenTransformationFilter(Handler, URI, Expression<String>) - Constructor for class org.forgerock.openig.openam.TokenTransformationFilter
Constructs a new TokenTransformationFilter transforming the OpenID Connect id_token from idToken into a SAML 2.0 Assertions structure (into StsContext).
TokenTransformationFilter.Heaplet - Class in org.forgerock.openig.openam
Creates and initializes a token transformation filter in a heap environment.
toKeyPair() - Method in class org.forgerock.json.jose.jwk.EcJWK
Converts the JWK to a KeyPair.
toKeyPair() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk
Converts the JWK to a key pair.
toKeyPair() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Converts the JWK to a key-pair.
toKeyPair() - Method in class org.forgerock.json.jose.jwk.RsaJWK
Create a KeyPair using the JWK.
toLdif(Entry) - Static method in class org.forgerock.opendj.ldap.Entries
Returns the LDIF representation of entry.
toLdif(Entry) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns the LDIF representation of entry.
toLdif(ChangeRecord) - Static method in class org.forgerock.opendj.ldif.Ldif
Returns the LDIF representation of change.
toLong() - Method in class org.forgerock.opendj.ldap.ByteString
Returns the long value represented by the first eight bytes of this byte string in big-endian order.
toLowerCase(String) - Static method in class org.forgerock.openig.el.Functions
Converts all of the characters in a string to lower case.
toMetricRegistry(MeterRegistry) - Static method in class org.forgerock.monitoring.dropwizard.DropwizardTypes
Converts a MeterRegistry to a MetricRegistry.
toNormalizedByteString() - Method in class org.forgerock.opendj.ldap.Dn
Retrieves a normalized byte string representation of this DN.
toNormalizedUrlSafeString() - Method in class org.forgerock.opendj.ldap.Dn
Retrieves a normalized string representation of this DN.
TOO_LATE - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that a cancel request was unsuccessful because processing on the targeted operation had already reached a point at which it could not be canceled.
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").
toOffsetDateTime() - Method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a OffsetDateTime representation of this generalized time.
toPercentHexString() - Method in class org.forgerock.opendj.ldap.ByteString
Returns a string representation of the contents of this byte sequence using hexadecimal characters and a percent prefix (%) before each char.
toPrivateKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Converts the JWK to a private key object.
toPublicJwk() - Method in class org.forgerock.json.jose.jwk.JWK
For asymmetric keys, get the public JWK representation of this JWK.
toPublicKey() - Method in class org.forgerock.json.jose.jwk.EcJWK
 
toPublicKey() - Method in interface org.forgerock.json.jose.jwk.EllipticCurveJwk
Converts the public claims in the JWK into a public key.
toPublicKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK
 
toQueryString() - Method in class org.forgerock.http.protocol.Form
Returns this form in a URL-encoded query string.
toRequestEntity(Request) - Method in class org.forgerock.http.protocol.Form
Populates a request with the necessary headers and entity for the form to be submitted as a POST with application/x-www-form-urlencoded content type.
toRequestQuery(Request) - Method in class org.forgerock.http.protocol.Form
Sets a request URI with query parameters.
toRSAPrivateKey() - Method in class org.forgerock.json.jose.jwk.RsaJWK
Creates a RSAPrivateKey from the JWK.
toRSAPublicKey() - Method in class org.forgerock.json.jose.jwk.RsaJWK
Creates a RSAPublicKey from the JWK.
toSchema() - Method in class org.forgerock.opendj.ldap.schema.SchemaBuilder
Returns a strict Schema containing all of the schema elements contained in this schema builder as well as the same set of schema compatibility options.
toSecretKey() - Method in class org.forgerock.json.jose.jwk.OctJWK
Returns the key as a secret key.
toSet(int) - Static method in enum org.forgerock.opendj.ldap.controls.PersistentSearchChangeType
Returns the set of enum values corresponding to the encoded persistent change types.
toSIAbbreviation(TimeUnit) - Static method in class org.forgerock.openig.util.StringUtil
Return the SI abbreviation from the given TimeUnit name.
toString() - Method in class org.forgerock.audit.events.AuditEvent
toString() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
 
toString() - Method in class org.forgerock.config.resolvers.ChainedPropertyResolver
 
toString() - Method in class org.forgerock.config.resolvers.EnvironmentVariableResolver
 
toString() - Method in class org.forgerock.config.resolvers.FlatFileResolver
 
toString() - Method in class org.forgerock.config.resolvers.JsonValueResolver
 
toString() - Method in class org.forgerock.config.resolvers.ProductPathResolver
 
toString() - Method in class org.forgerock.config.resolvers.PropertiesResolver
 
toString() - Method in class org.forgerock.config.resolvers.SystemPropertyResolver
 
toString() - Method in class org.forgerock.http.filter.CsrfFilter.Builder
 
toString() - Method in class org.forgerock.http.filter.throttling.ThrottlingRate
 
toString() - Method in class org.forgerock.http.header.authorization.BasicCredentials
 
toString(Charset) - Method in class org.forgerock.http.header.authorization.BasicCredentials
Get the string credentials in the specified charset.
toString() - Method in class org.forgerock.http.header.authorization.BearerToken
 
toString() - Method in class org.forgerock.http.header.Directive
 
toString() - Method in class org.forgerock.http.header.Warning
Formats a Warning header value, according to RFC 2616 14.46.
toString() - Method in class org.forgerock.http.header.WwwAuthenticateHeader.Challenge
 
toString() - Method in class org.forgerock.http.MutableUri
 
toString() - Method in class org.forgerock.http.oauth2.OAuth2Error
 
toString() - Method in enum org.forgerock.http.protocol.Cookie.SameSite
 
toString() - Method in class org.forgerock.http.protocol.Cookie
 
toString() - Method in class org.forgerock.http.protocol.Entity
Returns 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 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 class org.forgerock.json.jose.jwk.OkpJWK.OctetECPrivateKey
 
toString() - Method in class org.forgerock.json.jose.jwk.OkpJWK.OctetECPublicKey
 
toString() - Method in class org.forgerock.json.jose.jwk.OkpJWK
 
toString() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm
Turns the JwsAlgorithm constant into a JSON value string.
toString() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithmType
Turns the JwsAlgorithmType constant into a JSON value string.
toString() - Method in enum org.forgerock.json.jose.jws.JwsHeaderKey
Turns the JwsHeaderKey constant into a lowercase String.
toString() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
 
toString() - Method in class org.forgerock.json.jose.jwt.JWObject
Returns a string representation of the JWObject.
toString() - Method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey
Turns the JwtClaimsSetKey constant into a lowercase String.
toString() - Method in enum org.forgerock.json.jose.jwt.JwtHeaderKey
Turns the JwtHeaderKey constant into a lowercase String.
toString() - Method in class org.forgerock.json.JsonPointer
Returns the JSON pointer string value.
toString() - Method in class org.forgerock.json.JsonValue
Returns a string representation of the JSON value.
toString() - Method in class org.forgerock.json.resource.AdviceWarning
 
toString() - Method in class org.forgerock.json.resource.FilterChain
 
toString() - Method in class org.forgerock.json.resource.PatchOperation
 
toString() - Method in class org.forgerock.json.resource.ResourcePath
Returns the URL path encoded string representation of this resource path.
toString() - Method in class org.forgerock.json.resource.Router.UriTemplate
Return the string representation of the UriTemplate.
toString() - Method in class org.forgerock.json.resource.SortKey
Returns the string representation of this sort key.
toString() - Method in 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.monitoring.api.instrument.CountAtValue
 
toString() - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
toString() - Method in class org.forgerock.monitoring.api.instrument.ImmutableTag
 
toString() - Method in class org.forgerock.monitoring.api.instrument.Measurement
 
toString() - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
 
toString() - Method in class org.forgerock.monitoring.api.instrument.ValueAtPercentile
 
toString() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableCounter
 
toString() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableGauge
 
toString() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
toString() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
toString() - Method in class org.forgerock.opendj.grizzly.GrizzlyLdapSocketAcceptor
 
toString() - Method in class org.forgerock.opendj.ldap.AbstractAttribute
 
toString() - Method in class org.forgerock.opendj.ldap.AbstractConnection
toString() - Method in class org.forgerock.opendj.ldap.AbstractConnectionWrapper
toString() - Method in class org.forgerock.opendj.ldap.AbstractEntry
 
toString() - Method in class org.forgerock.opendj.ldap.AddressMask
Returns the string representation of this address mask.
toString() - Method in interface org.forgerock.opendj.ldap.Attribute
Returns a string representation of this attribute.
toString() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns the string representation of this attribute description as defined in RFC4512 section 2.5.
toString() - Method in class org.forgerock.opendj.ldap.AttributeFilter
 
toString() - Method in class org.forgerock.opendj.ldap.Ava
 
toString() - Method in interface org.forgerock.opendj.ldap.ByteSequence
Returns the UTF-8 decoded string representation of this byte sequence.
toString() - Method in class org.forgerock.opendj.ldap.ByteSequenceReader
 
toString() - Method in class org.forgerock.opendj.ldap.ByteString
 
toString() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
 
toString() - Method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the string representation of this condition result.
toString() - Method in class org.forgerock.opendj.ldap.ConsistentHashMap
 
toString() - Method in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.AssertionRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.AuthorizationIdentityResponseControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.EntryChangeNotificationResponseControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.GenericControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.GetEffectiveRightsRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.ManageDsaItRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.MatchedValuesRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiredResponseControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PasswordExpiringResponseControl
 
toString() - Method in enum org.forgerock.opendj.ldap.controls.PasswordPolicyErrorType
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PasswordPolicyResponseControl
 
toString() - Method in enum org.forgerock.opendj.ldap.controls.PasswordPolicyWarningType
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl
 
toString() - Method in enum org.forgerock.opendj.ldap.controls.PersistentSearchChangeType
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PersistentSearchRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PostReadRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PostReadResponseControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PreReadRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.PreReadResponseControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV1RequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.RelaxRulesRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.ServerSideSortResponseControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.SimplePagedResultsControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.SubentriesRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.SubtreeDeleteRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewRequestControl
 
toString() - Method in class org.forgerock.opendj.ldap.controls.VirtualListViewResponseControl
 
toString() - Method in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
Returns the string representation of this alias dereferencing policy.
toString() - Method in class org.forgerock.opendj.ldap.Dn
Returns the RFC 4514 string representation of this DN.
toString() - Method in interface org.forgerock.opendj.ldap.Entry
Returns a string representation of this entry.
toString() - Method in class org.forgerock.opendj.ldap.Filter
Returns a String whose contents is the LDAP string representation of this Filter.
toString() - Method in class org.forgerock.opendj.ldap.GeneralizedTime
 
toString() - Method in class org.forgerock.opendj.ldap.GserParser
Returns the GSER encoded String value.
toString() - Method in exception org.forgerock.opendj.ldap.LdapException
 
toString() - Method in class org.forgerock.opendj.ldap.LdapServer
 
toString() - Method in class org.forgerock.opendj.ldap.LdapUrl
 
toString() - Method in class org.forgerock.opendj.ldap.Matcher
 
toString() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest
 
toString() - Method in class org.forgerock.opendj.ldap.messages.AbstractExtendedResult
 
toString() - Method in class org.forgerock.opendj.ldap.messages.AbstractIntermediateResponse
 
toString() - Method in class org.forgerock.opendj.ldap.messages.InvalidRequest
 
toString() - Method in class org.forgerock.opendj.ldap.messages.UnknownRequest
 
toString() - Method in class org.forgerock.opendj.ldap.Modification
 
toString() - Method in class org.forgerock.opendj.ldap.ModificationType
Returns the string representation of this modification change type.
toString() - Method in class org.forgerock.opendj.ldap.Rdn
Returns the RFC 4514 string representation of this RDN.
toString() - Method in class org.forgerock.opendj.ldap.ResultCode
Returns the string representation of this result code.
toString() - Method in class org.forgerock.opendj.ldap.RootDse
 
toString() - Method in enum org.forgerock.opendj.ldap.schema.AttributeUsage
Retrieves a string representation of this attribute usage.
toString() - Method in enum org.forgerock.opendj.ldap.schema.ObjectClassType
Retrieves a string representation of this objectclass type.
toString() - Method in class org.forgerock.opendj.ldap.schema.Schema
 
toString() - Method in class org.forgerock.opendj.ldap.SearchScope
Returns the string representation of this search scope as defined in RFC 4516.
toString() - Method in class org.forgerock.opendj.ldap.SortKey
Returns a string representation of this sort key using the format defined in SortKey.valueOf(String).
toString(ChangeRecord) - Static method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
Returns the LDIF string representation of the provided change record.
toString(Entry) - Static method in class org.forgerock.opendj.ldif.LdifEntryWriter
Returns the LDIF string representation of the provided entry.
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.openig.tools.am.Version
 
toString() - Method in class org.forgerock.openig.tools.notifications.Notification
 
toString() - Method in enum org.forgerock.secrets.keys.KeyUsage
 
toString() - Method in class org.forgerock.secrets.keystore.KeyStoreSecretStore
 
toString() - Method in class org.forgerock.secrets.Purpose
 
toString() - Method in class org.forgerock.secrets.Secret
 
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
 
total() - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
total(TimeUnit) - Method in class org.forgerock.monitoring.api.instrument.HistogramSnapshot
 
totalAmount() - Method in interface org.forgerock.monitoring.api.instrument.DistributionSummary
The total amount of all recorded events since this summary was created.
totalAmount() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableMeter
 
totalTime(TimeUnit) - Method in interface org.forgerock.monitoring.api.instrument.Timer
The total time of recorded events.
totalTime(TimeUnit) - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableTimer
 
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.
toUuid() - Method in class org.forgerock.opendj.ldap.Dn
Returns a UUID whose content is based on the normalized content of this DN.
toWarnings(List<String>) - Static method in class org.forgerock.http.header.WarningHeader
Matches warning-headers from a List of header-values.
toWWWAuthenticateHeader() - Method in class org.forgerock.http.oauth2.OAuth2Error
Deprecated.
toX509KeyUsageBits(Set<KeyUsage>) - Static method in enum org.forgerock.secrets.keys.KeyUsage
Converts a set of key usage values to an X.509 KeyUsage constraint bit string.
toXECKeyPair() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Returns a KeyPair object containing the XECPrivateKey and XECPublicKey for this JWK.
toXECPublicKey() - Method in class org.forgerock.json.jose.jwk.OkpJWK
Converts the JWK to a Java 11 XECPublicKey instance.
TRACKING_IDS - Static variable in class org.forgerock.audit.events.AuditEventBuilder
Tracking IDs event payload field name.
trackingId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder
Adds an entry to trackingIds for the event.
trackingIds(Set<String>) - Method in class org.forgerock.audit.events.AuditEventBuilder
Adds the specified entries to trackingIds for the event.
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.
TransactionIdInboundFilter(BooleanSupplier) - Constructor for class org.forgerock.http.filter.TransactionIdInboundFilter
Constructor that defines whether or not HTTP request transaction ID headers should be trusted.
TransactionIdOutboundFilter - Class in org.forgerock.http.filter
This filter aims to create a sub-transaction's id and inserts that value as a header of the request.
TransactionIdOutboundFilter() - Constructor for class org.forgerock.http.filter.TransactionIdOutboundFilter
 
transform(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.
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.
TransportProvider - Interface in org.forgerock.opendj.ldap.spi
Interface for ldap socket providers, which provide implementation for LdapSocket class, using a specific transport.
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.
TreeMapEntry - Class in org.forgerock.opendj.ldap
An implementation of the Entry interface which uses a TreeMap for storing attributes.
TreeMapEntry() - Constructor for class org.forgerock.opendj.ldap.TreeMapEntry
Creates an entry with an empty (root) distinguished name and no attributes.
TreeMapEntry(Dn) - Constructor for class org.forgerock.opendj.ldap.TreeMapEntry
Creates an empty entry using the provided distinguished name and no attributes.
TreeMapEntry(String) - Constructor for class org.forgerock.opendj.ldap.TreeMapEntry
Creates an empty entry using the provided distinguished name decoded using the default schema.
TreeMapEntry(String...) - Constructor for class org.forgerock.opendj.ldap.TreeMapEntry
Creates a new entry using the provided lines of LDIF decoded using the default schema.
trim(String) - Static method in class org.forgerock.openig.el.Functions
Returns a copy of a string with leading and trailing whitespace omitted.
trimToSize() - Method in class org.forgerock.opendj.ldap.ByteStringBuilder
Attempts to reduce storage used for this byte string builder.
TRUE - Static variable in class org.forgerock.util.query.QueryFilterOperators
a literal "true".
trustAll() - Static method in class org.forgerock.opendj.security.TrustManagers
Returns an X509TrustManager which trusts all certificates.
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
 
TrustManagers - Class in org.forgerock.opendj.security
This class contains methods for creating common types of trust manager.
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.
tryWith(Single<C>, Function<? super C, Flowable<T>>) - Static method in class org.forgerock.opendj.ldap.Utils
Constructs a Flowable based upon a given Closeable and a Function mapper.
tryWithSingle(Single<C>, Function<? super C, Single<T>>) - Static method in class org.forgerock.opendj.ldap.Utils
Constructs a Single based upon a given Closeable and a Function mapper.
typ(JwtType) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder
Sets the type of the contents of the Claims Set.
TYPE - Static variable in class org.forgerock.json.schema.validator.Constants
The type field name.
type(ObjectClassType) - Method in class org.forgerock.opendj.ldap.schema.ObjectClass.Builder
Sets the type of this object class.
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_AUTHENTICATION_SASL - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the AuthenticationChoice element in a bind request when SASL authentication is to be used.
TYPE_AUTHENTICATION_SIMPLE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the AuthenticationChoice element in a bind request when simple authentication is to be used.
TYPE_BOOLEAN - Static variable in class org.forgerock.json.schema.validator.Constants
The boolean type.
TYPE_CONTROL_SEQUENCE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for encoding the sequence of controls in an LDAP message.
TYPE_EXTENDED_REQUEST_OID - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the OID of an extended request.
TYPE_EXTENDED_REQUEST_VALUE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the value of an extended request.
TYPE_EXTENDED_RESPONSE_OID - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the OID of an extended response.
TYPE_EXTENDED_RESPONSE_VALUE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the value of an extended response.
TYPE_FILTER_AND - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for AND filter components.
TYPE_FILTER_APPROXIMATE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for approximate filter components.
TYPE_FILTER_EQUALITY - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for equality filter components.
TYPE_FILTER_EXTENSIBLE_MATCH - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for extensible matching filter components.
TYPE_FILTER_GREATER_OR_EQUAL - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for greater than or equal to filter components.
TYPE_FILTER_LESS_OR_EQUAL - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for less than or equal to filter components.
TYPE_FILTER_NOT - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for NOT filter components.
TYPE_FILTER_OR - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for OR filter components.
TYPE_FILTER_PRESENCE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for presence filter components.
TYPE_FILTER_SUBSTRING - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for substring filter components.
TYPE_INTEGER - Static variable in class org.forgerock.json.schema.validator.Constants
The integer type.
TYPE_INTERMEDIATE_RESPONSE_OID - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the OID of an intermediate response message.
TYPE_INTERMEDIATE_RESPONSE_VALUE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the value of an intermediate response message.
TYPE_MASK_CONSTRUCTED - Static variable in class org.forgerock.opendj.io.Asn1
The bitmask that can be ANDed with the BER type to determine if the element is constructed.
TYPE_MASK_CONTEXT - Static variable in class org.forgerock.opendj.io.Asn1
The bitmask that can be ANDed with the BER type to determine if the element is in the context-specific class.
TYPE_MATCHING_RULE_DN_ATTRIBUTES - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the DN attributes flag in a matching rule assertion.
TYPE_MATCHING_RULE_ID - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the matching rule OID in a matching rule assertion.
TYPE_MATCHING_RULE_TYPE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the attribute type in a matching rule assertion.
TYPE_MATCHING_RULE_VALUE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the assertion value in a matching rule assertion.
TYPE_MODIFY_DN_NEW_SUPERIOR - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the newSuperior component of a modify DN request.
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_REFERRAL_SEQUENCE - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for encoding the sequence of referral URLs in an LDAPResult element.
TYPE_SERVER_SASL_CREDENTIALS - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the server SASL credentials in a bind response.
TYPE_STRING - Static variable in class org.forgerock.json.schema.validator.Constants
The string type.
TYPE_SUBANY - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the subAny component(s) of a substring filter.
TYPE_SUBFINAL - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the subFinal components of a substring filter.
TYPE_SUBINITIAL - Static variable in class org.forgerock.opendj.io.Ldap
The BER type to use for the subInitial component of a substring filter.
typesOnly(boolean) - Method in class org.forgerock.opendj.ldap.AttributeFilter
Specifies whether filtered attributes are to contain both attribute descriptions and values, or just attribute descriptions.
TyrusNotificationService - Class in org.forgerock.openig.tools.notifications.ws
Implements a web-socket client bound to Tyrus container.
TyrusNotificationService(URI, IdGenerator, ClientEndpointConfig.Configurator, Duration, TlsOptions) - Constructor for class org.forgerock.openig.tools.notifications.ws.TyrusNotificationService
Constructs a web-socket client with the given uri, ID generator, configurator and reconnection delay.

U

uma(String) - Method in class org.forgerock.openig.tools.am.AmService
Build the endpoint URI for an endpoint located in the /uma namespace.
uma(String) - Method in class org.forgerock.openig.tools.am.UriService
Build the endpoint URI for an endpoint located in the /uma namespace.
UmaClassAliasResolver - Class in org.forgerock.openig.uma
Register all the aliases supported by the openig-uma module.
UmaClassAliasResolver() - Constructor for class org.forgerock.openig.uma.UmaClassAliasResolver
 
UmaException - Exception in org.forgerock.openig.uma
UMA Resource Server specific exception thrown when unrecoverable errors are happening.
UmaException(String) - Constructor for exception org.forgerock.openig.uma.UmaException
Creates a new UmaException with the given message.
UmaException(String, Throwable) - Constructor for exception org.forgerock.openig.uma.UmaException
Creates a new UmaException with the given message and the given cause.
UmaResourceServerFilter - Class in org.forgerock.openig.uma
An UmaResourceServerFilter implements a PEP (Policy Enforcement Point) and is responsible to ensure the incoming requests (from requesting parties) all have a valid RPT (Request Party Token) with the required set of scopes.
UmaResourceServerFilter(UmaSharingService, Handler, String) - Constructor for class org.forgerock.openig.uma.UmaResourceServerFilter
Constructs a new UmaResourceServerFilter.
UmaResourceServerFilter.Heaplet - Class in org.forgerock.openig.uma
Creates and initializes an UMA resource server filter in a heap environment.
UmaSharingService - Class in org.forgerock.openig.uma
An UmaSharingService provides core UMA features to the Identity Gateway when acting as an UMA Resource Server.
UmaSharingService.Heaplet - Class in org.forgerock.openig.uma
Creates and initializes an UMA service in a heap environment.
umaUri(String) - Method in class org.forgerock.openig.tools.am.AmService
Build the endpoint URI for an endpoint located in the /uma namespace.
umaUri(String) - Method in class org.forgerock.openig.tools.am.UriService
Build the endpoint URI for an endpoint located in the /uma namespace.
UNAUTHORIZED - Static variable in class org.forgerock.http.protocol.Status
The request requires user authentication.
UNAVAILABLE - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the resource is temporarily unable to handle the request.
UNAVAILABLE - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that either the entire server or one or more required resources were not available for use in processing the request.
UNAVAILABLE_CRITICAL_EXTENSION - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it included a critical extension that is unsupported or inappropriate for that request.
UnbindRequest - Interface in org.forgerock.opendj.ldap.messages
The Unbind operation allows a client to terminate an LDAP session.
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.
uncloseable(Connection) - Static method in class org.forgerock.opendj.ldap.Connections
Returns an uncloseable view of the provided connection.
uncloseable(ConnectionFactory) - Static method in class org.forgerock.opendj.ldap.Connections
Returns an uncloseable view of the provided connection factory.
uncloseable(LdapClientSocket) - Static method in class org.forgerock.opendj.ldap.LdapClients
Returns an uncloseable view of the provided socket.
UNDEFINED - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that should only be used if the actual result code has not yet been determined.
UNDEFINED_ASSERTION - Static variable in interface org.forgerock.opendj.ldap.Assertion
An assertion that always return UNDEFINED for matches and that creates a match all query.
UNDEFINED_ATTRIBUTE_TYPE - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the requested operation failed because it referenced an attribute that is not defined in the server schema.
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 - Static variable in class org.forgerock.json.schema.validator.Constants
The uniqueItems field name.
UNIVERSAL_BIT_STRING_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal bit string type.
UNIVERSAL_BOOLEAN_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal Boolean element.
UNIVERSAL_ENUMERATED_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal enumerated type.
UNIVERSAL_INTEGER_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal integer type.
UNIVERSAL_NULL_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal null type.
UNIVERSAL_OCTET_STRING_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal octet string type.
UNIVERSAL_PRINTABLE_STRING_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal Printable String type.
UNIVERSAL_SEQUENCE_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal sequence type.
UNIVERSAL_SET_TYPE - Static variable in class org.forgerock.opendj.io.Asn1
The BER type that is assigned to the universal set type.
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.
UNKNOWN - Static variable in interface org.forgerock.openig.filter.oauth2.ConfirmationKeyVerifier
Verifier that always fail because verification method is not supported.
UNKNOWN_MATCHING_RULE_HANDLER - Static variable in class org.forgerock.opendj.ldap.schema.SchemaOptions
Specifies the unknown matching rule handler which will be invoked when a non-strict schema is queried about an unknown matching rule.
UnknownRequest - Class in org.forgerock.opendj.ldap.messages
Wraps a message that the LdapServer was unable to decode because it did not recognize it.
UnknownSchemaElementException - Exception in org.forgerock.opendj.ldap.schema
Thrown when a schema query fails because the requested schema element could not be found or is ambiguous.
UnknownSchemaElementException(LocalizableMessage) - Constructor for exception org.forgerock.opendj.ldap.schema.UnknownSchemaElementException
Creates a new unknown schema element exception with the provided message.
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.
unmodifiableAbandonRequest(AbandonRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable abandon request of the provided request.
unmodifiableAddRequest(AddRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable add request of the provided request.
unmodifiableAttribute(Attribute) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a read-only view of attribute.
unmodifiableBindRequest(BindRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable bind request of the provided request.
unmodifiableBindResult(BindResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable bind result using the provided response.
unmodifiableCancelExtendedRequest(CancelExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable cancel extended request of the provided request.
UnmodifiableCollection - Interface in org.forgerock.http.util
An marker interface for tagging collection implementations as read-only.
unmodifiableCompareRequest(CompareRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable compare request of the provided request.
unmodifiableCompareResult(CompareResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable compare result using the provided response.
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.
unmodifiableDeleteRequest(DeleteRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable delete request of the provided request.
unmodifiableEntry(Entry) - Static method in class org.forgerock.opendj.ldap.Entries
Returns a read-only view of entry and its attributes.
unmodifiableGenericExtendedRequest(GenericExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable generic extended request of the provided request.
unmodifiableGenericExtendedResult(GenericExtendedResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable generic extended result using the provided response.
unmodifiableGenericIntermediateResponse(GenericIntermediateResponse) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable generic intermediate response using the provided response.
unmodifiableModifyDnRequest(ModifyDnRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable modify DN request of the provided request.
unmodifiableModifyRequest(ModifyRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable modify request of the provided request.
unmodifiablePasswordModifyExtendedRequest(PasswordModifyExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable password modify extended request of the provided request.
unmodifiablePasswordModifyExtendedResult(PasswordModifyExtendedResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable password modify extended result using the provided response.
unmodifiableResult(Result) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable result using the provided response.
unmodifiableSearchRequest(SearchRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable search request of the provided request.
unmodifiableSearchResultEntry(SearchResultEntry) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable search result entry using the provided response.
unmodifiableSearchResultReference(SearchResultReference) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable search result reference using the provided response.
unmodifiableStartTlsExtendedRequest(StartTlsExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable startTLS extended request of the provided request.
unmodifiableUnbindRequest(UnbindRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable unbind request of the provided request.
unmodifiableWhoAmIExtendedRequest(WhoAmIExtendedRequest) - Static method in class org.forgerock.opendj.ldap.messages.Requests
Creates an unmodifiable new Who Am I extended request of the provided request.
unmodifiableWhoAmIExtendedResult(WhoAmIExtendedResult) - Static method in class org.forgerock.opendj.ldap.messages.Responses
Creates an unmodifiable who am I extended result using the provided response.
unquote(String) - Static method in class org.forgerock.http.header.HeaderUtil
Unquotes a string following the logic of HeaderUtil.quote(String).
unrecognized(byte, ByteString) - Static method in class org.forgerock.opendj.ldap.Filter
Creates a new unrecognized filter using the provided ASN1 filter tag and content.
unregister() - Method in class org.forgerock.openig.http.EndpointRegistry.Registration
Un-register the endpoint.
unregister() - Method in interface org.forgerock.openig.tools.notifications.NotificationService.Registration
Un-register the connection event listener.
unregisterFactory(String) - Method in class org.forgerock.openig.script.DefaultScriptFactoryManager
Un-registers the factory for the given mimeType.
UNRESOLVED - Static variable in interface org.forgerock.openig.resolver.Resolver
Singleton that is returned to indicate an element is not resolved by a resolver.
unsubscribe() - Method in interface org.forgerock.openig.tools.notifications.Subscription
Un-subscribes from the topic asynchronously.
UNSUPPORTED_MEDIA_TYPE - Static variable in class org.forgerock.http.protocol.Status
The 415 (Unsupported Media Type) status code indicates that the origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.
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.
UNWILLING_TO_PERFORM - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the server is unwilling to perform the requested operation.
unwrap(JsonValue, String) - Static method in class org.forgerock.openig.tools.userprofile.UserProfile
Utility method to unwrap a profile attribute that is wrapped in a JSON array.
unwrapKey(ByteSequence) - Method in interface org.forgerock.opendj.security.ExternalKeyWrappingStrategy
Unwraps the provided wrapped key.
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.
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.
updateSession(OAuth2Session) - Method in class org.forgerock.openig.filter.oauth2.client.OAuth2SessionContext
Replace the existing managed session (if any) with the provided one (can be null).
UPGRADE_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.
upperCamelCase - Static variable in interface org.forgerock.monitoring.api.instrument.config.NamingConvention
 
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.
uriService(UriService) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Bind a UriService instance to this builder.
uriService(Realm) - Method in class org.forgerock.openig.tools.am.AmService
Provides an UriService instance that creates URI for the given realm.
UriService - Class in org.forgerock.openig.tools.am
Computes AM endpoint URIs, based on path normalizer, realm and a base Uri.
UriService(RealmNormalizer, Realm, URI) - Constructor for class org.forgerock.openig.tools.am.UriService
Constructs a new URI service.
uriTemplate(String) - Static method in class org.forgerock.json.resource.Router
Creates a Router.UriTemplate from a URI template string that will be used to match and route incoming requests.
UriUtils - Class in org.forgerock.openig.websocket
URI convenience methods.
url() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a uniform resource locator.
urlDecode(Object) - Static method in class org.forgerock.http.util.Paths
Returns the URL path decoding of the provided object's string representation.
urlDecode(String) - Static method in class org.forgerock.openig.el.Functions
Returns the URL decoding of the provided string.
urlDecodeFragment(String) - Static method in class org.forgerock.http.util.Uris
Decodes the provided URL encoded fragment as per RFC 3986.
urlDecodePathElement(String) - Static method in class org.forgerock.http.util.Uris
Decodes the provided URL encoded path element as per RFC 3986.
urlDecodeQueryParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris
Decodes the provided URL encoded query parameter name or value as per RFC 3986.
urlDecodeUserInfo(String) - Static method in class org.forgerock.http.util.Uris
Decodes the provided URL encoded userInfo as per RFC 3986.
urlEncode(Object) - Static method in class org.forgerock.http.util.Paths
Returns the URL path encoding of the provided object's string representation.
urlEncode(String) - Static method in class org.forgerock.openig.el.Functions
Returns the URL encoding of the provided string.
urlEncodeFragment(String) - Static method in class org.forgerock.http.util.Uris
URL encodes the provided fragment as per RFC 3986.
urlEncodePathElement(String) - Static method in class org.forgerock.http.util.Uris
URL encodes the provided path element as per RFC 3986.
urlEncodeQueryParameterNameOrValue(String) - Static method in class org.forgerock.http.util.Uris
URL encodes the provided query parameter name or value as per RFC 3986.
urlEncodeUserInfo(String) - Static method in class org.forgerock.http.util.Uris
URL encodes the provided userInfo as per RFC 3986.
usage(AttributeUsage) - Method in class org.forgerock.opendj.ldap.schema.AttributeType.Builder
Sets the usage indicator for this attribute type.
use - Variable in class org.forgerock.json.jose.jwk.JWK.Builder
The key use, optional.
USE_EMPTY_KEY_MANAGER - Static variable in class org.forgerock.opendj.security.SslOptions
Use an empty KeyManager while initializing an SSLContext.
USE_JVM_TRUST_MANAGER - Static variable in class org.forgerock.opendj.security.SslOptions
Use the JVM trust manager.
USE_PROXY - Static variable in class org.forgerock.http.protocol.Status
The 305 (Use Proxy) status code was defined in a previous version of this specification and is now deprecated (Appendix B).
USE_WRAP_UNWRAP_OPERATIONS - Static variable in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler
Indicates whether the handler should use Cipher.wrap(Key) and Cipher.unwrap(byte[], String, int) operations or normal encrypt/decrypt operations for encrypting the per-message symmetric AES key.
useJvmDefaultKeyManager() - Static method in class org.forgerock.opendj.security.KeyManagers
Creates a new X509KeyManager which will use the JVM's default keystore for retrieving certificates.
useKeyStoreFile(String) - Static method in class org.forgerock.opendj.security.KeyManagers
Creates a new X509KeyManager which will use the named key store file for retrieving certificates.
useKeyStoreFile(String, char[], String) - Static method in class org.forgerock.opendj.security.KeyManagers
Creates a new X509KeyManager which will use the named key store file for retrieving certificates.
useKeyStoreFile(String, char[], String, String) - Static method in class org.forgerock.opendj.security.KeyManagers
Creates a new X509KeyManager which will use the named key store file for retrieving certificates.
usePkcs11Token(char[]) - Static method in class org.forgerock.opendj.security.KeyManagers
Creates a new X509KeyManager which will use a PKCS#11 token for retrieving certificates.
USER_ID - Static variable in class org.forgerock.audit.events.AuditEventBuilder
User ID event payload field name.
userAgent(String) - Method in class org.forgerock.services.context.ClientContext.Builder
Sets the client's user agent.
userId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder
Sets the provided userId for the event.
UserProfile - Class in org.forgerock.openig.tools.userprofile
Class containing user profile information.
UserProfile(JsonValue) - Constructor for class org.forgerock.openig.tools.userprofile.UserProfile
Constructor taking the raw JsonValue.
UserProfileContext - Class in org.forgerock.openig.openam
Used by the UserProfileFilter to make the user's profile attributes available in the context.
UserProfileException - Exception in org.forgerock.openig.tools.userprofile
Represents an exception thrown whilst performing UserProfileService operations.
UserProfileException(String) - Constructor for exception org.forgerock.openig.tools.userprofile.UserProfileException
Builds an UserProfileException with a given message.
UserProfileException(String, Throwable) - Constructor for exception org.forgerock.openig.tools.userprofile.UserProfileException
Builds an UserProfileException with a given message and cause.
UserProfileFilter - Class in org.forgerock.openig.openam
This filter requests user profile attributes from Access Management and stores them in the context for later use.
UserProfileFilterHeaplet - Class in org.forgerock.openig.openam
Creates and initialises a user profile filter in a heap environment.
UserProfileFilterHeaplet() - Constructor for class org.forgerock.openig.openam.UserProfileFilterHeaplet
 
UserProfileService - Interface in org.forgerock.openig.tools.userprofile
The UserProfileService is responsible for requesting user profile attributes.
UserProfileServiceHeaplet - Class in org.forgerock.openig.openam
Creates and initializes a UserProfileService in a heap environment.
UserProfileServiceHeaplet() - Constructor for class org.forgerock.openig.openam.UserProfileServiceHeaplet
 
useSingleCertificate(String, X509KeyManager) - Static method in class org.forgerock.opendj.security.KeyManagers
Returns a new X509KeyManager which selects the named certificate from the provided X509KeyManager.
using(Function<JsonValue, Object, JsonValueException>) - Method in class org.forgerock.config.util.JsonValuePropertyEvaluator.CoercionFunctionSpecBuilder
Specify the function that will convert the matched JSON into an object.
usingSchema(Schema) - Method in class org.forgerock.opendj.ldap.AttributeParser
Sets the Schema which will be used when parsing schema sensitive values such as DNs and attribute descriptions.
USN_CHANGED_ATTR - Static variable in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
The name of the uSNChanged attribute as defined in the Active Directory schema.
Utils - Class in org.forgerock.json.jose.utils
This class provides utility methods to share common behaviour.
Utils - Class in org.forgerock.opendj.ldap
This class provides utility functions.
Utils - Class in org.forgerock.openig.tools
Utility class.
Utils - Class in org.forgerock.util
Deprecated.
Use Strings, Closeables, Objects or Threads instead.
uuid() - Static method in class org.forgerock.json.JsonValueFunctions
Returns the JSON string value as a universally unique identifier (UUID).

V

v(int) - Static method in class org.forgerock.openig.tools.am.Version
Builds a version from its components (minor set to 0, micro set to 0, no qualifier).
v(int, int) - Static method in class org.forgerock.openig.tools.am.Version
Builds a version from its components (micro set to 0, no qualifier).
v(int, int, int) - Static method in class org.forgerock.openig.tools.am.Version
Builds a version from its components.
validate() - Method in class org.forgerock.audit.events.AuditEventBuilder
Called by AuditEventBuilder.toEvent() to ensure that the audit event will be created in a valid state.
validate(PublicKey) - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve
Validates that the given public key is on this curve.
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.
validateEntry(Entry, SchemaValidationPolicy, Collection<LocalizableMessage>) - Method in class org.forgerock.opendj.ldap.schema.Schema
Returns true if the provided entry is valid according to this schema and the specified schema validation policy.
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.
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() - 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() - Method in class org.forgerock.monitoring.api.instrument.CountAtValue
 
value(TimeUnit) - Method in class org.forgerock.monitoring.api.instrument.CountAtValue
 
value() - Method in interface org.forgerock.monitoring.api.instrument.Gauge
Returns the current value.
value(TimeUnit) - Method in interface org.forgerock.monitoring.api.instrument.TimeGauge
 
value() - Method in class org.forgerock.monitoring.api.instrument.ValueAtPercentile
 
value(TimeUnit) - Method in class org.forgerock.monitoring.api.instrument.ValueAtPercentile
 
value() - Method in class org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableGauge
 
VALUE_PTR - Static variable in class org.forgerock.json.JsonPatch
Path to the "value" attribute of a patch entry.
ValueAtPercentile - Class in org.forgerock.monitoring.api.instrument
A precomputed percentile of a distribution.
valueExpression - Variable in class org.forgerock.openig.el.Expression
The underlying EL expression that this object represents.
valueIsAcceptable(ByteSequence, LocalizableMessageBuilder) - Method in class org.forgerock.opendj.ldap.schema.Syntax
Indicates whether the provided value is acceptable for use in an attribute with this syntax.
valueIsAcceptable(Schema, ByteSequence, LocalizableMessageBuilder) - Method in interface org.forgerock.opendj.ldap.schema.SyntaxImpl
Indicates whether the provided value is acceptable for use in an attribute with this syntax.
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.apache.async.AsyncHttpClientProvider.AsyncBehaviour
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(String) - Static method in class org.forgerock.http.header.AuthorizationHeader
Parse a string as an Authorization header value.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.AuthorizationHeader
Constructs a new header, initialized from the specified message.
valueOf(Message<?>) - Static method in class org.forgerock.http.header.ConnectionHeader
Constructs a new header, initialized from the specified message.
valueOf(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(Message<?>) - Static method in class org.forgerock.http.header.ReferrerHeader
Constructs a new header, initialized from the specified message.
valueOf(String) - Static method in class org.forgerock.http.header.ReferrerHeader
Parse the provided value as a Referrer header.
valueOf(String) - Static method in class org.forgerock.http.header.SetCookie2Header
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(Response) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader
Obtain a WwwAuthenticateHeader representation of the headers in the given response.
valueOf(List<String>) - Static method in class org.forgerock.http.header.WwwAuthenticateHeader
Obtain a WwwAuthenticateHeader representation of the given header values.
valueOf(String) - Static method in class org.forgerock.http.oauth2.OAuth2Error
Parses the provided OAuth2Error.toString() representation as an OAuth 2.0 error.
valueOf(String) - Static method in enum org.forgerock.http.protocol.Cookie.SameSite
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.http.protocol.Status.Family
Returns the enum constant of this type with the specified name.
valueOf(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(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.json.resource.SortKeyComparator.NullPosition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.monitoring.api.instrument.config.MeterFilterReply
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.monitoring.api.instrument.Meter.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.monitoring.api.instrument.Statistic
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.AddressMask
Parses the provided string as an address mask.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Parses the provided LDAP string representation of an attribute description using the default schema.
valueOf(String, Schema) - Static method in class org.forgerock.opendj.ldap.AttributeDescription
Parses the provided LDAP string representation of an attribute description using the provided schema.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.Ava
Parses the provided LDAP string representation of an AVA using the default schema.
valueOf(String, Schema) - Static method in class org.forgerock.opendj.ldap.Ava
Parses the provided LDAP string representation of an AVA using the provided schema.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the enum constant of this type with the specified name.
valueOf(boolean) - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns the condition result which is equivalent to the provided boolean value.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.ConnectionSecurity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.controls.PasswordPolicyErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.controls.PasswordPolicyWarningType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.controls.PersistentSearchChangeType
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum org.forgerock.opendj.ldap.controls.PersistentSearchChangeType
Returns the enum value that would return the provided argument value from its PersistentSearchChangeType.intValue method.
valueOf(int) - Static method in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
Returns the alias dereferencing policy having the specified integer value as defined in RFC 4511 section 4.5.1.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.Dn
Parses the provided LDAP string representation of a DN using the default schema.
valueOf(String, Schema) - Static method in class org.forgerock.opendj.ldap.Dn
Parses the provided LDAP string representation of a DN using the provided schema.
valueOf(ByteString) - Static method in class org.forgerock.opendj.ldap.Dn
Parses the provided LDAP string representation of a DN using the default schema.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.Entries.DiffStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.Entries.ReplaceStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.Filter.FilterType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.Filter
Parses the provided LDAP string representation of a filter as a Filter.
valueOf(Calendar) - Static method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a generalized time representing the provided Calendar.
valueOf(Date) - Static method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a generalized time representing the provided Date.
valueOf(long) - Static method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a generalized time representing the provided time in milliseconds since the epoch.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.GeneralizedTime
Parses the provided string as an LDAP generalized time.
valueOf(OffsetDateTime) - Static method in class org.forgerock.opendj.ldap.GeneralizedTime
Returns a generalized time representing the provided OffsetDateTime.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.LdapUrl
Parses the provided LDAP string representation of an LDAP URL using the default schema.
valueOf(String, Schema) - Static method in class org.forgerock.opendj.ldap.LdapUrl
Parses the provided LDAP string representation of an LDAP URL using the provided schema.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.Matcher.MatcherType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.messages.Request.RequestType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.ModificationType.Enum
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in class org.forgerock.opendj.ldap.ModificationType
Returns the modification change type having the specified integer value as defined in RFC 4511 section 4.6.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.Rdn
Parses the provided LDAP string representation of an RDN using the default schema.
valueOf(String, Schema) - Static method in class org.forgerock.opendj.ldap.Rdn
Parses the provided LDAP string representation of a RDN using the provided schema.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.ResultCode.Enum
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in class org.forgerock.opendj.ldap.ResultCode
Returns the result code having the specified integer value as defined in RFC 4511 section 4.1.9.
valueOf(Entry) - Static method in class org.forgerock.opendj.ldap.RootDse
Creates a new Root DSE instance backed by the provided entry.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.schema.AttributeUsage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.schema.ObjectClassType
Returns the enum constant of this type with the specified name.
valueOf(Entry) - Static method in class org.forgerock.opendj.ldap.schema.Schema
Parses the provided entry as a subschema subentry.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.schema.SchemaValidationPolicy.Action
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.ldap.SearchScope.Enum
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in class org.forgerock.opendj.ldap.SearchScope
Returns the search scope having the specified integer value as defined in RFC 4511 section 4.5.1.2.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.SearchScope
Returns the search scope having the specified name as defined in RFC 4511 section 4.5.1.2.
valueOf(String) - Static method in class org.forgerock.opendj.ldap.SortKey
Parses the provided string representation of a sort key as a SortKey.
valueOf(String) - Static method in enum org.forgerock.opendj.security.SslOptions.ClientAuthPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.decoration.capture.CapturePoint
Returns the enum constant of this type with the specified name.
valueOf(String, 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(Response) - 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.secrets.PropertyFormat
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.CachePolicyDecisionRequestHandler.DisconnectionStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.tools.notifications.ConnectionEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.openig.tools.session.CacheSessionService.DisconnectionStrategy
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.secrets.keys.KeyFormatRaw
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.keys.KeyType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.keys.KeyUsage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.secrets.propertyresolver.PropertyFormatBase64
Returns the enum constant of this type with the specified name.
valueOf(String) - 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.EnumValueOfHelper
Fast lookup of E by its name.
valueOf(String) - Method in class org.forgerock.util.query.QueryFilterParser
Parses the provided string representation of a query filter as a QueryFilter.
valueOf(String) - Static method in enum org.forgerock.util.thread.listener.ShutdownPriority
Returns the enum constant of this type with the specified name.
valueOfBase64(String) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing the Base64 decoded bytes of the provided string.
valueOfBytes(byte[]) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing the contents of the provided byte array.
valueOfBytes(byte[], int, int) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing a subsequence of the contents of the provided byte array.
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.
valueOfHex(String) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing the bytes of the provided hexadecimal string.
valueOfInt(int) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing the big-endian encoded bytes of the provided integer.
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.
valueOfLong(long) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing the big-endian encoded bytes of the provided long.
valueOfObject(Object) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string representation of the provided object.
valueOfUtf8(CharSequence) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing the UTF-8 encoded bytes of the provided char sequence.
valueOfUtf8(char[]) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string containing the UTF-8 encoded bytes of the provided char array.
valueOfWWWAuthenticateHeader(String) - Static method in class org.forgerock.http.oauth2.OAuth2Error
Parses the provided WWW-Authenticate header content as an OAuth 2.0 error.
values() - Static method in enum org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.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.apache.async.AsyncHttpClientProvider.AsyncBehaviour
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.handler.HttpClientHandler.HostnameVerifier
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.protocol.Cookie.SameSite
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.forgerock.http.protocol.Headers
 
values() - Method in class org.forgerock.http.protocol.RequestCookies
 
values() - Static method in enum org.forgerock.http.protocol.Status.Family
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.routing.DefaultVersionBehaviour
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.http.routing.RoutingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithmType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwe.JweHeaderKey
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwk.KeyOperation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.jwk.KeyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.json.jose.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.json.resource.SortKeyComparator.NullPosition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.monitoring.api.instrument.config.MeterFilterReply
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.monitoring.api.instrument.Meter.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.monitoring.api.instrument.Statistic
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.ConditionResult
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.ConnectionSecurity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.controls.PasswordPolicyErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.controls.PasswordPolicyWarningType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.controls.PersistentSearchChangeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class org.forgerock.opendj.ldap.DereferenceAliasesPolicy
Returns an unmodifiable list containing the set of available alias dereferencing policies indexed on their integer value as defined in RFC 4511 section 4.5.1.
values() - Static method in enum org.forgerock.opendj.ldap.Entries.DiffStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.Entries.ReplaceStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.Filter.FilterType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.Matcher.MatcherType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.messages.Request.RequestType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.ModificationType.Enum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class org.forgerock.opendj.ldap.ModificationType
Returns an unmodifiable list containing the set of available modification change types indexed on their integer value as defined in RFC 4511 section 4.6.
values() - Static method in enum org.forgerock.opendj.ldap.ResultCode.Enum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class org.forgerock.opendj.ldap.ResultCode
Returns an unmodifiable list containing the set of available result codes indexed on their integer value as defined in RFC 4511 section 4.1.9.
values() - Static method in enum org.forgerock.opendj.ldap.schema.AttributeUsage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.schema.ObjectClassType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.schema.SchemaValidationPolicy.Action
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.ldap.SearchScope.Enum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class org.forgerock.opendj.ldap.SearchScope
Returns an unmodifiable list containing the set of available search scopes indexed on their integer value as defined in RFC 4511 section 4.5.1.2.
values() - Static method in enum org.forgerock.opendj.security.SslOptions.ClientAuthPolicy
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.secrets.PropertyFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.text.Separators
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.tools.CachePolicyDecisionRequestHandler.DisconnectionStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.tools.notifications.ConnectionEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.tools.session.CacheSessionService.DisconnectionStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.openig.util.MessageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.keys.KeyFormatRaw
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.keys.KeyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.keys.KeyUsage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.secrets.propertyresolver.PropertyFormatBase64
Returns an array containing the constants of this enum type, in the order they are declared.
values() - 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.
VerificationKey - Class in org.forgerock.secrets.keys
A key used for verifying digital signatures.
VerificationKey(SecretBuilder) - Constructor for class org.forgerock.secrets.keys.VerificationKey
Initialises the key with the given secret data.
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.EdDSASigningHandler
 
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(Context, AccessTokenInfo, JsonValue) - Method in class org.forgerock.openig.filter.oauth2.CertificateThumbprintConfirmationKeyVerifier
 
verify(Context, AccessTokenInfo, JsonValue) - Method in interface org.forgerock.openig.filter.oauth2.ConfirmationKeyVerifier
Verifies the given confirmation key value.
VERIFY - Static variable in class org.forgerock.secrets.Purpose
Indicates a key intended for verifying digital signatures or message authentication codes.
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 - 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(String) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Set the version and returns this builder.
version(Version) - Method in class org.forgerock.openig.tools.am.AmService.Builder
Set the version and returns this builder.
Version - Class in org.forgerock.openig.tools.am
Supports version with the following format: major[.minor[.micro]].
Version(int, int, int) - Constructor for class org.forgerock.openig.tools.am.Version
Constructs a new Version from its given components.
VERSION_MISMATCH - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the resource's current version does not match the version provided.
VERSION_REQUIRED - Static variable in exception org.forgerock.json.resource.ResourceException
Indicates that the resource requires a version, but no version was supplied in the request.
VersionUtil - Class in org.forgerock.openig.util
Utility class to retrieve version information about this project.
Violation - Class in org.forgerock.openig.tools.jwt
Describe a Violation, used for the JWT validation.
Violation(String) - Constructor for class org.forgerock.openig.tools.jwt.Violation
Creates a new Violation.
VIRTUAL_LIST_VIEW_ERROR - Static variable in class org.forgerock.opendj.ldap.ResultCode
The result code that indicates that the operation could not be processed because there was an error while processing the virtual list view control.
virtualAttribute(Attribute) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a view of attribute that is virtual, i.e.
virtualAttribute(AttributeDescription, Supplier<?>) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns a virtual attribute whose values will be supplied by provided Supplier.
virtualAttribute(AttributeDescription) - Static method in class org.forgerock.opendj.ldap.Attributes
Returns an empty virtual attribute.
VirtualListViewRequestControl - Class in org.forgerock.opendj.ldap.controls
The virtual list view request control as defined in draft-ietf-ldapext-ldapv3-vlv.
VirtualListViewResponseControl - Class in org.forgerock.opendj.ldap.controls
The virtual list view response control as defined in draft-ietf-ldapext-ldapv3-vlv.
VisibleForTesting - Annotation Type in org.forgerock.util.annotations
This annotation doesn't actually do anything, other than provide documentation of the fact that a function has either been marked public, or package private in order for a test (somewhere physically distant in the system) to compile.
visitActionRequest(P, ActionRequest) - Method in interface org.forgerock.json.resource.RequestVisitor
Visits an action request.
visitAndFilter(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.
visitAnyRequest(P, Request) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
Catch-all method visiting any request for which the visit method has not been overridden.
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.
visitRequest(P, AbandonRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, AddRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, BindRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, CompareRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, DeleteRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, ExtendedRequest<?>) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, InvalidRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, ModifyDnRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, ModifyRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, SearchRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, UnbindRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, UnknownRequest) - Method in class org.forgerock.opendj.ldap.messages.AbstractRequestVisitor
 
visitRequest(P, AbandonRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Abandon request.
visitRequest(P, AddRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Add request.
visitRequest(P, BindRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Bind request.
visitRequest(P, CompareRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Compare request.
visitRequest(P, DeleteRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Delete request.
visitRequest(P, ExtendedRequest<?>) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Extended request.
visitRequest(P, InvalidRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Invalid request.
visitRequest(P, ModifyDnRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an ModifyDN request.
visitRequest(P, ModifyRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Modify request.
visitRequest(P, SearchRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Search request.
visitRequest(P, UnbindRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Unbind request.
visitRequest(P, UnknownRequest) - Method in interface org.forgerock.opendj.ldap.messages.RequestVisitor
Visits an Unknown request.
visitRequest(P, AddRequest) - Method in class org.forgerock.opendj.ldif.ChangeRecordVisitor
 
visitRequest(P, DeleteRequest) - Method in class org.forgerock.opendj.ldif.ChangeRecordVisitor
 
visitRequest(P, ModifyRequest) - Method in class org.forgerock.opendj.ldif.ChangeRecordVisitor
 
visitRequest(P, ModifyDnRequest) - Method in class org.forgerock.opendj.ldif.ChangeRecordVisitor
 
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

wallTime() - Method in interface org.forgerock.monitoring.api.instrument.Clock
Current wall time in milliseconds since the epoch.
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.
WebSocketAdapterFilter - Class in org.forgerock.openig.websocket.grizzly
Top-level filter in the Grizzly filter chain.
WebSocketAdapterFilter() - Constructor for class org.forgerock.openig.websocket.grizzly.WebSocketAdapterFilter
 
WebSocketExchange - Class in org.forgerock.openig.websocket.grizzly
Message that initiates the web-socket connection establishment.
WebSocketExchange(Request, PromiseImpl<Response, NeverThrowsException>, HttpServletRequest) - Constructor for class org.forgerock.openig.websocket.grizzly.WebSocketExchange
Constructs a new exchange.
WebSocketProxyFilter - Class in org.forgerock.openig.websocket
A WebSocketProxyFilter detects WebSocket upgrade requests and, when found, connects to the protected application using a dedicated tunnel.
WebSocketProxyFilter(Options) - Constructor for class org.forgerock.openig.websocket.WebSocketProxyFilter
Constructs a new web-socket filter with the given set of Options.
websocketUri(String) - Method in class org.forgerock.openig.tools.am.UriService
Build a websocket URI, based on this server's baseUri.
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.
WHEN_CHANGED_ATTR - Static variable in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
The name of the whenChanged attribute as defined in the Active Directory schema.
WHEN_CREATED_ATTR - Static variable in class org.forgerock.opendj.ldap.controls.AdNotificationRequestControl
The name of the whenCreated attribute as defined in the Active Directory schema.
WhoAmIExtendedRequest - Interface in org.forgerock.opendj.ldap.messages
The who am I extended request as defined in RFC 4532.
WhoAmIExtendedResult - Interface in org.forgerock.opendj.ldap.messages
The who am I extended result as defined in RFC 4532.
WHOLE_SUBTREE - Static variable in class org.forgerock.opendj.ldap.SearchScope
The scope is constrained to the search base entry and to all its subordinates.
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.
WITH_CERTIFICATE - Static variable in class org.forgerock.secrets.keys.KeyFormatPem
Exports the key material with the certificate as well.
withAdditionalTopicSchemas(JsonValue) - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder
Specifies schemas for additional topics.
withAuditEventHandler(Class<? extends AuditEventHandler>, EventHandlerConfiguration) - Method in class org.forgerock.audit.AuditServiceBuilder
Register an AuditEventHandler.
withAuditEventHandler(AuditEventHandler) - Method in class org.forgerock.audit.AuditServiceBuilder
Register an AuditEventHandler.
withAuditEventHandlerFactory(AuditEventHandlerFactory) - Method in class org.forgerock.audit.AuditServiceBuilder
Register factory for creating instances of AuditEventHandler.
withAuditTopics(Collection<String>) - Method in class org.forgerock.audit.filter.FilterChainBuilder
Adds the topics this filter chain is for.
withBaseUnit(String) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
Generate a new id with a different base unit.
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.
withDefaultStore(Supplier<SecretStore<?>>) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder
Configure this service with a default SecretStore supplier.
withDependencyProvider(DependencyProvider) - Method in class org.forgerock.audit.AuditServiceBuilder
Register the DependencyProvider, after which, an AuditEventHandler can be registered and receive this provider.
withEncryptionPassword(SecretReference<GenericSecret>) - Method in class org.forgerock.secrets.keys.KeyFormatPem
Returns a new PEM key format that will encrypt private keys with the given password.
withEventTopicsMetaData(EventTopicsMetaData) - Method in class org.forgerock.audit.AuditServiceBuilder
Set the topic metadata that should be used by the audit service and the handlers.
withHeadlessAuthentication(Handler) - Method in class org.forgerock.openig.tools.am.AmService
Returns a Handler which wraps the HeadlessAuthenticationFilter.
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.
withOption(String) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an attribute description having the same attribute type and options as this attribute description as well as the provided option.
withOptions(Iterable<String>) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an attribute description having the same attribute type and options as this attribute description as well as the provided options.
withOptions(String...) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an attribute description having the same attribute type and options as this attribute description as well as the provided options.
WITHOUT_CERTIFICATE - Static variable in class org.forgerock.secrets.keys.KeyFormatPem
Exports the key material without any associated certificate.
withoutAnyOptions() - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an attribute description having the same attribute type as this attribute description except that all options has been removed.
withoutOption(String) - Method in class org.forgerock.opendj.ldap.AttributeDescription
Returns an attribute description having the same attribute type and options as this attribute description except for the provided option.
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(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.
withSecretsProvider(SecretsProvider) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder
Configure this service with the given provider.
withSecretsService(SecretsService) - Method in class org.forgerock.openig.secrets.DefaultSecretsService.Builder
Configure this service with the given parent secrets service.
withTag(Tag) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
Generate a new id with an additional tag.
withTag(Statistic) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
Generate a new id with an additional tag with a tag key of "statistic".
withTags(Iterable<Tag>) - Method in class org.forgerock.monitoring.api.instrument.Meter.Id
Generate a new id with a different set of tags.
withValues(Object...) - Method in class org.forgerock.opendj.ldap.Modification
Adds values to this modification's attribute.
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
 
wrap(Runnable) - Method in interface org.forgerock.monitoring.api.instrument.Timer
Wrap a Runnable so that it is timed when invoked.
wrap(Callable<T>) - Method in interface org.forgerock.monitoring.api.instrument.Timer
Wrap a Callable so that it is timed when invoked.
wrap(byte[]) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string that wraps the provided byte array.
wrap(byte[], int, int) - Static method in class org.forgerock.opendj.ldap.ByteString
Returns a byte string that wraps a subsequence of the provided byte array.
wrap(SecretStore<S>, ExecutorService) - Static method in class org.forgerock.secrets.ThreadPoolSecretStore
Wraps the given store in an asynchronous thread-pool executor using the given thread pool.
wrap(SecretStore<S>) - Static method in class org.forgerock.secrets.ThreadPoolSecretStore
Wraps the given store in an asynchronous thread-pool executor using the system ForkJoinPool.commonPool().
wrapKey(ByteSequence) - Method in interface org.forgerock.opendj.security.ExternalKeyWrappingStrategy
Wraps the provided encoded key.
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
 
WRITE_TIMEOUT_MS - Static variable in class org.forgerock.opendj.ldap.LdapServer
Maximum time allowed for write operations to complete.
writeAbandonRequest(int, AbandonRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided abandon request.
writeAddRequest(int, AddRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided add request.
writeAddResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided add result.
writeAttribute(Asn1Writer, Attribute) - Static method in class org.forgerock.opendj.io.Ldap
Writes an Attribute to the provided Asn1Writer.
writeBindRequest(int, BindRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided bind request.
writeBindResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided bind result.
writeBoolean(boolean) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeBoolean(boolean) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a boolean element using the Universal Boolean ASN.1 type tag.
writeBoolean(byte, boolean) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a boolean element using the provided type tag.
writeChangeRecord(AddRequest) - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Writes an Add change record.
writeChangeRecord(ChangeRecord) - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Writes a change record.
writeChangeRecord(DeleteRequest) - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Writes a Delete change record.
writeChangeRecord(ModifyDnRequest) - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Writes a ModifyDN change record.
writeChangeRecord(ModifyRequest) - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Writes a Modify change record.
writeChangeRecord(AddRequest) - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Writes the provided Add request to the underlying connection, blocking until the request completes.
writeChangeRecord(ChangeRecord) - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Writes the provided change record to the underlying connection, blocking until the request completes.
writeChangeRecord(DeleteRequest) - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Writes the provided Delete request to the underlying connection, blocking until the request completes.
writeChangeRecord(ModifyDnRequest) - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Writes the provided ModifyDN request to the underlying connection, blocking until the request completes.
writeChangeRecord(ModifyRequest) - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Writes the provided Modify request to the underlying connection, blocking until the request completes.
writeChangeRecord(AddRequest) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
writeChangeRecord(ChangeRecord) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
writeChangeRecord(DeleteRequest) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
writeChangeRecord(ModifyDnRequest) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
writeChangeRecord(ModifyRequest) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
writeComment(CharSequence) - Method in interface org.forgerock.opendj.ldif.ChangeRecordWriter
Writes a comment.
writeComment(CharSequence) - Method in class org.forgerock.opendj.ldif.ConnectionChangeRecordWriter
Connection change record writers do not support comments, so the provided comment will be ignored.
writeComment(CharSequence) - Method in class org.forgerock.opendj.ldif.ConnectionEntryWriter
Connection entry writers do not support comments, so the provided comment will be ignored.
writeComment(CharSequence) - Method in interface org.forgerock.opendj.ldif.EntryWriter
Writes a comment.
writeComment(CharSequence) - Method in class org.forgerock.opendj.ldif.LdifChangeRecordWriter
 
writeComment(CharSequence) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
 
writeCompareRequest(int, CompareRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided compare request.
writeCompareResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided compare result.
writeControl(Control) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided control.
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.
writeDeleteRequest(int, DeleteRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided delete request.
writeDeleteResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided delete result.
writeEndSequence() - Method in interface org.forgerock.opendj.io.Asn1Writer
Finishes writing a sequence element.
writeEndSet() - Method in interface org.forgerock.opendj.io.Asn1Writer
Finishes writing a set element.
writeEntry(Asn1Writer, Entry) - Static method in class org.forgerock.opendj.io.Ldap
Writes an Entry to the provided Asn1Writer.
writeEntry(Entry) - Method in class org.forgerock.opendj.ldif.ConnectionEntryWriter
Writes an entry to the underlying connection using an Add request, blocking until the request completes.
writeEntry(Entry) - Method in interface org.forgerock.opendj.ldif.EntryWriter
Writes an entry.
writeEntry(Entry) - Method in class org.forgerock.opendj.ldif.LdifEntryWriter
 
writeEnumerated(int) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeEnumerated(byte, int) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an enumerated element using the provided type tag.
writeEnumerated(int) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an enumerated element using the Universal Enumerated ASN.1 type tag.
writeExtendedRequest(int, ExtendedRequest<?>) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided extended request.
writeExtendedResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided extended result.
writeFilter(Asn1Writer, Filter) - Static method in class org.forgerock.opendj.io.Ldap
Writes a Filter to the provided Asn1Writer.
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.
writeInteger(int) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeInteger(long) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeInteger(byte, int) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an integer element using the provided type tag.
writeInteger(byte, long) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an integer element using the provided type tag.
writeInteger(int) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an integer element using the Universal Integer ASN.1 type tag.
writeInteger(long) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an integer element using the Universal Integer ASN.1 type tag.
writeIntermediateResponse(int, IntermediateResponse) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided intermediate response.
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.
writeLdapMessage(LdapMessage) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided LDAP message.
writeLength(ByteBuffer, int) - Static method in class org.forgerock.json.jose.utils.DerUtils
Writes a length field to the output.
writeModification(Asn1Writer, Modification) - Static method in class org.forgerock.opendj.io.Ldap
Writes an Modification to the provided Asn1Writer.
writeModifyDnRequest(int, ModifyDnRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided modify DN request.
writeModifyDnResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided modify DN result.
writeModifyRequest(int, ModifyRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided modify request.
writeModifyResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided extended result.
writeNull() - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeNull() - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a null element using the Universal Null ASN.1 type tag.
writeNull(byte) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a null element using the provided type tag.
writeOctetString(byte, byte[]) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeOctetString(byte[]) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeOctetString(byte[], int, int) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeOctetString(ByteSequence) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeOctetString(CharSequence) - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeOctetString(byte, byte[]) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an octet string element using the provided type tag.
writeOctetString(byte, byte[], int, int) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an octet string element using the provided type tag.
writeOctetString(byte, ByteSequence) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an octet string element using the provided type tag.
writeOctetString(byte, CharSequence) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a string as a UTF-8 encoded octet string element using the provided type tag.
writeOctetString(byte[]) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an octet string element using the Universal Octet String ASN.1 type tag.
writeOctetString(byte[], int, int) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an octet string element using the Universal Octet String ASN.1 type tag.
writeOctetString(ByteSequence) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes an octet string element using the Universal Octet String ASN.1 type tag.
writeOctetString(CharSequence) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a string as a UTF-8 encoded octet string element using the Universal Octet String ASN.1 type tag.
writer() - Method in interface org.forgerock.opendj.io.LdapSocket
Returns a Processor which will write all LdapMessage it receives to the network.
writeSearchRequest(int, SearchRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided search request.
writeSearchResult(int, Result) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided search result.
writeSearchResultEntry(int, SearchResultEntry) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided search result entry.
writeSearchResultReference(int, SearchResultReference) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided search result reference.
writeStartSequence() - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeStartSequence() - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a sequence element using the Universal Sequence ASN.1 type tag.
writeStartSequence(byte) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a sequence element using the provided type tag.
writeStartSet() - Method in class org.forgerock.opendj.io.AbstractAsn1Writer
 
writeStartSet() - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a set element using the Universal Set ASN.1 type tag.
writeStartSet(byte) - Method in interface org.forgerock.opendj.io.Asn1Writer
Writes a set element using the provided type tag.
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.
writeUnbindRequest(int, UnbindRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided unbind request.
writeUnknownRequest(int, UnknownRequest) - Method in class org.forgerock.opendj.io.LdapWriter
Writes the provided unknown request.
WwwAuthenticateHeader - Class in org.forgerock.http.header
A Header representation of the WWW-Authenticate HTTP header.
WwwAuthenticateHeader() - Constructor for class org.forgerock.http.header.WwwAuthenticateHeader
 
WwwAuthenticateHeader.Challenge - Class in org.forgerock.http.header
A single WWW-Authenticate challenge.

X

x(String) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the public key x-coordinate of the key.
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.
xecPrivateKey(PrivateKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the private scalar value from the given XECPrivateKey (Java 11+).
xecPrivateKey(SupportedEllipticCurve, byte[]) - Static method in class org.forgerock.json.jose.utils.XECUtils
Converts a private scalar byte value into a XECPrivateKey on the given curve.
xecPublicKey(PublicKey) - Method in class org.forgerock.json.jose.jwk.OkpJWK.Builder
Sets the public x-coordinate from the given XECPublicKey (Java 11+).
xecPublicKey(SupportedEllipticCurve, BigInteger) - Static method in class org.forgerock.json.jose.utils.XECUtils
Converts a public u-coordinate into a XECPublicKey on the given curve.
XECUtils - Class in org.forgerock.json.jose.utils
Utilities for handling XEC keys for X25519 and X448 ECDH key agreement.
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
Identity Gateway 6.5.4 API

Copyright 2011-2017 ForgeRock AS.