org.springframework.integration.event.inbound
Class ApplicationEventListeningMessageProducer

java.lang.Object
  extended by org.springframework.integration.context.IntegrationObjectSupport
      extended by org.springframework.integration.endpoint.AbstractEndpoint
          extended by org.springframework.integration.endpoint.MessageProducerSupport
              extended by org.springframework.integration.event.inbound.ApplicationEventListeningMessageProducer
All Implemented Interfaces:
java.util.EventListener, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationListener<ApplicationEvent>, Lifecycle, Phased, SmartLifecycle, NamedComponent, MessageProducer, TrackableComponent

public class ApplicationEventListeningMessageProducer
extends MessageProducerSupport
implements ApplicationListener<ApplicationEvent>

An inbound Channel Adapter that passes Spring ApplicationEvents within messages. If a payloadExpression is provided, it will be evaluated against the ApplicationEvent instance to create the Message payload. Otherwise, the event itself will be the payload.


Field Summary
 
Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
logger
 
Constructor Summary
ApplicationEventListeningMessageProducer()
           
 
Method Summary
protected  void doStart()
          Takes no action by default.
protected  void doStop()
          Takes no action by default.
 java.lang.String getComponentType()
          Subclasses may implement this method to provide component type information.
 void onApplicationEvent(ApplicationEvent event)
           
 void setEventTypes(java.lang.Class<? extends ApplicationEvent>[] eventTypes)
          Set the list of event types (classes that extend ApplicationEvent) that this adapter should send to the message channel.
 void setPayloadExpression(java.lang.String payloadExpression)
          Provide an expression to be evaluated against the received ApplicationEvent instance (the "root object") in order to create the Message payload.
 
Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport
onInit, sendMessage, setErrorChannel, setOutputChannel, setSendTimeout, setShouldTrack
 
Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint
getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop
 
Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport
afterPropertiesSet, getBeanFactory, getComponentName, getConversionService, getTaskScheduler, setBeanFactory, setBeanName, setComponentName, setConversionService, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.springframework.integration.context.NamedComponent
getComponentName
 

Constructor Detail

ApplicationEventListeningMessageProducer

public ApplicationEventListeningMessageProducer()
Method Detail

setEventTypes

public void setEventTypes(java.lang.Class<? extends ApplicationEvent>[] eventTypes)
Set the list of event types (classes that extend ApplicationEvent) that this adapter should send to the message channel. By default, all event types will be sent.


setPayloadExpression

public void setPayloadExpression(java.lang.String payloadExpression)
Provide an expression to be evaluated against the received ApplicationEvent instance (the "root object") in order to create the Message payload. If none is provided, the ApplicationEvent itself will be used as the payload.


getComponentType

public java.lang.String getComponentType()
Description copied from class: IntegrationObjectSupport
Subclasses may implement this method to provide component type information.

Specified by:
getComponentType in interface NamedComponent
Overrides:
getComponentType in class IntegrationObjectSupport

onApplicationEvent

public void onApplicationEvent(ApplicationEvent event)
Specified by:
onApplicationEvent in interface ApplicationListener<ApplicationEvent>

doStart

protected void doStart()
Description copied from class: MessageProducerSupport
Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:
doStart in class MessageProducerSupport

doStop

protected void doStop()
Description copied from class: MessageProducerSupport
Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:
doStop in class MessageProducerSupport