org.springframework.integration.event.inbound
Class ApplicationEventListeningMessageProducer
java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.endpoint.AbstractEndpoint
org.springframework.integration.endpoint.MessageProducerSupport
org.springframework.integration.event.inbound.ApplicationEventListeningMessageProducer
- All Implemented Interfaces:
- java.util.EventListener, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, NamedComponent, MessageProducer, TrackableComponent
public class ApplicationEventListeningMessageProducer
- extends MessageProducerSupport
- implements org.springframework.context.ApplicationListener<org.springframework.context.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.
- Author:
- Mark Fisher
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(org.springframework.context.ApplicationEvent event)
|
void |
setEventTypes(java.lang.Class<? extends org.springframework.context.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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
ApplicationEventListeningMessageProducer
public ApplicationEventListeningMessageProducer()
setEventTypes
public void setEventTypes(java.lang.Class<? extends org.springframework.context.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(org.springframework.context.ApplicationEvent event)
- Specified by:
onApplicationEvent
in interface org.springframework.context.ApplicationListener<org.springframework.context.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