org.forgerock.openam.utils

Class JCECipherProvider

java.lang.Object

org.forgerock.openam.utils.JCECipherProvider

All Implemented Interfaces:

CipherProvider

public class JCECipherProvider
extends Object
implements CipherProvider

A CipherProvider that gets queries from the underlying Java Cryptographic Extension (JCE) facilities, via Cipher.getInstance(String, Provider). If the preferred JCE provider is not available, then falls back on any provider that can supply the given transformation.

Since:

12.0.0

Constructor Summary

Constructors

Constructor and Description
JCECipherProvider(String transformation, Provider preferredProvider) Initialises the cipher provider with the given cipher transformation and preferred provider.
JCECipherProvider(String transformation, String preferredProvider) Initialises the cipher provider with the given cipher transformation and preferred provider.

Method Summary

Modifier and Type	Method and Description
Cipher	getCipher() Attempts to get a cipher matching the chosen transformation from the underlying JCE facilities.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCECipherProvider

public JCECipherProvider(String transformation,
                         String preferredProvider)

Initialises the cipher provider with the given cipher transformation and preferred provider. See Cipher.getInstance(String, String) for details on valid values for these parameters.

Parameters:

transformation - the cipher transformation specification. Cannot be null.

preferredProvider - the preferred crypto provider such as "SunJCE". Will be ignored if null or no such provider exists.

JCECipherProvider

public JCECipherProvider(String transformation,
                         Provider preferredProvider)

Initialises the cipher provider with the given cipher transformation and preferred provider. See Cipher.getInstance(String, java.security.Provider) for details on valid values for these parameters.

Parameters:

transformation - the cipher transformation specification. Cannot be null.

preferredProvider - the preferred crypto provider. May be null, in which case it is ignored.

Method Detail

getCipher

public Cipher getCipher()

Attempts to get a cipher matching the chosen transformation from the underlying JCE facilities. If the preferred provider is present, then it will use that provider, otherwise any provider will be used.

Specified by:

getCipher in interface CipherProvider

Returns:

a cipher matching the configuration parameters, or null if no matching cipher could be obtained from JCE.