org.springframework.web.accept

Class ContentNegotiationManagerFactoryBean

java.lang.Object

org.springframework.web.accept.ContentNegotiationManagerFactoryBean

All Implemented Interfaces:

Aware, FactoryBean<ContentNegotiationManager>, InitializingBean, ServletContextAware

public class ContentNegotiationManagerFactoryBean
extends Object
implements FactoryBean<ContentNegotiationManager>, ServletContextAware, InitializingBean

Factory to create a 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

Constructors

Constructor and Description
ContentNegotiationManagerFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	addMediaType(String key, MediaType mediaType) An alternative to setMediaTypes(java.util.Properties) for programmatic registrations.
void	addMediaTypes(Map<String,MediaType> mediaTypes) An alternative to setMediaTypes(java.util.Properties) for programmatic registrations.
void	afterPropertiesSet() Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
ContentNegotiationManager	build() Create and initialize a ContentNegotiationManager instance.
ContentNegotiationManager	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
Class<?>	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the object managed by this factory a singleton? That is, will FactoryBean.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	setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy) Set a custom ContentNegotiationStrategy 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. 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 to false. In 5.3 the default changes to false and use of this property becomes unnecessary.
void	setIgnoreAcceptHeader(boolean ignoreAcceptHeader) Whether to disable checking the 'Accept' request header.
void	setIgnoreUnknownPathExtensions(boolean ignore) Deprecated. as of 5.2.4. See class-level note on the deprecation of path extension config options.
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 when setFavorParameter(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 of setUseRegisteredExtensionsOnly(boolean), which has reverse behavior.
void	setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) When favorPathExtension or setFavorParameter(boolean) is set, this property determines whether to use only registered MediaType mappings or to allow dynamic resolution, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentNegotiationManagerFactoryBean

public ContentNegotiationManagerFactoryBean()

Method Detail

setStrategies

public void setStrategies(@Nullable
                          List<ContentNegotiationStrategy> strategies)

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 register media type mappings.

By default this is set to false.

See Also:

setParameterName(java.lang.String)

setParameterName

public void setParameterName(String parameterName)

Set the query parameter name to use when setFavorParameter(boolean) is on.

The default parameter name is "format".

setFavorPathExtension

@Deprecated
public void setFavorPathExtension(boolean favorPathExtension)

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 to false. In 5.3 the default changes to false 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

public 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.

The parameter strategy requires such mappings in order to work while the path extension strategy can fall back on lookups via ServletContext.getMimeType(java.lang.String) and MediaTypeFactory.

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:

addMediaType(String, MediaType), addMediaTypes(Map)

addMediaType

public void addMediaType(String key,
                         MediaType mediaType)

An alternative to setMediaTypes(java.util.Properties) for programmatic registrations.

addMediaTypes

public void addMediaTypes(@Nullable
                          Map<String,MediaType> mediaTypes)

An alternative to setMediaTypes(java.util.Properties) for programmatic registrations.

setIgnoreUnknownPathExtensions

@Deprecated
public void setIgnoreUnknownPathExtensions(boolean ignore)

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 to false will result in an HttpMediaTypeNotAcceptableException if there is no match.

By default this is set to true.

setUseJaf

@Deprecated
public void setUseJaf(boolean useJaf)

Deprecated. as of 5.0, in favor of setUseRegisteredExtensionsOnly(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)

When favorPathExtension or setFavorParameter(boolean) is set, this property determines whether to use only registered MediaType mappings or to allow dynamic resolution, e.g. via MediaTypeFactory.

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

public void setDefaultContentType(MediaType contentType)

Set the default content type to use when no content type is requested.

By default this is not set.

See Also:

setDefaultContentTypeStrategy(org.springframework.web.accept.ContentNegotiationStrategy)

setDefaultContentTypes

public void setDefaultContentTypes(List<MediaType> contentTypes)

Set the default content types to use when no content type is requested.

By default this is not set.

Since:

5.0

See Also:

setDefaultContentTypeStrategy(org.springframework.web.accept.ContentNegotiationStrategy)

setDefaultContentTypeStrategy

public void setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy)

Set a custom ContentNegotiationStrategy 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:

setDefaultContentType(org.springframework.http.MediaType)

setServletContext

public void setServletContext(ServletContext servletContext)

Invoked by Spring to inject the ServletContext.

Specified by:

setServletContext in interface ServletContextAware

Parameters:

servletContext - the ServletContext object to be used by this object

See Also:

InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

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.

Specified by:

afterPropertiesSet in interface InitializingBean

build

public ContentNegotiationManager build()

Create and initialize a ContentNegotiationManager instance.

Since:

5.0

getObject

@Nullable
public ContentNegotiationManager 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 interface FactoryBean<ContentNegotiationManager>

Returns:

an instance of the bean (can be null)

See Also:

FactoryBeanNotInitializedException

getObjectType

public Class<?> getObjectType()

Description copied from interface: FactoryBean

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.

Specified by:

getObjectType in interface FactoryBean<ContentNegotiationManager>

Returns:

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

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class<T>)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the object managed by this factory a singleton? That is, will FactoryBean.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.

Specified by:

isSingleton in interface FactoryBean<ContentNegotiationManager>

Returns:

whether the exposed object is a singleton

See Also:

FactoryBean.getObject(), SmartFactoryBean.isPrototype()