Spring Framework 6.1.4 · org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer

Creates a ContentNegotiationManager and configures it with one or more 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

As of 5.0 you can set the exact strategies to use via strategies(List).

Note

if you must use URL-based content type resolution, the use of a query parameter is simpler and preferable to the use of a path extension since the latter can cause issues with URI variables, path parameters, and URI decoding. Consider setting favorPathExtension to false or otherwise set the strategies to use explicitly via strategies(List).

Modifier and Type	Field and Description
private final ContentNegotiationManagerFactoryBean	factory
private final Map<String, MediaType>	mediaTypes

Constructor Summary

Access	Constructor and Description
public	ContentNegotiationConfigurer(ServletContext servletContext) Class constructor with `jakarta.servlet.ServletContext`.

Method Summary

Modifier and Type	Method and Description
protected ContentNegotiationManager	buildContentNegotiationManager() Build a `ContentNegotiationManager` based on this configurer's settings.
public ContentNegotiationConfigurer	defaultContentType(MediaType... defaultContentTypes) Set the default content type(s) to use when no content type is requested in order of priority.
public ContentNegotiationConfigurer	defaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy) Set a custom `ContentNegotiationStrategy` to use to determine the content type to use when no content type is requested.
public ContentNegotiationConfigurer	favorParameter(boolean favorParameter) Whether a request parameter ("format" by default) should be used to determine the requested media type.
public ContentNegotiationConfigurer	favorPathExtension(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 ContentNegotiationConfigurer	ignoreAcceptHeader(boolean ignoreAcceptHeader) Whether to disable checking the 'Accept' request header.
public ContentNegotiationConfigurer	ignoreUnknownPathExtensions(boolean ignore) Deprecated as of 5.2.4. Whether to ignore requests with path extension that cannot be resolved to any media type.
public ContentNegotiationConfigurer	mediaType(String the key to look up extension, MediaType the media type mediaType) Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType.
public ContentNegotiationConfigurer	mediaTypes(Map<String, MediaType> mediaTypes) An alternative to `mediaType`.
public ContentNegotiationConfigurer	parameterName(String parameterName) Set the query parameter name to use when `favorParameter` is on.
public ContentNegotiationConfigurer	replaceMediaTypes(Map<String, MediaType> mediaTypes) Similar to `mediaType` but for replacing existing mappings.
public void	strategies(List<ContentNegotiationStrategy> the strategies to use strategies) Set the exact list of strategies to use.
public ContentNegotiationConfigurer	useJaf(boolean useJaf) Deprecated as of 5.0, in favor of `useRegisteredExtensionsOnly(boolean)` which has reverse behavior When `favorPathExtension` is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType.
public ContentNegotiationConfigurer	useRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) When `favorPathExtension` is set, this property determines whether to use only registered `MediaType` mappings to resolve a path extension to a specific MediaType.

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

Field Detail

factory	back to summary
private final ContentNegotiationManagerFactoryBean factory

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

Constructor Detail

ContentNegotiationConfigurer	back to summary
public ContentNegotiationConfigurer(ServletContext servletContext) Class constructor with `jakarta.servlet.ServletContext`.

Method Detail

buildContentNegotiationManager back to summary

buildContentNegotiationManager	back to summary
protected ContentNegotiationManager buildContentNegotiationManager() Build a `ContentNegotiationManager` based on this configurer's settings. Since 4.3.12 See Also `ContentNegotiationManagerFactoryBean#getObject()`

protected ContentNegotiationManager buildContentNegotiationManager()

Build a ContentNegotiationManager based on this configurer's settings.

Since: 4.3.12
See Also: ContentNegotiationManagerFactoryBean#getObject()

defaultContentType back to summary

defaultContentType	back to summary
public ContentNegotiationConfigurer defaultContentType(MediaType... defaultContentTypes) Set the default content type(s) to use when no content type is requested in order of priority. If destinations are present that do not support any of the given media types, consider appending `MediaType#ALL` at the end. By default this is not set. See Also `defaultContentTypeStrategy`

public ContentNegotiationConfigurer defaultContentType(MediaType... defaultContentTypes)

Set the default content type(s) to use when no content type is requested in order of priority.

If destinations are present that do not support any of the given media types, consider appending MediaType#ALL at the end.

By default this is not set.

See Also: defaultContentTypeStrategy

defaultContentTypeStrategy back to summary

defaultContentTypeStrategy	back to summary
public ContentNegotiationConfigurer defaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy) 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 `defaultContentType`

public ContentNegotiationConfigurer defaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)

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: defaultContentType

favorParameter back to summary

favorParameter	back to summary
public ContentNegotiationConfigurer favorParameter(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 `parameterName(String)`

public ContentNegotiationConfigurer favorParameter(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: parameterName(String)

favorPathExtension back to summary

favorPathExtension	back to summary
public ContentNegotiationConfigurer favorPathExtension(boolean favorPathExtension) Deprecated as of 5.2.4. See deprecation note on `ContentNegotiationManagerFactoryBean#setFavorPathExtension(boolean)`. 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 ContentNegotiationConfigurer favorPathExtension(boolean favorPathExtension)

Deprecated

as of 5.2.4. See deprecation note on ContentNegotiationManagerFactoryBean#setFavorPathExtension(boolean).

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

ignoreAcceptHeader back to summary

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

public ContentNegotiationConfigurer ignoreAcceptHeader(boolean ignoreAcceptHeader)

Whether to disable checking the 'Accept' request header.

By default this value is set to false.

ignoreUnknownPathExtensions back to summary

ignoreUnknownPathExtensions	back to summary
public ContentNegotiationConfigurer ignoreUnknownPathExtensions(boolean ignore) Deprecated as of 5.2.4. See deprecation note on `ContentNegotiationManagerFactoryBean#setIgnoreUnknownPathExtensions(boolean)`. 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 ContentNegotiationConfigurer ignoreUnknownPathExtensions(boolean ignore)

Deprecated

as of 5.2.4. See deprecation note on ContentNegotiationManagerFactoryBean#setIgnoreUnknownPathExtensions(boolean).

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

mediaType back to summary

mediaType	back to summary
public ContentNegotiationConfigurer mediaType(String extension, MediaType mediaType) Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType. This is required in order for the parameter strategy to work. Any extensions explicitly registered here are also treated as safe for the purpose of Reflected File Download attack detection (see Spring Framework reference documentation for more details on RFD attack protection). The path extension strategy will also try to use `ServletContext#getMimeType` and `MediaTypeFactory` to resolve path extensions. To change this behavior see the `useRegisteredExtensionsOnly` property. Parameters extension:String the key to look up mediaType:MediaType the media type See Also `mediaTypes(Map)`, `replaceMediaTypes(Map)`

public ContentNegotiationConfigurer mediaType(String extension, MediaType mediaType)

Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType. This is required in order for the parameter strategy to work. Any extensions explicitly registered here are also treated as safe for the purpose of Reflected File Download attack detection (see Spring Framework reference documentation for more details on RFD attack protection).

The path extension strategy will also try to use ServletContext#getMimeType and MediaTypeFactory to resolve path extensions. To change this behavior see the useRegisteredExtensionsOnly property.

Parameters

extension:String: the key to look up
mediaType:MediaType: the media type

mediaTypes back to summary

mediaTypes	back to summary
public ContentNegotiationConfigurer mediaTypes(Map<String, MediaType> mediaTypes) An alternative to `mediaType`. See Also `mediaType(String, MediaType)`, `replaceMediaTypes(Map)`

public ContentNegotiationConfigurer mediaTypes(Map<String, MediaType> mediaTypes)

An alternative to mediaType.

See Also: mediaType(String, MediaType), replaceMediaTypes(Map)

parameterName back to summary

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

public ContentNegotiationConfigurer parameterName(String parameterName)

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

The default parameter name is "format".

replaceMediaTypes back to summary

replaceMediaTypes	back to summary
public ContentNegotiationConfigurer replaceMediaTypes(Map<String, MediaType> mediaTypes) Similar to `mediaType` but for replacing existing mappings. See Also `mediaType(String, MediaType)`, `mediaTypes(Map)`

public ContentNegotiationConfigurer replaceMediaTypes(Map<String, MediaType> mediaTypes)

Similar to mediaType but for replacing existing mappings.

See Also: mediaType(String, MediaType), mediaTypes(Map)

strategies	back to summary
public void strategies(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

strategies

back to summary

public void strategies(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

useJaf back to summary

useJaf	back to summary
public ContentNegotiationConfigurer useJaf(boolean useJaf) Deprecated as of 5.0, in favor of `useRegisteredExtensionsOnly(boolean)` which has reverse behavior When `favorPathExtension` is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType. Annotations @Deprecated

public ContentNegotiationConfigurer useJaf(boolean useJaf)

Deprecated

as of 5.0, in favor of useRegisteredExtensionsOnly(boolean) which has reverse behavior

When favorPathExtension is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType.

Annotations

@Deprecated

useRegisteredExtensionsOnly back to summary

useRegisteredExtensionsOnly	back to summary
public ContentNegotiationConfigurer useRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) When `favorPathExtension` is set, this property determines whether to use only registered `MediaType` mappings to resolve a path extension to a specific MediaType. By default this is not set in which case `PathExtensionContentNegotiationStrategy` will use defaults if available.

public ContentNegotiationConfigurer useRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly)

When favorPathExtension is set, this property determines whether to use only registered MediaType mappings to resolve a path extension to a specific MediaType.

By default this is not set in which case PathExtensionContentNegotiationStrategy will use defaults if available.

public Class ContentNegotiationConfigurer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail