org.springframework.messaging.handler.invocation.reactive

Class InvocableHelper

java.lang.Object

org.springframework.messaging.handler.invocation.reactive.InvocableHelper

class InvocableHelper
extends java.lang.Object

Help to initialize and invoke an InvocableHandlerMethod, and to then apply return value handling and exception handling. Holds all necessary configuration necessary to do so.

Since:

5.2

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private HandlerMethodArgumentResolverComposite	argumentResolvers
private java.util.Map<MessagingAdviceBean,AbstractExceptionHandlerMethodResolver>	exceptionHandlerAdviceCache
private java.util.Map<java.lang.Class<?>,AbstractExceptionHandlerMethodResolver>	exceptionHandlerCache
private java.util.function.Function<java.lang.Class<?>,AbstractExceptionHandlerMethodResolver>	exceptionMethodResolverFactory
private static Log	logger
private ReactiveAdapterRegistry	reactiveAdapterRegistry
private HandlerMethodReturnValueHandlerComposite	returnValueHandlers

Constructor Summary

Constructors

Constructor and Description
InvocableHelper(java.util.function.Function<java.lang.Class<?>,AbstractExceptionHandlerMethodResolver> exceptionMethodResolverFactory)

Method Summary

Modifier and Type	Method and Description
void	addArgumentResolvers(java.util.List<? extends HandlerMethodArgumentResolver> resolvers) Add the arguments resolvers to use for message handling and exception handling methods.
void	addReturnValueHandlers(java.util.List<? extends HandlerMethodReturnValueHandler> handlers) Add the return value handlers to use for message handling and exception handling methods.
ReactiveAdapterRegistry	getReactiveAdapterRegistry() Return the configured registry for adapting reactive types.
<any>	handleMessage(HandlerMethod handlerMethod, Message<?> message)
private <any>	handleReturnValue(java.lang.Object returnValue, HandlerMethod handlerMethod, Message<?> message)
InvocableHandlerMethod	initExceptionHandlerMethod(HandlerMethod handlerMethod, java.lang.Throwable ex) Find an exception handling method for the given exception.
InvocableHandlerMethod	initMessageMappingMethod(HandlerMethod handlerMethod) Create InvocableHandlerMethod with the configured arg resolvers.
void	registerExceptionHandlerAdvice(MessagingAdviceBean bean, AbstractExceptionHandlerMethodResolver resolver) Method to populate the MessagingAdviceBean cache (e.g.
void	setReactiveAdapterRegistry(ReactiveAdapterRegistry registry) Configure the registry for adapting various reactive types.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static Log logger

argumentResolvers

private final HandlerMethodArgumentResolverComposite argumentResolvers

returnValueHandlers

private final HandlerMethodReturnValueHandlerComposite returnValueHandlers

reactiveAdapterRegistry

private ReactiveAdapterRegistry reactiveAdapterRegistry

exceptionMethodResolverFactory

private final java.util.function.Function<java.lang.Class<?>,AbstractExceptionHandlerMethodResolver> exceptionMethodResolverFactory

exceptionHandlerCache

private final java.util.Map<java.lang.Class<?>,AbstractExceptionHandlerMethodResolver> exceptionHandlerCache

exceptionHandlerAdviceCache

private final java.util.Map<MessagingAdviceBean,AbstractExceptionHandlerMethodResolver> exceptionHandlerAdviceCache

Constructor Detail

InvocableHelper

public InvocableHelper(java.util.function.Function<java.lang.Class<?>,AbstractExceptionHandlerMethodResolver> exceptionMethodResolverFactory)

Method Detail

addArgumentResolvers

public void addArgumentResolvers(java.util.List<? extends HandlerMethodArgumentResolver> resolvers)

Add the arguments resolvers to use for message handling and exception handling methods.

addReturnValueHandlers

public void addReturnValueHandlers(java.util.List<? extends HandlerMethodReturnValueHandler> handlers)

Add the return value handlers to use for message handling and exception handling methods.

setReactiveAdapterRegistry

public void setReactiveAdapterRegistry(ReactiveAdapterRegistry registry)

Configure the registry for adapting various reactive types.

By default this is an instance of ReactiveAdapterRegistry with default settings.

getReactiveAdapterRegistry

public ReactiveAdapterRegistry getReactiveAdapterRegistry()

Return the configured registry for adapting reactive types.

registerExceptionHandlerAdvice

public void registerExceptionHandlerAdvice(MessagingAdviceBean bean,
                                           AbstractExceptionHandlerMethodResolver resolver)

Method to populate the MessagingAdviceBean cache (e.g. to support "global" @MessageExceptionHandler).

initMessageMappingMethod

public InvocableHandlerMethod initMessageMappingMethod(HandlerMethod handlerMethod)

Create InvocableHandlerMethod with the configured arg resolvers.

Parameters:

handlerMethod - the target handler method to invoke

Returns:

the created instance

initExceptionHandlerMethod

@Nullable
public InvocableHandlerMethod initExceptionHandlerMethod(HandlerMethod handlerMethod,
                                                                   java.lang.Throwable ex)

Find an exception handling method for the given exception.

The default implementation searches methods in the class hierarchy of the HandlerMethod first and if not found, it continues searching for additional handling methods registered via registerExceptionHandlerAdvice(org.springframework.messaging.handler.MessagingAdviceBean, org.springframework.messaging.handler.invocation.AbstractExceptionHandlerMethodResolver).

Parameters:

handlerMethod - the method where the exception was raised

ex - the exception raised or signaled

Returns:

a method to handle the exception, or null

handleMessage

public <any> handleMessage(HandlerMethod handlerMethod,
                           Message<?> message)

handleReturnValue

private <any> handleReturnValue(@Nullable
                                java.lang.Object returnValue,
                                HandlerMethod handlerMethod,
                                Message<?> message)