Class StompInboundChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.stomp.inbound.StompInboundChannelAdapter

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ComponentSourceAware, ExpressionCapable, MessageProducer, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent

@ManagedResource
@IntegrationManagedResource
public class StompInboundChannelAdapter
extends MessageProducerSupport
implements ApplicationEventPublisherAware

The MessageProducerSupport for STOMP protocol to handle STOMP frames from provided destination and send messages to the outputChannel.

Destinations can be added and removed at runtime.

The StompReceiptEvent is emitted for each Subscribe STOMP frame if provided StompSessionManager supports autoReceiptEnabled.

Since:

4.2

Author:

Artem Bilan, Gary Russell, Trung Pham

Nested Class Summary

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class AbstractEndpoint

lifecycleLock

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
StompInboundChannelAdapter(StompSessionManager stompSessionManager, String... destinations)

Method Summary

Modifier and Type	Method	Description
void	addDestination(String... destination)	Add a destination (or destinations) to the subscribed list and subscribe it.
protected void	doStart()	Take no action by default.
protected void	doStop()	Take no action by default.
String	getComponentType()
String[]	getDestinations()
void	removeDestination(String... destination)	Remove a destination (or destinations) from the subscribed list and unsubscribe it.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setHeaderMapper(HeaderMapper<StompHeaders> headerMapper)
void	setPayloadType(Class<?> payloadType)

Methods inherited from class MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getErrorMessageStrategy, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, getOutputChannelName, getRequiredOutputChannel, isObserved, onInit, registerObservationRegistry, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setObservationConvention, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

Methods inherited from class AbstractEndpoint

destroy, doStop, getPhase, getRole, isActive, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

Methods inherited from class IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class Object

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

Methods inherited from interface IntegrationManagement

destroy, getManagedName, getManagedType, getOverrides, getThisAs, isLoggingEnabled, registerMetricsCaptor, setLoggingEnabled, setManagedName, setManagedType

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Methods inherited from interface SmartLifecycle

isPauseable

Constructor Details

StompInboundChannelAdapter

public StompInboundChannelAdapter(StompSessionManager stompSessionManager,
 String... destinations)

Method Details

setPayloadType

public void setPayloadType(Class<?> payloadType)

setHeaderMapper

public void setHeaderMapper(HeaderMapper<StompHeaders> headerMapper)

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

getDestinations

@ManagedAttribute
public String[] getDestinations()

addDestination

@ManagedOperation
public void addDestination(String... destination)

Add a destination (or destinations) to the subscribed list and subscribe it.

Parameters:

destination - The destinations.

removeDestination

@ManagedOperation
public void removeDestination(String... destination)

Remove a destination (or destinations) from the subscribed list and unsubscribe it.

Parameters:

destination - The destinations.

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageProducerSupport

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class MessageProducerSupport

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class MessageProducerSupport