Spring Framework 6.1.4 · org.springframework.web.accept.ContentNegotiationManagerFactoryBean

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

Modifier and Type	Field and Description
private ContentNegotiationManager	contentNegotiationManager
private ContentNegotiationStrategy	defaultNegotiationStrategy
private boolean	favorParameter
private boolean	favorPathExtension
private boolean	ignoreAcceptHeader
private boolean	ignoreUnknownPathExtensions
private final Map<String, MediaType>	mediaTypes
private String	parameterName
private ServletContext	servletContext
private List<ContentNegotiationStrategy>	strategies
private Boolean	useRegisteredExtensionsOnly

Access	Constructor and Description
public	ContentNegotiationManagerFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	addMediaType(String key, MediaType mediaType) An alternative to `setMediaTypes` for programmatic registrations.
public void	addMediaTypes(Map<String, MediaType> mediaTypes) An alternative to `setMediaTypes` for programmatic registrations.
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 ContentNegotiationManager	build() Create and initialize a `ContentNegotiationManager` instance.
public ContentNegotiationManager	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	setDefaultContentType(MediaType contentType) Set the default content type to use when no content type is requested.
public void	setDefaultContentTypes(List<MediaType> contentTypes) Set the default content types to use when no content type is requested.
public void	setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy) Set a custom `ContentNegotiationStrategy` to use to determine the content type to use when no content type is requested.
public void	setFavorParameter(boolean favorParameter) Whether a request parameter ("format" by default) should be used to determine the requested media type.
public void	setFavorPathExtension(boolean favorPathExtension) Deprecated as of 5.2.4. Whether the path extension in the URL path should be used to determine the requested media type.
public void	setIgnoreAcceptHeader(boolean ignoreAcceptHeader) Whether to disable checking the 'Accept' request header.
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.
public void	setMediaTypes(Properties media type mappings 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.
public void	setParameterName(String parameterName) Set the query parameter name to use when `setFavorParameter` is on.
public void	setServletContext(ServletContext the ServletContext object to be used by this object servletContext) Implements org.springframework.web.context.ServletContextAware.setServletContext. Invoked by Spring to inject the ServletContext.
public void	setStrategies(List<ContentNegotiationStrategy> the strategies to use strategies) Set the exact list of strategies to use.
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.
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`.
private boolean	useRegisteredExtensionsOnly()

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

contentNegotiationManager	back to summary
private ContentNegotiationManager contentNegotiationManager Annotations @Nullable

defaultNegotiationStrategy	back to summary
private ContentNegotiationStrategy defaultNegotiationStrategy Annotations @Nullable

favorParameter	back to summary
private boolean favorParameter

favorPathExtension	back to summary
private boolean favorPathExtension

ignoreAcceptHeader	back to summary
private boolean ignoreAcceptHeader

ignoreUnknownPathExtensions	back to summary
private boolean ignoreUnknownPathExtensions

mediaTypes	back to summary
private final Map<String, MediaType> mediaTypes

parameterName	back to summary
private String parameterName

servletContext	back to summary
private ServletContext servletContext Annotations @Nullable

strategies	back to summary
private List<ContentNegotiationStrategy> strategies Annotations @Nullable

useRegisteredExtensionsOnly	back to summary
private Boolean useRegisteredExtensionsOnly Annotations @Nullable

ContentNegotiationManagerFactoryBean	back to summary
public ContentNegotiationManagerFactoryBean()

Method Detail

addMediaType	back to summary
public void addMediaType(String key, MediaType mediaType) An alternative to `setMediaTypes` for programmatic registrations.

addMediaTypes	back to summary
public void addMediaTypes(Map<String, MediaType> mediaTypes) An alternative to `setMediaTypes` for programmatic registrations.

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

build back to summary

build	back to summary
public ContentNegotiationManager build() Create and initialize a `ContentNegotiationManager` instance. Annotations @SuppressWarnings:deprecation Since 5.0

public ContentNegotiationManager build()

Create and initialize a ContentNegotiationManager instance.

Annotations

@SuppressWarnings:deprecation

Since

5.0

getObject back to summary

getObject	back to summary
public ContentNegotiationManager 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:ContentNegotiationManager an instance of the bean (can be `null`) Annotations @Override @Nullable

public ContentNegotiationManager 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:ContentNegotiationManager

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

setDefaultContentType back to summary

setDefaultContentType	back to summary
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`

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

setDefaultContentTypes back to summary

setDefaultContentTypes	back to summary
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`

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

setDefaultContentTypeStrategy back to summary

setDefaultContentTypeStrategy	back to summary
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`

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

setFavorParameter back to summary

setFavorParameter	back to summary
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`

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

setFavorPathExtension back to summary

setFavorPathExtension	back to summary
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. Annotations @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.

Annotations

@Deprecated

setIgnoreAcceptHeader back to summary

setIgnoreAcceptHeader	back to summary
public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader) Whether to disable checking the 'Accept' request header. By default this value is set to `false`.

public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)

Whether to disable checking the 'Accept' request header.

By default this value is set to false.

setIgnoreUnknownPathExtensions back to summary

setIgnoreUnknownPathExtensions	back to summary
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`. Annotations @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.

Annotations

@Deprecated

setMediaTypes back to summary

setMediaTypes	back to summary
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` and `org.springframework.http.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:Properties media type mappings See Also `addMediaType(String, MediaType)`, `addMediaTypes(Map)`

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 and org.springframework.http.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:Properties: media type mappings

setParameterName back to summary

setParameterName	back to summary
public void setParameterName(String parameterName) Set the query parameter name to use when `setFavorParameter` is on. The default parameter name is `"format"`.

public void setParameterName(String parameterName)

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

The default parameter name is "format".

setServletContext	back to summary
public void setServletContext(ServletContext servletContext) Implements org.springframework.web.context.ServletContextAware.setServletContext. Invoked by Spring to inject the ServletContext. Parameters servletContext:ServletContext Doc from org.springframework.web.context.ServletContextAware.setServletContext. the ServletContext object to be used by this object Annotations @Override

setServletContext

back to summary

public void setServletContext(ServletContext servletContext)

Implements org.springframework.web.context.ServletContextAware.setServletContext.

Invoked by Spring to inject the ServletContext.

Parameters

servletContext:ServletContext

Doc from org.springframework.web.context.ServletContextAware.setServletContext.

the ServletContext object to be used by this object

Annotations

@Override

setStrategies	back to summary
public void setStrategies(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:List<ContentNegotiationStrategy> the strategies to use Since 5.0

setStrategies

back to summary

public void setStrategies(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:List<ContentNegotiationStrategy>: the strategies to use

Since

5.0

setUseJaf back to summary

setUseJaf	back to summary
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. Annotations @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.

Annotations

@Deprecated

setUseRegisteredExtensionsOnly back to summary

setUseRegisteredExtensionsOnly	back to summary
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.

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.

useRegisteredExtensionsOnly	back to summary
private boolean useRegisteredExtensionsOnly()

public Class ContentNegotiationManagerFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail