org.springframework.messaging.simp.annotation.support

Class ReplyToMethodReturnValueHandler

java.lang.Object

org.springframework.messaging.simp.annotation.support.ReplyToMethodReturnValueHandler

All Implemented Interfaces:

HandlerMethodReturnValueHandler

public class ReplyToMethodReturnValueHandler
extends java.lang.Object
implements HandlerMethodReturnValueHandler

A HandlerMethodReturnValueHandler for replying to destinations specified in a ReplyTo or ReplyToUser method-level annotations.

The value returned from the method is converted, and turned to a Message and sent through the provided MessageChannel. The message is then enriched with the sessionId of the input message as well as the destination from the annotation(s). If multiple destinations are specified, a copy of the message is sent to each destination.

Since:

4.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ReplyToMethodReturnValueHandler.SessionHeaderPostProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private SimpMessageSendingOperations	messagingTemplate

Constructor Summary

Constructors

Constructor and Description
ReplyToMethodReturnValueHandler(SimpMessageSendingOperations messagingTemplate)

Method Summary

Modifier and Type	Method and Description
void	handleReturnValue(java.lang.Object returnValue, MethodParameter returnType, Message<?> inputMessage) Handle the given return value.
boolean	supportsReturnType(MethodParameter returnType) Whether the given method return type is supported by this handler.

Methods inherited from class java.lang.Object

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

Field Detail

messagingTemplate

private final SimpMessageSendingOperations messagingTemplate

Constructor Detail

ReplyToMethodReturnValueHandler

public ReplyToMethodReturnValueHandler(SimpMessageSendingOperations messagingTemplate)

Method Detail

supportsReturnType

public boolean supportsReturnType(MethodParameter returnType)

Description copied from interface: HandlerMethodReturnValueHandler

Whether the given method return type is supported by this handler.

Specified by:

supportsReturnType in interface HandlerMethodReturnValueHandler

Parameters:

returnType - the method return type to check

Returns:

true if this handler supports the supplied return type; false otherwise

handleReturnValue

public void handleReturnValue(java.lang.Object returnValue,
                     MethodParameter returnType,
                     Message<?> inputMessage)
                       throws java.lang.Exception

Description copied from interface: HandlerMethodReturnValueHandler

Handle the given return value.

Specified by:

handleReturnValue in interface HandlerMethodReturnValueHandler

Parameters:

returnValue - the value returned from the handler method

returnType - the type of the return value. This type must have previously been passed to HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter) and it must have returned true

inputMessage - the message that caused this method to be called

Throws:

java.lang.Exception - if the return value handling results in an error