com.avaje.ebeaninternal.api

Interface SpiEbeanServer

All Superinterfaces:

BeanCollectionLoader, BeanLoader, EbeanServer

All Known Implementing Classes:

DefaultServer

public interface SpiEbeanServer
extends EbeanServer, BeanLoader, BeanCollectionLoader

Service Provider extension to EbeanServer.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearQueryStatistics() Clear the query execution statistics.
void	collectQueryStats(ObjectGraphNode objectGraphNode, long loadedBeanCount, long timeMicros) Collect query statistics by ObjectGraphNode.
<T> CQuery<T>	compileQuery(Query<T> query, Transaction t) Compile a query.
CallStack	createCallStack() Create an object to represent the current CallStack.
<T> SpiOrmQueryRequest<T>	createQueryRequest(BeanDescriptor<T> desc, SpiQuery<T> q, Transaction t) Create a query request object.
SpiTransaction	createQueryTransaction() Create a ServerTransaction for query purposes.
ScopeTrans	createScopeTrans(TxScope txScope) Create a ScopeTrans for a method for the given scope definition.
SpiTransaction	createServerTransaction(boolean isExplicit, int isolationLevel) Create a ServerTransaction.
void	externalModification(TransactionEventTable event) Process committed changes from another framework.
<T> List<Object>	findIdsWithCopy(Query<T> query, Transaction t) Execute the findId's query but without copying the query.
<T> int	findRowCountWithCopy(Query<T> query, Transaction t) Execute the findRowCount query but without copying the query.
AutoFetchManager	getAutoFetchManager() Return the AutoFetchListener.
<T> BeanDescriptor<T>	getBeanDescriptor(Class<T> type) Return the BeanDescriptor for a given type of bean.
BeanDescriptor<?>	getBeanDescriptorById(String descriptorId) Return BeanDescriptor using it's unique id.
List<BeanDescriptor<?>>	getBeanDescriptors() Return all the descriptors.
List<BeanDescriptor<?>>	getBeanDescriptors(String tableName) Return BeanDescriptors mapped to this table.
SpiTransaction	getCurrentServerTransaction() Return the current transaction or null if there is no current transaction.
DatabasePlatform	getDatabasePlatform() Return the DatabasePlatform for this server.
DdlGenerator	getDdlGenerator() Return the DDL generator.
int	getLazyLoadBatchSize() Return the default batch size for lazy loading.
PstmtBatch	getPstmtBatch() Return a JDBC driver specific handler for batching.
CQueryEngine	getQueryEngine() Return the queryEngine for this server.
boolean	isCollectQueryOrigins()
boolean	isDefaultDeleteMissingChildren() Return true if DeleteMissingChildren defaults to true for stateless updates.
boolean	isDefaultUpdateNullProperties() Return true if UpdateNullProperties defaults to true for stateless updates.
boolean	isSupportedType(Type genericType) Return true if the type is known as an Entity or Xml type or a List Set or Map of known bean types.
void	loadBean(LoadBeanRequest loadRequest) Load a batch of Associated One Beans.
void	loadMany(LoadManyRequest loadRequest) Lazy load a batch of Many's.
void	remoteTransactionEvent(RemoteTransactionEvent event) An event from another server in the cluster used to notify local BeanListeners of remote inserts updates and deletes.
void	shutdownManaged() For internal use, shutdown of the server invoked by JVM Shutdown.

Methods inherited from interface com.avaje.ebean.EbeanServer

beginTransaction, beginTransaction, commitTransaction, createCallableSql, createCsvReader, createEntityBean, createJsonContext, createNamedQuery, createNamedSqlQuery, createNamedSqlUpdate, createNamedUpdate, createQuery, createQuery, createSqlQuery, createSqlUpdate, createTransaction, createTransaction, createUpdate, currentTransaction, delete, delete, delete, delete, delete, delete, delete, delete, delete, deleteManyToManyAssociations, deleteManyToManyAssociations, diff, endTransaction, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, externalModification, filter, find, find, find, findFutureIds, findFutureList, findFutureList, findFutureRowCount, findIds, findIterate, findList, findList, findMap, findMap, findPagingList, findRowCount, findSet, findSet, findUnique, findUnique, findVisit, getAdminAutofetch, getBackgroundExecutor, getBeanId, getBeanState, getExpressionFactory, getMetaInfoManager, getName, getReference, getServerCacheManager, insert, insert, nextId, refresh, refreshMany, rollbackTransaction, runCacheWarming, runCacheWarming, save, save, save, save, save, saveAssociation, saveAssociation, saveManyToManyAssociations, saveManyToManyAssociations, shutdown, sort, update, update, update, update, update

Methods inherited from interface com.avaje.ebean.bean.BeanLoader

getName, loadBean

Methods inherited from interface com.avaje.ebean.bean.BeanCollectionLoader

getName, loadMany

Method Detail

shutdownManaged

void shutdownManaged()

For internal use, shutdown of the server invoked by JVM Shutdown.

isCollectQueryOrigins

boolean isCollectQueryOrigins()

isDefaultDeleteMissingChildren

boolean isDefaultDeleteMissingChildren()

Return true if DeleteMissingChildren defaults to true for stateless updates.

isDefaultUpdateNullProperties

boolean isDefaultUpdateNullProperties()

Return true if UpdateNullProperties defaults to true for stateless updates.

getDatabasePlatform

DatabasePlatform getDatabasePlatform()

Return the DatabasePlatform for this server.

getPstmtBatch

PstmtBatch getPstmtBatch()

Return a JDBC driver specific handler for batching.

Required for Oracle specific batch handling.

createCallStack

CallStack createCallStack()

Create an object to represent the current CallStack.

Typically used to identify the origin of queries for Autofetch and object graph costing.

getDdlGenerator

DdlGenerator getDdlGenerator()

Return the DDL generator.

getAutoFetchManager

AutoFetchManager getAutoFetchManager()

Return the AutoFetchListener.

clearQueryStatistics

void clearQueryStatistics()

Clear the query execution statistics.

getBeanDescriptors

List<BeanDescriptor<?>> getBeanDescriptors()

Return all the descriptors.

getBeanDescriptor

<T> BeanDescriptor<T> getBeanDescriptor(Class<T> type)

Return the BeanDescriptor for a given type of bean.

getBeanDescriptorById

BeanDescriptor<?> getBeanDescriptorById(String descriptorId)

Return BeanDescriptor using it's unique id.

getBeanDescriptors

List<BeanDescriptor<?>> getBeanDescriptors(String tableName)

Return BeanDescriptors mapped to this table.

externalModification

void externalModification(TransactionEventTable event)

Process committed changes from another framework.

This notifies this instance of the framework that beans have been committed externally to it. Either by another framework or clustered server. It uses this to maintain its cache and text indexes appropriately.

createServerTransaction

SpiTransaction createServerTransaction(boolean isExplicit,
                                     int isolationLevel)

Create a ServerTransaction.

To specify to use the default transaction isolation use a value of -1.

getCurrentServerTransaction

SpiTransaction getCurrentServerTransaction()

Return the current transaction or null if there is no current transaction.

createScopeTrans

ScopeTrans createScopeTrans(TxScope txScope)

Create a ScopeTrans for a method for the given scope definition.

createQueryTransaction

SpiTransaction createQueryTransaction()

Create a ServerTransaction for query purposes.

remoteTransactionEvent

void remoteTransactionEvent(RemoteTransactionEvent event)

An event from another server in the cluster used to notify local BeanListeners of remote inserts updates and deletes.

createQueryRequest

<T> SpiOrmQueryRequest<T> createQueryRequest(BeanDescriptor<T> desc,
                                           SpiQuery<T> q,
                                           Transaction t)

Create a query request object.

compileQuery

<T> CQuery<T> compileQuery(Query<T> query,
                         Transaction t)

Compile a query.

getQueryEngine

CQueryEngine getQueryEngine()

Return the queryEngine for this server.

findIdsWithCopy

<T> List<Object> findIdsWithCopy(Query<T> query,
                               Transaction t)

Execute the findId's query but without copying the query.

Used so that the list of Id's can be made accessible to client code before the query has finished (if executing in a background thread).

findRowCountWithCopy

<T> int findRowCountWithCopy(Query<T> query,
                           Transaction t)

Execute the findRowCount query but without copying the query.

loadBean

void loadBean(LoadBeanRequest loadRequest)

Load a batch of Associated One Beans.

loadMany

void loadMany(LoadManyRequest loadRequest)

Lazy load a batch of Many's.

getLazyLoadBatchSize

int getLazyLoadBatchSize()

Return the default batch size for lazy loading.

isSupportedType

boolean isSupportedType(Type genericType)

Return true if the type is known as an Entity or Xml type or a List Set or Map of known bean types.

collectQueryStats

void collectQueryStats(ObjectGraphNode objectGraphNode,
                     long loadedBeanCount,
                     long timeMicros)

Collect query statistics by ObjectGraphNode. Used for Lazy loading reporting.