Class AbstractMethodMessageHandler<T>
- Type Parameters:
T
- the type of the Object that contains information mapping information
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanNameAware
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.ApplicationContextAware
,ReactiveMessageHandler
- Direct Known Subclasses:
MessageMappingMessageHandler
Also supports discovering and invoking exception handling methods to process exceptions raised during message handling.
- Since:
- 5.2
- Author:
- Rossen Stoyanchev
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
protected abstract AbstractExceptionHandlerMethodResolver
createExceptionMethodResolverFor
(Class<?> beanType) Create a concrete instance ofAbstractExceptionHandlerMethodResolver
that finds exception handling methods based on some criteria, e.g.protected final void
detectHandlerMethods
(Object handler) Detect if the given handler has any methods that can handle messages and if so register it with the extracted mapping information.protected T
extendMapping
(T mapping, HandlerMethod handlerMethod) This method is invoked just before mappings are added.org.springframework.context.ApplicationContext
Return the configured custom resolvers for handler method arguments.protected HandlerMethodArgumentResolverComposite
Return the argument resolvers initialized duringafterPropertiesSet()
.protected abstract org.springframework.util.RouteMatcher.Route
getDestination
(Message<?> message) Extract the destination from the given message.Return a read-only multi-value map with a direct lookup of mappings, (e.g.getDirectLookupMappings
(T mapping) Return String-based destinations for the given mapping, if any, that can be used to find matches with a direct lookup (i.e.Return a read-only map with all handler methods and their mappings.Return theconfigured
handler predicate.protected abstract Comparator<T>
getMappingComparator
(Message<?> message) Return a comparator for sorting matching mappings.protected abstract T
getMappingForMethod
(Method method, Class<?> handlerType) Obtain the mapping for the given method, if any.protected abstract T
getMatchingMapping
(T mapping, Message<?> message) Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.org.springframework.core.ReactiveAdapterRegistry
Return the configured registry for adapting reactive types.Return the configured return value handlers.protected reactor.core.publisher.Mono<Void>
handleMatch
(T mapping, HandlerMethod handlerMethod, Message<?> message) reactor.core.publisher.Mono<Void>
handleMessage
(Message<?> message) Handle the given message.protected void
handleNoMatch
(org.springframework.util.RouteMatcher.Route destination, Message<?> message) Invoked when no matching handler is found.protected abstract List<? extends HandlerMethodArgumentResolver>
Return the list of argument resolvers to use.protected abstract List<? extends HandlerMethodReturnValueHandler>
Return the list of return value handlers to use.protected void
registerExceptionHandlerAdvice
(MessagingAdviceBean bean, AbstractExceptionHandlerMethodResolver resolver) Subclasses can invoke this method to populate the MessagingAdviceBean cache (e.g.final void
registerHandlerMethod
(Object handler, Method method, T mapping) Register a handler method and its unique mapping.void
setApplicationContext
(org.springframework.context.ApplicationContext applicationContext) void
Configure custom resolvers for handler method arguments.void
setBeanName
(String name) void
setHandlerPredicate
(Predicate<Class<?>> handlerPredicate) Configure a predicate for selecting which Spring beans to check for the presence of message handler methods.void
setHandlers
(List<Object> handlers) Manually configure the handlers to check for the presence of message handling methods, which also disables auto-detection via ahandlerPredicate
.void
setReactiveAdapterRegistry
(org.springframework.core.ReactiveAdapterRegistry registry) Configure the registry for adapting various reactive types.void
Configure custom return value handlers for handler methods.
-
Field Details
-
logger
protected final org.apache.commons.logging.Log logger
-
-
Constructor Details
-
AbstractMethodMessageHandler
public AbstractMethodMessageHandler()
-
-
Method Details
-
setHandlerPredicate
Configure a predicate for selecting which Spring beans to check for the presence of message handler methods.This is not set by default. However, subclasses may initialize it to some default strategy (e.g.
@Controller
classes).- See Also:
-
getHandlerPredicate
Return theconfigured
handler predicate. -
setHandlers
Manually configure the handlers to check for the presence of message handling methods, which also disables auto-detection via ahandlerPredicate
. If you do not want to disable auto-detection, then call this method first, and then set the handler predicate.- Parameters:
handlers
- the handlers to check
-
setArgumentResolverConfigurer
Configure custom resolvers for handler method arguments. -
getArgumentResolverConfigurer
Return the configured custom resolvers for handler method arguments. -
setReturnValueHandlerConfigurer
Configure custom return value handlers for handler methods. -
getReturnValueHandlerConfigurer
Return the configured return value handlers. -
setReactiveAdapterRegistry
public void setReactiveAdapterRegistry(org.springframework.core.ReactiveAdapterRegistry registry) Configure the registry for adapting various reactive types.By default this is an instance of
ReactiveAdapterRegistry
with default settings. -
getReactiveAdapterRegistry
public org.springframework.core.ReactiveAdapterRegistry getReactiveAdapterRegistry()Return the configured registry for adapting reactive types. -
setApplicationContext
public void setApplicationContext(@Nullable org.springframework.context.ApplicationContext applicationContext) - Specified by:
setApplicationContext
in interfaceorg.springframework.context.ApplicationContextAware
-
getApplicationContext
@Nullable public org.springframework.context.ApplicationContext getApplicationContext() -
setBeanName
- Specified by:
setBeanName
in interfaceorg.springframework.beans.factory.BeanNameAware
-
getBeanName
-
registerExceptionHandlerAdvice
protected void registerExceptionHandlerAdvice(MessagingAdviceBean bean, AbstractExceptionHandlerMethodResolver resolver) Subclasses can invoke this method to populate the MessagingAdviceBean cache (e.g. to support "global"@MessageExceptionHandler
). -
getHandlerMethods
Return a read-only map with all handler methods and their mappings. -
getDestinationLookup
Return a read-only multi-value map with a direct lookup of mappings, (e.g. for non-pattern destinations). -
getArgumentResolvers
Return the argument resolvers initialized duringafterPropertiesSet()
. Primarily for internal use in subclasses.- Since:
- 5.2.2
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
initArgumentResolvers
Return the list of argument resolvers to use.Subclasses should also take into account custom argument types configured via
setArgumentResolverConfigurer(org.springframework.messaging.handler.invocation.reactive.ArgumentResolverConfigurer)
. -
initReturnValueHandlers
Return the list of return value handlers to use.Subclasses should also take into account custom return value types configured via
setReturnValueHandlerConfigurer(org.springframework.messaging.handler.invocation.reactive.ReturnValueHandlerConfigurer)
. -
detectHandlerMethods
Detect if the given handler has any methods that can handle messages and if so register it with the extracted mapping information.Note: This method is protected and can be invoked by subclasses, but this should be done on startup only as documented in
registerHandlerMethod(java.lang.Object, java.lang.reflect.Method, T)
.- Parameters:
handler
- the handler to check, either an instance of a Spring bean name
-
getMappingForMethod
Obtain the mapping for the given method, if any.- Parameters:
method
- the method to checkhandlerType
- the handler type, possibly a subtype of the method's declaring class- Returns:
- the mapping, or
null
if the method is not mapped
-
registerHandlerMethod
Register a handler method and its unique mapping.Note: As of 5.3 this method is public (rather than protected) and can be used both at startup and at runtime.
- Parameters:
handler
- the bean name of the handler or the handler instancemethod
- the method to registermapping
- the mapping conditions associated with the handler method- Throws:
IllegalStateException
- if another method was already registered under the same mapping
-
extendMapping
This method is invoked just before mappings are added. It allows subclasses to update the mapping with theHandlerMethod
in mind. This can be useful when the method signature is used to refine the mapping, e.g. based on the cardinality of input and output.By default this method returns the mapping that is passed in.
- Parameters:
mapping
- the mapping to be addedhandlerMethod
- the target handler for the mapping- Returns:
- a new mapping or the same
- Since:
- 5.2.2
-
getDirectLookupMappings
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 subclass may support neither direct lookups, nor String based destinations.
-
handleMessage
public reactor.core.publisher.Mono<Void> handleMessage(Message<?> message) throws MessagingException Description copied from interface:ReactiveMessageHandler
Handle the given message.- Specified by:
handleMessage
in interfaceReactiveMessageHandler
- Parameters:
message
- the message to be handled- Returns:
- a completion
Mono
for the result of the message handling - Throws:
MessagingException
-
handleMatch
protected reactor.core.publisher.Mono<Void> handleMatch(T mapping, HandlerMethod handlerMethod, Message<?> message) -
getDestination
@Nullable protected abstract org.springframework.util.RouteMatcher.Route getDestination(Message<?> message) Extract the destination from the given message.- See Also:
-
getMatchingMapping
Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.- Parameters:
mapping
- the mapping to get a match formessage
- the message being handled- Returns:
- the match or
null
if there is no match
-
getMappingComparator
Return a comparator for sorting matching mappings. The returned comparator should sort 'better' matches higher.- Parameters:
message
- the current Message- Returns:
- the comparator, never
null
-
handleNoMatch
protected void handleNoMatch(@Nullable org.springframework.util.RouteMatcher.Route destination, Message<?> message) Invoked when no matching handler is found.- Parameters:
destination
- the destinationmessage
- the message
-
createExceptionMethodResolverFor
protected abstract AbstractExceptionHandlerMethodResolver createExceptionMethodResolverFor(Class<?> beanType) Create a concrete instance ofAbstractExceptionHandlerMethodResolver
that finds exception handling methods based on some criteria, e.g. based on the presence of@MessageExceptionHandler
.- Parameters:
beanType
- the class in which an exception occurred during handling- Returns:
- the resolver to use
-