Package io.ebean.plugin

Interface SpiServer

All Superinterfaces:

Database

public interface SpiServer
extends Database

Extensions to Database API made available to plugins.

Method Summary

Modifier and Type	Method	Description
BeanLoader	beanLoader()	Return a BeanLoader.
<T> BeanType<T>	beanType(Class<T> beanClass)	Return the bean type for a given entity bean class.
BeanType<?>	beanTypeForQueueId(String queueId)	Return the bean type for a given doc store queueId.
List<? extends BeanType<?>>	beanTypes()	Return all the bean types registered on this server instance.
List<? extends BeanType<?>>	beanTypes(String baseTableName)	Return the bean types mapped to the given base table.
DatabaseConfig	config()	Return the DatabaseConfig.
DatabasePlatform	databasePlatform()	Return the DatabasePlatform for this database.
default <T> BeanType<T>	getBeanType(Class<T> beanClass)	Deprecated.
default BeanType<?>	getBeanTypeForQueueId(String queueId)	Deprecated.
default List<? extends BeanType<?>>	getBeanTypes()	Deprecated.
default List<? extends BeanType<?>>	getBeanTypes(String baseTableName)	Deprecated.
default DatabasePlatform	getDatabasePlatform()	Deprecated.
default DatabaseConfig	getServerConfig()	Deprecated.
void	loadBean(EntityBeanIntercept ebi)	Invoke lazy loading on this single bean when no BeanLoader is set.
void	loadBeanL2(EntityBeanIntercept ebi)	Invoke lazy loading on this single bean (L2 cache bean).
void	loadBeanRef(EntityBeanIntercept ebi)	Invoke lazy loading on this single bean (reference bean).

Methods inherited from interface io.ebean.Database

autoTune, backgroundExecutor, beanId, beanId, beanState, beginTransaction, beginTransaction, beginTransaction, cacheManager, checkUniqueness, checkUniqueness, commitTransaction, createCallableSql, createCsvReader, createEntityBean, createNamedDtoQuery, createNamedQuery, createQuery, createQuery, createSqlQuery, createSqlUpdate, createTransaction, createTransaction, createUpdate, currentTransaction, dataSource, delete, delete, delete, delete, deleteAll, deleteAll, deleteAll, deleteAll, deleteAllPermanent, deleteAllPermanent, deleteAllPermanent, deleteAllPermanent, deletePermanent, deletePermanent, deletePermanent, deletePermanent, diff, docStore, draftRestore, draftRestore, draftRestore, draftRestore, endTransaction, execute, execute, execute, execute, execute, execute, execute, execute, executeCall, executeCall, expressionFactory, extended, externalModification, filter, find, find, find, findDto, findNative, flush, getAutoTune, getBackgroundExecutor, getBeanId, getBeanState, getDataSource, getExpressionFactory, getMetaInfoManager, getName, getPlatform, getPluginApi, getReadOnlyDataSource, getReference, getServerCacheManager, insert, insert, insertAll, insertAll, json, lock, markAsDirty, merge, merge, merge, metaInfo, name, nextId, platform, pluginApi, publish, publish, publish, publish, readOnlyDataSource, reference, refresh, refreshMany, register, rollbackTransaction, save, save, saveAll, saveAll, saveAll, script, setBeanId, shutdown, shutdown, sort, sqlQuery, sqlUpdate, truncate, truncate, update, update, update, updateAll, updateAll, validateQuery

Method Details

config

DatabaseConfig config()

Return the DatabaseConfig.

getServerConfig

@Deprecated
default DatabaseConfig getServerConfig()

Deprecated.

Migrate to config().

databasePlatform

DatabasePlatform databasePlatform()

Return the DatabasePlatform for this database.

getDatabasePlatform

@Deprecated
default DatabasePlatform getDatabasePlatform()

Deprecated.

Migrate to config().

beanTypes

List<? extends BeanType<?>> beanTypes()

Return all the bean types registered on this server instance.

getBeanTypes

@Deprecated
default List<? extends BeanType<?>> getBeanTypes()

Deprecated.

Migrate to beanTypes().

beanType

<T> BeanType<T> beanType(Class<T> beanClass)

Return the bean type for a given entity bean class.

getBeanType

@Deprecated
default <T> BeanType<T> getBeanType(Class<T> beanClass)

Deprecated.

Migrate to beanType().

beanTypes

List<? extends BeanType<?>> beanTypes(String baseTableName)

Return the bean types mapped to the given base table.

getBeanTypes

@Deprecated
default List<? extends BeanType<?>> getBeanTypes(String baseTableName)

Deprecated.

Migrate to beanTypes().

beanTypeForQueueId

BeanType<?> beanTypeForQueueId(String queueId)

Return the bean type for a given doc store queueId.

getBeanTypeForQueueId

@Deprecated
default BeanType<?> getBeanTypeForQueueId(String queueId)

Deprecated.

Migrate to beanTypes().

beanLoader

BeanLoader beanLoader()

Return a BeanLoader.

loadBeanRef

void loadBeanRef(EntityBeanIntercept ebi)

Invoke lazy loading on this single bean (reference bean).

loadBeanL2

void loadBeanL2(EntityBeanIntercept ebi)

Invoke lazy loading on this single bean (L2 cache bean).

loadBean

void loadBean(EntityBeanIntercept ebi)

Invoke lazy loading on this single bean when no BeanLoader is set. Typically due to serialisation or multiple stateless updates.