Module io.ebean.api

Package io.ebean.config

Configuration settings for Database construction

Interface Summary

Interface	Description
AutoConfigure	Used to provide some automatic configuration early in the creation of a Database.
BackgroundExecutorWrapper	BackgroundExecutorWrapper that can be used to wrap tasks that are sent to background (i.e.
CurrentTenantProvider	Provides the Tenant Id for the current request based on the current user.
CurrentUserProvider	Provides the current user in order to support 'Who created', 'Who modified' and other audit features.
DatabaseConfigProvider	Provides a ServiceLoader based mechanism to configure a DatabaseConfig.
DbConstraintNaming.MaxLength	Defines how constraint names are shortened if required based on platform limitations.
EncryptDeployManager	Programmatically define which database columns are encrypted.
EncryptKey	Represents the key used for encryption.
EncryptKeyManager	Determine keys used for encryption and decryption.
Encryptor	Used for Java side encryption of properties when DB encryption is not used.
ExternalTransactionManager	Provides awareness of externally managed transactions.
IdGenerator	A customer Id generator that can be registered with Ebean and assigned to @Id properties using the name attribute of @GeneratedValue.
ModuleInfoLoader	Loads and returns entity classes to register with Ebean databases.
NamingConvention	Defines the naming convention for converting between logical property names/entity names and physical DB column names/table names.
QueryPlanListener	EXPERIMENTAL: Listener for captured query plans.
ScalarTypeConverter<B,S>	Matches the functionality of javax.persistence.AttributeConverter
SlowQueryListener	Listener for slow query events.
TenantCatalogProvider	For multi-tenancy via DB CATALOG supply the catalog given the tenantId.
TenantDataSourceProvider	For multi-tenancy via DB supply the DataSource given the tenantId.
TenantSchemaProvider	For multi-tenancy via DB SCHEMA supply the schema given the tenantId.

Class Summary

Class	Description
AbstractNamingConvention	Provides some base implementation for NamingConventions.
AutoTuneConfig	Defines the AutoTune behaviour for a Database.
ClassLoadConfig	Helper to find classes taking into account the context class loader.
ClassLoadConfig.ClassLoaderContext	Wraps the preferred, caller and context class loaders.
ContainerConfig	Configuration for the container that holds the Database instances.
CustomDbTypeMapping	Custom mappings for DB types that override the default.
DatabaseConfig	The configuration used for creating a Database.
DbConstraintNaming	Naming convention used for constraint names.
DbConstraintNormalise	Used to normalise table and column names which means stripping out quoted identifier characters and any catalog or schema prefix.
DocStoreConfig	Configuration for the Document store integration (e.g.
EncryptDeploy	Define the encryption options for a bean property.
JsonConfig	Configuration for JSON features.
MatchingNamingConvention	The JPA naming convention where column names match property names and table names match entity names.
MdcBackgroundExecutorWrapper	Propagates MDC context for tasks executed in the background.
PlatformConfig	Configuration for DB types such as UUID, Geometry etc.
ProfilingConfig	Configuration for transaction profiling.
PropertiesWrapper
QueryPlanCapture	The captured query plans.
SlowQueryEvent	Slow query event.
TableName	TableName holds catalog, schema and table name.
UnderscoreNamingConvention	Converts between Camel Case and Underscore based names for both table and column names (and is the default naming convention in Ebean).

Enum Summary

Enum	Description
AutoTuneMode	The mode for determining if AutoTune will be used for a given query when Query.setAutoTune(boolean) has not been explicitly set on a query.
DatabaseConfig.UuidVersion
EncryptDeploy.Mode	The Encryption mode.
JsonConfig.Date	Defined the format used for Date types.
JsonConfig.DateTime	Defined the format used for DateTime types.
JsonConfig.Include
PlatformConfig.DbUuid	Specify how UUID is stored.
TenantMode	The mode to use for multi-tenancy.

Exception Summary

Exception	Description
BeanNotEnhancedException	Throw when an processing an entity bean that is not bytecode enhanced.
BeanNotRegisteredException	Throw when an processing thinks a bean is not registered.

Annotation Types Summary

Annotation Type	Description
ModuleInfo	Used by generated code to hold entity classes to register with Ebean.