Spring Web 6.1.4 · org.springframework.web.accept.AbstractMappingContentNegotiationStrategy

Base class for ContentNegotiationStrategy implementations with the steps to resolve a request to media types.

First a key (e.g. "json", "pdf") must be extracted from the request (e.g. file extension, query param). The key must then be resolved to media type(s) through the base class MappingMediaTypeFileExtensionResolver which stores such mappings.

The method handleNoMatch allow subclasses to plug in additional ways of looking up media types (e.g. through the Java Activation framework, or jakarta.servlet.ServletContext#getMimeType). Media types resolved via base classes are then added to the base class MappingMediaTypeFileExtensionResolver, i.e. cached for new lookups.

Field Summary

Modifier and Type	Field and Description
private boolean	ignoreUnknownExtensions
protected final Log	logger
private boolean	useRegisteredExtensionsOnly

Constructor Summary

Access	Constructor and Description
public	AbstractMappingContentNegotiationStrategy(Map<String, MediaType> mediaTypes) Create an instance with the given map of file extensions and media types.

Method Summary

Modifier and Type	Method and Description
protected abstract String	Returns: the lookup key, or `null` if none getMediaTypeKey(NativeWebRequest request) Extract a key from the request to use to look up media types.
protected void	handleMatch(String key, MediaType mediaType) Override to provide handling when a key is successfully resolved via `lookupMediaType`.
protected MediaType	handleNoMatch(NativeWebRequest request, String key) Override to provide handling when a key is not resolved via.
public boolean	isIgnoreUnknownExtensions()
public boolean	isUseRegisteredExtensionsOnly()
public List<MediaType>	resolveMediaTypeKey(NativeWebRequest webRequest, String key) An alternative to `resolveMediaTypes(NativeWebRequest)` that accepts an already extracted key.
public List<MediaType>	resolveMediaTypes(NativeWebRequest the current request webRequest) Implements org.springframework.web.accept.ContentNegotiationStrategy.resolveMediaTypes. Resolve the given request to a list of media types.
public void	setIgnoreUnknownExtensions(boolean ignoreUnknownExtensions) Whether to ignore requests with unknown file extension.
public void	setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) Whether to only use the registered mappings to look up file extensions, or also to use dynamic resolution (e.g. via `MediaTypeFactory`).

Inherited from org.springframework.web.accept.MappingMediaTypeFileExtensionResolver:: addMapping getAllFileExtensions getAllMediaTypes getMediaTypes lookupMediaType resolveFileExtensions

Field Detail

ignoreUnknownExtensions	back to summary
private boolean ignoreUnknownExtensions

logger	back to summary
protected final Log logger

useRegisteredExtensionsOnly	back to summary
private boolean useRegisteredExtensionsOnly

Constructor Detail

AbstractMappingContentNegotiationStrategy	back to summary
public AbstractMappingContentNegotiationStrategy(Map<String, MediaType> mediaTypes) Create an instance with the given map of file extensions and media types.

Method Detail

getMediaTypeKey back to summary

getMediaTypeKey	back to summary
protected abstract String getMediaTypeKey(NativeWebRequest request) Extract a key from the request to use to look up media types. Returns:String the lookup key, or `null` if none Annotations @Nullable

protected abstract String getMediaTypeKey(NativeWebRequest request)

Extract a key from the request to use to look up media types.

Returns:String

the lookup key, or null if none

Annotations

@Nullable

handleMatch	back to summary
protected void handleMatch(String key, MediaType mediaType) Override to provide handling when a key is successfully resolved via `lookupMediaType`.

handleNoMatch back to summary

handleNoMatch	back to summary
protected MediaType handleNoMatch(NativeWebRequest request, String key) throws HttpMediaTypeNotAcceptableException Override to provide handling when a key is not resolved via. `lookupMediaType`. Subclasses can take further steps to determine the media type(s). If a MediaType is returned from this method it will be added to the cache in the base class. Annotations @Nullable

protected MediaType handleNoMatch(NativeWebRequest request, String key) throws HttpMediaTypeNotAcceptableException

Override to provide handling when a key is not resolved via. lookupMediaType. Subclasses can take further steps to determine the media type(s). If a MediaType is returned from this method it will be added to the cache in the base class.

Annotations

@Nullable

isIgnoreUnknownExtensions	back to summary
public boolean isIgnoreUnknownExtensions()

isUseRegisteredExtensionsOnly	back to summary
public boolean isUseRegisteredExtensionsOnly()

resolveMediaTypeKey back to summary

resolveMediaTypeKey	back to summary
public List<MediaType> resolveMediaTypeKey(NativeWebRequest webRequest, String key) throws HttpMediaTypeNotAcceptableException An alternative to `resolveMediaTypes(NativeWebRequest)` that accepts an already extracted key. Since 3.2.16

public List<MediaType> resolveMediaTypeKey(NativeWebRequest webRequest, String key) throws HttpMediaTypeNotAcceptableException

An alternative to resolveMediaTypes(NativeWebRequest) that accepts an already extracted key.

Since: 3.2.16

resolveMediaTypes back to summary

resolveMediaTypes	back to summary
public List<MediaType> resolveMediaTypes(NativeWebRequest webRequest) throws HttpMediaTypeNotAcceptableException Implements org.springframework.web.accept.ContentNegotiationStrategy.resolveMediaTypes. Doc from org.springframework.web.accept.ContentNegotiationStrategy.resolveMediaTypes. Resolve the given request to a list of media types. The returned list is ordered by specificity first and by quality parameter second. Parameters webRequest:NativeWebRequest the current request Returns:List<MediaType> the requested media types, or `MEDIA_TYPE_ALL_LIST` if none were requested. Annotations @Override Exceptions HttpMediaTypeNotAcceptableException: if the requested media types cannot be parsed

public List<MediaType> resolveMediaTypes(NativeWebRequest webRequest) throws HttpMediaTypeNotAcceptableException

Implements org.springframework.web.accept.ContentNegotiationStrategy.resolveMediaTypes.

Doc from org.springframework.web.accept.ContentNegotiationStrategy.resolveMediaTypes.

Resolve the given request to a list of media types. The returned list is ordered by specificity first and by quality parameter second.

Parameters

webRequest:NativeWebRequest: the current request

Returns:List<MediaType>

the requested media types, or MEDIA_TYPE_ALL_LIST if none were requested.

Annotations

@Override

Exceptions

HttpMediaTypeNotAcceptableException:: if the requested media types cannot be parsed

setIgnoreUnknownExtensions back to summary

setIgnoreUnknownExtensions	back to summary
public void setIgnoreUnknownExtensions(boolean ignoreUnknownExtensions) Whether to ignore requests with unknown file extension. Setting this to `false` results in `HttpMediaTypeNotAcceptableException`. By default this is set to false but is overridden in `PathExtensionContentNegotiationStrategy` to true.

public void setIgnoreUnknownExtensions(boolean ignoreUnknownExtensions)

Whether to ignore requests with unknown file extension. Setting this to false results in HttpMediaTypeNotAcceptableException.

By default this is set to false but is overridden in PathExtensionContentNegotiationStrategy to true.

setUseRegisteredExtensionsOnly back to summary

setUseRegisteredExtensionsOnly	back to summary
public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) Whether to only use the registered mappings to look up file extensions, or also to use dynamic resolution (e.g. via `MediaTypeFactory`). By default this is set to `false`.

public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly)

Whether to only use the registered mappings to look up file extensions, or also to use dynamic resolution (e.g. via MediaTypeFactory).

By default this is set to false.

public abstract Class AbstractMappingContentNegotiationStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail