SimpleMessageListenerContainer (Spring Cloud AWS Messaging Module 1.0.0.M3 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

Constructor Summary

Constructors
Constructor and Description

SimpleMessageListenerContainer()

Constructors
Constructor and Description
`SimpleMessageListenerContainer()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected org.springframework.core.task.TaskExecutor`	`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.AmazonSQS`	`getAmazonSqs()`
`protected String`	`getBeanName()`
`protected org.springframework.messaging.core.DestinationResolver<String>`	`getDestinationResolver()`
`protected org.springframework.util.ErrorHandler`	`getErrorHandler()`
`protected Object`	`getLifecycleMonitor()`
`protected org.slf4j.Logger`	`getLogger()`
`protected Integer`	`getMaxNumberOfMessages()`
`protected QueueMessageHandler`	`getMessageHandler()`
`Map<String,com.amazonaws.services.sqs.model.ReceiveMessageRequest>`	`getMessageRequests()`
`int`	`getPhase()`
`protected org.springframework.core.task.TaskExecutor`	`getTaskExecutor()`
`protected Integer`	`getVisibilityTimeout()`
`protected Integer`	`getWaitTimeOut()`
`protected void`	`handleError(Throwable throwable)`
`protected void`	`initialize()`
`boolean`	`isActive()`
`boolean`	`isAutoStartup()`
`boolean`	`isRunning()`
`void`	`setAmazonSqs(com.amazonaws.services.sqs.AmazonSQS amazonSqs)` Configures the mandatory `AmazonSQS` client for this instance.
`void`	`setAutoStartup(boolean autoStartup)` Configures if this container should be automatically started.
`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`	`setErrorHandler(org.springframework.util.ErrorHandler errorHandler)` A custom error handler that will be called in case of any message listener error.
`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`	`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)`
`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`	`stop()`
`void`	`stop(Runnable callback)`
`protected void`	`validateConfiguration()`

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.TaskExecutor getTaskExecutor()
```
  - setTaskExecutor
```
public void setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)
```
  - initialize
```
protected void initialize()
```
  - doStart
```
protected void doStart()
```
  - doStop
```
protected void doStop()
```
  - doDestroy
```
protected void doDestroy()
```
  - createDefaultTaskExecutor
```
protected org.springframework.core.task.TaskExecutor 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)
```
  - getMessageRequests
```
public Map<String,com.amazonaws.services.sqs.model.ReceiveMessageRequest> getMessageRequests()
```
  - 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.AmazonSQS getAmazonSqs()
```
  - setAmazonSqs
```
public void setAmazonSqs(com.amazonaws.services.sqs.AmazonSQS 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.
    
    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
  - getErrorHandler
```
protected org.springframework.util.ErrorHandler getErrorHandler()
```
  - setErrorHandler
```
public void setErrorHandler(org.springframework.util.ErrorHandler errorHandler)
```
    A custom error handler that will be called in case of any message listener error.
    
    Parameters:
    errorHandler - custom error handler implementation
  - isActive
```
public boolean isActive()
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
  - validateConfiguration
```
protected void validateConfiguration()
```
  - 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
  - handleError
```
protected void handleError(Throwable throwable)
```

Class SimpleMessageListenerContainer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleMessageListenerContainer

Method Detail

getTaskExecutor

setTaskExecutor

initialize

doStart

doStop

doDestroy

createDefaultTaskExecutor

executeMessage

getMessageRequests

getMessageHandler

setMessageHandler

getLifecycleMonitor

getLogger

getAmazonSqs

setAmazonSqs

getDestinationResolver

setDestinationResolver

getBeanName

setBeanName

getMaxNumberOfMessages

setMaxNumberOfMessages

getVisibilityTimeout

setVisibilityTimeout

setResourceIdResolver

getWaitTimeOut

setWaitTimeOut

isAutoStartup

setAutoStartup

stop

getPhase

setPhase

getErrorHandler

setErrorHandler

isActive

afterPropertiesSet

validateConfiguration

start

stop

isRunning

destroy

handleError