All Classes

Class	Description
AbstractBeanPersistListener	Provides a base implementation of BeanPersistListener.
AbstractDbEncrypt	Base type for DB platform specific Encryption.
AbstractMatch	Options for the text match and multi match expressions.
AbstractMetricVisitor	An abstract MetricVisitor that handles the boolean flags - reset, collectTransactionMetrics and collectQueryMetrics.
AbstractNamingConvention	Provides some base implementation for NamingConventions.
AcquireLockException	Thrown when failing to acquire a pessimistic lock.
AnnotationUtil	Annotation utility methods to find annotations.
AutoConfigure	Used to provide some automatic configuration early in the creation of a Database.
AutoTune	Administrative control of AutoTune during runtime.
AutoTuneConfig	Defines the AutoTune behaviour for a Database.
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.
BackgroundExecutor	Background executor service for executing of tasks asynchronously.
BaseMySqlPlatform	Base platform for both MySql and MariaDB.
BasicMetricVisitor	A simple MetricVisitor that can collect the desired metrics into lists.
BasicSqlAnsiLimiter	Adds ANSI based OFFSET FETCH NEXT clauses to a SQL query.
BasicSqlLimiter	Simple SQL limiter for use with SqlQuery.
BasicSqlLimitOffset	Adds LIMIT OFFSET clauses to a SQL query.
BeanChange	A bean insert, update or delete change sent as part of a ChangeSet.
BeanCollection<E>	Lazy loading capable Maps, Lists and Sets.
BeanCollection.ModifyListenMode
BeanCollectionAdd	Interface to define the addition of a bean to the underlying collection.
BeanCollectionLoader	Loads a entity bean collection.
BeanDeleteIdRequest	A request to delete a bean by Id value.
BeanDiffVisitor	Visitor for collecting new/old values for a bean update.
BeanDocType<T>	Doc store functions for a specific entity bean type.
BeanFindController	Used to override the finding implementation for a bean.
BeanFinder<I,T>	Provides finder functionality for use with "Dependency Injection style" use of Ebean.
BeanList<E>	List capable of lazy loading.
BeanLoader	Loads a entity bean.
BeanMap<K,E>	Map capable of lazy loading.
BeanNotEnhancedException	Throw when an processing an entity bean that is not bytecode enhanced.
BeanNotRegisteredException	Throw when an processing thinks a bean is not registered.
BeanPersistAdapter	A no operation implementation of BeanPersistController.
BeanPersistController	Used to enhance or override the default bean persistence mechanism.
BeanPersistListener	Listens for committed bean events.
BeanPersistRequest<T>	Holds the information available for a bean persist (insert, update or delete).
BeanPostConstructListener	Fired after a bean is constructed, but not yet loaded from database.
BeanPostLoad	Fired after a bean is fetched and loaded from the database.
BeanQueryAdapter	Objects extending this modify queries prior their execution.
BeanQueryRequest<T>	Holds the information available for a bean query.
BeanRepository<I,T>	Provides finder functionality for use with "Dependency Injection style" use of Ebean.
BeanSet<E>	Set capable of lazy loading.
BeanState	Provides access to the internal state of an entity bean.
BeanType<T>	Information and methods on BeanDescriptors made available to plugins.
BulkTableEvent	The bulk table event.
BulkTableEventListener	Listen for bulk table events that occur.
CacheMode	Enum to control the different cache modes for queryCache and beanCache.
CallableSql	For making calls to stored procedures.
CallOrigin	A call origin for query execution profiling to collect graph use (for query tuning).
CallStack	Represent the call stack (stack trace elements).
CamelCaseHelper
CancelableQuery	Defines a cancelable query.
ChangeLogFilter	Used to provide fine grained control over what persist requests are included in the change log.
ChangeLogListener	Listen for changes.
ChangeLogPrepare	Listen for changes.
ChangeLogRegister	Used to assign ChangeLogFilters to bean types.
ChangeSet	Holds a set of changes.
ChangeType	The type of the change.
ClassLoadConfig	Helper to find classes taking into account the context class loader.
ClickHousePlatform
CockroachPlatform	CockroachDB based platform.
ContainerConfig	Configuration for the container that holds the Database instances.
CopyOnFirstWriteList<E>	List that copies itself on first write access.
CountDistinctOrder	Enumeration to use with Query.setCountDistinct(CountDistinctOrder).
CountedValue<A>	Holds a distinct value with it's count.
CountMetric	Metric for timed events like transaction execution times.
CountMetricStats
CsvCallback<T>	Provides callback methods for customisation of CSV processing.
CsvReader<T>	Reads CSV data turning it into object graphs that you can be saved (inserted) or processed yourself.
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.
CustomDbTypeMapping	Custom mappings for DB types that override the default.
Database	Provides the API for fetching and saving beans to a particular database.
DatabaseConfig	The configuration used for creating a Database.
DatabaseConfig.UuidVersion
DatabaseConfigProvider	Provides a ServiceLoader based mechanism to configure a DatabaseConfig.
DatabaseFactory	Creates Database instances.
DatabasePlatform	Database platform specific settings.
DatabasePlatform.OnQueryOnly	Behavior used when ending a query only transaction (at read committed isolation level).
DataErrorType	Specific persistence error types we wish to map.
DataIntegrityException	Thrown when a foreign key constraint is enforced.
DB	DB is a registry of Database by name.
DB2Platform	DB2 specific platform.
DB2SequenceIdGenerator	DB2 specific sequence Id Generator.
Db2SqlLimiter
DbConstraintNaming	Naming convention used for constraint names.
DbConstraintNaming.MaxLength	Defines how constraint names are shortened if required based on platform limitations.
DbConstraintNormalise	Used to normalise table and column names which means stripping out quoted identifier characters and any catalog or schema prefix.
DbDefaultValue	DB Column default values mapping to database platform specific literals.
DbEncrypt	Defines DB encryption support for encrypting and decrypting data using DB encryption features.
DbEncryptFunction
DbHistorySupport	History support for the database platform.
DbIdentity	Defines the identity/sequence behaviour for the database.
DbPlatformType	Represents a DB type with name, length, precision, and scale.
DbPlatformTypeMapping	Used to map bean property types to DB specific types for DDL generation.
DbStandardHistorySupport	SQL2011 based history support using 'as of timestamp' type clause appended as part of the the from or join clause.
DbType	The known DB types that are mapped.
DbViewHistorySupport	Database view based implementation of DbHistorySupport.
DefaultCsvCallback<T>	Provides the default implementation of CsvCallback.
DocMapping	Document Mapping for a bean marker interface.
DocQueryContext<T>	Document query request context marker interface.
DocStoreConfig	Configuration for the Document store integration (e.g.
DocStoreQueueEntry	Bean holding the details to update the document store.
DocStoreQueueEntry.Action	Action to either update or delete a document from the index.
DocumentStore	Document storage operations.
DocUpdateContext	Document update context marker interface.
DtoQuery<T>	Query for performing native SQL queries that return DTO Bean's.
DuplicateKeyException	Thrown when a duplicate is attempted on a unique constraint.
Ebean	Deprecated.
EbeanServer	Deprecated.
EbeanServerFactory	Deprecated.
EbeanVersion	Class to determine the ebean version.
EJson	Utility that converts between JSON content and simple java Maps/Lists.
EmptyPagedList<T>	An empty PagedList.
EncodeB64	Integer to base64 encoder.
EncryptDeploy	Define the encryption options for a bean property.
EncryptDeploy.Mode	The Encryption mode.
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.
EnhancedTransactional	Marker interface for classes enhanced to support Transactional methods.
EntityBean	Bean that is aware of EntityBeanIntercept.
EntityBeanIntercept	This is the object added to every entity bean using byte code enhancement.
ExampleExpression	Query by Example expression.
Expr	Expression factory for creating standard expressions for WHERE and HAVING clauses.
Expression	An expression that is part of a WHERE or HAVING clause.
ExpressionFactory	Expression factory for creating standard expressions.
ExpressionList<T>	List of Expressions that make up a where or having clause.
ExpressionPath	A dot notation expression path.
ExtendedServer	The extended API for Database.
ExternalTransactionManager	Provides awareness of externally managed transactions.
ExtraDbTypes	Integer codes for the extra types beyond java.sql.Types.
FetchConfig	Defines how a relationship is fetched via either normal SQL join, a eager secondary query, via lazy loading or via eagerly hitting L2 cache.
FetchGroup<T>	Defines what part of the object graph to load (select and fetch clauses).
FetchGroupBuilder<T>	Builds a FetchGroup by adding fetch clauses.
FetchPath	Provides paths and properties for an object graph that can be used to control what parts of the object graph is fetching (select and fetch clauses) and also can be used to control JSON marshalling (what parts of the object graph are included in the JSON).
Filter<T>	Provides support for filtering and sorting lists of entities without going back to the database.
Finder<I,T>	Intended to be used as a base class for 'Finder' implementations that can then be injected or used as public static fields on the associated entity bean.
FutureIds<T>	FutureIds represents the result of a background query execution for the Id's.
FutureList<T>	FutureList represents the result of a background query execution that will return a list of entities.
FutureRowCount<T>	Represents the result of a background query execution for the total row count for a query.
H2DbEncrypt	H2 encryption support via encrypt decrypt function.
H2HistorySupport	Runtime support for @History with H2.
H2HistoryTrigger	H2 database trigger used to populate history tables to support the @History feature.
H2Platform	H2 specific platform.
H2SequenceIdGenerator	H2 specific sequence Id Generator.
HanaBasicSqlLimiter
HanaHistorySupport
HanaPlatform
HanaSqlLimiter
HsqldbPlatform	H2 specific platform.
IdGenerator	A customer Id generator that can be registered with Ebean and assigned to @Id properties using the name attribute of @GeneratedValue.
IdType	The types of Identity generation that can be defined.
IOUtils	Utilities for IO.
JdbcClose	Utility for closing raw Jdbc resources.
JsonBeanReader<T>	Provides a JSON reader that can hold a persistence context and load context while reading JSON.
JsonConfig	Configuration for JSON features.
JsonConfig.Date	Defined the format used for Date types.
JsonConfig.DateTime	Defined the format used for DateTime types.
JsonConfig.Include
JsonContext	Converts objects to and from JSON format.
JsonIOException	Unchecked exception thrown when an IOException occurs in json processing.
JsonReadBeanVisitor<T>	Provides for custom handling of json content as it is read.
JsonReadOptions	Provides the ability to customise the reading of JSON content.
JsonWriteBeanVisitor<T>	Allows for customising the JSON write processing.
JsonWriteOptions	Provides options for customising the JSON write process.
JsonWriter	Wraps an underlying JsonGenerator taking into account null suppression and exposing isIncludeEmpty() etc.
Junction<T>	Represents a Conjunction or a Disjunction.
Junction.Type	The type of Junction used in full text expressions.
LikeType	Used to specify the type of like matching used.
LimitOffsetSqlLimiter	Adds LIMIT OFFSET clauses to a SQL query.
MariaDbHistorySupport	History support for MariaDB.
MariaDbPlatform	MariaDB platform.
MariaDbSequence
Match	Options for the text match expression.
MatchingNamingConvention	The JPA naming convention where column names match property names and table names match entity names.
MergeOptions	Options used to control a merge.
MergeOptionsBuilder	Builds a MergeOptions which is immutable and thread safe.
MetaCountMetric	Count metrics.
MetaInfoManager	Provides access to the meta data in Database such as query execution statistics.
MetaMetric	Metrics collected by Ebean including timed metrics and counters.
MetaQueryMetric	Query execution metrics.
MetaQueryPlan	Meta data for captured query plan.
MetaTimedMetric	Timed execution statistics.
MetricData	An individual metric.
MetricFactory	Factory to create timed metric counters.
MetricVisitor	Defines visitor to read and report the transaction and query metrics.
Model	A MappedSuperclass base class that provides convenience methods for inserting, updating and deleting beans.
ModifyAwareType	Owner object notified when a modification is detected.
ModuleInfo	Used by generated code to hold entity classes to register with Ebean.
ModuleInfoLoader	Loads and returns entity classes to register with Ebean databases.
MultiMatch	Options for the text match expression.
MultiMatch.Type	The MultiMatch type.
MutableValueInfo	Holds information on mutable values (like plain beans stored as json).
MutableValueNext	Represents a next value to use for mutable content properties (DbJson with jackson beans).
MySql55Platform
MySqlBlob	Support for blob, mediumblob or longblob selection based on the deployment length.
MySqlClob	Support for text, mediumtext or longtext selection based on the deployment length.
MySqlDbEncrypt	MySql aes_encrypt aes_decrypt based encryption support.
MySqlHistorySupport	Runtime support for @History with MySql.
MySqlPlatform	MySQL specific platform.
NamingConvention	Defines the naming convention for converting between logical property names/entity names and physical DB column names/table names.
NodeUsageCollector	Collects profile information for a bean (or reference/proxy bean) at a given node.
NodeUsageListener	Collects the profile information.
NotEnhancedException	This exception is thrown, when the default implementation of EntityBean is not or not properly overwritten by enhancer.
NuoDbHistorySupport	Runtime support for @History with NuoDB.
NuoDbPlatform	NuoDb specific platform.
NuoDbSequence
ObjectGraphNode	Identifies a unique node of an object graph.
ObjectGraphOrigin	Represents a "origin" of an ORM object graph.
Oracle11Platform	Oracle 11 platform using rownum sql limiting.
Oracle12Platform	Oracle 12 platform using column alias.
OracleDbEncrypt	Oracle encryption support.
OracleDbHistorySupport	Oracle Total recall based history support.
OraclePlatform	Oracle specific platform.
OracleRownumBasicLimiter	Row limiter for Oracle 9,10,11 using rownum.
OracleSequenceIdGenerator	Oracle specific sequence Id Generator.
OrderBy<T>	Represents an Order By for a Query.
OrderBy.Property	A property and its ascending descending order.
PagedList<T>	Represents a page of results.
Pairs	Holds a list of value object pairs.
Pairs.Entry	A pair of 2 value objects.
PathProperties	This is a Tree like structure of paths and properties that can be used for defining which parts of an object graph to render in JSON or XML, and can also be used to define which parts to select and fetch for an ORM query.
PathProperties.Props
PersistenceContext	Holds entity beans by there type and id.
PersistenceContext.WithOption	Wrapper on a bean to also indicate if a bean has been deleted.
PersistenceContextScope	Defines the scope for PersistenceContext.
PersistenceIOException	Captures and wraps IOException's occurring during ElasticSearch processing etc.
PlatformConfig	Configuration for DB types such as UUID, Geometry etc.
PlatformConfig.DbUuid	Specify how UUID is stored.
PlatformIdGenerator	Generates unique id's for objects.
Plugin	A 'plugin' that wants to be configured on startup so it can use features of the Database itself.
Postgres9Platform	Postgres9 platform - uses serial type for identity columns.
PostgresDbEncrypt	Postgres pgp_sym_encrypt pgp_sym_decrypt based encryption support.
PostgresHistorySupport	Postgres support for history features.
PostgresPlatform	Postgres 10+ platform.
PostgresSequenceIdGenerator	Postgres specific sequence Id Generator.
PreGetterCallback	A callback that can be registered to fire on getter method calls.
ProfileLocation	A location for profiling transactions and queries.
ProfilingConfig	Configuration for transaction profiling.
PropertiesWrapper
Property	Property of a entity bean that can be read.
PropertyAssocMany	Property of a entity bean that is a ToMany property.
Query<T>	Object relational query for finding a List, Set, Map or single entity bean.
Query.LockType	The lock type (strength) to use with query FOR UPDATE row locking.
Query.LockWait	FOR UPDATE wait mode.
QueryCacheEntry	For query cache entries we additionally hold the dependent tables and timestamp for the query result.
QueryCacheEntryValidate	Used to validate that a query cache entry is still valid based on dependent tables.
QueryIterator<T>	Used to provide iteration over query results.
QueryPlanCapture	The captured query plans.
QueryPlanCollector	Object used to collect query plan metrics.
QueryPlanInit	Initiate query plan collection for plans by their hash or all query plans.
QueryPlanListener	EXPERIMENTAL: Listener for captured query plans.
QueryPlanMetric	Internal Query plan metric holder.
QueryPlanRequest	Request used to capture query plans.
QueryType	The type of the query being executed.
RawDoc	Raw document.
RawSql	Used to build object graphs based on a raw SQL statement (rather than generated by Ebean).
RawSqlBuilder	Builds RawSql instances from a SQL string and column mappings.
ReadAuditLogger	Log that the query was executed
ReadAuditPrepare	Set user context information into the read event prior to it being logged.
ReadAuditQueryPlan	A SQL query and associated keys.
ReadEvent	Read event sent to the ReadEventLogger.
RowConsumer	Used with SqlQuery to process potentially large queries reading directly from the JDBC ResultSet.
RowMapper<T>	Used with SqlQuery to map raw JDBC ResultSet to objects.
ScalarTypeConverter<B,S>	Matches the functionality of javax.persistence.AttributeConverter
ScriptRunner	Runs DDL and SQL scripts.
SequenceBatchIdGenerator	Database sequence based IdGenerator using Sequence Step 1 but batch fetch many sequence values.
SequenceIdGenerator	Database sequence based IdGenerator.
SequenceStepIdGenerator	Database sequence based IdGenerator using Sequence Step (e.g.
SerializableConflictException	Thrown at SERIALIZABLE isolation level for non-recoverable concurrent conflict.
ServerCache	Represents part of the "L2" server side cache.
ServerCacheConfig	Configuration used to create ServerCache instances.
ServerCacheFactory	Defines method for constructing caches for beans and queries.
ServerCacheManager	The cache service for server side caching of beans and query results.
ServerCacheNotification	Notification event that dependent tables have been modified.
ServerCacheNotify	Interface for both listening to notification changes and sending them to other members of the cluster.
ServerCacheNotifyPlugin	Plugin that provides a ServerCacheNotify implementation.
ServerCacheOptions	Options for controlling a cache.
ServerCachePlugin	The plugin interface that creates a ServerCacheFactory.
ServerCacheRegion	Cache region can be enabled independently.
ServerCacheStatistics	The statistics collected per cache.
ServerCacheType	The type of L2 caches.
ServerConfig	Deprecated.
ServerConfigProvider	Deprecated.
ServerConfigStartup	Used to configure the server on startup.
ServerMetrics	Metrics of the Database instance.
ServerMetricsAsJson	Collect the metrics in raw JSON form.
ServletContextListener	Listens for webserver server starting and stopping events.
ShutdownManager	Manages the shutdown of Ebean.
SimpleSequenceIdGenerator	A very simple Database sequence based IdGenerator.
SingleBeanLoader	BeanLoader used when single beans are loaded (which is usually not ideal / N+1).
SingleBeanLoader.Dflt	Single bean lazy loaded when a reference bean.
SingleBeanLoader.L2	Single bean lazy loaded when bean from L2 cache.
SingleBeanLoader.Ref	Single bean lazy loaded when a reference bean.
SlowQueryEvent	Slow query event.
SlowQueryListener	Listener for slow query events.
SortMetric	Comparator for timed metrics sorted by name and then count.
SortMetric.Count	Sort by count desc.
SortMetric.CountName	Sort MetaCountMetric's by name.
SortMetric.Max	Sort by max desc.
SortMetric.Mean	Sort by mean desc.
SortMetric.Name	Sort by name.
SortMetric.Total	Sort by total time desc.
SpiContainer	Creates the Database implementations.
SpiContainerFactory	Provides shutdown of the entire container.
SpiFetchGroupQuery<T>	Extension of Query to build FetchGroup via query beans.
SpiFetchGroupService	Service that parses FetchGroup expressions.
SpiJsonService	JSON service that Ebean is expected to provide.
SpiProfileLocationFactory	Factory for creating profile locations.
SpiRawSqlService	Service provided by Ebean for parsing and column mapping raw SQL queries.
SpiServer	Extensions to Database API made available to plugins.
SplitName	Helper for dot notation property paths.
SqlAnywhereLimiter	Use top xx and start at xx to limit sql results.
SqlAnywherePlatform	Sybase SQL Anywhere specific platform.
SqlCodeTranslator	Translate SQLException based on SQLState codes.
SqlErrorCodes	Used to build a SQLCodeTranslator given DB platform specific codes.
SqlExceptionTranslator	Used to translate SQLExceptions to specific persistence exceptions.
SQLitePlatform
SqlLimiter	Adds SQL limiting to a query (such as LIMIT OFFSET).
SqlLimitRequest	The request object for the query that can have sql limiting applied to it (such as a LIMIT OFFSET clause).
SqlLimitResponse	The resulting SQL from a SqlLimit process.
SqlQuery	Query object for performing native SQL queries that return SqlRow or directly read ResultSet using a RowMapper.
SqlQuery.TypeQuery<T>	Query mapping to single scalar values.
SqlRow	Used to return raw SQL query results.
SqlServer16Platform	Microsoft SQL Server platform that has non-UTF8 types (char, varchar, text) and default to Identity rather than Sequence.
SqlServer17Platform	Microsoft SQL Server platform - NVarchar UTF types and Sequence preference.
SqlServerBasicSqlLimiter	SQL Server 2012 style limiter for raw sql.
SqlServerDbEncrypt	SQL Server EncryptByPassPhrase DecryptByPassPhrase based encryption support.
SqlServerHistorySupport	History support only valid on SqlServer 2016 or later.
SqlServerSqlLimiter	Use ANSI offset rows syntax or top n - SQL Server 2012 onwards.
SqlServerStepSequence
SqlUpdate	A SqlUpdate for executing insert update or delete statements.
StringFormatter	Convert an Object value into a String value.
StringHelper	Utility String class that supports String manipulation functions.
StringParser	Convert a String value into an Object value.
TableName	TableName holds catalog, schema and table name.
TenantAwareKey	Tenant aware handling for caching.
TenantAwareKey.CacheKey	We use a combined key, if this serverCache is per tenant.
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.
TenantMode	The mode to use for multi-tenancy.
TenantSchemaProvider	For multi-tenancy via DB SCHEMA supply the schema given the tenantId.
TextCommonTerms	Text common terms query.
TextException	An exception occurred typically in processing CSV, JSON or XML.
TextQueryString	Text query string options.
TextSimple	Simple text query options.
TimedMetric	Metric for timed events like transaction execution times.
TimedMetricMap	A map of timed metrics keyed by a string.
TimedMetricStats	Extend public MetaTimedMetric with ability to set details from profile location.
TimeStringParser	Parser for TIME types that supports both HH:mm:ss and HH:mm.
Transaction	The Transaction object.
TransactionCallback	Provides a callback that can be registered with a Transaction.
TransactionCallbackAdapter	Adapter that can be extended for easier implementation of TransactionCallback.
TxnState	Transaction state when ChangeSets are sent to the ChangeSetListener.
TxScope	Holds the definition of how a transactional method should run.
UnderscoreNamingConvention	Converts between Camel Case and Underscore based names for both table and column names (and is the default naming convention in Ebean).
Update<T>	An Insert Update or Delete statement.
UpdateQuery<T>	An update query typically intended to perform a bulk update of many rows that match the query.
ValuePair	Holds two values as the result of a difference comparison.
Version<T>	Wraps a version of a @History bean.