public class ContentNegotiationManagerFactoryBean extends Object implements org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, ServletContextAware, org.springframework.beans.factory.InitializingBean
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 |
---|---|---|---|
favorPathExtension |
true | PathExtensionContentNegotiationStrategy |
Enabled |
favorParameter |
false | ParameterContentNegotiationStrategy |
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.
Constructor and Description |
---|
ContentNegotiationManagerFactoryBean() |
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() |
ContentNegotiationManager |
build()
Create and initialize a
ContentNegotiationManager instance. |
ContentNegotiationManager |
getObject() |
Class<?> |
getObjectType() |
boolean |
isSingleton() |
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,
for the time being it's necessary to continue using it in order to set it
to
false . In 5.3 when false becomes the default, use of
this property will no longer be necessary. |
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. |
public ContentNegotiationManagerFactoryBean()
public void setStrategies(@Nullable List<ContentNegotiationStrategy> strategies)
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.
strategies
- the strategies to use@Deprecated public void setFavorPathExtension(boolean favorPathExtension)
false
. In 5.3 when false
becomes the default, use of
this property will no longer be necessary.By default this is set to true
in which case a request
for /hotels.pdf
will be interpreted as a request for
"application/pdf"
regardless of the 'Accept' header.
public void setMediaTypes(Properties mediaTypes)
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:
ResourceHttpRequestHandler
.
ContentNegotiatingViewResolver
.
mediaTypes
- media type mappingsaddMediaType(String, MediaType)
,
addMediaTypes(Map)
public void addMediaType(String key, MediaType mediaType)
setMediaTypes(java.util.Properties)
for programmatic registrations.public void addMediaTypes(@Nullable Map<String,MediaType> mediaTypes)
setMediaTypes(java.util.Properties)
for programmatic registrations.@Deprecated public void setIgnoreUnknownPathExtensions(boolean ignore)
false
will result in an
HttpMediaTypeNotAcceptableException
if there is no match.
By default this is set to true
.
@Deprecated public void setUseJaf(boolean useJaf)
setUseRegisteredExtensionsOnly(boolean)
, which
has reverse behavior.public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly)
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 setFavorParameter(boolean favorParameter)
media type mappings
.
By default this is set to false
.
setParameterName(java.lang.String)
public void setParameterName(String parameterName)
setFavorParameter(boolean)
is on.
The default parameter name is "format"
.
public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
By default this value is set to false
.
public void setDefaultContentType(MediaType contentType)
By default this is not set.
public void setDefaultContentTypes(List<MediaType> contentTypes)
By default this is not set.
public void setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy)
ContentNegotiationStrategy
to use to determine
the content type to use when no content type is requested.
By default this is not set.
setDefaultContentType(org.springframework.http.MediaType)
public void setServletContext(ServletContext servletContext)
setServletContext
in interface ServletContextAware
servletContext
- the ServletContext object to be used by this objectInitializingBean.afterPropertiesSet()
,
ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
public void afterPropertiesSet()
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
public ContentNegotiationManager build()
ContentNegotiationManager
instance.@Nullable public ContentNegotiationManager getObject()
getObject
in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>
public Class<?> getObjectType()
getObjectType
in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>
public boolean isSingleton()
isSingleton
in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>