org.springframework.integration.event
Class ApplicationEventInboundChannelAdapter
java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.endpoint.AbstractEndpoint
org.springframework.integration.endpoint.MessageProducerSupport
org.springframework.integration.event.ApplicationEventInboundChannelAdapter
- All Implemented Interfaces:
- java.util.EventListener, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationListener<ApplicationEvent>, Lifecycle, Phased, SmartLifecycle, NamedComponent, MessageProducer, TrackableComponent
public class ApplicationEventInboundChannelAdapter
- 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.
Method Summary |
protected void |
doStart()
Subclasses must implement this method with the start behavior. |
protected void |
doStop()
Subclasses must implement this method with the stop behavior. |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
ApplicationEventInboundChannelAdapter
public ApplicationEventInboundChannelAdapter()
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:
AbstractEndpoint
- Subclasses must implement this method with the start behavior.
This method will be invoked while holding the
AbstractEndpoint.lifecycleLock
.
- Specified by:
doStart
in class AbstractEndpoint
doStop
protected void doStop()
- Description copied from class:
AbstractEndpoint
- Subclasses must implement this method with the stop behavior.
This method will be invoked while holding the
AbstractEndpoint.lifecycleLock
.
- Specified by:
doStop
in class AbstractEndpoint