Package org.hibernate.event.spi

Interface EventManager

All Known Implementing Classes:

EmptyEventManager

@JavaServiceLoadable
@Incubating
public interface EventManager

Defines a contract for reporting and monitoring low-level events involving interactions between the session and the database or second-level cache.

For example, this interface is implemented by Hibernate JFR to report events to Java Flight Recorder.

Note that event reporting is different to aggregate metrics, which Hibernate exposes via the Statistics interface.

Since:

6.4

API Note:

This an incubating API, subject to change.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EventManager.CacheActionDescription

Method Summary

Modifier and Type	Method	Description
HibernateMonitoringEvent	beginCacheGetEvent()
HibernateMonitoringEvent	beginCachePutEvent()
HibernateMonitoringEvent	beginCollectionRecreateEvent()
HibernateMonitoringEvent	beginCollectionRemoveEvent()
HibernateMonitoringEvent	beginCollectionUpdateEvent()
HibernateMonitoringEvent	beginDirtyCalculationEvent()
HibernateMonitoringEvent	beginEntityDeleteEvent()
HibernateMonitoringEvent	beginEntityInsertEvent()
HibernateMonitoringEvent	beginEntityLockEvent()
HibernateMonitoringEvent	beginEntityUpdateEvent()
HibernateMonitoringEvent	beginEntityUpsertEvent()
HibernateMonitoringEvent	beginFlushEvent()
HibernateMonitoringEvent	beginJdbcBatchExecutionEvent()
HibernateMonitoringEvent	beginJdbcConnectionAcquisitionEvent()
HibernateMonitoringEvent	beginJdbcConnectionReleaseEvent()
HibernateMonitoringEvent	beginJdbcPreparedStatementCreationEvent()
HibernateMonitoringEvent	beginJdbcPreparedStatementExecutionEvent()
HibernateMonitoringEvent	beginPartialFlushEvent()
HibernateMonitoringEvent	beginPrePartialFlush()
HibernateMonitoringEvent	beginSessionClosedEvent()
HibernateMonitoringEvent	beginSessionOpenEvent()
void	completeCacheGetEvent(HibernateMonitoringEvent cacheGetEvent, SharedSessionContractImplementor session, Region region, boolean hit)
void	completeCacheGetEvent(HibernateMonitoringEvent cacheGetEvent, SharedSessionContractImplementor session, Region region, CollectionPersister persister, boolean hit)
void	completeCacheGetEvent(HibernateMonitoringEvent cacheGetEvent, SharedSessionContractImplementor session, Region region, EntityPersister persister, boolean isNaturalKey, boolean hit)
void	completeCachePutEvent(HibernateMonitoringEvent cachePutEvent, SharedSessionContractImplementor session, CachedDomainDataAccess cachedDomainDataAccess, CollectionPersister persister, boolean cacheContentChanged, EventManager.CacheActionDescription description)
void	completeCachePutEvent(HibernateMonitoringEvent cachePutEvent, SharedSessionContractImplementor session, CachedDomainDataAccess cachedDomainDataAccess, EntityPersister persister, boolean cacheContentChanged, boolean isNatualId, EventManager.CacheActionDescription description)
void	completeCachePutEvent(HibernateMonitoringEvent cachePutEvent, SharedSessionContractImplementor session, CachedDomainDataAccess cachedDomainDataAccess, EntityPersister persister, boolean cacheContentChanged, EventManager.CacheActionDescription description)
void	completeCachePutEvent(HibernateMonitoringEvent cachePutEvent, SharedSessionContractImplementor session, Region region, boolean cacheContentChanged, EventManager.CacheActionDescription description)
void	completeCollectionRecreateEvent(HibernateMonitoringEvent event, Object id, String role, boolean success, SharedSessionContractImplementor session)
void	completeCollectionRemoveEvent(HibernateMonitoringEvent event, Object id, String role, boolean success, SharedSessionContractImplementor session)
void	completeCollectionUpdateEvent(HibernateMonitoringEvent event, Object id, String role, boolean success, SharedSessionContractImplementor session)
void	completeDirtyCalculationEvent(HibernateMonitoringEvent dirtyCalculationEvent, SharedSessionContractImplementor session, EntityPersister persister, EntityEntry entry, int[] dirtyProperties)
void	completeEntityDeleteEvent(HibernateMonitoringEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeEntityInsertEvent(HibernateMonitoringEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeEntityLockEvent(HibernateMonitoringEvent event, Object id, String entityName, LockMode lockMode, boolean success, SharedSessionContractImplementor session)
void	completeEntityUpdateEvent(HibernateMonitoringEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeEntityUpsertEvent(HibernateMonitoringEvent event, Object id, String entityName, boolean success, SharedSessionContractImplementor session)
void	completeFlushEvent(HibernateMonitoringEvent flushEvent, FlushEvent event)
void	completeFlushEvent(HibernateMonitoringEvent flushEvent, FlushEvent event, boolean autoFlush)
void	completeJdbcBatchExecutionEvent(HibernateMonitoringEvent jdbcBatchExecutionEvent, String statementSql)
void	completeJdbcConnectionAcquisitionEvent(HibernateMonitoringEvent jdbcConnectionAcquisitionEvent, SharedSessionContractImplementor session, Object tenantId)
void	completeJdbcConnectionReleaseEvent(HibernateMonitoringEvent jdbcConnectionReleaseEvent, SharedSessionContractImplementor session, Object tenantId)
void	completeJdbcPreparedStatementCreationEvent(HibernateMonitoringEvent jdbcPreparedStatementCreation, String preparedStatementSql)
void	completeJdbcPreparedStatementExecutionEvent(HibernateMonitoringEvent jdbcPreparedStatementExecutionEvent, String preparedStatementSql)
void	completePartialFlushEvent(HibernateMonitoringEvent flushEvent, AutoFlushEvent event)
void	completePrePartialFlush(HibernateMonitoringEvent prePartialFlush, SharedSessionContractImplementor session)
void	completeSessionClosedEvent(HibernateMonitoringEvent sessionClosedEvent, SharedSessionContractImplementor session)
void	completeSessionOpenEvent(HibernateMonitoringEvent sessionOpenEvent, SharedSessionContractImplementor session)

Method Details

beginSessionOpenEvent

HibernateMonitoringEvent beginSessionOpenEvent()

completeSessionOpenEvent

void completeSessionOpenEvent(HibernateMonitoringEvent sessionOpenEvent,
 SharedSessionContractImplementor session)

beginSessionClosedEvent

HibernateMonitoringEvent beginSessionClosedEvent()

completeSessionClosedEvent

void completeSessionClosedEvent(HibernateMonitoringEvent sessionClosedEvent,
 SharedSessionContractImplementor session)

beginJdbcConnectionAcquisitionEvent

HibernateMonitoringEvent beginJdbcConnectionAcquisitionEvent()

completeJdbcConnectionAcquisitionEvent

void completeJdbcConnectionAcquisitionEvent(HibernateMonitoringEvent jdbcConnectionAcquisitionEvent,
 SharedSessionContractImplementor session,
 Object tenantId)

beginJdbcConnectionReleaseEvent

HibernateMonitoringEvent beginJdbcConnectionReleaseEvent()

completeJdbcConnectionReleaseEvent

void completeJdbcConnectionReleaseEvent(HibernateMonitoringEvent jdbcConnectionReleaseEvent,
 SharedSessionContractImplementor session,
 Object tenantId)

beginJdbcPreparedStatementCreationEvent

HibernateMonitoringEvent beginJdbcPreparedStatementCreationEvent()

completeJdbcPreparedStatementCreationEvent

void completeJdbcPreparedStatementCreationEvent(HibernateMonitoringEvent jdbcPreparedStatementCreation,
 String preparedStatementSql)

beginJdbcPreparedStatementExecutionEvent

HibernateMonitoringEvent beginJdbcPreparedStatementExecutionEvent()

completeJdbcPreparedStatementExecutionEvent

void completeJdbcPreparedStatementExecutionEvent(HibernateMonitoringEvent jdbcPreparedStatementExecutionEvent,
 String preparedStatementSql)

beginJdbcBatchExecutionEvent

HibernateMonitoringEvent beginJdbcBatchExecutionEvent()

completeJdbcBatchExecutionEvent

void completeJdbcBatchExecutionEvent(HibernateMonitoringEvent jdbcBatchExecutionEvent,
 String statementSql)

beginCachePutEvent

HibernateMonitoringEvent beginCachePutEvent()

completeCachePutEvent

void completeCachePutEvent(HibernateMonitoringEvent cachePutEvent,
 SharedSessionContractImplementor session,
 Region region,
 boolean cacheContentChanged,
 EventManager.CacheActionDescription description)

completeCachePutEvent

void completeCachePutEvent(HibernateMonitoringEvent cachePutEvent,
 SharedSessionContractImplementor session,
 CachedDomainDataAccess cachedDomainDataAccess,
 EntityPersister persister,
 boolean cacheContentChanged,
 EventManager.CacheActionDescription description)

completeCachePutEvent

void completeCachePutEvent(HibernateMonitoringEvent cachePutEvent,
 SharedSessionContractImplementor session,
 CachedDomainDataAccess cachedDomainDataAccess,
 EntityPersister persister,
 boolean cacheContentChanged,
 boolean isNatualId,
 EventManager.CacheActionDescription description)

completeCachePutEvent

void completeCachePutEvent(HibernateMonitoringEvent cachePutEvent,
 SharedSessionContractImplementor session,
 CachedDomainDataAccess cachedDomainDataAccess,
 CollectionPersister persister,
 boolean cacheContentChanged,
 EventManager.CacheActionDescription description)

beginCacheGetEvent

HibernateMonitoringEvent beginCacheGetEvent()

completeCacheGetEvent

void completeCacheGetEvent(HibernateMonitoringEvent cacheGetEvent,
 SharedSessionContractImplementor session,
 Region region,
 boolean hit)

completeCacheGetEvent

void completeCacheGetEvent(HibernateMonitoringEvent cacheGetEvent,
 SharedSessionContractImplementor session,
 Region region,
 EntityPersister persister,
 boolean isNaturalKey,
 boolean hit)

completeCacheGetEvent

void completeCacheGetEvent(HibernateMonitoringEvent cacheGetEvent,
 SharedSessionContractImplementor session,
 Region region,
 CollectionPersister persister,
 boolean hit)

beginFlushEvent

HibernateMonitoringEvent beginFlushEvent()

completeFlushEvent

void completeFlushEvent(HibernateMonitoringEvent flushEvent,
 FlushEvent event)

completeFlushEvent

void completeFlushEvent(HibernateMonitoringEvent flushEvent,
 FlushEvent event,
 boolean autoFlush)

beginPartialFlushEvent

HibernateMonitoringEvent beginPartialFlushEvent()

completePartialFlushEvent

void completePartialFlushEvent(HibernateMonitoringEvent flushEvent,
 AutoFlushEvent event)

beginDirtyCalculationEvent

HibernateMonitoringEvent beginDirtyCalculationEvent()

completeDirtyCalculationEvent

void completeDirtyCalculationEvent(HibernateMonitoringEvent dirtyCalculationEvent,
 SharedSessionContractImplementor session,
 EntityPersister persister,
 EntityEntry entry,
 int[] dirtyProperties)

beginPrePartialFlush

HibernateMonitoringEvent beginPrePartialFlush()

completePrePartialFlush

void completePrePartialFlush(HibernateMonitoringEvent prePartialFlush,
 SharedSessionContractImplementor session)

beginEntityInsertEvent

HibernateMonitoringEvent beginEntityInsertEvent()

completeEntityInsertEvent

void completeEntityInsertEvent(HibernateMonitoringEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityUpdateEvent

HibernateMonitoringEvent beginEntityUpdateEvent()

completeEntityUpdateEvent

void completeEntityUpdateEvent(HibernateMonitoringEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityUpsertEvent

HibernateMonitoringEvent beginEntityUpsertEvent()

completeEntityUpsertEvent

void completeEntityUpsertEvent(HibernateMonitoringEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityDeleteEvent

HibernateMonitoringEvent beginEntityDeleteEvent()

completeEntityDeleteEvent

void completeEntityDeleteEvent(HibernateMonitoringEvent event,
 Object id,
 String entityName,
 boolean success,
 SharedSessionContractImplementor session)

beginEntityLockEvent

HibernateMonitoringEvent beginEntityLockEvent()

completeEntityLockEvent

void completeEntityLockEvent(HibernateMonitoringEvent event,
 Object id,
 String entityName,
 LockMode lockMode,
 boolean success,
 SharedSessionContractImplementor session)

beginCollectionRecreateEvent

HibernateMonitoringEvent beginCollectionRecreateEvent()

completeCollectionRecreateEvent

void completeCollectionRecreateEvent(HibernateMonitoringEvent event,
 Object id,
 String role,
 boolean success,
 SharedSessionContractImplementor session)

beginCollectionUpdateEvent

HibernateMonitoringEvent beginCollectionUpdateEvent()

completeCollectionUpdateEvent

void completeCollectionUpdateEvent(HibernateMonitoringEvent event,
 Object id,
 String role,
 boolean success,
 SharedSessionContractImplementor session)

beginCollectionRemoveEvent

HibernateMonitoringEvent beginCollectionRemoveEvent()

completeCollectionRemoveEvent

void completeCollectionRemoveEvent(HibernateMonitoringEvent event,
 Object id,
 String role,
 boolean success,
 SharedSessionContractImplementor session)