Package io.micronaut.data.runtime.event

Class EntityEventRegistry

java.lang.Object

io.micronaut.data.runtime.event.EntityEventRegistry

All Implemented Interfaces:

io.micronaut.context.processor.ExecutableMethodProcessor<EntityEventMapping>, io.micronaut.core.order.Ordered, EntityEventListener<Object>, EventListener

@Singleton
@Primary
public class EntityEventRegistry
extends Object
implements EntityEventListener<Object>, io.micronaut.context.processor.ExecutableMethodProcessor<EntityEventMapping>

Primary implementation of the EntityEventListener interface that aggregates all other listeners.

Since:

2.3.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field	Description
static final List<Class<? extends Annotation>>	EVENT_TYPES

Fields inherited from interface io.micronaut.data.event.EntityEventListener

NOOP

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
EntityEventRegistry(io.micronaut.context.BeanContext beanContext)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	postLoad(@NonNull EntityEventContext<Object> context)	A post-load hook.
void	postPersist(@NonNull EntityEventContext<Object> context)	A post-persist hook.
void	postRemove(@NonNull EntityEventContext<Object> context)	A post-remove hook.
void	postUpdate(@NonNull EntityEventContext<Object> context)	A post-update hook.
boolean	prePersist(@NonNull EntityEventContext<Object> context)	A pre-persist hook.
boolean	preRemove(@NonNull EntityEventContext<Object> context)	A pre-remove hook.
boolean	preUpdate(@NonNull EntityEventContext<Object> context)	A pre-update hook.
<B> void	process(io.micronaut.inject.BeanDefinition<B> beanDefinition, io.micronaut.inject.ExecutableMethod<B,?> method)
boolean	supports(RuntimePersistentEntity<Object> entity, Class<? extends Annotation> eventType)	Allows including or excluding a listener for a specific entity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.data.event.EntityEventListener

preQuery

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Details

EVENT_TYPES

public static final List<Class<? extends Annotation>> EVENT_TYPES

Constructor Details

EntityEventRegistry

public EntityEventRegistry(io.micronaut.context.BeanContext beanContext)

Default constructor.

Parameters:

beanContext - The bean context

Method Details

supports

public boolean supports(RuntimePersistentEntity<Object> entity,
 Class<? extends Annotation> eventType)

Description copied from interface: EntityEventListener

Allows including or excluding a listener for a specific entity.

Specified by:

supports in interface EntityEventListener<Object>

Parameters:

entity - The entity

eventType - The event type

Returns:

True if it is supported

prePersist

public boolean prePersist(@NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A pre-persist hook. Implementors can return false to evict the operation.

Specified by:

prePersist in interface EntityEventListener<Object>

Parameters:

context - The context object

Returns:

A boolean value indicating whether to proceed with the operation.

postPersist

public void postPersist(@NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A post-persist hook. Executed once the object has been persisted.

Specified by:

postPersist in interface EntityEventListener<Object>

Parameters:

context - The context object

postLoad

public void postLoad(@NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A post-load hook. Executed once the object has been persisted.

Specified by:

postLoad in interface EntityEventListener<Object>

Parameters:

context - The context object

preRemove

public boolean preRemove(@NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A pre-remove hook. Implementors can return false to evict the operation.

Specified by:

preRemove in interface EntityEventListener<Object>

Parameters:

context - The context object

Returns:

A boolean value indicating whether to proceed with the operation.

postRemove

public void postRemove(@NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A post-remove hook. Executed once the object has been removed.

Specified by:

postRemove in interface EntityEventListener<Object>

Parameters:

context - The context object

preUpdate

public boolean preUpdate(@NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A pre-update hook. Implementors can return false to evict the operation.

Specified by:

preUpdate in interface EntityEventListener<Object>

Parameters:

context - The context object

Returns:

A boolean value indicating whether to proceed with the operation.

postUpdate

public void postUpdate(@NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A post-update hook. Executed once the object has been updated.

Specified by:

postUpdate in interface EntityEventListener<Object>

Parameters:

context - The context object

process

public <B> void process(io.micronaut.inject.BeanDefinition<B> beanDefinition,
 io.micronaut.inject.ExecutableMethod<B,?> method)

Specified by:

process in interface io.micronaut.context.processor.ExecutableMethodProcessor<EntityEventMapping>