Package io.jmix.data.impl

Class EntityListenerManager

java.lang.Object

io.jmix.data.impl.EntityListenerManager

@Component("data_EntityListenerManager")
public class EntityListenerManager
extends 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	Description
protected static class	EntityListenerManager.Key
protected static class	EntityListenerManager.ListenerExecution

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EntityListenerManager()

Method Summary

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

beanFactory

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

cache

protected Map<EntityListenerManager.Key,List> cache

dynamicListeners

protected Map<Class<?>,Set<String>> dynamicListeners

lock

protected ReadWriteLock lock

enabled

protected volatile boolean enabled

threadLocalExecutions

protected ThreadLocal<List<EntityListenerManager.ListenerExecution>> threadLocalExecutions

Constructor Details

EntityListenerManager

public EntityListenerManager()

Method Details

addListener

public void addListener(Class<?> entityClass,
 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(Class<?> entityClass,
 Class<?> listenerClass)

Unregister an entity listener.

Parameters:

entityClass - entity

listenerClass - listener class

addListener

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

Register an entity listener which is a ManagedBean.

Parameters:

entityClass - entity

listenerBeanName - listener bean name

removeListener

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

Unregister an entity listener.

Parameters:

entityClass - entity

listenerBeanName - listener bean name

fireListener

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

enable

public void enable(boolean enable)

logExecution

protected void logExecution(EntityListenerType type,
 Object entity)

getListener

protected List<?> getListener(Class<?> entityClass,
 EntityListenerType type)

findListener

protected List<?> findListener(Class<?> entityClass,
 EntityListenerType type)

getDeclaredListeners

protected List<String> getDeclaredListeners(Class<?> entityClass)