Spring Framework 6.1.4 · org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory

The default MessageHandlerMethodFactory implementation creating an InvocableHandlerMethod with the necessary HandlerMethodArgumentResolver instances to detect and process most of the use cases defined by MessageMapping.

Extra method argument resolvers can be added to customize the method signature that can be handled.

By default, the validation process redirects to a no-op implementation, see setValidator(Validator) to customize it. The ConversionService can be customized in a similar manner to tune how the message payload can be converted

Modifier and Type	Field and Description
private final HandlerMethodArgumentResolverComposite	argumentResolvers
private BeanFactory	beanFactory
private ConversionService	conversionService
private List<HandlerMethodArgumentResolver>	customArgumentResolvers
private MessageConverter	messageConverter
private Validator	validator

Constructor Summary

Access	Constructor and Description
public	DefaultMessageHandlerMethodFactory()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
public InvocableHandlerMethod	createInvocableHandlerMethod(Object the bean instance bean, Method the method to invoke method) Implements org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory.createInvocableHandlerMethod. Create the `InvocableHandlerMethod` that is able to process the specified method endpoint.
protected List<HandlerMethodArgumentResolver>	initArgumentResolvers()
public void	setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the complete list of supported argument types effectively overriding the ones configured by default.
public void	setBeanFactory(BeanFactory owning BeanFactory (never `null`). The bean can immediately call methods on the factory. beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. A `BeanFactory` only needs to be available for placeholder resolution in handler method arguments; it's optional otherwise.
public void	setConversionService(ConversionService conversionService) Set the `ConversionService` to use to convert the original message payload or headers.
public void	setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> the list of resolvers (never `null`) customArgumentResolvers) Set the list of custom `HandlerMethodArgumentResolver`s that will be used after resolvers for supported argument type.
public void	setMessageConverter(MessageConverter messageConverter) Set the `MessageConverter` to use.
public void	setValidator(Validator validator) Set the Validator instance used for validating `@Payload` arguments.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

argumentResolvers	back to summary
private final HandlerMethodArgumentResolverComposite argumentResolvers

beanFactory	back to summary
private BeanFactory beanFactory Annotations @Nullable

conversionService	back to summary
private ConversionService conversionService

customArgumentResolvers	back to summary
private List<HandlerMethodArgumentResolver> customArgumentResolvers Annotations @Nullable

messageConverter	back to summary
private MessageConverter messageConverter Annotations @Nullable

validator	back to summary
private Validator validator Annotations @Nullable

Constructor Detail

DefaultMessageHandlerMethodFactory	back to summary
public DefaultMessageHandlerMethodFactory()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

createInvocableHandlerMethod back to summary

createInvocableHandlerMethod	back to summary
public InvocableHandlerMethod createInvocableHandlerMethod(Object bean, Method method) Implements org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory.createInvocableHandlerMethod. Doc from org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory.createInvocableHandlerMethod. Create the `InvocableHandlerMethod` that is able to process the specified method endpoint. Parameters bean:Object the bean instance method:Method the method to invoke Returns:InvocableHandlerMethod an `InvocableHandlerMethod` suitable for that method Annotations @Override

public InvocableHandlerMethod createInvocableHandlerMethod(Object bean, Method method)

Implements org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory.createInvocableHandlerMethod.

Doc from org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory.createInvocableHandlerMethod.

Create the InvocableHandlerMethod that is able to process the specified method endpoint.

Parameters

bean:Object: the bean instance
method:Method: the method to invoke

Returns:InvocableHandlerMethod

an InvocableHandlerMethod suitable for that method

Annotations

@Override

initArgumentResolvers	back to summary
protected List<HandlerMethodArgumentResolver> initArgumentResolvers()

setArgumentResolvers	back to summary
public void setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the complete list of supported argument types effectively overriding the ones configured by default. This is an advanced option. For most use cases it should be sufficient to use `setCustomArgumentResolvers(java.util.List)`.

setBeanFactory back to summary

setBeanFactory	back to summary
public void setBeanFactory(BeanFactory beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. A `BeanFactory` only needs to be available for placeholder resolution in handler method arguments; it's optional otherwise. Parameters beanFactory:BeanFactory Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. owning BeanFactory (never `null`). The bean can immediately call methods on the factory. Annotations @Override

public void setBeanFactory(BeanFactory beanFactory)

Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

A BeanFactory only needs to be available for placeholder resolution in handler method arguments; it's optional otherwise.

Parameters

beanFactory:BeanFactory

Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

owning BeanFactory (never null). The bean can immediately call methods on the factory.

Annotations

@Override

setConversionService back to summary

setConversionService	back to summary
public void setConversionService(ConversionService conversionService) Set the `ConversionService` to use to convert the original message payload or headers. See Also `HeaderMethodArgumentResolver`, `GenericMessageConverter`

public void setConversionService(ConversionService conversionService)

Set the ConversionService to use to convert the original message payload or headers.

See Also: HeaderMethodArgumentResolver, GenericMessageConverter

setCustomArgumentResolvers back to summary

setCustomArgumentResolvers	back to summary
public void setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> customArgumentResolvers) Set the list of custom `HandlerMethodArgumentResolver`s that will be used after resolvers for supported argument type. Parameters customArgumentResolvers:List<HandlerMethodArgumentResolver> the list of resolvers (never `null`)

public void setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> customArgumentResolvers)

Set the list of custom HandlerMethodArgumentResolvers that will be used after resolvers for supported argument type.

Parameters

customArgumentResolvers:List<HandlerMethodArgumentResolver>: the list of resolvers (never null)

setMessageConverter back to summary

setMessageConverter	back to summary
public void setMessageConverter(MessageConverter messageConverter) Set the `MessageConverter` to use. By default a `GenericMessageConverter` is used. See Also `GenericMessageConverter`

public void setMessageConverter(MessageConverter messageConverter)

Set the MessageConverter to use. By default a GenericMessageConverter is used.

See Also: GenericMessageConverter

setValidator back to summary

setValidator	back to summary
public void setValidator(Validator validator) Set the Validator instance used for validating `@Payload` arguments. See Also `org.springframework.validation.annotation.Validated`, `PayloadMethodArgumentResolver`

public void setValidator(Validator validator)

Set the Validator instance used for validating @Payload arguments.

See Also: org.springframework.validation.annotation.Validated, PayloadMethodArgumentResolver

public Class DefaultMessageHandlerMethodFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail