org.apache.cayenne.crypto

Class CryptoModuleBuilder

java.lang.Object

org.apache.cayenne.crypto.CryptoModuleBuilder

public class CryptoModuleBuilder
extends Object

A builder of a Cayenne DI module that will contain all extension to Cayenne runtime needed to enable encryption of certain data columns. Builder allows to specify custom ciphers, as well as a strategy for discovering which columns are encrypted.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
CryptoModuleBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.cayenne.di.Module	build() Produces a module that can be used to start Cayenne runtime.
CryptoModuleBuilder	bytesTransformer(Class<? extends BytesTransformerFactory> factoryType)
CryptoModuleBuilder	cipherAlgorithm(String algorithm)
CryptoModuleBuilder	cipherFactory(Class<? extends CipherFactory> factoryType)
CryptoModuleBuilder	cipherMode(String mode)
CryptoModuleBuilder	columnMapper(Class<? extends ColumnMapper> columnMapperType)
CryptoModuleBuilder	columnMapper(ColumnMapper columnMapper)
CryptoModuleBuilder	columnMapper(String pattern)
CryptoModuleBuilder	compress()
CryptoModuleBuilder	encryptionKeyAlias(String encryptionKeyAlias)
CryptoModuleBuilder	keySource(Class<? extends KeySource> type)
CryptoModuleBuilder	keySource(KeySource keySource)
CryptoModuleBuilder	keyStore(File file, char[] passwordForAllKeys, String encryptionKeyAlias) Configures keystore parameters.
CryptoModuleBuilder	keyStore(String url, char[] passwordForAllKeys, String encryptionKeyAlias) Configures keystore parameters.
CryptoModuleBuilder	keyStore(URL url, char[] passwordForAllKeys, String encryptionKeyAlias) Configures keystore parameters.
CryptoModuleBuilder	valueTransformer(Class<? extends ValueTransformerFactory> factoryType)

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptoModuleBuilder

public CryptoModuleBuilder()

Method Detail

cipherAlgorithm

public CryptoModuleBuilder cipherAlgorithm(String algorithm)

cipherMode

public CryptoModuleBuilder cipherMode(String mode)

cipherFactory

public CryptoModuleBuilder cipherFactory(Class<? extends CipherFactory> factoryType)

valueTransformer

public CryptoModuleBuilder valueTransformer(Class<? extends ValueTransformerFactory> factoryType)

bytesTransformer

public CryptoModuleBuilder bytesTransformer(Class<? extends BytesTransformerFactory> factoryType)

columnMapper

public CryptoModuleBuilder columnMapper(Class<? extends ColumnMapper> columnMapperType)

columnMapper

public CryptoModuleBuilder columnMapper(ColumnMapper columnMapper)

columnMapper

public CryptoModuleBuilder columnMapper(String pattern)

encryptionKeyAlias

public CryptoModuleBuilder encryptionKeyAlias(String encryptionKeyAlias)

Parameters:

encryptionKeyAlias - The name of the key in the keystore that should be used for encryption by default.

keyStore

public CryptoModuleBuilder keyStore(File file,
                           char[] passwordForAllKeys,
                           String encryptionKeyAlias)

Configures keystore parameters. The KeyStore must be of "jceks" type and contain all needed secret keys for the target database. Currently all keys must be protected with the same password.

Parameters:

file - A file to load keystore from.

passwordForAllKeys - A password that unlocks all keys in the keystore.

encryptionKeyAlias - The name of the key in the keystore that should be used for encryption by default.

keyStore

public CryptoModuleBuilder keyStore(String url,
                           char[] passwordForAllKeys,
                           String encryptionKeyAlias)

Configures keystore parameters. The KeyStore must be of "jceks" type and contain all needed secret keys for the target database. Currently all keys must be protected with the same password.

Parameters:

url - A URL to load keystore from.

passwordForAllKeys - A password that unlocks all keys in the keystore.

encryptionKeyAlias - The name of the key in the keystore that should be used for encryption by default.

keyStore

public CryptoModuleBuilder keyStore(URL url,
                           char[] passwordForAllKeys,
                           String encryptionKeyAlias)

Configures keystore parameters. The KeyStore must be of "jceks" type and contain all needed secret keys for the target database. Currently all keys must be protected with the same password.

Parameters:

url - A URL to load keystore from.

passwordForAllKeys - A password that unlocks all keys in the keystore.

encryptionKeyAlias - The name of the key in the keystore that should be used for encryption by default.

keySource

public CryptoModuleBuilder keySource(Class<? extends KeySource> type)

keySource

public CryptoModuleBuilder keySource(KeySource keySource)

compress

public CryptoModuleBuilder compress()

build

public org.apache.cayenne.di.Module build()

Produces a module that can be used to start Cayenne runtime.