EncryptDeploy (Ebean 2.6.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.avaje.ebean.config
Class EncryptDeploy

java.lang.Object
  com.avaje.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.

Author:: rbygrave
See Also:: EncryptDeployManager.getEncryptDeploy(TableName, String)

Nested Class Summary
`static class`	`EncryptDeploy.Mode` The Encryption mode.

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

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

Method Summary
`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
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

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 Detail

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 Detail

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.