org.springframework.messaging.handler.annotation.support.reactive

Class MessageMappingMessageHandler

java.lang.Object

org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler<CompositeMessageCondition>

org.springframework.messaging.handler.annotation.support.reactive.MessageMappingMessageHandler

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, EmbeddedValueResolverAware, ReactiveMessageHandler

Direct Known Subclasses:

RSocketMessageHandler

public class MessageMappingMessageHandler
extends AbstractMethodMessageHandler<CompositeMessageCondition>
implements EmbeddedValueResolverAware

Extension of AbstractMethodMessageHandler for reactive, non-blocking handling of messages via @MessageMapping methods. By default such methods are detected in @Controller Spring beans but that can be changed via setHandlerPredicate(Predicate).

Payloads for incoming messages are decoded through the configured setDecoders(List) decoders, with the help of PayloadMethodArgumentResolver.

There is no default handling for return values but AbstractMethodMessageHandler.setReturnValueHandlerConfigurer(org.springframework.messaging.handler.invocation.reactive.ReturnValueHandlerConfigurer) can be used to configure custom return value handlers. Sub-classes may also override initReturnValueHandlers() to set up default return value handlers.

Since:

5.2

Author:

Rossen Stoyanchev

See Also:

AbstractEncoderMethodReturnValueHandler

Field Summary

Fields

Modifier and Type	Field and Description
private ConversionService	conversionService
private java.util.List<Decoder<?>>	decoders
private java.util.function.Predicate<java.lang.Class<?>>	handlerPredicate
private PathMatcher	pathMatcher
private Validator	validator
private StringValueResolver	valueResolver

Fields inherited from class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler

logger

Constructor Summary

Constructors

Constructor and Description
MessageMappingMessageHandler()

Method Summary

Modifier and Type	Method and Description
protected AbstractExceptionHandlerMethodResolver	createExceptionMethodResolverFor(java.lang.Class<?> beanType) Create a concrete instance of AbstractExceptionHandlerMethodResolver that finds exception handling methods based on some criteria, e.g.
private CompositeMessageCondition	getCondition(java.lang.reflect.AnnotatedElement element)
ConversionService	getConversionService() Return the configured ConversionService.
java.util.List<? extends Decoder<?>>	getDecoders() Return the configured decoders.
protected java.lang.String	getDestination(Message<?> message) Extract a String-based destination, if any, that can be used to perform a direct look up into the registered mappings.
protected java.util.Set<java.lang.String>	getDirectLookupMappings(CompositeMessageCondition mapping) Return String-based destinations for the given mapping, if any, that can be used to find matches with a direct lookup (i.e.
java.util.function.Predicate<java.lang.Class<?>>	getHandlerPredicate() Return the configured handler predicate.
protected java.util.Comparator<CompositeMessageCondition>	getMappingComparator(Message<?> message) Return a comparator for sorting matching mappings.
protected CompositeMessageCondition	getMappingForMethod(java.lang.reflect.Method method, java.lang.Class<?> handlerType) Obtain the mapping for the given method, if any.
protected CompositeMessageCondition	getMatchingMapping(CompositeMessageCondition mapping, Message<?> message) Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.
PathMatcher	getPathMatcher() Return the PathMatcher implementation to use for matching destinations.
Validator	getValidator() Return the configured Validator instance.
protected <any>	handleMatch(CompositeMessageCondition mapping, HandlerMethod handlerMethod, Message<?> message)
protected java.util.List<? extends HandlerMethodArgumentResolver>	initArgumentResolvers() Return the list of argument resolvers to use.
protected java.util.function.Predicate<java.lang.Class<?>>	initHandlerPredicate() Return the predicate to use to check whether a given Spring bean should be introspected for message handling methods.
protected java.util.List<? extends HandlerMethodReturnValueHandler>	initReturnValueHandlers() Return the list of return value handlers to use.
void	setAutoDetectDisabled() Disable auto-detection of @MessageMapping methods, e.g.
void	setConversionService(ConversionService conversionService) Configure a ConversionService to use for type conversion of String based values, e.g.
void	setDecoders(java.util.List<? extends Decoder<?>> decoders) Configure the decoders to use for incoming payloads.
void	setEmbeddedValueResolver(StringValueResolver resolver) Set the StringValueResolver to use for resolving embedded definition values.
void	setHandlerPredicate(java.util.function.Predicate<java.lang.Class<?>> handlerPredicate) Configure the predicate to use for selecting which Spring beans to check for @MessageMapping methods.
void	setHandlers(java.util.List<java.lang.Object> handlers) Manually configure handlers to check for @MessageMapping methods.
void	setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher implementation to use for matching destinations against configured destination patterns.
void	setValidator(Validator validator) Set the Validator instance used for validating @Payload arguments.

Methods inherited from class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler

afterPropertiesSet, detectHandlerMethods, getApplicationContext, getArgumentResolverConfigurer, getBeanName, getDestinationLookup, getHandlerMethods, getReactiveAdapterRegistry, getReturnValueHandlerConfigurer, handleMessage, handleNoMatch, registerExceptionHandlerAdvice, registerHandlerMethod, setApplicationContext, setArgumentResolverConfigurer, setBeanName, setReactiveAdapterRegistry, setReturnValueHandlerConfigurer

Methods inherited from class java.lang.Object

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

Field Detail

handlerPredicate

@Nullable
private java.util.function.Predicate<java.lang.Class<?>> handlerPredicate

decoders

private final java.util.List<Decoder<?>> decoders

validator

@Nullable
private Validator validator

pathMatcher

private PathMatcher pathMatcher

conversionService

private ConversionService conversionService

valueResolver

@Nullable
private StringValueResolver valueResolver

Constructor Detail

MessageMappingMessageHandler

public MessageMappingMessageHandler()

Method Detail

setHandlers

public void setHandlers(java.util.List<java.lang.Object> handlers)

Manually configure handlers to check for @MessageMapping methods.

Note: the given handlers are not required to be annotated with @Controller. Consider also using setAutoDetectDisabled() if the intent is to use these handlers instead of, and not in addition to @Controller classes. Or alternatively use setHandlerPredicate(Predicate) to select a different set of beans based on a different criteria.

Parameters:

handlers - the handlers to register

See Also:

setAutoDetectDisabled(), setHandlerPredicate(Predicate)

setHandlerPredicate

public void setHandlerPredicate(@Nullable
                                java.util.function.Predicate<java.lang.Class<?>> handlerPredicate)

Configure the predicate to use for selecting which Spring beans to check for @MessageMapping methods. When set to null, auto-detection is turned off which is what setAutoDetectDisabled() does internally.

The predicate used by default selects @Controller classes.

See Also:

setHandlers(List), setAutoDetectDisabled()

getHandlerPredicate

@Nullable
public java.util.function.Predicate<java.lang.Class<?>> getHandlerPredicate()

Return the configured handler predicate.

setAutoDetectDisabled

public void setAutoDetectDisabled()

Disable auto-detection of @MessageMapping methods, e.g. in @Controllers, by setting setHandlerPredicate(null).

setDecoders

public void setDecoders(java.util.List<? extends Decoder<?>> decoders)

Configure the decoders to use for incoming payloads.

getDecoders

public java.util.List<? extends Decoder<?>> getDecoders()

Return the configured decoders.

setValidator

public void setValidator(@Nullable
                         Validator validator)

Set the Validator instance used for validating @Payload arguments.

See Also:

Validated, PayloadMethodArgumentResolver

getValidator

@Nullable
public Validator getValidator()

Return the configured Validator instance.

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Set the PathMatcher implementation to use for matching destinations against configured destination patterns.

By default, AntPathMatcher is used with separator set to ".".

getPathMatcher

public PathMatcher getPathMatcher()

Return the PathMatcher implementation to use for matching destinations.

setConversionService

public void setConversionService(ConversionService conversionService)

Configure a ConversionService to use for type conversion of String based values, e.g. in destination variables or headers.

By default DefaultFormattingConversionService is used.

Parameters:

conversionService - the conversion service to use

getConversionService

public ConversionService getConversionService()

Return the configured ConversionService.

setEmbeddedValueResolver

public void setEmbeddedValueResolver(StringValueResolver resolver)

Description copied from interface: EmbeddedValueResolverAware

Set the StringValueResolver to use for resolving embedded definition values.

Specified by:

setEmbeddedValueResolver in interface EmbeddedValueResolverAware

initArgumentResolvers

protected java.util.List<? extends HandlerMethodArgumentResolver> initArgumentResolvers()

Description copied from class: AbstractMethodMessageHandler

Return the list of argument resolvers to use.

Subclasses should also take into account custom argument types configured via AbstractMethodMessageHandler.setArgumentResolverConfigurer(org.springframework.messaging.handler.invocation.reactive.ArgumentResolverConfigurer).

Specified by:

initArgumentResolvers in class AbstractMethodMessageHandler<CompositeMessageCondition>

initReturnValueHandlers

protected java.util.List<? extends HandlerMethodReturnValueHandler> initReturnValueHandlers()

Description copied from class: AbstractMethodMessageHandler

Return the list of return value handlers to use.

Subclasses should also take into account custom return value types configured via AbstractMethodMessageHandler.setReturnValueHandlerConfigurer(org.springframework.messaging.handler.invocation.reactive.ReturnValueHandlerConfigurer).

Specified by:

initReturnValueHandlers in class AbstractMethodMessageHandler<CompositeMessageCondition>

initHandlerPredicate

protected java.util.function.Predicate<java.lang.Class<?>> initHandlerPredicate()

Description copied from class: AbstractMethodMessageHandler

Return the predicate to use to check whether a given Spring bean should be introspected for message handling methods. If null is returned, auto-detection is effectively disabled.

Specified by:

initHandlerPredicate in class AbstractMethodMessageHandler<CompositeMessageCondition>

getMappingForMethod

protected CompositeMessageCondition getMappingForMethod(java.lang.reflect.Method method,
                                                        java.lang.Class<?> handlerType)

Description copied from class: AbstractMethodMessageHandler

Obtain the mapping for the given method, if any.

Specified by:

getMappingForMethod in class AbstractMethodMessageHandler<CompositeMessageCondition>

Parameters:

method - the method to check

handlerType - the handler type, possibly a sub-type of the method's declaring class

Returns:

the mapping, or null if the method is not mapped

getCondition

@Nullable
private CompositeMessageCondition getCondition(java.lang.reflect.AnnotatedElement element)

getDirectLookupMappings

protected java.util.Set<java.lang.String> getDirectLookupMappings(CompositeMessageCondition mapping)

Description copied from class: AbstractMethodMessageHandler

Return String-based destinations for the given mapping, if any, that can be used to find matches with a direct lookup (i.e. non-patterns).

Note: This is completely optional. The mapping metadata for a sub-class may support neither direct lookups, nor String based destinations.

Specified by:

getDirectLookupMappings in class AbstractMethodMessageHandler<CompositeMessageCondition>

getDestination

protected java.lang.String getDestination(Message<?> message)

Description copied from class: AbstractMethodMessageHandler

Extract a String-based destination, if any, that can be used to perform a direct look up into the registered mappings.

Note: This is completely optional. The mapping metadata for a sub-class may support neither direct lookups, nor String based destinations.

Specified by:

getDestination in class AbstractMethodMessageHandler<CompositeMessageCondition>

See Also:

AbstractMethodMessageHandler.getDirectLookupMappings(Object)

getMatchingMapping

protected CompositeMessageCondition getMatchingMapping(CompositeMessageCondition mapping,
                                                       Message<?> message)

Description copied from class: AbstractMethodMessageHandler

Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.

Specified by:

getMatchingMapping in class AbstractMethodMessageHandler<CompositeMessageCondition>

Parameters:

mapping - the mapping to get a match for

message - the message being handled

Returns:

the match or null if there is no match

getMappingComparator

protected java.util.Comparator<CompositeMessageCondition> getMappingComparator(Message<?> message)

Description copied from class: AbstractMethodMessageHandler

Return a comparator for sorting matching mappings. The returned comparator should sort 'better' matches higher.

Specified by:

getMappingComparator in class AbstractMethodMessageHandler<CompositeMessageCondition>

Parameters:

message - the current Message

Returns:

the comparator, never null

createExceptionMethodResolverFor

protected AbstractExceptionHandlerMethodResolver createExceptionMethodResolverFor(java.lang.Class<?> beanType)

Description copied from class: AbstractMethodMessageHandler

Create a concrete instance of AbstractExceptionHandlerMethodResolver that finds exception handling methods based on some criteria, e.g. based on the presence of @MessageExceptionHandler.

Specified by:

createExceptionMethodResolverFor in class AbstractMethodMessageHandler<CompositeMessageCondition>

Parameters:

beanType - the class in which an exception occurred during handling

Returns:

the resolver to use

handleMatch

protected <any> handleMatch(CompositeMessageCondition mapping,
                            HandlerMethod handlerMethod,
                            Message<?> message)

Overrides:

handleMatch in class AbstractMethodMessageHandler<CompositeMessageCondition>