public abstract class AbstractApplicationEventMulticaster extends Object implements ApplicationEventMulticaster, BeanClassLoaderAware, BeanFactoryAware
ApplicationEventMulticaster interface,
providing the basic listener registration facility.
Doesn't permit multiple instances of the same listener by default, as it keeps listeners in a linked Set. The collection class used to hold ApplicationListener objects can be overridden through the "collectionClass" bean property.
Implementing ApplicationEventMulticaster's actual ApplicationEventMulticaster.multicastEvent(org.springframework.context.ApplicationEvent) method
is left to subclasses. SimpleApplicationEventMulticaster simply multicasts
all events to all registered listeners, invoking them in the calling thread.
Alternative implementations could be more sophisticated in those respects.
getApplicationListeners(ApplicationEvent),
SimpleApplicationEventMulticaster| Constructor and Description |
|---|
AbstractApplicationEventMulticaster() |
| Modifier and Type | Method and Description |
|---|---|
void |
addApplicationListener(ApplicationListener<?> listener)
Add a listener to be notified of all events.
|
void |
addApplicationListenerBean(String listenerBeanName)
Add a listener bean to be notified of all events.
|
protected Collection<ApplicationListener<?>> |
getApplicationListeners()
Return a Collection containing all ApplicationListeners.
|
protected Collection<ApplicationListener<?>> |
getApplicationListeners(ApplicationEvent event)
Return a Collection of ApplicationListeners matching the given
event type.
|
void |
removeAllListeners()
Remove all listeners registered with this multicaster.
|
void |
removeApplicationListener(ApplicationListener<?> listener)
Remove a listener from the notification list.
|
void |
removeApplicationListenerBean(String listenerBeanName)
Remove a listener bean from the notification list.
|
void |
setBeanClassLoader(ClassLoader classLoader)
Callback that supplies the bean
class loader to
a bean instance. |
void |
setBeanFactory(BeanFactory beanFactory)
Callback that supplies the owning factory to a bean instance.
|
protected boolean |
supportsEvent(ApplicationListener<?> listener,
Class<? extends ApplicationEvent> eventType,
Class<?> sourceType)
Determine whether the given listener supports the given event.
|
protected boolean |
supportsEvent(Class<?> listenerType,
ApplicationEvent event)
Filter a listener early through checking its generically declared event
type before trying to instantiate it.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitmulticastEventpublic void addApplicationListener(ApplicationListener<?> listener)
ApplicationEventMulticasteraddApplicationListener in interface ApplicationEventMulticasterlistener - the listener to addpublic void addApplicationListenerBean(String listenerBeanName)
ApplicationEventMulticasteraddApplicationListenerBean in interface ApplicationEventMulticasterlistenerBeanName - the name of the listener bean to addpublic void removeApplicationListener(ApplicationListener<?> listener)
ApplicationEventMulticasterremoveApplicationListener in interface ApplicationEventMulticasterlistener - the listener to removepublic void removeApplicationListenerBean(String listenerBeanName)
ApplicationEventMulticasterremoveApplicationListenerBean in interface ApplicationEventMulticasterlistenerBeanName - the name of the listener bean to addpublic void removeAllListeners()
ApplicationEventMulticasterAfter a remove call, the multicaster will perform no action on event notification until new listeners are being registered.
removeAllListeners in interface ApplicationEventMulticasterpublic void setBeanClassLoader(ClassLoader classLoader)
BeanClassLoaderAwareclass loader to
a bean instance.
Invoked after the population of normal bean properties but
before an initialization callback such as
InitializingBean's
InitializingBean.afterPropertiesSet()
method or a custom init-method.
setBeanClassLoader in interface BeanClassLoaderAwareclassLoader - the owning class loader; may be null in
which case a default ClassLoader must be used, for example
the ClassLoader obtained via
ClassUtils.getDefaultClassLoader()public void setBeanFactory(BeanFactory beanFactory)
BeanFactoryAwareInvoked after the population of normal bean properties
but before an initialization callback such as
InitializingBean.afterPropertiesSet() or a custom init-method.
setBeanFactory in interface BeanFactoryAwarebeanFactory - owning BeanFactory (never null).
The bean can immediately call methods on the factory.BeanInitializationExceptionprotected Collection<ApplicationListener<?>> getApplicationListeners()
ApplicationListenerprotected Collection<ApplicationListener<?>> getApplicationListeners(ApplicationEvent event)
event - the event to be propagated. Allows for excluding
non-matching listeners early, based on cached matching information.ApplicationListenerprotected boolean supportsEvent(Class<?> listenerType, ApplicationEvent event)
If this method returns true for a given listener as a first pass,
the listener instance will get retrieved and fully evaluated through a
supportsEvent(ApplicationListener, Class, Class) call afterwards.
listenerType - the listener's type as determined by the BeanFactoryevent - the event to checkprotected boolean supportsEvent(ApplicationListener<?> listener, Class<? extends ApplicationEvent> eventType, Class<?> sourceType)
The default implementation detects the SmartApplicationListener
interface. In case of a standard ApplicationListener, a
GenericApplicationListenerAdapter will be used to introspect
the generically declared type of the target listener.
listener - the target listener to checkeventType - the event type to check againstsourceType - the source type to check against