Class EventPublicationInterceptor
- java.lang.Object
- org.springframework.context.event.EventPublicationInterceptor
- All Implemented Interfaces:
Advice
,Interceptor
,MethodInterceptor
,Aware
,InitializingBean
,ApplicationEventPublisherAware
public class EventPublicationInterceptor extends Object implements MethodInterceptor, ApplicationEventPublisherAware, InitializingBean
Interceptor
that publishes anApplicationEvent
to allApplicationListeners
registered with anApplicationEventPublisher
after each successful method invocation.Note that this interceptor is only capable of publishing stateless events configured via the
"applicationEventClass"
property.- Author:
- Dmitriy Kopylenko, Juergen Hoeller, Rick Evans
- See Also:
setApplicationEventClass(java.lang.Class<?>)
,ApplicationEvent
,ApplicationListener
,ApplicationEventPublisher
,ApplicationContext
Constructor Summary
Constructors Constructor Description EventPublicationInterceptor()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.Object
invoke(MethodInvocation invocation)
Implement this method to perform extra treatments before and after the invocation.void
setApplicationEventClass(Class<?> applicationEventClass)
Set the application event class to publish.void
setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
Set the ApplicationEventPublisher that this object runs in.
Constructor Detail
EventPublicationInterceptor
public EventPublicationInterceptor()
Method Detail
setApplicationEventClass
public void setApplicationEventClass(Class<?> applicationEventClass)
Set the application event class to publish.The event class must have a constructor with a single
Object
argument for the event source. The interceptor will pass in the invoked object.- Throws:
IllegalArgumentException
- if the suppliedClass
isnull
or if it is not anApplicationEvent
subclass or if it does not expose a constructor that takes a singleObject
argument
setApplicationEventPublisher
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
Description copied from interface:ApplicationEventPublisherAware
Set the ApplicationEventPublisher that this object runs in.Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.
- Specified by:
setApplicationEventPublisher
in interfaceApplicationEventPublisherAware
- Parameters:
applicationEventPublisher
- event publisher to be used by this object
afterPropertiesSet
public void afterPropertiesSet() throws Exception
Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Throws:
Exception
- in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason
invoke
public Object invoke(MethodInvocation invocation) throws Throwable
Description copied from interface:MethodInterceptor
Implement this method to perform extra treatments before and after the invocation. Polite implementations would certainly like to invokeJoinpoint.proceed()
.- Specified by:
invoke
in interfaceMethodInterceptor
- Parameters:
invocation
- the method invocation joinpoint- Returns:
- the result of the call to
Joinpoint.proceed()
; might be intercepted by the interceptor - Throws:
Throwable
- if the interceptors or the target object throws an exception