Module datarush.commons

Package com.pervasive.datarush.encryption

Class EncryptionManager

java.lang.Object

com.pervasive.datarush.encryption.EncryptionManager

public final class EncryptionManager
extends Object

A manager of EncryptionProvider's. Within a JVM, there is a single, static currentEncryptor that is used when performing encryption of sensitive information. The currentEncryptor may be globally set by setting the currentEncryptorId. Within a JVM, there can be multiple providers that are used when performing decryption.

This model allows for the encryption strategy to evolve over time while always being able to read files written by previous EncryptionProvider's.

See Also:

EncryptionProvider

Method Summary

Modifier and Type	Method	Description
EncryptionProvider	getCurrentEncryptor()	Returns the encryptor to use when encrypting.
String	getCurrentEncryptorId()	Gets the id of the EncryptionProvider to use when encrypting.
static EncryptionManager	getInstance()	Returns the single instance of this class.
EncryptionProvider	getProvider(String id)	Returns the provider whose providerID matches that given.
void	setCurrentEncryptorId(String id)	Sets the id of the EncryptionProvider to use when encrypting.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static EncryptionManager getInstance()

Returns the single instance of this class.

Returns:

the single instance of this class

getProvider

public EncryptionProvider getProvider(String id)

Returns the provider whose providerID matches that given.

Parameters:

id - the providerID

Returns:

the matching provider

Throws:

IllegalArgumentException - if no provider was found that matches the given ID

setCurrentEncryptorId

public void setCurrentEncryptorId(String id)

Sets the id of the EncryptionProvider to use when encrypting. By default this is set to DefaultEncryptionProvider.ID.

Parameters:

id - the encryptor id

Throws:

IllegalArgumentException - if the given provider is not registered

getCurrentEncryptorId

public String getCurrentEncryptorId()

Gets the id of the EncryptionProvider to use when encrypting. By default this is set to DefaultEncryptionProvider.ID.

Returns:

the encryptor id

getCurrentEncryptor

public EncryptionProvider getCurrentEncryptor()

Returns the encryptor to use when encrypting. By default this is a DefaultEncryptionProvider.

Returns:

the encryptor to use when encrypting.