com.github.sonus21.rqueue.config

Class SimpleRqueueListenerContainerFactory

java.lang.Object

com.github.sonus21.rqueue.config.SimpleRqueueListenerContainerFactory

public class SimpleRqueueListenerContainerFactory
extends java.lang.Object

This is a bare minimal factory class that can be used to configure the entire Rqueue library. By default it can create all different components, though some of the component can be overridden using it's methods.

Constructor Summary

Constructors

Constructor and Description
SimpleRqueueListenerContainerFactory()

Method Summary

Modifier and Type	Method and Description
RqueueMessageListenerContainer	createMessageListenerContainer() Creates a RqueueMessageListenerContainer container.
java.lang.Boolean	getAutoStartup()
java.lang.Long	getBackOffTime()
java.lang.Integer	getMaxNumWorkers()
java.util.List<org.springframework.messaging.converter.MessageConverter>	getMessageConverters()
org.springframework.data.redis.connection.RedisConnectionFactory	getRedisConnectionFactory()
RqueueMessageHandler	getRqueueMessageHandler() Return configured message handler
RqueueMessageTemplate	getRqueueMessageTemplate()
org.springframework.core.task.AsyncTaskExecutor	getTaskExecutor() Get configured task executor
void	setAutoStartup(boolean autoStartup) Configures if this container should be automatically started.
void	setBackOffTime(long backOffTime) The number of milliseconds the polling thread must wait before trying to recover when an error occurs (e.g.
void	setMaxNumWorkers(int maxNumWorkers) Maximum number of workers, that would be used to run tasks.
void	setMessageConverters(java.util.List<org.springframework.messaging.converter.MessageConverter> messageConverters) For message (de)serialization we might need one or more message converters, configure those message converters
void	setRedisConnectionFactory(org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory) Set redis connection factory, that would be used to configured message template and other components
void	setRqueueMessageHandler(RqueueMessageHandler rqueueMessageHandler) Set message handler, this can be used to set custom message handlers that could have some special features apart of the default one
void	setRqueueMessageTemplate(RqueueMessageTemplate messageTemplate) Set RqueueMessageTemplate that's used to pull and push messages from/to Redis.
void	setTaskExecutor(org.springframework.core.task.AsyncTaskExecutor taskExecutor) Configures the TaskExecutor which is used to poll messages and execute them by calling the handler methods.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRqueueListenerContainerFactory

public SimpleRqueueListenerContainerFactory()

Method Detail

setTaskExecutor

public void setTaskExecutor(org.springframework.core.task.AsyncTaskExecutor taskExecutor)

Configures the TaskExecutor which is used to poll messages and execute them by calling the handler methods. If no TaskExecutor is set, a default one is created.

Parameters:

taskExecutor - The TaskExecutor used by the container

See Also:

RqueueMessageListenerContainer.createDefaultTaskExecutor()

getTaskExecutor

public org.springframework.core.task.AsyncTaskExecutor getTaskExecutor()

Get configured task executor

Returns:

async task executor

setAutoStartup

public void setAutoStartup(boolean autoStartup)

Configures if this container should be automatically started. The default value is true.

Parameters:

autoStartup - - false if the container will be manually started

getAutoStartup

public java.lang.Boolean getAutoStartup()

setRqueueMessageHandler

public void setRqueueMessageHandler(RqueueMessageHandler rqueueMessageHandler)

Set message handler, this can be used to set custom message handlers that could have some special features apart of the default one

Parameters:

rqueueMessageHandler - RqueueMessageHandler object

getRqueueMessageHandler

public RqueueMessageHandler getRqueueMessageHandler()

Return configured message handler

Returns:

RqueueMessageHandler object

getBackOffTime

public java.lang.Long getBackOffTime()

Returns:

The number of milliseconds the polling thread must wait before trying to recover when an error occurs (e.g. connection timeout)

setBackOffTime

public void setBackOffTime(long backOffTime)

The number of milliseconds the polling thread must wait before trying to recover when an error occurs (e.g. connection timeout). Default value is 10000 milliseconds.

Parameters:

backOffTime - in milliseconds

setMaxNumWorkers

public void setMaxNumWorkers(int maxNumWorkers)

Maximum number of workers, that would be used to run tasks.

Parameters:

maxNumWorkers - Maximum number of workers

getMaxNumWorkers

public java.lang.Integer getMaxNumWorkers()

setMessageConverters

public void setMessageConverters(java.util.List<org.springframework.messaging.converter.MessageConverter> messageConverters)

For message (de)serialization we might need one or more message converters, configure those message converters

Parameters:

messageConverters - list of message converters

getMessageConverters

public java.util.List<org.springframework.messaging.converter.MessageConverter> getMessageConverters()

Returns:

list of configured message converters

setRedisConnectionFactory

public void setRedisConnectionFactory(org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory)

Set redis connection factory, that would be used to configured message template and other components

Parameters:

redisConnectionFactory - redis connection factory object

getRedisConnectionFactory

public org.springframework.data.redis.connection.RedisConnectionFactory getRedisConnectionFactory()

Returns:

get Redis connection factor

setRqueueMessageTemplate

public void setRqueueMessageTemplate(RqueueMessageTemplate messageTemplate)

Set RqueueMessageTemplate that's used to pull and push messages from/to Redis.

Parameters:

messageTemplate - a message template object

getRqueueMessageTemplate

public RqueueMessageTemplate getRqueueMessageTemplate()

Returns:

message template

createMessageListenerContainer

public RqueueMessageListenerContainer createMessageListenerContainer()

Creates a RqueueMessageListenerContainer container. To create this container we would need redis connection factory RedisConnectionFactoryas well as message handler RqueueMessageHandler.

Returns:

an object of RqueueMessageListenerContainer object