org.forgerock.openam.utils

Interface CipherProvider

All Known Implementing Classes:

JCECipherProvider, PerThreadCipherProvider

public interface CipherProvider

Abstract factory for obtaining Cipher instances. Implementations may cache or pool ciphers to avoid expensive initialisation overhead. Callers should ensure that they initialise ciphers returned from a cipher provider before making use of them.

Since:

12.0.0

Method Summary

Modifier and Type	Method and Description
Cipher	getCipher() Returns a cipher from the underlying mechanism.

Method Detail

getCipher

Cipher getCipher()

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.

Returns:

a configured cipher or null if a cipher could not be provided.