Module io.ebean.api

Package io.ebean.config

Class EncryptDeploy

java.lang.Object

io.ebean.config.EncryptDeploy

public class EncryptDeploy
extends Object

Define the encryption options for a bean property.

You can define the encryption options for a Bean property via the Encrypt annotation and programmatically via EncryptDeployManager.

See Also:

• EncryptDeployManager.getEncryptDeploy(TableName, String)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EncryptDeploy.Mode	The Encryption mode.

Field Summary

Fields

Modifier and Type	Field	Description
static final EncryptDeploy	ANNOTATION	Use to define that the Encrypt annotation should be used to control encryption.
static final EncryptDeploy	ENCRYPT_CLIENT	Use to define that Java client Encryption should be used (rather than DB encryption).
static final EncryptDeploy	ENCRYPT_DB	Use to define that Encryption should be used and String types should use DB encryption.
static final EncryptDeploy	NO_ENCRYPT	Use to define that no encryption should be used.

Constructor Summary

Constructors

Constructor	Description
EncryptDeploy(EncryptDeploy.Mode mode, boolean dbEncrypt, int dbLength)	Construct with all options for Encryption including the dbLength.

Method Summary

Modifier and Type	Method	Description
int	getDbLength()	Return a hint to specify the DB length.
EncryptDeploy.Mode	getMode()	Return the encryption mode.
boolean	isDbEncrypt()	Return true if String type should use DB encryption.

Methods inherited from class java.lang.Object

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

Field Details

NO_ENCRYPT

public static final EncryptDeploy NO_ENCRYPT

Use to define that no encryption should be used.

ANNOTATION

public static final EncryptDeploy ANNOTATION

Use to define that the Encrypt annotation should be used to control encryption.

ENCRYPT_DB

public static final EncryptDeploy ENCRYPT_DB

Use to define that Encryption should be used and String types should use DB encryption.

ENCRYPT_CLIENT

public static final EncryptDeploy ENCRYPT_CLIENT

Use to define that Java client Encryption should be used (rather than DB encryption).

Constructor Details

EncryptDeploy

public EncryptDeploy(EncryptDeploy.Mode mode,
 boolean dbEncrypt,
 int dbLength)

Construct with all options for Encryption including the dbLength.

Parameters:

mode - the Encryption mode

dbEncrypt - set to false if you want to use Java client side encryption rather than DB encryption.

dbLength - set the DB length to use.

Method Details

getMode

public EncryptDeploy.Mode getMode()

Return the encryption mode.

isDbEncrypt

public boolean isDbEncrypt()

Return true if String type should use DB encryption.

Return false if String type should use java client encryption instead.

getDbLength

public int getDbLength()

Return a hint to specify the DB length.

Returning 0 means just use the normal DB length determination.