org.springframework.cloud.aws.messaging.config

Class SimpleMessageListenerContainerFactory

java.lang.Object

org.springframework.cloud.aws.messaging.config.SimpleMessageListenerContainerFactory

public class SimpleMessageListenerContainerFactory
extends Object

Since:

1.0

Author:

Alain Sahli

Constructor Summary

Constructors

Constructor and Description
SimpleMessageListenerContainerFactory()

Method Summary

Modifier and Type	Method and Description
SimpleMessageListenerContainer	createSimpleMessageListenerContainer()
com.amazonaws.services.sqs.AmazonSQS	getAmazonSqs()
Long	getBackOffTime()
QueueMessageHandler	getQueueMessageHandler()
org.springframework.cloud.aws.core.env.ResourceIdResolver	getResourceIdResolver()
void	setAmazonSqs(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs) Sets the AmazonSQSAsync that is going to be used by the container to interact with the messaging (SQS) API.
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	setDeleteMessageOnException(Boolean deleteMessageOnException) Defines if a message must be deleted or not if the handler method throws an exception and the exception handler method is called.
void	setDestinationResolver(org.springframework.messaging.core.DestinationResolver<String> destinationResolver) Configures the destination resolver used to retrieve the queue url based on the destination name configured for this instance.
void	setMaxNumberOfMessages(Integer maxNumberOfMessages) Configure the maximum number of messages that should be retrieved during one poll to the Amazon SQS system.
void	setQueueMessageHandler(QueueMessageHandler messageHandler) Configures the QueueMessageHandler that must be used to handle incoming messages.
void	setResourceIdResolver(org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver) This value must be set if no destination resolver has been set.
void	setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor) Configures the TaskExecutor which is used to poll messages and execute them by calling the handler methods.
void	setVisibilityTimeout(Integer visibilityTimeout) Configures the duration (in seconds) that the received messages are hidden from subsequent poll requests after being retrieved from the system.
void	setWaitTimeOut(Integer waitTimeOut) Configures the wait timeout that the poll request will wait for new message to arrive if the are currently no messages on the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMessageListenerContainerFactory

public SimpleMessageListenerContainerFactory()

Method Detail

setTaskExecutor

public void setTaskExecutor(org.springframework.core.task.TaskExecutor 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:

SimpleMessageListenerContainer.createDefaultTaskExecutor()

setMaxNumberOfMessages

public void setMaxNumberOfMessages(Integer maxNumberOfMessages)

Configure the maximum number of messages that should be retrieved during one poll to the Amazon SQS system. This number must be a positive, non-zero number that has a maximum number of 10. Values higher then 10 are currently not supported by the queueing system.

Parameters:

maxNumberOfMessages - the maximum number of messages (between 1-10)

setVisibilityTimeout

public void setVisibilityTimeout(Integer visibilityTimeout)

Configures the duration (in seconds) that the received messages are hidden from subsequent poll requests after being retrieved from the system.

Parameters:

visibilityTimeout - the visibility timeout in seconds

setWaitTimeOut

public void setWaitTimeOut(Integer waitTimeOut)

Configures the wait timeout that the poll request will wait for new message to arrive if the are currently no messages on the queue. Higher values will reduce poll request to the system significantly. The value should be between 1 and 20. For more information read the documentation.

Parameters:

waitTimeOut - - the wait time out in seconds

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

setAmazonSqs

public void setAmazonSqs(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs)

Sets the AmazonSQSAsync that is going to be used by the container to interact with the messaging (SQS) API.

Parameters:

amazonSqs - The AmazonSQSAsync, must not be null.

getAmazonSqs

public com.amazonaws.services.sqs.AmazonSQS getAmazonSqs()

setQueueMessageHandler

public void setQueueMessageHandler(QueueMessageHandler messageHandler)

Configures the QueueMessageHandler that must be used to handle incoming messages.

NOTE: It is rather unlikely that the QueueMessageHandler must be configured with this setter. Consider using the QueueMessageHandlerFactory to configure the QueueMessageHandler before using this setter.

Parameters:

messageHandler - the QueueMessageHandler that must be used by the container, must not be null.

See Also:

QueueMessageHandlerFactory

getQueueMessageHandler

public QueueMessageHandler getQueueMessageHandler()

setResourceIdResolver

public void setResourceIdResolver(org.springframework.cloud.aws.core.env.ResourceIdResolver resourceIdResolver)

This value must be set if no destination resolver has been set.

Parameters:

resourceIdResolver - the resourceIdResolver to use for resolving logical to physical ids in a CloudFormation environment. Must not be null.

getResourceIdResolver

public org.springframework.cloud.aws.core.env.ResourceIdResolver getResourceIdResolver()

setDestinationResolver

public void setDestinationResolver(org.springframework.messaging.core.DestinationResolver<String> destinationResolver)

Configures the destination resolver used to retrieve the queue url based on the destination name configured for this instance.
This setter can be used when a custom configured DestinationResolver must be provided. (For example if one want to have the DynamicQueueUrlDestinationResolver with the auto creation of queues set to true.

Parameters:

destinationResolver - another or customized DestinationResolver

setDeleteMessageOnException

public void setDeleteMessageOnException(Boolean deleteMessageOnException)

Defines if a message must be deleted or not if the handler method throws an exception and the exception handler method is called. By default this value is set to true which means that the message is deleted to avoid poison messages. If this value is set to false it is the responsibility of the exception handler method to delete the message. The exception handler method can inject the message headers with Headers in order to get the receipt handle.

Parameters:

deleteMessageOnException - whether a message must be deleted or not when the handler method throws an exception

getBackOffTime

public 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

createSimpleMessageListenerContainer

public SimpleMessageListenerContainer createSimpleMessageListenerContainer()