Package org.forgerock.openam.utils

This package contains general utilities for use throughout the OpenAM codebase.

Interface Summary

Interface	Description
CipherProvider	Abstract factory for obtaining Cipher instances.
CodeGeneratorSource	For extensibility of the RecoveryCodeGenerator.
Config<T>	Simple interface class for lazily retrieving configuration objects.
ConfigListener	Listener interface allowing changes to hot swappable configuration (e.g.
DocumentBuilderProvider	Abstract factory interface for supplying configured DocumentBuilder instances.
OpenAMSettings	Provides access to any OpenAM settings.
SAXParserProvider	Abstract factory interface for constructing SAXParser instances.
TransformerFactoryProvider	Abstract factory for obtaining TransformerFactory instances.

Class Summary

Class	Description
AMKeyProvider	Implementation of a KeyProvider interface for retrieving X509 Certificates and private keys from the user data store.
AttributeUtils	A utility class to simplify dealing with attributes flagged as static or binary.
BundleUtils	Utility methods for dealing with ResourceBundles.
ClientUtils	Shared utility class for HTTP Clients.
CollectionUtils	A simple utility class to simplify interactions with collections.
CrestQuery	This class was created to handle queries made via CREST that can provide either a _queryID (String) or a _queryFilter (QueryFilter<JsonPointer>) to search for.
Enums
ForwardedHeader	A utility class for handling the RFC 7239 Forwarded header.
IOUtils	Utility class for handling I/O streams.
IPRange
JCECipherProvider	A CipherProvider that gets queries from the underlying Java Cryptographic Extension (JCE) facilities, via Cipher.getInstance(String, Provider).
JsonArray	A Builder class for creating json array objects.
JsonObject	A Builder class for creating JsonValues for json objects.
JsonValueBuilder	Builder factory class for a fluent way of creating JsonValue objects.
MapHelper	Utility class for operations on Maps.
MappingUtils	Utility method for parsing mappings.
ModifiedProperty<T>	Responsible for tracking the current and previous values of a property and indicating when they are differ.
OpenAMSettingsImpl	Provides access to any OpenAM settings.
PerThreadCache<T,E extends Exception>	Provides caching of some expensive objects in a per-thread LRU cache for performance.
PerThreadCipherProvider	A CipherProvider that caches ciphers in per-thread storage.
Providers	Static factory methods for getting pre-configured provider instances.
RealmNormaliser	Normalises the realm so that the returned realm is never null or an empty String.
RealmUtils	Realm related utilities.
RecoveryCodeGenerator	Generates codes of a specified length using a given Alphabet as valid characters.
ServiceConfigUtils	Static utilities for attribute retrieval for the provided service config.
ShutdownMonitor	Responsible for monitoring the system Shutdown state and providing this signal to callers that need to poll the shutdown state.
SingleValueMapper<K,V>	A utility collection which maintains mappings for any given value.
StringUtils	Utility class for handling Strings.
TimeDuration	Simple Class to Provide Time Duration Calculation for certain events within the OpenAM framework.
TimeUtils	A collection of static immutable time functions.
ValidateIPaddress	Validates IP V4 and V6 addresses.

Enum Summary

Enum	Description
Alphabet	Representative of different alphabets.
Time	The source of all time-based information in OpenAM.

Exception Summary

Exception	Description
CodeException	An exception for errors caused by invalid generation of codes.