A BeanDefinitionParser that provides the configuration for the <annotation-driven/> MVC namespace element.

This class registers the following HandlerMappings:

RequestMappingHandlerMapping ordered at 0 for mapping requests to annotated controller methods.
BeanNameUrlHandlerMapping ordered at 2 to map URL paths to controller bean names.

Note

Additional HandlerMappings may be registered as a result of using the <view-controller> or the <resources> MVC namespace elements.

This class registers the following HandlerAdapters:

RequestMappingHandlerAdapter for processing requests with annotated controller methods.
HttpRequestHandlerAdapter for processing requests with HttpRequestHandlers.
SimpleControllerHandlerAdapter for processing requests with interface-based Controllers.

This class registers the following HandlerExceptionResolvers:

ExceptionHandlerExceptionResolver for handling exceptions through org.springframework.web.bind.annotation.ExceptionHandler methods.
ResponseStatusExceptionResolver for exceptions annotated with org.springframework.web.bind.annotation.ResponseStatus.
DefaultHandlerExceptionResolver for resolving known Spring exception types

This class registers an org.springframework.util.AntPathMatcher and a org.springframework.web.util.UrlPathHelper to be used by:

the RequestMappingHandlerMapping,
the HandlerMapping for ViewControllers
and the HandlerMapping for serving resources

Note that those beans can be configured by using the path-matching MVC namespace element.

Both the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver are configured with instances of the following by default:

A ContentNegotiationManager
A DefaultFormattingConversionService
A org.springframework.validation.beanvalidation.LocalValidatorFactoryBean if a JSR-303 implementation is available on the classpath
A range of HttpMessageConverters depending on which third-party libraries are available on the classpath.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	AnnotationDrivenBeanDefinitionParser.CompositeUriComponentsContributorFactoryBean A FactoryBean for a CompositeUriComponentsContributor that obtains the HandlerMethodArgumentResolver's configured in RequestMappingHandlerAdapter after it is fully initialized.

Modifier and Type	Field and Description
public static final String	CONTENT_NEGOTIATION_MANAGER_BEAN_NAME
private static final boolean	gsonPresent
public static final String	HANDLER_ADAPTER_BEAN_NAME
public static final String	HANDLER_MAPPING_BEAN_NAME
private static final boolean	jackson2CborPresent
private static final boolean	jackson2Present
private static final boolean	jackson2SmilePresent
private static final boolean	jackson2XmlPresent
private static final boolean	javaxValidationPresent
private static final boolean	jaxb2Present
private static final boolean	romePresent

Constructor Summary

Access	Constructor and Description
pack-priv	AnnotationDrivenBeanDefinitionParser()

Modifier and Type	Method and Description
protected void	addRequestBodyAdvice(RootBeanDefinition beanDef)
protected void	addResponseBodyAdvice(RootBeanDefinition beanDef)
private void	configurePathMatchingProperties(RootBeanDefinition handlerMappingDef, Element element, ParserContext context)
private RootBeanDefinition	createConverterDefinition(Class<?> converterClass, Object source)
private GenericBeanDefinition	createObjectMapperFactoryDefinition(Object source)
private ManagedList<Object>	extractBeanSubElements(Element parentElement, ParserContext context)
private ManagedList<?>	getArgumentResolvers(Element element, ParserContext context)
private RuntimeBeanReference	getAsyncExecutor(Element element)
private String	getAsyncTimeout(Element element)
private RuntimeBeanReference	getContentNegotiationManager(Element element, Object source, ParserContext context)
private RuntimeBeanReference	getConversionService(Element element, Object source, ParserContext context)
private Properties	getDefaultMediaTypes()
private ManagedList<?>	getInterceptors(Element element, Object source, ParserContext context, String interceptorElementName)
private RuntimeBeanReference	getMessageCodesResolver(Element element)
private ManagedList<?>	getMessageConverters(Element element, Object source, ParserContext context)
private ManagedList<?>	getReturnValueHandlers(Element element, ParserContext context)
private RuntimeBeanReference	getValidator(Element element, Object source, ParserContext context)
public BeanDefinition	parse(Element the element that is to be parsed into one or more `BeanDefinitions` element, ParserContext the object encapsulating the current state of the parsing process; provides access to a `org.springframework.beans.factory.support.BeanDefinitionRegistry` context) Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse. Parse the specified `Element` and register the resulting `BeanDefinition(s)` with the `BeanDefinitionRegistry` embedded in the supplied `ParserContext`.
private ManagedList<Object>	wrapLegacyResolvers(List<Object> list, ParserContext context)

CONTENT_NEGOTIATION_MANAGER_BEAN_NAME	back to summary
public static final String CONTENT_NEGOTIATION_MANAGER_BEAN_NAME

gsonPresent	back to summary
private static final boolean gsonPresent

HANDLER_ADAPTER_BEAN_NAME	back to summary
public static final String HANDLER_ADAPTER_BEAN_NAME

HANDLER_MAPPING_BEAN_NAME	back to summary
public static final String HANDLER_MAPPING_BEAN_NAME

jackson2CborPresent	back to summary
private static final boolean jackson2CborPresent

jackson2Present	back to summary
private static final boolean jackson2Present

jackson2SmilePresent	back to summary
private static final boolean jackson2SmilePresent

jackson2XmlPresent	back to summary
private static final boolean jackson2XmlPresent

javaxValidationPresent	back to summary
private static final boolean javaxValidationPresent

jaxb2Present	back to summary
private static final boolean jaxb2Present

romePresent	back to summary
private static final boolean romePresent

Constructor Detail

AnnotationDrivenBeanDefinitionParser	back to summary
pack-priv AnnotationDrivenBeanDefinitionParser()

Method Detail

addRequestBodyAdvice	back to summary
protected void addRequestBodyAdvice(RootBeanDefinition beanDef)

addResponseBodyAdvice	back to summary
protected void addResponseBodyAdvice(RootBeanDefinition beanDef)

configurePathMatchingProperties	back to summary
private void configurePathMatchingProperties(RootBeanDefinition handlerMappingDef, Element element, ParserContext context)

createConverterDefinition	back to summary
private RootBeanDefinition createConverterDefinition(Class<?> converterClass, Object source)

createObjectMapperFactoryDefinition	back to summary
private GenericBeanDefinition createObjectMapperFactoryDefinition(Object source)

extractBeanSubElements	back to summary
private ManagedList<Object> extractBeanSubElements(Element parentElement, ParserContext context)

getArgumentResolvers	back to summary
private ManagedList<?> getArgumentResolvers(Element element, ParserContext context) Annotations @Nullable

getAsyncExecutor	back to summary
private RuntimeBeanReference getAsyncExecutor(Element element) Annotations @Nullable

getAsyncTimeout	back to summary
private String getAsyncTimeout(Element element) Annotations @Nullable

getContentNegotiationManager	back to summary
private RuntimeBeanReference getContentNegotiationManager(Element element, Object source, ParserContext context)

getConversionService	back to summary
private RuntimeBeanReference getConversionService(Element element, Object source, ParserContext context)

getDefaultMediaTypes	back to summary
private Properties getDefaultMediaTypes()

getInterceptors	back to summary
private ManagedList<?> getInterceptors(Element element, Object source, ParserContext context, String interceptorElementName)

getMessageCodesResolver	back to summary
private RuntimeBeanReference getMessageCodesResolver(Element element) Annotations @Nullable

getMessageConverters	back to summary
private ManagedList<?> getMessageConverters(Element element, Object source, ParserContext context)

getReturnValueHandlers	back to summary
private ManagedList<?> getReturnValueHandlers(Element element, ParserContext context) Annotations @Nullable

getValidator	back to summary
private RuntimeBeanReference getValidator(Element element, Object source, ParserContext context) Annotations @Nullable

parse back to summary

parse	back to summary
public BeanDefinition parse(Element element, ParserContext context) Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse. Doc from org.springframework.beans.factory.xml.BeanDefinitionParser.parse. Parse the specified `Element` and register the resulting `BeanDefinition(s)` with the `BeanDefinitionRegistry` embedded in the supplied `ParserContext`. Implementations must return the primary `BeanDefinition` that results from the parse if they will ever be used in a nested fashion (for example as an inner tag in a `<property/>` tag). Implementations may return `null` if they will not be used in a nested fashion. Parameters element:Element the element that is to be parsed into one or more `BeanDefinitions` context:ParserContext the object encapsulating the current state of the parsing process; provides access to a `org.springframework.beans.factory.support.BeanDefinitionRegistry` Returns:BeanDefinition the primary `BeanDefinition` Annotations @Override @Nullable

public BeanDefinition parse(Element element, ParserContext context)

Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse.

Doc from org.springframework.beans.factory.xml.BeanDefinitionParser.parse.

Parse the specified Element and register the resulting BeanDefinition(s) with the BeanDefinitionRegistry embedded in the supplied ParserContext.

Implementations must return the primary BeanDefinition that results from the parse if they will ever be used in a nested fashion (for example as an inner tag in a <property/> tag). Implementations may return null if they will not be used in a nested fashion.

Parameters

element:Element: the element that is to be parsed into one or more BeanDefinitions
context:ParserContext: the object encapsulating the current state of the parsing process; provides access to a org.springframework.beans.factory.support.BeanDefinitionRegistry

Returns:BeanDefinition

the primary BeanDefinition

Annotations

@Override
@Nullable

wrapLegacyResolvers	back to summary
private ManagedList<Object> wrapLegacyResolvers(List<Object> list, ParserContext context)

org.springframework.web.servlet.config back to summary

pack-priv Class AnnotationDrivenBeanDefinitionParser.CompositeUriComponentsContributorFactoryBean

Class Inheritance

extends Object
implements FactoryBean<CompositeUriComponentsContributor>, InitializingBean

java.lang.Object
org.springframework.web.servlet.config.AnnotationDrivenBeanDefinitionParser.CompositeUriComponentsContributorFactoryBean

All Implemented Interfaces

org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.FactoryBean

A FactoryBean for a CompositeUriComponentsContributor that obtains the HandlerMethodArgumentResolver's configured in RequestMappingHandlerAdapter after it is fully initialized.

Field Summary

Modifier and Type	Field and Description
private ConversionService	conversionService
private RequestMappingHandlerAdapter	handlerAdapter
private CompositeUriComponentsContributor	uriComponentsContributor

Constructor Summary

Access	Constructor and Description
pack-priv	CompositeUriComponentsContributorFactoryBean()

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 CompositeUriComponentsContributor	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<?>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
public void	setConversionService(ConversionService conversionService)
public void	setHandlerAdapter(RequestMappingHandlerAdapter handlerAdapter)

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

Field Detail

conversionService	back to summary
private ConversionService conversionService Annotations @Nullable

handlerAdapter	back to summary
private RequestMappingHandlerAdapter handlerAdapter Annotations @Nullable

uriComponentsContributor	back to summary
private CompositeUriComponentsContributor uriComponentsContributor Annotations @Nullable

Constructor Detail

CompositeUriComponentsContributorFactoryBean	back to summary
pack-priv CompositeUriComponentsContributorFactoryBean()

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

getObject back to summary

getObject	back to summary
public CompositeUriComponentsContributor getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory. As with a `BeanFactory`, this allows support for both the Singleton and Prototype design pattern. If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding `FactoryBeanNotInitializedException`. As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. Returns:CompositeUriComponentsContributor an instance of the bean (can be `null`) Annotations @Override @Nullable

public CompositeUriComponentsContributor getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:CompositeUriComponentsContributor

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<?> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance. This allows one to check for specific types of beans without instantiating objects, for example on autowiring. In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too. This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available. Note Autowiring will simply ignore FactoryBeans that return `null` here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean. Returns:Class<?> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<?> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

Note

Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns:Class<?>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? Note If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory. Hence, do not return `true` unless the FactoryBean always exposes the same reference. The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there. Note This method returning `false` does not necessarily indicate that returned objects are independent instances. An implementation of the extended `SmartFactoryBean` interface may explicitly indicate independent instances through its `SmartFactoryBean#isPrototype()` method. Plain `FactoryBean` implementations which do not implement this extended interface are simply assumed to always return independent instances if the `isSingleton()` implementation returns `false`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Note

This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean#isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

setConversionService	back to summary
public void setConversionService(ConversionService conversionService)

setHandlerAdapter	back to summary
public void setHandlerAdapter(RequestMappingHandlerAdapter handlerAdapter)