org.springframework.integration.redis.channel

Class SubscribableRedisChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.redis.channel.SubscribableRedisChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, BroadcastCapableChannel, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent, MessageChannel, SubscribableChannel, InterceptableChannel

public class SubscribableRedisChannel
extends AbstractMessageChannel
implements BroadcastCapableChannel, ManageableSmartLifecycle

An AbstractMessageChannel implementation with BroadcastCapableChannel aspect to provide a pub-sub semantics to consume messages fgrom Redis topic.

Since:

2.0

Author:

Oleg Zhurakousky, 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
SubscribableRedisChannel(RedisConnectionFactory connectionFactory, String topicName)

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected boolean	doSend(Message<?> message, long arg1) Subclasses must implement this method.
int	getPhase()
boolean	isAutoStartup()
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	setMessageConverter(MessageConverter messageConverter) Specify the MessageConverter to use when trying to convert to one of this channel's supported datatypes (in order) for a Message whose payload does not already match.
void	setSerializer(RedisSerializer<?> serializer)
void	setTaskExecutor(Executor taskExecutor)
void	start()
void	stop()
void	stop(Runnable callback)
boolean	subscribe(MessageHandler handler)
boolean	unsubscribe(MessageHandler handler)

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

addInterceptor, addInterceptor, getComponentType, getFullChannelName, getIChannelInterceptorList, getIntegrationPatternType, getInterceptors, getMetricsCaptor, getOverrides, isLoggingEnabled, registerMetricsCaptor, removeInterceptor, removeInterceptor, send, send, setDatatypes, setInterceptors, setLoggingEnabled, setShouldTrack

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.integration.channel.BroadcastCapableChannel

isBroadcast

Methods inherited from interface org.springframework.messaging.MessageChannel

send, send

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

getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

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

getBeanName, getComponentName

Constructor Detail

SubscribableRedisChannel

public SubscribableRedisChannel(RedisConnectionFactory connectionFactory,
                                String topicName)

Method Detail

setTaskExecutor

public void setTaskExecutor(Executor taskExecutor)

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

Description copied from class: AbstractMessageChannel

Specify the MessageConverter to use when trying to convert to one of this channel's supported datatypes (in order) for a Message whose payload does not already match.

Note: only the MessageConverter.fromMessage(Message, Class) method is used. If the returned object is not a Message, the inbound headers will be copied; if the returned object is a Message, it is expected that the converter will have fully populated the headers; no further action is performed by the channel. If null is returned, conversion to the next datatype (if any) will be attempted. Defaults to a DefaultDatatypeChannelMessageConverter.

Overrides:

setMessageConverter in class AbstractMessageChannel

Parameters:

messageConverter - The message converter.

setSerializer

public void setSerializer(RedisSerializer<?> serializer)

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

doSend

protected boolean doSend(Message<?> message,
                         long arg1)

Description copied from class: AbstractMessageChannel

Subclasses must implement this method. A non-negative timeout indicates how long to wait if the channel is at capacity (if the value is 0, it must return immediately with or without success). A negative timeout value indicates that the method should block until either the message is accepted or the blocking thread is interrupted.

Specified by:

doSend in class AbstractMessageChannel

Parameters:

message - The message.

arg1 - The timeout.

Returns:

true if the send was successful.

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

Specified by:

isRunning in interface ManageableLifecycle

start

public void start()

Specified by:

start in interface Lifecycle

Specified by:

start in interface ManageableLifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

Specified by:

stop in interface ManageableLifecycle

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