Class MethodAmqpListenerEndpoint

java.lang.Object

org.springframework.amqp.client.config.AbstractAmqpListenerEndpoint

org.springframework.amqp.client.config.MethodAmqpListenerEndpoint

All Implemented Interfaces:

AmqpListenerEndpoint

public class MethodAmqpListenerEndpoint
extends AbstractAmqpListenerEndpoint

The AbstractAmqpListenerEndpoint implementation for POJO method invocation listener. Usually, instances of this class are created and handled by the framework.

The setMessageHandlerMethodFactory(MessageHandlerMethodFactory) and setBeanFactory(BeanFactory) must be provided before calling getMessageListener(). If other options have to be propagated to the AmqpMessagingListenerAdapter, they have to be provided prior to getMessageListener() call.

If this class is configured by the framework, any not provided options will be populated with default values from the MethodAmqpMessageListenerContainerFactory (if any).

Since:

4.1

Author:

Artem Bilan

Constructor Summary

Constructors

Constructor	Description
MethodAmqpListenerEndpoint(Object bean, Method method, String... addresses)	Create an instance for the method to invoke on the provided bean.

Method Summary

Modifier and Type	Method	Description
protected @Nullable AmqpListenerErrorHandler	getErrorHandler()
protected @Nullable AmqpHeaderMapper	getHeaderMapper()
protected @Nullable MessageConverter	getMessageConverter()
MessageListener	getMessageListener()	Return the message listener to be used in the target listener container bean.
protected @Nullable String	getReplyContentType()
protected @Nullable ReplyPostProcessor	getReplyPostProcessor()
protected boolean	isDefaultRequeueRejected()
protected boolean	isReturnExceptions()
void	setBeanFactory(BeanFactory beanFactory)	Provide a BeanFactory to use for resolving expressions in the listener method.
void	setDefaultRequeueRejected(boolean defaultRequeueRejected)	Set the default behavior for messages rejection, for example, when the listener throws an exception.
void	setErrorHandler(AmqpListenerErrorHandler errorHandler)	Set the AmqpListenerErrorHandler to invoke if the listener method throws an exception.
void	setHeaderMapper(AmqpHeaderMapper headerMapper)	Set the AmqpHeaderMapper implementation to use to map the standard AMQP headers.
void	setMessageConverter(MessageConverter messageConverter)	Set the converter to convert incoming messages to listener method arguments, and objects returned from listener methods for response messages.
void	setMessageHandlerMethodFactory(MessageHandlerMethodFactory messageHandlerMethodFactory)	Set the MessageHandlerMethodFactory to build an InvocableHandlerMethod for the listener method.
void	setReplyContentType(String replyContentType)	Set the reply content type.
void	setReplyPostProcessor(ReplyPostProcessor replyPostProcessor)	Set a ReplyPostProcessor to post process a response message before it is sent.
void	setReturnExceptions(boolean returnExceptions)	Set whether exceptions thrown by the listener should be returned as a response message body to the sender using the normal replyTo/@SendTo semantics.

Methods inherited from class AbstractAmqpListenerEndpoint

getAddresses, getAdviceChain, getAutoAccept, getAutoStartup, getConcurrency, getGracefulShutdownPeriod, getId, getInitialCredits, getReceiveTimeout, getTaskExecutor, setAdviceChain, setAutoAccept, setAutoStartup, setConcurrency, setGracefulShutdownPeriod, setId, setInitialCredits, setReceiveTimeout, setTaskExecutor

Methods inherited from class Object

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

Constructor Details

MethodAmqpListenerEndpoint

public MethodAmqpListenerEndpoint(Object bean,
 Method method,
 String... addresses)

Create an instance for the method to invoke on the provided bean. The addresses are propagated to the AmqpMessageListenerContainer.

Parameters:

bean - the bean to invoke the method on.

method - the method to invoke.

addresses - the addresses to listen to.

Method Details

setMessageHandlerMethodFactory

public void setMessageHandlerMethodFactory(MessageHandlerMethodFactory messageHandlerMethodFactory)

Set the MessageHandlerMethodFactory to build an InvocableHandlerMethod for the listener method. Must be provided before calling getMessageListener(). Usually provided by the framework.

Parameters:

messageHandlerMethodFactory - the factory to use.

setDefaultRequeueRejected

public void setDefaultRequeueRejected(boolean defaultRequeueRejected)

Set the default behavior for messages rejection, for example, when the listener throws an exception. When true (default), messages will be requeued, otherwise - rejected. Setting to false causes all rejections to not be requeued. When set to true, the default can be overridden by the listener throwing an AmqpRejectAndDontRequeueException.

Parameters:

defaultRequeueRejected - false to reject messages by default.

See Also:

• AmqpMessagingListenerAdapter.setDefaultRequeueRejected(boolean)

isDefaultRequeueRejected

protected boolean isDefaultRequeueRejected()

setReturnExceptions

public void setReturnExceptions(boolean returnExceptions)

Set whether exceptions thrown by the listener should be returned as a response message body to the sender using the normal replyTo/@SendTo semantics.

Parameters:

returnExceptions - true to return exceptions.

See Also:

• AmqpMessagingListenerAdapter.setReturnExceptions(boolean)

isReturnExceptions

protected boolean isReturnExceptions()

setReplyPostProcessor

public void setReplyPostProcessor(ReplyPostProcessor replyPostProcessor)

Set a ReplyPostProcessor to post process a response message before it is sent.

Parameters:

replyPostProcessor - the post-processor.

See Also:

• AmqpMessagingListenerAdapter.setReplyPostProcessor(ReplyPostProcessor)

getReplyPostProcessor

protected @Nullable ReplyPostProcessor getReplyPostProcessor()

setErrorHandler

public void setErrorHandler(AmqpListenerErrorHandler errorHandler)

Set the AmqpListenerErrorHandler to invoke if the listener method throws an exception.

Parameters:

errorHandler - the error handler.

See Also:

• AmqpMessagingListenerAdapter.setErrorHandler(AmqpListenerErrorHandler)

getErrorHandler

protected @Nullable AmqpListenerErrorHandler getErrorHandler()

setReplyContentType

public void setReplyContentType(String replyContentType)

Set the reply content type. Overrides the one populated by a message converter.

Parameters:

replyContentType - the content type.

See Also:

• AmqpMessagingListenerAdapter.setReplyContentType(String)

getReplyContentType

protected @Nullable String getReplyContentType()

setHeaderMapper

public void setHeaderMapper(AmqpHeaderMapper headerMapper)

Set the AmqpHeaderMapper implementation to use to map the standard AMQP headers.

Parameters:

headerMapper - the AmqpHeaderMapper instance.

See Also:

• AmqpMessagingListenerAdapter.setHeaderMapper(AmqpHeaderMapper)

getHeaderMapper

protected @Nullable AmqpHeaderMapper getHeaderMapper()

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

Set the converter to convert incoming messages to listener method arguments, and objects returned from listener methods for response messages.

Parameters:

messageConverter - The message converter.

See Also:

• AmqpMessagingListenerAdapter.setMessageConverter(MessageConverter)

getMessageConverter

protected @Nullable MessageConverter getMessageConverter()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Provide a BeanFactory to use for resolving expressions in the listener method. Usually populated by the framework.

Parameters:

beanFactory - the BeanFactory to use.

getMessageListener

public MessageListener getMessageListener()

Description copied from interface: AmqpListenerEndpoint

Return the message listener to be used in the target listener container bean.

Returns:

the message listener.