org.forgerock.openam.utils

Class PerThreadCipherProvider

java.lang.Object

org.forgerock.openam.utils.PerThreadCipherProvider

All Implemented Interfaces:

CipherProvider

public class PerThreadCipherProvider
extends Object
implements CipherProvider

A CipherProvider that caches ciphers in per-thread storage. To avoid using an actual thread-local (and polluting any thread pools that may touch this), we instead maintain our own map from thread id to cipher instances. As this is just a normal (concurrent) map, then it can be garbage collected as normal so there is no memory leak on hot-redeploy.

Since:

12.0.0

Constructor Summary

Constructors

Constructor and Description
PerThreadCipherProvider(CipherProvider delegate) Constructs a new PerThreadCipherProvider instance.
PerThreadCipherProvider(CipherProvider delegate, int maxSize) Initialises the thread-local cipher cache, delegating to the supplied cipher provider for actual ciphers.

Method Summary

Modifier and Type	Method and Description
Cipher	getCipher() Gets a cipher from the thread-local storage, initialising to the delegate cipher provider if not already initialised for this thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerThreadCipherProvider

public PerThreadCipherProvider(CipherProvider delegate,
                               int maxSize)

Initialises the thread-local cipher cache, delegating to the supplied cipher provider for actual ciphers.

Parameters:

delegate - the non-null provider to get ciphers from.

maxSize - the maximum size of the thread-local cache.

Throws:

NullPointerException - if the delegate is null

IllegalArgumentException - if maxSize is not a positive integer (> 0).

PerThreadCipherProvider

public PerThreadCipherProvider(CipherProvider delegate)

Constructs a new PerThreadCipherProvider instance.

Parameters:

delegate - The CipherProvider delegate.

Method Detail

getCipher

public Cipher getCipher()

Gets a cipher from the thread-local storage, initialising to the delegate cipher provider if not already initialised for this thread. Returns a cipher from the underlying mechanism. The algorithm, padding, and provider used by the cipher are determined by the underlying CipherProvider implementation. The caller should call Cipher.init(int, java.security.Key, java.security.AlgorithmParameters) before making use of the cipher to ensure it is properly initialised.

Specified by:

getCipher in interface CipherProvider

Returns:

a cipher instance for this thread. May be null.