Class ContentNegotiationManagerFactoryBean
- All Implemented Interfaces:
Aware
,FactoryBean<ContentNegotiationManager>
,InitializingBean
,ServletContextAware
ContentNegotiationManager
and configure it with
ContentNegotiationStrategy
instances.
This factory offers properties that in turn result in configuring the underlying strategies. The table below shows the property names, their default settings, as well as the strategies that they help to configure:
Property Setter | Default Value | Underlying Strategy | Enabled Or Not |
---|---|---|---|
favorParameter |
false | ParameterContentNegotiationStrategy |
Off |
favorPathExtension |
false (as of 5.3) | PathExtensionContentNegotiationStrategy |
Off |
ignoreAcceptHeader |
false | HeaderContentNegotiationStrategy |
Enabled |
defaultContentType |
null | FixedContentNegotiationStrategy |
Off |
defaultContentTypeStrategy |
null | ContentNegotiationStrategy |
Off |
Alternatively you can avoid use of the above convenience builder
methods and set the exact strategies to use via
setStrategies(List)
.
Deprecation Note: As of 5.2.4,
favorPathExtension
and
ignoreUnknownPathExtensions
are deprecated in order to discourage using path extensions for content
negotiation and for request mapping with similar deprecations on
RequestMappingHandlerMapping
. For further context, please read issue
#24719.
- Since:
- 3.2
- Author:
- Rossen Stoyanchev, Brian Clozel
-
Field Summary
Fields inherited from interface org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addMediaType
(String key, MediaType mediaType) An alternative tosetMediaTypes(java.util.Properties)
for programmatic registrations.void
addMediaTypes
(Map<String, MediaType> mediaTypes) An alternative tosetMediaTypes(java.util.Properties)
for programmatic registrations.void
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.build()
Create and initialize aContentNegotiationManager
instance.Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()
always return the same object (a reference that can be cached)?void
setDefaultContentType
(MediaType contentType) Set the default content type to use when no content type is requested.void
setDefaultContentTypes
(List<MediaType> contentTypes) Set the default content types to use when no content type is requested.void
Set a customContentNegotiationStrategy
to use to determine the content type to use when no content type is requested.void
setFavorParameter
(boolean favorParameter) Whether a request parameter ("format" by default) should be used to determine the requested media type.void
setFavorPathExtension
(boolean favorPathExtension) Deprecated.as of 5.2.4.void
setIgnoreAcceptHeader
(boolean ignoreAcceptHeader) Whether to disable checking the 'Accept' request header.void
setIgnoreUnknownPathExtensions
(boolean ignore) Deprecated.as of 5.2.4.void
setMediaTypes
(Properties mediaTypes) Add a mapping from a key to a MediaType where the key are normalized to lowercase and may have been extracted from a path extension, a filename extension, or passed as a query parameter.void
setParameterName
(String parameterName) Set the query parameter name to use whensetFavorParameter(boolean)
is on.void
setServletContext
(ServletContext servletContext) Invoked by Spring to inject the ServletContext.void
setStrategies
(List<ContentNegotiationStrategy> strategies) Set the exact list of strategies to use.void
setUseJaf
(boolean useJaf) Deprecated.as of 5.0, in favor ofsetUseRegisteredExtensionsOnly(boolean)
, which has reverse behavior.void
setUseRegisteredExtensionsOnly
(boolean useRegisteredExtensionsOnly) WhenfavorPathExtension
orsetFavorParameter(boolean)
is set, this property determines whether to use only registeredMediaType
mappings or to allow dynamic resolution, e.g.
-
Constructor Details
-
ContentNegotiationManagerFactoryBean
public ContentNegotiationManagerFactoryBean()
-
-
Method Details
-
setStrategies
Set the exact list of strategies to use.Note: use of this method is mutually exclusive with use of all other setters in this class which customize a default, fixed set of strategies. See class level doc for more details.
- Parameters:
strategies
- the strategies to use- Since:
- 5.0
-
setFavorParameter
public void setFavorParameter(boolean favorParameter) Whether a request parameter ("format" by default) should be used to determine the requested media type. For this option to work you must registermedia type mappings
.By default this is set to
false
.- See Also:
-
setParameterName
Set the query parameter name to use whensetFavorParameter(boolean)
is on.The default parameter name is
"format"
. -
setFavorPathExtension
Deprecated.as of 5.2.4. See class-level note on the deprecation of path extension config options. As there is no replacement for this method, in 5.2.x it is necessary to set it tofalse
. In 5.3 the default changes tofalse
and use of this property becomes unnecessary.Whether the path extension in the URL path should be used to determine the requested media type.By default this is set to
false
in which case path extensions have no impact on content negotiation. -
setMediaTypes
Add a mapping from a key to a MediaType where the key are normalized to lowercase and may have been extracted from a path extension, a filename extension, or passed as a query parameter.The
parameter strategy
requires such mappings in order to work while thepath extension strategy
can fall back on lookups viaServletContext.getMimeType(java.lang.String)
andMediaTypeFactory
.Note: Mappings registered here may be accessed via
ContentNegotiationManager.getMediaTypeMappings()
and may be used not only in the parameter and path extension strategies. For example, with the Spring MVC config, e.g.@EnableWebMvc
or<mvc:annotation-driven>
, the media type mappings are also plugged in to:- Determine the media type of static resources served with
ResourceHttpRequestHandler
. - Determine the media type of views rendered with
ContentNegotiatingViewResolver
. - List safe extensions for RFD attack detection (check the Spring Framework reference docs for details).
- Parameters:
mediaTypes
- media type mappings- See Also:
- Determine the media type of static resources served with
-
addMediaType
An alternative tosetMediaTypes(java.util.Properties)
for programmatic registrations. -
addMediaTypes
An alternative tosetMediaTypes(java.util.Properties)
for programmatic registrations. -
setIgnoreUnknownPathExtensions
Deprecated.as of 5.2.4. See class-level note on the deprecation of path extension config options.Whether to ignore requests with path extension that cannot be resolved to any media type. Setting this tofalse
will result in anHttpMediaTypeNotAcceptableException
if there is no match.By default this is set to
true
. -
setUseJaf
Deprecated.as of 5.0, in favor ofsetUseRegisteredExtensionsOnly(boolean)
, which has reverse behavior.Indicate whether to use the Java Activation Framework as a fallback option to map from file extensions to media types. -
setUseRegisteredExtensionsOnly
public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) WhenfavorPathExtension
orsetFavorParameter(boolean)
is set, this property determines whether to use only registeredMediaType
mappings or to allow dynamic resolution, e.g. viaMediaTypeFactory
.By default this is not set in which case dynamic resolution is on.
-
setIgnoreAcceptHeader
public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader) Whether to disable checking the 'Accept' request header.By default this value is set to
false
. -
setDefaultContentType
Set the default content type to use when no content type is requested.By default this is not set.
-
setDefaultContentTypes
Set the default content types to use when no content type is requested.By default this is not set.
-
setDefaultContentTypeStrategy
Set a customContentNegotiationStrategy
to use to determine the content type to use when no content type is requested.By default this is not set.
- Since:
- 4.1.2
- See Also:
-
setServletContext
Invoked by Spring to inject the ServletContext.- Specified by:
setServletContext
in interfaceServletContextAware
- Parameters:
servletContext
- the ServletContext object to be used by this object- See Also:
-
afterPropertiesSet
public void afterPropertiesSet()Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,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.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
-
build
Create and initialize aContentNegotiationManager
instance.- Since:
- 5.0
-
getObject
Description copied from interface:FactoryBean
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.- Specified by:
getObject
in interfaceFactoryBean<ContentNegotiationManager>
- Returns:
- an instance of the bean (can be
null
) - See Also:
-
getObjectType
Description copied from interface:FactoryBean
Return the type of object that this FactoryBean creates, ornull
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.- Specified by:
getObjectType
in interfaceFactoryBean<ContentNegotiationManager>
- Returns:
- the type of object that this FactoryBean creates,
or
null
if not known at the time of the call - See Also:
-
isSingleton
public boolean isSingleton()Description copied from interface:FactoryBean
Is the object managed by this factory a singleton? That is, willFactoryBean.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 returntrue
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 extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.The default implementation returns
true
, since aFactoryBean
typically manages a singleton instance.- Specified by:
isSingleton
in interfaceFactoryBean<ContentNegotiationManager>
- Returns:
- whether the exposed object is a singleton
- See Also:
-