org.kuali.common.util.spring.event

Class GenericExecutableApplicationListener

java.lang.Object

org.kuali.common.util.spring.event.GenericExecutableApplicationListener

All Implemented Interfaces:

EventListener, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>, org.springframework.context.event.SmartApplicationListener, org.springframework.core.Ordered

public final class GenericExecutableApplicationListener
extends Object
implements org.springframework.context.event.SmartApplicationListener

Associate an executable with one or more Spring framework application events.

If an application event gets fired where both supportsEventType and supportsSourceType return true, onApplicationEvent invokes the executable.

The default behavior of supportsEventType and supportsSourceType is to always return true irrespective of what application event was fired.

To be more discriminatory, provide values for supportedSourceTypes and supportedEventTypes.

To limit execution to a specific event type, eg ContextRefreshedEvent:

 ExecutableApplicationListener.builder(executable).supportedEventType(ContextRefreshedEvent.class).build()
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericExecutableApplicationListener.Builder

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Methods

Modifier and Type	Method and Description
static GenericExecutableApplicationListener.Builder	builder(Executable executable)
Executable	getExecutable()
int	getOrder()
List<Class<? extends org.springframework.context.ApplicationEvent>>	getSupportedEventTypes()
List<Class<?>>	getSupportedSourceTypes()
void	onApplicationEvent(org.springframework.context.ApplicationEvent event)
boolean	supportsEventType(Class<? extends org.springframework.context.ApplicationEvent> eventType)
boolean	supportsSourceType(Class<?> sourceType)

Methods inherited from class java.lang.Object

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

Method Detail

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

supportsEventType

public boolean supportsEventType(Class<? extends org.springframework.context.ApplicationEvent> eventType)

Specified by:

supportsEventType in interface org.springframework.context.event.SmartApplicationListener

supportsSourceType

public boolean supportsSourceType(Class<?> sourceType)

Specified by:

supportsSourceType in interface org.springframework.context.event.SmartApplicationListener

builder

public static GenericExecutableApplicationListener.Builder builder(Executable executable)

getExecutable

public Executable getExecutable()

getSupportedSourceTypes

public List<Class<?>> getSupportedSourceTypes()

getSupportedEventTypes

public List<Class<? extends org.springframework.context.ApplicationEvent>> getSupportedEventTypes()