Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- accept(QueryFilterVisitor<R, P, F>, P) - Method in class org.forgerock.util.query.QueryFilter
-
Applies a
QueryFilterVisitor
to thisQueryFilter
. - add(int, E) - Method in class org.forgerock.util.LazyList
-
Inserts the specified element at the specified position in this list.
- add(int, E) - Method in class org.forgerock.util.ListDecorator
-
Inserts the specified element at the specified position in this list.
- add(int, Object) - Method in class org.forgerock.json.JsonValue
-
Adds the specified value to the list.
- add(E) - Method in class org.forgerock.util.LazyList
-
Appends the specified element to the end of this list.
- add(E) - Method in class org.forgerock.util.ListDecorator
-
Appends the specified element to the end of this list.
- add(Object) - Method in class org.forgerock.json.JsonValue
-
Adds the specified value to the end of the list.
- add(String, Object) - Method in class org.forgerock.json.JsonValue
-
Adds the specified value.
- add(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
-
Adds the value identified by the specified pointer, relative to this value as root.
- addAll(int, Collection<? extends E>) - Method in class org.forgerock.util.LazyList
-
Inserts all of the elements in the specified collection into this list at the specified position.
- addAll(int, Collection<? extends E>) - Method in class org.forgerock.util.ListDecorator
-
Inserts all of the elements in the specified collection into this list at the specified position.
- addAll(Collection<? extends E>) - Method in class org.forgerock.util.LazyList
-
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
- addAll(Collection<? extends E>) - Method in class org.forgerock.util.ListDecorator
-
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.
- addPermissive(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
-
Adds the value identified by the specified pointer, relative to this value as root.
- 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.
- 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.
- alwaysFalse() - Static method in class org.forgerock.util.query.QueryFilter
-
Returns a filter which does not match any resources.
- alwaysTrue() - Static method in class org.forgerock.util.query.QueryFilter
-
Returns a filter which matches all resources.
- 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.
- apply(JsonValue) - Method in class org.forgerock.json.JsonValueTraverseFunction
- apply(VIN) - Method in interface org.forgerock.util.AsyncFunction
-
Asynchronously applies this function to the input parameter
value
and returns aPromise
for the result. - apply(VIN) - Method in class org.forgerock.util.CloseSilentlyFunction
-
Invokes the delegate function's
Function.apply(Object)
with the input parametervalue
, 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. - array(Object...) - Static method in class org.forgerock.json.JsonValue
-
Returns a mutable JSON array containing the provided objects.
- 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.
- asBoolean() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
Boolean
object. - 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. - asDouble() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
Double
object. - asEnum(String, Class<T>) - Static method in class org.forgerock.util.Utils
-
Returns the string value as an enum constant of the specified enum type.
- asInteger() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as an
Integer
object. - asList() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
List
object. - asList(Class<E>) - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
List
containing objects of the specified type. - asLong() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
Long
object. - asMap() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
Map
object. - asMap(Class<V>) - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
Map
containing objects of the specified type. - asMapOfList(Class<E>) - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
Map
containing a collection of objects of the specified type. - asNumber() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
Number
object. - asString() - Method in class org.forgerock.json.JsonValue
-
Returns the JSON value as a
String
object. - AsyncFunction<VIN,
VOUT, E extends Exception> - Interface in org.forgerock.util -
An asynchronous
Function
which returns a result at some point in the future.
B
- 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 tosun.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.
- BaseQueryFilterVisitor<R,
P, F> - Class in org.forgerock.util.query -
A base implementation of
QueryFilterVisitor
where all methods throw anUnsupportedOperationException
by default - override just the methods you need. - BaseQueryFilterVisitor() - Constructor for class org.forgerock.util.query.BaseQueryFilterVisitor
C
- 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
- charset() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a character set used for byte encoding/decoding.
- 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. - 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(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.
- CIPHER_AES_CBC_PKCS5 - Static variable in class org.forgerock.util.crypto.CryptoConstants
-
A cipher value for the AES/CBC/PKCS5Padding algorithm.
- clear() - Method in class org.forgerock.json.JsonValue
-
Removes all child values from this JSON value, if it has any.
- clear() - Method in class org.forgerock.util.LazyList
-
Removes all of the elements from this list.
- clear() - Method in class org.forgerock.util.LazyMap
-
Removes all of the mappings from the map.
- clear() - Method in class org.forgerock.util.ListDecorator
-
Removes all of the elements from this list.
- clear() - Method in class org.forgerock.util.MapDecorator
-
Removes all of the mappings from the map.
- clear() - Method in class org.forgerock.util.PerItemEvictionStrategyCache
-
Clean-up the cache entries.
- clone() - Method in class org.forgerock.json.JsonValue
-
Returns a shallow copy of this JSON value.
- closeSilently(Closeable...) - Static method in class org.forgerock.util.Utils
-
Closes the provided resources ignoring any errors which occurred.
- closeSilently(Iterable<? extends Closeable>) - Static method in class org.forgerock.util.Utils
-
Closes the provided resources ignoring any errors which occurred.
- closeSilently(Function<IN, OUT, EX>) - Static method in class org.forgerock.util.CloseSilentlyFunction
-
Wraps a delegate function in a
CloseSilentlyFunction
. - CloseSilentlyFunction<VIN extends Closeable,
VOUT, E extends Exception> - Class in org.forgerock.util -
Function
that silently closes an input-parameter after a delegate-function'sFunction.apply(Object)
is invoked. - CloseSilentlyFunction(Function<VIN, VOUT, E>) - Constructor for class org.forgerock.util.CloseSilentlyFunction
-
Creates a new
CloseSilentlyFunction
instance. - COMPARATOR - Static variable in class org.forgerock.util.Pair
- compareTo(Duration) - Method in class org.forgerock.util.time.Duration
- 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.
- contains(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
-
Creates a new
contains
filter using the provided field name and value assertion. - contains(Object) - Method in class org.forgerock.json.JsonValue
-
Returns
true
this JSON value contains an item with the specified 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(Object) - Method in class org.forgerock.util.RangeSet
-
Returns
true
if this set contains the specified element. - CONTAINS - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
the "contains" operator".
- 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. - 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. - 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. - convertTo(TimeUnit) - Method in class org.forgerock.util.time.Duration
-
Convert the current duration to a given
TimeUnit
. - copy() - Method in class org.forgerock.json.JsonValue
-
Returns a deep copy of this JSON value.
- copyOf(Options) - Static method in class org.forgerock.util.Options
-
Returns a copy of the provided set of options.
- create() - Static method in class org.forgerock.util.promise.PromiseImpl
-
Creates a new pending
Promise
implementation. - createCachedThreadPool() - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Generates a Cached Thread Pool ExecutorService.
- createCachedThreadPool(String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Generates a Cached Thread Pool ExecutorService using the provided name as a prefix of the thread names.
- createCachedThreadPool(ThreadFactory) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Generates a Cached Thread Pool ExecutorService which has been pre-registered with the ShutdownManager.
- createFixedThreadPool(int) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Create a fixed size Thread Pool ExecutorService.
- createFixedThreadPool(int, String) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Create a fixed size Thread Pool ExecutorService using the provided name as the prefix of the thread names.
- createFixedThreadPool(int, ThreadFactory) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Creates a fixed size Thread Pool ExecutorService which has been pre-registered with the
ShutdownManager
. - createScheduledService(int) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Generates a ScheduledExecutorService which has been pre-registered with the ShutdownManager.
- createThreadPool(int, int, long, TimeUnit, BlockingQueue<Runnable>) - Method in class org.forgerock.util.thread.ExecutorServiceFactory
-
Generates a ThreadPoolExecutor with the provided values, and registers that executor as listening for shutdown messages.
- 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. salt) used to crypt the data.
- 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.
D
- 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.
- 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.
- 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 - Enum constant in enum org.forgerock.util.thread.listener.ShutdownPriority
-
DEFAULT is the priority pre-defined in the system.
- DEFAULT - Static variable in interface org.forgerock.util.generator.IdGenerator
-
The default implementation of
IdGenerator
. - DEFAULT_CONNECTION_TIMEOUT - Static variable in class org.forgerock.util.SimpleHTTPClient
-
Default connection timeout on HTTP requests from this client.
- DEFAULT_READ_TIMEOUT - Static variable in class org.forgerock.util.SimpleHTTPClient
-
Default read timeout on HTTP requests from this client.
- defaultOptions() - Static method in class org.forgerock.util.Options
-
Returns a new set of options with default settings.
- defaultTo(Object) - Method in class org.forgerock.json.JsonValue
-
Defaults the JSON value to the specified value if it is currently
null
. - diff(JsonValue) - Method in class org.forgerock.json.JsonValue
-
Performs a deep comparison of this JSON vlaue with another JSON value, and produces a JSON Patch value, which contains the operations necessary to modify the current value to arrive at the
target
value. - diff(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch
-
Compares two JSON values, and produces a JSON Patch value, which contains the operations necessary to modify the
original
value to arrive at thetarget
value. - duration() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a
Duration
. - duration(long, TimeUnit) - Static method in class org.forgerock.util.time.Duration
-
Provides a
Duration
, given a number and time unit. - duration(String) - Static method in class org.forgerock.util.time.Duration
-
Provides a
Duration
that represents the given duration expressed in english. - Duration - Class in org.forgerock.util.time
-
Represents a duration in english.
- Duration(Long, TimeUnit) - Constructor for class org.forgerock.util.time.Duration
-
Deprecated.
E
- empty() - Static method in class org.forgerock.util.Pair
-
Returns an empty Pair matching the required types.
- EMPTY - Static variable in class org.forgerock.util.Pair
-
An empty Pair.
- encode(byte[]) - Static method in class org.forgerock.util.encode.Base64
-
This method is using
Base64.encode(byte[], boolean)
, and it only exists so we don't break the API. - encode(byte[]) - Static method in class org.forgerock.util.encode.Base64url
-
Encodes the given byte array into a Base64url encoded String.
- encode(byte[], 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. - 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. - entrySet() - Method in class org.forgerock.util.LazyMap
-
Returns a
Set
view of the mappings contained in the map. - entrySet() - Method in class org.forgerock.util.MapDecorator
-
Returns a
Set
view of the mappings contained in the map. - enumConstant(Class<T>) - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as an enum constant of the specified enum type.
- 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.util.i18n.LocalizableString
-
The default equals operation.
- equals(Object) - Method in class org.forgerock.util.LazyList
-
Compares the specified object with this list for equality.
- equals(Object) - Method in class org.forgerock.util.LazyMap
-
Compares the specified object with the map for equality.
- equals(Object) - Method in class org.forgerock.util.ListDecorator
-
Compares the specified object with this list for equality.
- equals(Object) - Method in class org.forgerock.util.MapDecorator
-
Compares the specified object with the map for equality.
- equals(Object) - Method in class org.forgerock.util.Pair
- equals(Object) - Method in class org.forgerock.util.query.QueryFilter
- equals(Object) - Method in class org.forgerock.util.time.Duration
- EQUALS - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
the "equals" operator.
- equalTo(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
-
Creates a new
equality
filter using the provided field name and value assertion. - 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.
- 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.
- expect(Class<?>) - Method in class org.forgerock.json.JsonValue
-
Called to enforce that the JSON value is of a particular type.
- ExpiredTokenException - Exception in org.forgerock.tokenhandler
-
An exception generated by a
TokenHandler
on extraction when the token is expired. - ExpiredTokenException(String) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
-
Constructs a new exception with the specified detail message.
- ExpiredTokenException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
-
Constructs a new exception with the specified detail message and cause.
- ExpiredTokenException(Throwable) - Constructor for exception org.forgerock.tokenhandler.ExpiredTokenException
-
Constructs a new exception with the specified cause.
- 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.
F
- factory - Variable in class org.forgerock.util.LazyList
-
Factory to create the instance of the list to expose.
- factory - Variable in class org.forgerock.util.LazyMap
-
Factory to create the instance of the map to expose.
- Factory<T> - Interface in org.forgerock.util
-
A factory interface.
- FALSE - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
a literal "false.
- field(String, Object) - Static method in class org.forgerock.json.JsonValue
-
Returns a JSON field for inclusion in a JSON object using
object
. - 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 notnull
. - file() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a
File
object. - FROM_PTR - Static variable in class org.forgerock.json.JsonPatch
-
Path to the "from" attribute of a patch entry.
- Function<VIN,
VOUT, E extends Exception> - Interface in org.forgerock.util -
A synchronous function which returns a result immediately.
G
- generate() - Method in interface org.forgerock.util.generator.IdGenerator
-
Returns a new globally unique identifier.
- generate() - Method in class org.forgerock.util.generator.IdGenerator.SequenceUuidIdGenerator
- generate(JsonValue) - Method in interface org.forgerock.tokenhandler.TokenHandler
-
Generates a new token using the state.
- 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 anExecutionException
containing the cause of the failure. - get() - Method in class org.forgerock.util.promise.PromiseImpl
- get(int) - Method in class org.forgerock.json.JsonPointer
-
Returns the reference token at the specified position.
- get(int) - Method in class org.forgerock.json.JsonValue
-
Returns the specified child value.
- get(int) - Method in class org.forgerock.util.LazyList
-
Returns the element at the specified position in this list.
- get(int) - Method in class org.forgerock.util.ListDecorator
-
Returns the element at the specified position in this list.
- get(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 anExecutionException
containing the cause of the failure. - get(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
- get(Object) - Method in class org.forgerock.util.LazyMap
-
Returns the value to which the specified key is mapped, or
null
if the map contains no mapping for the key. - get(Object) - Method in class org.forgerock.util.MapDecorator
-
Returns the value to which the specified key is mapped, or
null
if the map contains no mapping for the key. - get(String) - Method in class org.forgerock.json.JsonValue
-
Returns the specified item value.
- get(URL) - Method in class org.forgerock.util.SimpleHTTPClient
-
Utility method for gathering the contents of an HTTP page.
- get(JsonPointer) - Method in class org.forgerock.json.JsonValue
-
Returns the specified child value with a pointer, relative to this value as root.
- 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.
- getBundleInPreferredLocale(String, ClassLoader) - Method in class org.forgerock.util.i18n.PreferredLocales
-
Get a
ResourceBundle
using the preferred locale list and using the providedClassLoader
. - getFirst() - Method in class org.forgerock.util.Pair
-
Returns the first element of this pair.
- getInstance() - Static method in class org.forgerock.util.SignatureUtil
-
Gets the SignatureUtil instance.
- getIntValue() - Method in enum org.forgerock.util.thread.listener.ShutdownPriority
-
Returns the priority.
- getJsonValue() - Method in exception org.forgerock.json.JsonValueException
-
Returns the JSON value for which the exception was thrown.
- getLocales() - Method in class org.forgerock.util.i18n.PreferredLocales
-
The ordered list of preferred locales.
- getMaxTimeout() - Method in class org.forgerock.util.PerItemEvictionStrategyCache
-
Gets the maximum timeout (can be null).
- getMessage() - Method in exception org.forgerock.json.JsonValueException
-
Returns the detail message string of this exception.
- getObject() - Method in class org.forgerock.json.JsonValue
-
Returns the raw Java object representing this JSON value.
- getOrThrow() - Method in interface org.forgerock.util.promise.Promise
-
Waits if necessary for this
Promise
to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure. - getOrThrow() - Method in class org.forgerock.util.promise.PromiseImpl
- getOrThrow(long, TimeUnit) - Method in interface org.forgerock.util.promise.Promise
-
Waits if necessary for at most the given time for this
Promise
to complete, and then returns the result if it completed successfully, or throws an exception representing the cause of the failure. - getOrThrow(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
- 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() - Method in class org.forgerock.util.promise.PromiseImpl
- 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(long, TimeUnit) - Method in class org.forgerock.util.promise.PromiseImpl
- getPairComparator() - Static method in class org.forgerock.util.Pair
-
Returns a comparator for Pairs of comparable objects.
- getPointer() - Method in class org.forgerock.json.JsonValue
-
Returns the pointer of the JSON value in its JSON structure.
- getPreferredLocale() - Method in class org.forgerock.util.i18n.PreferredLocales
-
The preferred locale, i.e. the head of the preferred locales list.
- 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.
- 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.
- getSecond() - Method in class org.forgerock.util.Pair
-
Returns the second element of this pair.
- getTransformedValue(JsonValue, JsonValue) - Method in interface org.forgerock.json.JsonPatchValueTransformer
-
Return the value to be used for a given patch operation.
- getUnit() - Method in class org.forgerock.util.time.Duration
-
Returns the
TimeUnit
this duration is expressed in. - getValue() - Method in class org.forgerock.util.time.Duration
-
Returns the number of
TimeUnit
this duration represents. - 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.
- GREATER_EQUAL - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
the "greater-than-or-equal" operator.
- GREATER_THAN - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
the "greater-than" operator.
- greaterThan(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
-
Creates a new
greater than
filter using the provided field name and value assertion. - greaterThanOrEqualTo(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
-
Creates a new
greater than or equal to
filter using the provided field name and value assertion.
H
- 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.
- 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.
- 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.
- hashCode() - Method in class org.forgerock.json.JsonPointer
-
Returns the hash code value for this pointer.
- 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
- HIGHEST - Enum constant in enum org.forgerock.util.thread.listener.ShutdownPriority
-
HIGHEST is the priority pre-defined in the system.
I
- identity() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns an identity function that will copy the input
JsonValue
. - 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
. - 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 custommessage
if the condition parameter is false. - ifNull(Object) - Static method in class org.forgerock.util.Reject
-
Alias for
checkNotNull
to be used in fluentReject.ifNull
syntax. - ifNull(Object, String) - Static method in class org.forgerock.util.Reject
-
Alias for
checkNotNull
to be used in fluentReject.ifNull
syntax. - ifNull(T...) - Static method in class org.forgerock.util.Reject
-
Throws a
NullPointerException
if any of the provided arguments arenull
. - 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 custommessage
if the condition parameter is true. - 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. - InvalidTokenException - Exception in org.forgerock.tokenhandler
-
An exception generated by a
TokenHandler
on validation or extraction when the token is invalid. - InvalidTokenException(String) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException
-
Constructs a new exception with the specified detail message.
- InvalidTokenException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException
-
Constructs a new exception with the specified detail message and cause.
- InvalidTokenException(Throwable) - Constructor for exception org.forgerock.tokenhandler.InvalidTokenException
-
Constructs a new exception with the specified cause.
- isBlank(CharSequence) - Static method in class org.forgerock.util.Utils
-
Check to see if a character sequence is null or blank.
- isBoolean() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the JSON value is aBoolean
. - isCancelled() - Method in interface org.forgerock.util.promise.Promise
-
Returns
true
if thisPromise
was cancelled before it completed normally. - isCancelled() - Method in class org.forgerock.util.promise.PromiseImpl
- isCollection() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the JSON value is aCollection
. - isDefined(String) - Method in class org.forgerock.json.JsonValue
-
Returns
true
if this JSON value contains the specified item. - isDone() - Method in interface org.forgerock.util.promise.Promise
-
Returns
true
if thisPromise
has completed. - isDone() - Method in class org.forgerock.util.promise.PromiseImpl
- 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.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. - 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.
- isList() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the JSON value is aList
. - isMap() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the JSON value is aMap
. - isNotNull() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the value is notnull
. - isNull() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the value isnull
. - isNullOrEmpty(String) - Static method in class org.forgerock.util.Utils
-
Check to see if the provided String is
null
or empty. - isNumber() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the JSON value is aNumber
. - isString() - Method in class org.forgerock.json.JsonValue
-
Returns
true
if the JSON value is aString
. - isUnlimited() - Method in class org.forgerock.util.time.Duration
-
Returns true if this Duration represents an unlimited (or indefinite) duration.
- isZero() - Method in class org.forgerock.util.time.Duration
-
Returns true if this Duration represents a zero-length duration.
- iterator() - Method in class org.forgerock.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.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
- joinAsString(StringBuilder, String, Iterable<?>) - Static method in class org.forgerock.util.Utils
-
Appends into the provided
StringBuilder
the string representation of the objects contained in the provided iterable concatenated together using the provided separator. - joinAsString(StringBuilder, String, Object...) - Static method in class org.forgerock.util.Utils
-
Appends into the provided
StringBuilder
the string representation of the provided objects concatenated together using the provided separator. - joinAsString(String, Iterable<?>) - Static method in class org.forgerock.util.Utils
-
Returns a string whose content is the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
- joinAsString(String, Object...) - Static method in class org.forgerock.util.Utils
-
Returns a string whose content is the string representation of the provided objects concatenated together using the provided separator.
- json(Object) - Static method in class org.forgerock.json.JsonValue
-
Returns a JSON value whose content is the provided object.
- JsonException - Exception in org.forgerock.json
-
An exception that is thrown during JSON operations.
- JsonException() - Constructor for exception org.forgerock.json.JsonException
-
Constructs a new exception with
null
as its detail message. - JsonException(String) - Constructor for exception org.forgerock.json.JsonException
-
Constructs a new exception with the specified detail message.
- JsonException(String, Throwable) - Constructor for exception org.forgerock.json.JsonException
-
Constructs a new exception with the specified detail message and cause.
- JsonException(Throwable) - Constructor for exception org.forgerock.json.JsonException
-
Constructs a new exception with the specified cause.
- JsonPatch - Class in org.forgerock.json
-
Processes partial modifications to JSON values.
- JsonPatchValueTransformer - Interface in org.forgerock.json
-
RFC6902 expects the patch value to be a predetermined, static value to be used in the patch operation's execution.
- JsonPointer - Class in org.forgerock.json
-
Identifies a specific value within a JSON structure.
- JsonPointer() - Constructor for class org.forgerock.json.JsonPointer
-
Constructs a JSON pointer, identifying the root value of a JSON structure.
- JsonPointer(Iterable<String>) - Constructor for class org.forgerock.json.JsonPointer
-
Constructs a JSON pointer from an iterable collection of reference tokens.
- JsonPointer(String) - Constructor for class org.forgerock.json.JsonPointer
-
Constructs a JSON pointer, identifying the specified pointer value.
- JsonPointer(String...) - Constructor for class org.forgerock.json.JsonPointer
-
Constructs a JSON pointer from an array of reference tokens.
- JsonValue - Class in org.forgerock.json
-
Represents a value in a JSON object model structure.
- JsonValue(Object) - Constructor for class org.forgerock.json.JsonValue
-
Constructs a JSON value object with a given object.
- JsonValue(Object, JsonPointer) - Constructor for class org.forgerock.json.JsonValue
-
Constructs a JSON value object with a given object and pointer.
- JsonValueException - Exception in org.forgerock.json
-
An exception that is thrown during JSON value operations.
- JsonValueException(JsonValue) - Constructor for exception org.forgerock.json.JsonValueException
-
Constructs a new exception with the specified JSON value and
null
as its detail message. - JsonValueException(JsonValue, String) - Constructor for exception org.forgerock.json.JsonValueException
-
Constructs a new exception with the specified JSON value and detail message.
- JsonValueException(JsonValue, String, Throwable) - Constructor for exception org.forgerock.json.JsonValueException
-
Constructs a new exception with the specified JSON value, detail message and cause.
- JsonValueException(JsonValue, Throwable) - Constructor for exception org.forgerock.json.JsonValueException
-
Constructs a new exception with the specified JSON value and cause.
- JsonValueFunctions - Class in org.forgerock.json
-
This class contains the utility functions to convert a
JsonValue
to another type. - JsonValueTraverseFunction - Class in org.forgerock.json
- 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.
K
- keys() - Method in class org.forgerock.json.JsonValue
-
Returns the set of keys for this JSON value's child values.
- 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.
L
- 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. - 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.
- 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. references document root). - LESS_EQUAL - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
the "less-than-or-equal" operator.
- LESS_THAN - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
the "less-than" operator.
- lessThan(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
-
Creates a new
less than
filter using the provided field name and value assertion. - lessThanOrEqualTo(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
-
Creates a new
less than or equal to
filter using the provided field name and value assertion. - list - Variable in class org.forgerock.util.ListDecorator
-
The list wrapped by this decorator.
- 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.
- listIterator() - Method in class org.forgerock.util.LazyList
-
Returns a list iterator over the elements in this list (in proper sequence).
- listIterator() - Method in class org.forgerock.util.ListDecorator
-
Returns a list iterator over the elements in this list (in proper sequence).
- listIterator(int) - Method in class org.forgerock.util.LazyList
-
Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
- listIterator(int) - Method in class org.forgerock.util.ListDecorator
-
Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
- listOf(Function<JsonValue, 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. - 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
. - LOWEST - Enum constant in enum org.forgerock.util.thread.listener.ShutdownPriority
-
LOWEST is the priority pre-defined in the system.
M
- map - Variable in class org.forgerock.util.MapDecorator
-
The map wrapped by this decorator.
- MapDecorator<K,
V> - Class in org.forgerock.util -
Wraps another map.
- MapDecorator(Map<K, V>) - Constructor for class org.forgerock.util.MapDecorator
-
Constructs a new map decorator, wrapping the specified map.
- MapFilterVisitor<F> - Class in org.forgerock.util.query
-
A
QueryFilterVisitor
that produces a Map representation of the filter tree. - MapFilterVisitor() - Constructor for class org.forgerock.util.query.MapFilterVisitor
- 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?
- MEDIA_TYPE - Static variable in class org.forgerock.json.JsonPatch
-
Internet media type for the JSON Patch format.
N
- NeverThrowsException - Exception in org.forgerock.util.promise
-
The
NeverThrowsException
class is an uninstantiable placeholder exception which should be used for indicating that aFunction
orAsyncFunction
never throws an exception (i.e. the function cannot fail). - 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. - newInstance() - Method in interface org.forgerock.util.Factory
-
Creates and returns a new object instance.
- 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. - 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. - newThreadFactory(ThreadGroup, String, boolean) - Static method in class org.forgerock.util.Utils
-
Creates a new thread factory which will create threads using the specified thread group, naming template, and daemon status.
- 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.
- now() - Method in interface org.forgerock.util.time.TimeService
-
Returns a value that represents "now" since the epoch.
O
- object(int) - Static method in class org.forgerock.json.JsonValue
-
Produces an empty JSON object pre-allocated for
size
fields
. - object(Map.Entry<String, Object>...) - Static method in class org.forgerock.json.JsonValue
-
Returns a JSON object comprised of the provided JSON
fields
. - of(F, S) - Static method in class org.forgerock.util.Pair
-
Creates a new
Pair
. - of(Class<T>, T) - Static method in class org.forgerock.util.Option
-
Defines an option with the provided type and default value.
- OP_PTR - Static variable in class org.forgerock.json.JsonPatch
-
Path to the "op" attribute of a patch entry.
- Option<T> - Class in org.forgerock.util
-
A configuration option whose value can be stored in a set of
Options
. - Options - Class in org.forgerock.util
-
A set of options which can be used for customizing the behavior of HTTP clients and servers.
- 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.
- org.forgerock.json - package org.forgerock.json
-
Provides an API for the traversal and manipulation of JSON object model structures in Java.
- 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.
P
- Pair<F,
S> - Class in org.forgerock.util -
Ordered pair of arbitrary objects.
- 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. references document root). - 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.
- patch(JsonValue) - Method in class org.forgerock.json.JsonValue
-
Applies a set of modifications in a JSON patch value to the current object, resulting in the intended target value.
- patch(JsonValue, JsonValue) - Static method in class org.forgerock.json.JsonPatch
-
Applies a set of modifications in a JSON patch value to an original value, resulting in the intended target value.
- patch(JsonValue, JsonValue, JsonPatchValueTransformer) - Static method in class org.forgerock.json.JsonPatch
-
Applies a set of modifications in a JSON patch value to an original value, resulting in the intended target value.
- PATH_PTR - Static variable in class org.forgerock.json.JsonPatch
-
Path to the "path" attribute of a patch entry.
- pattern() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a regular expression pattern.
- PerItemEvictionStrategyCache<K,
V> - Class in org.forgerock.util -
PerItemEvictionStrategyCache is a thread-safe write-through cache.
- PerItemEvictionStrategyCache(ScheduledExecutorService, AsyncFunction<V, Duration, Exception>) - Constructor for class org.forgerock.util.PerItemEvictionStrategyCache
-
Build a new
PerItemEvictionStrategyCache
using the given scheduled executor. - PerItemEvictionStrategyCache(ScheduledExecutorService, Duration) - Constructor for class org.forgerock.util.PerItemEvictionStrategyCache
-
Build a new
PerItemEvictionStrategyCache
using the given scheduled executor. - pimpl - Variable in class org.forgerock.util.query.QueryFilter
-
the filter implementation.
- pointer() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a JSON pointer.
- 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
ResourceBundle
s. - PreferredLocales() - Constructor for class org.forgerock.util.i18n.PreferredLocales
-
Create a new, empty preference of locales.
- PreferredLocales(List<Locale>) - Constructor for class org.forgerock.util.i18n.PreferredLocales
-
Create a new preference of locales by copying the provided locales list.
- 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.
- 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
Promise
s. - ptr(Iterable<String>) - Static method in class org.forgerock.json.JsonPointer
-
Constructs a JSON pointer from an iterable collection of reference tokens.
- ptr(String) - Static method in class org.forgerock.json.JsonPointer
-
Constructs a JSON pointer, identifying the specified pointer value.
- ptr(String...) - Static method in class org.forgerock.json.JsonPointer
-
Constructs a JSON pointer from an array of reference tokens.
- put(int, Object) - Method in class org.forgerock.json.JsonValue
-
Sets the value of the specified child list element.
- put(String, Object) - Method in class org.forgerock.json.JsonValue
-
Sets the value of the specified member. Â
- put(K, V) - Method in class org.forgerock.util.LazyMap
-
Associates the specified value with the specified key in the map.
- put(K, V) - Method in class org.forgerock.util.MapDecorator
-
Associates the specified value with the specified key in the map.
- put(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
-
Sets the value identified by the specified pointer, relative to this value as root.
- 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.
- putPermissive(JsonPointer, Object) - Method in class org.forgerock.json.JsonValue
-
Sets the value identified by the specified pointer, relative to this value as root.
Q
- 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
- QueryFilterVisitor<R,
P, F> - Interface in org.forgerock.util.query -
A visitor of
QueryFilter
s, in the style of the visitor design pattern.
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.
- Reject - Class in org.forgerock.util
-
A input parameter-validating utility class using fluent invocation:
- rejectStateIfTrue(boolean, String) - Static method in class org.forgerock.util.Reject
-
Throws an
IllegalStateException
with a custommessage
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. - remove(int) - Method in class org.forgerock.json.JsonValue
-
Removes the specified child value, shifting any subsequent elements to the left.
- remove(int) - Method in class org.forgerock.util.LazyList
-
Removes the element at the specified position in this list.
- remove(int) - Method in class org.forgerock.util.ListDecorator
-
Removes the element at the specified position in this list.
- remove(Object) - Method in class org.forgerock.util.LazyList
-
Removes the first occurrence of the specified element from this list, if it is present.
- remove(Object) - Method in class org.forgerock.util.LazyMap
-
Removes the mapping for a key from the map if it is present.
- remove(Object) - Method in class org.forgerock.util.ListDecorator
-
Removes the first occurrence of the specified element from this list, if it is present.
- remove(Object) - Method in class org.forgerock.util.MapDecorator
-
Removes the mapping for a key from the map if it is present.
- remove(String) - Method in class org.forgerock.json.JsonValue
-
Removes the specified child value.
- remove(JsonPointer) - Method in class org.forgerock.json.JsonValue
-
Removes the specified child value with a pointer, relative to this value as root.
- 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.
- removeShutdownListener(ShutdownListener) - Method in interface org.forgerock.util.thread.listener.ShutdownManager
-
Removes a ShutdownListener from this ShutdownManager.
- replaceShutdownListener(ShutdownListener, ShutdownListener, ShutdownPriority) - Method in interface org.forgerock.util.thread.listener.ShutdownManager
-
Reaplces an existing ShutdownListener with the new ShutdownListener.
- required() - Method in class org.forgerock.json.JsonValue
-
Throws a
JsonValueException
if the JSON value isnull
. - reset(Option<T>) - Method in class org.forgerock.util.Options
-
Resets an option to its default behavior.
- resolveEntity(String, String) - Method in class org.forgerock.util.xml.XMLHandler
- 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.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.
- RuntimeExceptionHandler - Interface in org.forgerock.util.promise
-
A completion handler for consuming runtime exceptions which occur during the execution of asynchronous tasks.
S
- 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.
- setMaxTimeout(Duration) - Method in class org.forgerock.util.PerItemEvictionStrategyCache
-
Sets the maximum timeout.
- setObject(Object) - Method in class org.forgerock.json.JsonValue
-
Sets the Java object representing this JSON value.
- setOf(Class<V>) - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON value as a
Set
containing objects whose type (and value) is specified by the parametertype
. - 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. - shutdown() - Method in interface org.forgerock.util.thread.listener.ShutdownListener
-
The function to run when the system shutdown.
- shutdown() - Method in interface org.forgerock.util.thread.listener.ShutdownManager
-
Shuts down all the listeners in this ShutdownManager.
- ShutdownListener - Interface in org.forgerock.util.thread.listener
-
Any component which needs to be shut down should implement this interface and use the function to shut down the component.
- ShutdownManager - Interface in org.forgerock.util.thread.listener
-
Interface used by shutdown managers to allow for thread safe adding and removing of shutdown listeners.
- ShutdownPriority - Enum in org.forgerock.util.thread.listener
-
This class defines the shutdown priorities that are consumed by
com.sun.identity.common.ShutdownManager
. - sign(PrivateKey, String, String) - Method in class org.forgerock.util.SignatureUtil
-
Signs a String using the given private key.
- SignatureUtil - Class in org.forgerock.util
-
Utility class for signing and verifying signatures.
- 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.
- since(long) - Method in interface org.forgerock.util.time.TimeService
-
Computes the elapsed time between now and
past
. - 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.util.LazyList
-
Returns the number of elements in this list.
- size() - Method in class org.forgerock.util.LazyMap
-
Returns the number of key-value mappings in this map.
- size() - Method in class org.forgerock.util.ListDecorator
-
Returns the number of elements in this list.
- size() - Method in class org.forgerock.util.MapDecorator
-
Returns the number of key-value mappings in this map.
- size() - Method in class org.forgerock.util.PerItemEvictionStrategyCache
-
Returns the number of cached values.
- size() - Method in class org.forgerock.util.RangeSet
-
Returns the number of elements in this set.
- STARTS_WITH - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
the "starts-with" operator.
- startsWith(FF, Object) - Static method in class org.forgerock.util.query.QueryFilter
-
Creates a new
starts with
filter using the provided field name and value assertion. - STORAGE_TYPE_HASH - Static variable in class org.forgerock.util.crypto.CryptoConstants
-
A salted hash encryption storage type.
- 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.
- SYSTEM - Static variable in interface org.forgerock.util.time.TimeService
-
TimeService
implementation based onSystem
.
T
- 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 newPromise
representing the outcome of the function. - then(Function<? super V, VOUT, E>) - Method in class org.forgerock.util.promise.PromiseImpl
- then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided functions for execution once this
Promise
has completed (with a result or an exception), and returns a newPromise
representing the outcome of the invoked function. - then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
- then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>, Function<? super RuntimeException, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided functions for execution once this
Promise
has completed (with a result or an exception or aRuntimeException
), and returns a newPromise
representing the outcome of the invoked function. - then(Function<? super V, VOUT, EOUT>, Function<? super E, VOUT, EOUT>, Function<? super RuntimeException, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenAlways(Runnable) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided runnable for execution once this
Promise
has completed, and regardless of whether it has a result or an exception. - thenAlways(Runnable) - Method in class org.forgerock.util.promise.PromiseImpl
- thenAsync(AsyncFunction<? super V, VOUT, E>) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided asynchronous function for execution once this
Promise
has completed with a result, and returns a newPromise
representing the outcome of the function. - thenAsync(AsyncFunction<? super V, VOUT, E>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided asynchronous functions for execution once this
Promise
has completed, and returns a newPromise
representing the outcome of the invoked function. - thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>, AsyncFunction<? super RuntimeException, VOUT, EOUT>) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided asynchronous functions for execution once this
Promise
has completed, and returns a newPromise
representing the outcome of the invoked function. - thenAsync(AsyncFunction<? super V, VOUT, EOUT>, AsyncFunction<? super E, VOUT, EOUT>, AsyncFunction<? super RuntimeException, VOUT, EOUT>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenCatch(Function<? super E, V, EOUT>) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided function for execution once this
Promise
has not completed with a result (has completed with an exception), and returns a newPromise
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 newPromise
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 aRuntimeException
, and returns a newPromise
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 aRuntimeException
, and returns a newPromise
representing the outcome of the function. - thenCatchRuntimeExceptionAsync(AsyncFunction<? super RuntimeException, V, E>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenFinally(Runnable) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided runnable for execution once this
Promise
has completed, and regardless of whether of its outcome. - thenFinally(Runnable) - Method in class org.forgerock.util.promise.PromiseImpl
- thenOnException(ExceptionHandler<? super E>) - Method in interface org.forgerock.util.promise.Promise
-
Registers the provided completion handler for notification if this
Promise
cannot be completed due to an exception. - thenOnException(ExceptionHandler<? super E>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenOnResult(ResultHandler<? super V>) - Method in interface org.forgerock.util.promise.Promise
-
Registers the provided completion handler for notification once this
Promise
has completed with a result. - thenOnResult(ResultHandler<? super V>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenOnResultOrException(Runnable) - Method in interface org.forgerock.util.promise.Promise
-
Submits the provided runnable for execution once this
Promise
has completed, and regardless of whether it has a result or an exception. - thenOnResultOrException(Runnable) - Method in class org.forgerock.util.promise.PromiseImpl
- thenOnResultOrException(ResultHandler<? super V>, ExceptionHandler<? super E>) - Method in interface org.forgerock.util.promise.Promise
-
Registers the provided completion handlers for notification once this
Promise
has completed (with a result or an exception). - thenOnResultOrException(ResultHandler<? super V>, ExceptionHandler<? super E>) - Method in class org.forgerock.util.promise.PromiseImpl
- thenOnRuntimeException(RuntimeExceptionHandler) - Method in interface org.forgerock.util.promise.Promise
-
Registers the provided completion handler for notification if this
Promise
cannot be completed due to an runtime exception. - thenOnRuntimeException(RuntimeExceptionHandler) - Method in class org.forgerock.util.promise.PromiseImpl
- TimeService - Interface in org.forgerock.util.time
-
Provides time related methods for computing durations, for providing the now instant and other use cases.
- 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.json.JsonPointer
-
Returns a newly allocated array of strings, containing the pointer's reference tokens.
- toArray() - Method in class org.forgerock.util.LazyList
-
Returns an array containing all of the elements in this list in proper sequence (from first to last element).
- toArray() - Method in class org.forgerock.util.ListDecorator
-
Returns an array containing all of the elements in this list in proper sequence (from first to last element).
- toArray(T[]) - Method in class org.forgerock.util.LazyList
-
Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
- toArray(T[]) - Method in class org.forgerock.util.ListDecorator
-
Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
- toIndex(String) - Static method in class org.forgerock.json.JsonValue
-
Returns the key as an list index value.
- TokenHandler - Interface in org.forgerock.tokenhandler
-
Responsible for the validation, generation and parsing of tokens used for keying a JsonValue representative of some state.
- TokenHandlerException - Exception in org.forgerock.tokenhandler
-
An exception generated by a
TokenHandler
on either creation, validation, or state extraction. - TokenHandlerException(String) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException
-
Constructs a new exception with the specified detail message.
- TokenHandlerException(String, Throwable) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException
-
Constructs a new exception with the specified detail message and cause.
- TokenHandlerException(Throwable) - Constructor for exception org.forgerock.tokenhandler.TokenHandlerException
-
Constructs a new exception with the specified cause.
- 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.util.i18n.LocalizableString
-
The default toString method.
- toString() - Method in class org.forgerock.util.Pair
- toString() - Method in class org.forgerock.util.query.QueryFilter
-
Returns the string representation of this query filter.
- toString() - Method in class org.forgerock.util.time.Duration
- toTranslatedString(PreferredLocales) - Method in class org.forgerock.util.i18n.LocalizableString
-
Returns the contained string, translated if applicable.
- TRANSLATION_KEY_PREFIX - Static variable in class org.forgerock.util.i18n.LocalizableString
-
A constant used to indicate a string should be translated.
- 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.
- TRUE - Static variable in class org.forgerock.util.query.QueryFilterOperators
-
a literal "true".
- 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.
U
- UNLIMITED - Static variable in class org.forgerock.util.time.Duration
-
Special duration that represents an unlimited duration (or indefinite).
- 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.
- uri() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a uniform resource identifier.
- url() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a uniform resource locator.
- Utils - Class in org.forgerock.util
-
Common utility methods.
- uuid() - Static method in class org.forgerock.json.JsonValueFunctions
-
Returns the JSON string value as a universally unique identifier (UUID).
V
- validate(String) - Method in interface org.forgerock.tokenhandler.TokenHandler
-
Validates the passed token.
- validateAndExtractState(String) - Method in interface org.forgerock.tokenhandler.TokenHandler
-
Validates and parses the token, extracting any encapsulated state.
- VALUE_PTR - Static variable in class org.forgerock.json.JsonPatch
-
Path to the "value" attribute of a patch entry.
- 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.
- 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.
- 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.
- 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.
- visitAndFilter(Void, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits an
and
filter. - visitAndFilter(P, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitAndFilter(P, List<QueryFilter<F>>) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits an
and
filter. - visitBooleanLiteralFilter(Void, boolean) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a boolean literal filter.
- visitBooleanLiteralFilter(P, boolean) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitBooleanLiteralFilter(P, boolean) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a boolean literal filter.
- visitContainsFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
contains
filter. - visitContainsFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitContainsFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
contains
filter. - visitEqualsFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
equality
filter. - visitEqualsFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitEqualsFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
equality
filter. - visitExtendedMatchFilter(Void, F, String, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
comparison
filter. - visitExtendedMatchFilter(P, F, String, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitExtendedMatchFilter(P, F, String, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
comparison
filter. - visitGreaterThanFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
greater than
filter. - visitGreaterThanFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitGreaterThanFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
greater than
filter. - visitGreaterThanOrEqualToFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
greater than or equal to
filter. - visitGreaterThanOrEqualToFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitGreaterThanOrEqualToFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
greater than or equal to
filter. - visitLessThanFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
less than
filter. - visitLessThanFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitLessThanFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
less than
filter. - visitLessThanOrEqualToFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
less than or equal to
filter. - visitLessThanOrEqualToFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitLessThanOrEqualToFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
less than or equal to
filter. - visitNotFilter(Void, QueryFilter<F>) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
not
filter. - visitNotFilter(P, QueryFilter<F>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitNotFilter(P, QueryFilter<F>) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
not
filter. - visitOrFilter(Void, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits an
or
filter. - visitOrFilter(P, List<QueryFilter<F>>) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitOrFilter(P, List<QueryFilter<F>>) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits an
or
filter. - visitPresentFilter(Void, F) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
present
filter. - visitPresentFilter(P, F) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitPresentFilter(P, F) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
present
filter. - visitStartsWithFilter(Void, F, Object) - Method in class org.forgerock.util.query.MapFilterVisitor
-
Visits a
starts with
filter. - visitStartsWithFilter(P, F, Object) - Method in class org.forgerock.util.query.BaseQueryFilterVisitor
- visitStartsWithFilter(P, F, Object) - Method in interface org.forgerock.util.query.QueryFilterVisitor
-
Visits a
starts with
filter.
W
- 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. - withDefault(T) - Static method in class org.forgerock.util.Option
-
Defines a boolean option with the provided default value.
X
- 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.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Duration.duration(long, TimeUnit)
.