io.jmix.data.impl

Class EntityListenerManager

java.lang.Object

io.jmix.data.impl.EntityListenerManager

@Component(value="data_EntityListenerManager")
public class EntityListenerManager
extends java.lang.Object

This bean allows to register and fire entity listeners.

Usually entity listeners are registered declaratively with @Listeners annotation on entity class. Methods addListener(Class, Class) and addListener(Class, String) allow to add listeners dynamically, e.g. to an entity from a base project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EntityListenerManager.Key
protected static class	EntityListenerManager.ListenerExecution

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.beans.factory.BeanFactory	beanFactory
protected java.util.Map<EntityListenerManager.Key,java.util.List>	cache
protected java.util.Map<java.lang.Class<?>,java.util.Set<java.lang.String>>	dynamicListeners
protected boolean	enabled
protected java.util.concurrent.locks.ReadWriteLock	lock
protected java.lang.ThreadLocal<java.util.List<EntityListenerManager.ListenerExecution>>	threadLocalExecutions

Constructor Summary

Constructors

Constructor and Description
EntityListenerManager()

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.Class<?> entityClass, java.lang.Class<?> listenerClass) Register an entity listener by its class.
void	addListener(java.lang.Class<?> entityClass, java.lang.String listenerBeanName) Register an entity listener which is a ManagedBean.
void	enable(boolean enable)
protected java.util.List<?>	findListener(java.lang.Class<?> entityClass, EntityListenerType type)
void	fireListener(java.lang.Object entity, EntityListenerType type, java.lang.String storeName)
protected java.util.List<java.lang.String>	getDeclaredListeners(java.lang.Class<?> entityClass)
protected java.util.List<?>	getListener(java.lang.Class<?> entityClass, EntityListenerType type)
protected void	logExecution(EntityListenerType type, java.lang.Object entity)
void	removeListener(java.lang.Class<?> entityClass, java.lang.Class<?> listenerClass) Unregister an entity listener.
void	removeListener(java.lang.Class<?> entityClass, java.lang.String listenerBeanName) Unregister an entity listener.

Methods inherited from class java.lang.Object

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

Field Detail

beanFactory

@Autowired
protected org.springframework.beans.factory.BeanFactory beanFactory

cache

protected java.util.Map<EntityListenerManager.Key,java.util.List> cache

dynamicListeners

protected java.util.Map<java.lang.Class<?>,java.util.Set<java.lang.String>> dynamicListeners

lock

protected java.util.concurrent.locks.ReadWriteLock lock

enabled

protected volatile boolean enabled

threadLocalExecutions

protected java.lang.ThreadLocal<java.util.List<EntityListenerManager.ListenerExecution>> threadLocalExecutions

Constructor Detail

EntityListenerManager

public EntityListenerManager()

Method Detail

addListener

public void addListener(java.lang.Class<?> entityClass,
                        java.lang.Class<?> listenerClass)

Register an entity listener by its class. The listener instance will be instantiated as a plain object.

Parameters:

entityClass - entity

listenerClass - listener class

removeListener

public void removeListener(java.lang.Class<?> entityClass,
                           java.lang.Class<?> listenerClass)

Unregister an entity listener.

Parameters:

entityClass - entity

listenerClass - listener class

addListener

public void addListener(java.lang.Class<?> entityClass,
                        java.lang.String listenerBeanName)

Register an entity listener which is a ManagedBean.

Parameters:

entityClass - entity

listenerBeanName - listener bean name

removeListener

public void removeListener(java.lang.Class<?> entityClass,
                           java.lang.String listenerBeanName)

Unregister an entity listener.

Parameters:

entityClass - entity

listenerBeanName - listener bean name

fireListener

public void fireListener(java.lang.Object entity,
                         EntityListenerType type,
                         java.lang.String storeName)

enable

public void enable(boolean enable)

logExecution

protected void logExecution(EntityListenerType type,
                            java.lang.Object entity)

getListener

protected java.util.List<?> getListener(java.lang.Class<?> entityClass,
                                        EntityListenerType type)

findListener

protected java.util.List<?> findListener(java.lang.Class<?> entityClass,
                                         EntityListenerType type)

getDeclaredListeners

protected java.util.List<java.lang.String> getDeclaredListeners(java.lang.Class<?> entityClass)