SimpleMessageListenerContainer (Spring Cloud AWS Messaging 2.0.2.RELEASE API)

java.lang.Object
- org.springframework.cloud.aws.messaging.listener.SimpleMessageListenerContainer

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
```
public class SimpleMessageListenerContainer
extends Object
```
Since:

1.0

Author:

Agim Emruli, Alain Sahli

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AbstractMessageListenerContainer.QueueAttributes

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractMessageListenerContainer.QueueAttributes`

Constructor Summary

Constructors
Constructor and Description

SimpleMessageListenerContainer()

Constructors
Constructor and Description
`SimpleMessageListenerContainer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected org.springframework.core.task.AsyncTaskExecutor`	`createDefaultTaskExecutor()` Create a default TaskExecutor.
`void`	`destroy()`
`protected void`	`doDestroy()`
`protected void`	`doStart()`
`protected void`	`doStop()`
`protected void`	`executeMessage(org.springframework.messaging.Message<String> stringMessage)`
`protected com.amazonaws.services.sqs.AmazonSQSAsync`	`getAmazonSqs()`
`long`	`getBackOffTime()`
`protected String`	`getBeanName()`
`protected org.springframework.messaging.core.DestinationResolver<String>`	`getDestinationResolver()`
`protected Object`	`getLifecycleMonitor()`
`protected org.slf4j.Logger`	`getLogger()`
`protected Integer`	`getMaxNumberOfMessages()`
`protected QueueMessageHandler`	`getMessageHandler()`
`int`	`getPhase()`
`long`	`getQueueStopTimeout()`
`protected Map<String,AbstractMessageListenerContainer.QueueAttributes>`	`getRegisteredQueues()`
`protected org.springframework.core.task.AsyncTaskExecutor`	`getTaskExecutor()`
`protected Integer`	`getVisibilityTimeout()`
`protected Integer`	`getWaitTimeOut()`
`protected void`	`initialize()`
`boolean`	`isActive()`
`boolean`	`isAutoStartup()`
`boolean`	`isRunning()`
`boolean`	`isRunning(String logicalQueueName)` Checks if the spinning thread for the specified queue `logicalQueueName` is still running (polling for new messages) or not.
`void`	`setAmazonSqs(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs)` Configures the mandatory `AmazonSQS` client for this instance.
`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`	`setBeanName(String name)`
`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`	`setMessageHandler(QueueMessageHandler messageHandler)`
`void`	`setPhase(int phase)` Configure a custom phase for the container to start.
`void`	`setQueueStopTimeout(long queueStopTimeout)` The number of milliseconds the `stop(String)` method waits for a queue to stop before interrupting the current thread.
`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.AsyncTaskExecutor taskExecutor)`
`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.
`void`	`start()`
`void`	`start(String logicalQueueName)`
`protected void`	`startQueue(String queueName, AbstractMessageListenerContainer.QueueAttributes queueAttributes)`
`void`	`stop()`
`void`	`stop(Runnable callback)`
`void`	`stop(String logicalQueueName)` Stops and waits until the specified queue has stopped.
`protected void`	`stopQueue(String logicalQueueName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleMessageListenerContainer
```
public SimpleMessageListenerContainer()
```
- Method Detail
  - getTaskExecutor
```
protected org.springframework.core.task.AsyncTaskExecutor getTaskExecutor()
```
  - setTaskExecutor
```
public void setTaskExecutor(org.springframework.core.task.AsyncTaskExecutor taskExecutor)
```
  - 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 is 10000 milliseconds.
    
    Parameters:
    
    backOffTime - in milliseconds
  - getQueueStopTimeout
```
public long getQueueStopTimeout()
```
    Returns:
    
    The number of milliseconds the stop(String) method waits for a queue to stop before interrupting the current thread. Default value is 10000 milliseconds (10 seconds).
  - setQueueStopTimeout
```
public void setQueueStopTimeout(long queueStopTimeout)
```
    The number of milliseconds the stop(String) method waits for a queue to stop before interrupting the current thread. Default value is 10000 milliseconds (10 seconds).
    
    Parameters:
    
    queueStopTimeout - in milliseconds
  - initialize
```
protected void initialize()
```
  - doStart
```
protected void doStart()
```
  - doStop
```
protected void doStop()
```
  - doDestroy
```
protected void doDestroy()
```
  - createDefaultTaskExecutor
```
protected org.springframework.core.task.AsyncTaskExecutor createDefaultTaskExecutor()
```
    Create a default TaskExecutor. Called if no explicit TaskExecutor has been specified.
    The default implementation builds a SimpleAsyncTaskExecutor with the specified bean name (or the class name, if no bean name specified) as thread name prefix.
    
    Returns:
    
    a SimpleAsyncTaskExecutor configured with the thread name prefix
    
    See Also:
    
    SimpleAsyncTaskExecutor.SimpleAsyncTaskExecutor(String)
  - executeMessage
```
protected void executeMessage(org.springframework.messaging.Message<String> stringMessage)
```
  - stop
```
public void stop(String logicalQueueName)
```
    Stops and waits until the specified queue has stopped. If the wait timeout specified by getQueueStopTimeout() is reached, the current thread is interrupted.
    
    Parameters:
    
    logicalQueueName - the name as defined on the listener method
  - stopQueue
```
protected void stopQueue(String logicalQueueName)
```
  - start
```
public void start(String logicalQueueName)
```
  - isRunning
```
public boolean isRunning(String logicalQueueName)
```
    Checks if the spinning thread for the specified queue logicalQueueName is still running (polling for new messages) or not.
    
    Parameters:
    
    logicalQueueName - the name as defined on the listener method
    
    Returns:
    
    true if the spinning thread for the specified queue is running otherwise false.
  - startQueue
```
protected void startQueue(String queueName,
                          AbstractMessageListenerContainer.QueueAttributes queueAttributes)
```
  - getRegisteredQueues
```
protected Map<String,AbstractMessageListenerContainer.QueueAttributes> getRegisteredQueues()
```
  - getMessageHandler
```
protected QueueMessageHandler getMessageHandler()
```
  - setMessageHandler
```
public void setMessageHandler(QueueMessageHandler messageHandler)
```
  - getLifecycleMonitor
```
protected Object getLifecycleMonitor()
```
  - getLogger
```
protected org.slf4j.Logger getLogger()
```
  - getAmazonSqs
```
protected com.amazonaws.services.sqs.AmazonSQSAsync getAmazonSqs()
```
  - setAmazonSqs
```
public void setAmazonSqs(com.amazonaws.services.sqs.AmazonSQSAsync amazonSqs)
```
    Configures the mandatory AmazonSQS client for this instance. Note:The configured instance should have a buffering amazon SQS instance (see subclasses) functionality to improve the performance during message reception and deletion on the queueing system.
    
    Parameters:
    
    amazonSqs - the amazon sqs instance. Must not be null
  - getDestinationResolver
```
protected org.springframework.messaging.core.DestinationResolver<String> getDestinationResolver()
```
  - 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 - - the destination resolver. Must not be null
  - getBeanName
```
protected String getBeanName()
```
  - setBeanName
```
public void setBeanName(String name)
```
    Specified by:
    
    setBeanName in interface org.springframework.beans.factory.BeanNameAware
  - getMaxNumberOfMessages
```
protected Integer getMaxNumberOfMessages()
```
  - 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)
  - getVisibilityTimeout
```
protected Integer getVisibilityTimeout()
```
  - 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
  - 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.
  - getWaitTimeOut
```
protected Integer getWaitTimeOut()
```
  - 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.
    
    Parameters:
    
    waitTimeOut - - the wait time out in seconds
  - isAutoStartup
```
public boolean isAutoStartup()
```
    Specified by:
    
    isAutoStartup in interface org.springframework.context.SmartLifecycle
  - 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
  - stop
```
public void stop(Runnable callback)
```
    Specified by:
    
    stop in interface org.springframework.context.SmartLifecycle
  - getPhase
```
public int getPhase()
```
    Specified by:
    
    getPhase in interface org.springframework.context.Phased
  - setPhase
```
public void setPhase(int phase)
```
    Configure a custom phase for the container to start. This allows to start other beans that also implements the SmartLifecycle interface.
    
    Parameters:
    
    phase - - the phase that defines the phase respecting the Ordered semantics
  - isActive
```
public boolean isActive()
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.springframework.context.Lifecycle
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.springframework.context.Lifecycle
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface org.springframework.context.Lifecycle
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean

Class SimpleMessageListenerContainer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleMessageListenerContainer

Method Detail

getTaskExecutor

setTaskExecutor

getBackOffTime

setBackOffTime

getQueueStopTimeout

setQueueStopTimeout

initialize

doStart

doStop

doDestroy

createDefaultTaskExecutor

executeMessage

stop

stopQueue

start

isRunning

startQueue

getRegisteredQueues

getMessageHandler

setMessageHandler

getLifecycleMonitor

getLogger

getAmazonSqs

setAmazonSqs

getDestinationResolver

setDestinationResolver

getBeanName

setBeanName

getMaxNumberOfMessages

setMaxNumberOfMessages

getVisibilityTimeout

setVisibilityTimeout

setResourceIdResolver

getWaitTimeOut

setWaitTimeOut

isAutoStartup

setAutoStartup

stop

getPhase

setPhase

isActive

afterPropertiesSet

start

stop

isRunning

destroy