org.forgerock.openam.utils

Class Providers

java.lang.Object

org.forgerock.openam.utils.Providers

public final class Providers
extends Object

Static factory methods for getting pre-configured provider instances. Acts as a poor-man's Guice for use in non-Guice aware code.

Since:

12.0.0

Method Summary

Modifier and Type	Method and Description
static CipherProvider	cipherProvider(String transformation, String preferredProvider, int maxSize) Gets a pre-configured Cipher provider that caches ciphers in a per-thread LRU cache.
static DocumentBuilderProvider	documentBuilderProvider(int maxSize) Gets a pre-configured DocumentBuilder provider that caches document builder instances in a per-thread LRU cache.
static SAXParserProvider	saxParserProvider(int maxSize) Gets a pre-configured SAXParser provider that caches parser instances in a per-thread LRU cache.
static TransformerFactoryProvider	transformerFactoryProvider(int maxSize) Gets a basic TransformerFactory instance that can be used to create new Transformer objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

cipherProvider

public static CipherProvider cipherProvider(String transformation,
                                            String preferredProvider,
                                            int maxSize)

Gets a pre-configured Cipher provider that caches ciphers in a per-thread LRU cache.

Parameters:

transformation - the cipher transformation algorithm.

preferredProvider - the preferred cipher provider.

maxSize - the maximum size of the per-thread cipher cache. Should be sized to match thread pool size.

Returns:

a per-thread caching JCE cipher provider.

documentBuilderProvider

public static DocumentBuilderProvider documentBuilderProvider(int maxSize)

Gets a pre-configured DocumentBuilder provider that caches document builder instances in a per-thread LRU cache. The created document builders are configured to avoid various entity expansion and remote DTD attacks.

Parameters:

maxSize - the maximum size of the per-thread cache. Should be sized to match thread pool size.

Returns:

a per-thread caching, safe document builder provider.

saxParserProvider

public static SAXParserProvider saxParserProvider(int maxSize)

Gets a pre-configured SAXParser provider that caches parser instances in a per-thread LRU cache. The created parsers are configured to avoid various entity expansion and remote DTD attacks.

Parameters:

maxSize - the maximum size of the per-thread cache. Should be sized to match thread pool size.

Returns:

a per-thread caching, safe SAX parser provider.

transformerFactoryProvider

public static TransformerFactoryProvider transformerFactoryProvider(int maxSize)

Gets a basic TransformerFactory instance that can be used to create new Transformer objects.

Parameters:

maxSize - The maximum size of the per-thread cache. Should be sized to match thread pool size.

Returns:

A per-thread caching, TransformerFactory provider.