MessagingMessageListenerAdapter (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.jms.listener.adapter.AbstractAdaptableMessageListener
- - org.springframework.jms.listener.adapter.MessagingMessageListenerAdapter

All Implemented Interfaces:

MessageListener, SessionAwareMessageListener<Message>
```
public class MessagingMessageListenerAdapter
extends AbstractAdaptableMessageListener
```
A MessageListener adapter that invokes a configurable InvocableHandlerMethod.
Wraps the incoming Message to Spring's Message abstraction, copying the JMS standard headers using a configurable JmsHeaderMapper.
The original Message and the Session are provided as additional arguments so that these can be injected as method arguments if necessary.

Since:

4.1

Author:

Stephane Nicoll

See Also:

Message, JmsHeaderMapper, InvocableHandlerMethod

Field Summary
- Fields inherited from class org.springframework.jms.listener.adapter.AbstractAdaptableMessageListener
  logger

Constructor Summary

Constructors
Constructor and Description

MessagingMessageListenerAdapter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`onMessage(Message jmsMessage, Session session)` Callback for processing a received JMS message.
`protected java.lang.Object`	`preProcessResponse(java.lang.Object result)` Pre-process the given result before it is converted to a `Message`.
`void`	`setHandlerMethod(InvocableHandlerMethod handlerMethod)` Set the `InvocableHandlerMethod` to use to invoke the method processing an incoming `Message`.
`protected Message<?>`	`toMessagingMessage(Message jmsMessage)`

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

- Constructor Detail
  - MessagingMessageListenerAdapter
```
public MessagingMessageListenerAdapter()
```
- Method Detail
  - setHandlerMethod
```
public void setHandlerMethod(InvocableHandlerMethod handlerMethod)
```
    Set the InvocableHandlerMethod to use to invoke the method processing an incoming Message.
  - onMessage
```
public void onMessage(Message jmsMessage,
                      @Nullable
                      Session session)
               throws JMSException
```
    Description copied from interface: SessionAwareMessageListener
    
    Callback for processing a received JMS message.
    Implementors are supposed to process the given Message, typically sending reply messages through the given Session.
    
    Specified by:
    
    onMessage in interface SessionAwareMessageListener<Message>
    
    Specified by:
    
    onMessage in class AbstractAdaptableMessageListener
    
    Parameters:
    
    jmsMessage - the received JMS message (never null)
    
    session - the underlying JMS Session (never null)
    
    Throws:
    
    JMSException - if thrown by JMS methods
  - preProcessResponse
```
protected java.lang.Object preProcessResponse(java.lang.Object result)
```
    Description copied from class: AbstractAdaptableMessageListener
    
    Pre-process the given result before it is converted to a Message.
    
    Overrides:
    
    preProcessResponse in class AbstractAdaptableMessageListener
    
    Parameters:
    
    result - the result of the invocation
    
    Returns:
    
    the payload response to handle, either the result argument or any other object (for instance wrapping the result).
  - toMessagingMessage
```
protected Message<?> toMessagingMessage(Message jmsMessage)
```

Class MessagingMessageListenerAdapter

Field Summary

Fields inherited from class org.springframework.jms.listener.adapter.AbstractAdaptableMessageListener

Constructor Summary

Method Summary

Methods inherited from class org.springframework.jms.listener.adapter.AbstractAdaptableMessageListener

Methods inherited from class java.lang.Object

Constructor Detail

MessagingMessageListenerAdapter

Method Detail

setHandlerMethod

onMessage

preProcessResponse

toMessagingMessage