org.springframework.integration.jms

Class SubscribableJmsChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.jms.AbstractJmsChannel

org.springframework.integration.jms.SubscribableJmsChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, BroadcastCapableChannel, ExpressionCapable, IntegrationPattern, NamedComponent, BaseChannelMetrics, ConfigurableMetricsAware<AbstractMessageChannelMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageChannelMetrics, TrackableComponent, MessageChannel, SubscribableChannel, InterceptableChannel

public class SubscribableJmsChannel
extends AbstractJmsChannel
implements BroadcastCapableChannel, SmartLifecycle

An AbstractJmsChannel implementation for message-driven subscriptions. Also implements a BroadcastCapableChannel to represent possible pub-sub semantics when configured against JMS topic.

Since:

2.0

Author:

Mark Fisher, Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.channel.AbstractMessageChannel

AbstractMessageChannel.ChannelInterceptorList

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.channel.AbstractMessageChannel

interceptors, meters

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
SubscribableJmsChannel(AbstractMessageListenerContainer container, JmsTemplate jmsTemplate)

Method Summary

Modifier and Type	Method and Description
void	destroy()
int	getPhase()
boolean	isAutoStartup()
boolean	isBroadcast() Return a state of this channel in regards of broadcasting capabilities.
boolean	isRunning()
void	onInit() Subclasses may implement this for initialization logic.
void	setMaxSubscribers(int maxSubscribers) Specify the maximum number of subscribers supported by the channel's dispatcher.
void	start()
void	stop()
void	stop(Runnable callback)
boolean	subscribe(MessageHandler handler)
boolean	unsubscribe(MessageHandler handler)

Methods inherited from class org.springframework.integration.jms.AbstractJmsChannel

doSend

Methods inherited from class org.springframework.integration.channel.AbstractMessageChannel

addInterceptor, addInterceptor, configureMetrics, getComponentType, getErrorRate, getFullChannelName, getIChannelInterceptorList, getIntegrationPatternType, getInterceptors, getMaxSendDuration, getMeanErrorRate, getMeanErrorRatio, getMeanSendDuration, getMeanSendRate, getMetrics, getMetricsCaptor, getMinSendDuration, getOverrides, getSendCount, getSendCountLong, getSendDuration, getSendErrorCount, getSendErrorCountLong, getSendRate, getStandardDeviationSendDuration, getTimeSinceLastSend, isCountsEnabled, isLoggingEnabled, isStatsEnabled, registerMetricsCaptor, removeInterceptor, removeInterceptor, reset, send, send, setCountsEnabled, setDatatypes, setInterceptors, setLoggingEnabled, setMessageConverter, setShouldTrack, setStatsEnabled

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.messaging.MessageChannel

send, send

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Methods inherited from interface org.springframework.integration.support.management.MessageChannelMetrics

sendCount, sendErrorCount

Constructor Detail

SubscribableJmsChannel

public SubscribableJmsChannel(AbstractMessageListenerContainer container,
                              JmsTemplate jmsTemplate)

Method Detail

setMaxSubscribers

public void setMaxSubscribers(int maxSubscribers)

Specify the maximum number of subscribers supported by the channel's dispatcher.

Parameters:

maxSubscribers - The maximum number of subscribers allowed.

subscribe

public boolean subscribe(MessageHandler handler)

Specified by:

subscribe in interface SubscribableChannel

unsubscribe

public boolean unsubscribe(MessageHandler handler)

Specified by:

unsubscribe in interface SubscribableChannel

isBroadcast

public boolean isBroadcast()

Description copied from interface: BroadcastCapableChannel

Return a state of this channel in regards of broadcasting capabilities.

Specified by:

isBroadcast in interface BroadcastCapableChannel

Returns:

the state of this channel in regards of broadcasting capabilities.

onInit

public void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageChannel

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement

Overrides:

destroy in class AbstractMessageChannel