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 an ApplicationEvent to all ApplicationListeners registered with an ApplicationEventPublisher after each successful method invocation.

Note that this interceptor is capable of publishing a custom event after each successful method invocation, configured via the "applicationEventClass" property. As of 7.0.3, you can configure a factory function instead, implementing the primary EventPublicationInterceptor.ApplicationEventFactory.onSuccess(MethodInvocation, Object) method there.

By default (as of 7.0.3), this interceptor publishes a MethodFailureEvent for every exception encountered from a method invocation. This can be conveniently tracked via an ApplicationListener<MethodFailureEvent> class or an @EventListener(MethodFailureEvent.class) method. The failure event can be customized through overriding the EventPublicationInterceptor.ApplicationEventFactory.onFailure(MethodInvocation, Throwable) method.

Author:

Dmitriy Kopylenko, Juergen Hoeller, Rick Evans

See Also:

• setApplicationEventClass(Class)
• ApplicationEvent
• ApplicationListener
• ApplicationEventPublisher
• ApplicationContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EventPublicationInterceptor.ApplicationEventFactory	Callback interface for building an ApplicationEvent after a method invocation.

Constructor Summary

Constructors

Constructor	Description
EventPublicationInterceptor()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
@Nullable Object	invoke(MethodInvocation invocation)	Implement this method to perform extra treatments before and after the invocation.
void	setApplicationEventClass(Class<? extends ApplicationEvent> applicationEventClass)	Set the application event class to publish after each successful invocation.
void	setApplicationEventFactory(EventPublicationInterceptor.ApplicationEventFactory applicationEventFactory)	Specify a factory function for ApplicationEvent instances built from a MethodInvocation, representing each successful method invocation.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)	Set the ApplicationEventPublisher that this object runs in.

Methods inherited from class Object

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

Constructor Details

EventPublicationInterceptor

public EventPublicationInterceptor()

Method Details

setApplicationEventClass

public void setApplicationEventClass(Class<? extends ApplicationEvent> applicationEventClass)

Set the application event class to publish after each successful invocation.

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 supplied Class is null or if it is not an ApplicationEvent subclass or if it does not expose a constructor that takes a single Object argument

See Also:

• setApplicationEventFactory(EventPublicationInterceptor.ApplicationEventFactory)

setApplicationEventFactory

public void setApplicationEventFactory(EventPublicationInterceptor.ApplicationEventFactory applicationEventFactory)

Specify a factory function for ApplicationEvent instances built from a MethodInvocation, representing each successful method invocation.

Since:

7.0.3

See Also:

• setApplicationEventClass(Class)

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 interface ApplicationEventPublisherAware

Parameters:

applicationEventPublisher - event publisher to be used by this object

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Description copied from interface: InitializingBean

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, 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 interface InitializingBean

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 @Nullable 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 invoke Joinpoint.proceed().

Specified by:

invoke in interface MethodInterceptor

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