public class ContentNegotiationManagerFactoryBean extends Object implements org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, ServletContextAware, org.springframework.beans.factory.InitializingBean
ContentNegotiationManager
configured with one or more ContentNegotiationStrategy
instances.
By default strategies for checking the extension of the request path and
the Accept
header are registered. The path extension check will perform
lookups through the ServletContext
and the Java Activation Framework
(if present) unless media types are configured.
Constructor and Description |
---|
ContentNegotiationManagerFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
addMediaType(String fileExtension,
MediaType mediaType)
Add a mapping from a file extension to a media type.
|
void |
addMediaTypes(Map<String,MediaType> mediaTypes)
Add mappings from file extensions to media types.
|
void |
afterPropertiesSet() |
ContentNegotiationManager |
getObject() |
Class<?> |
getObjectType() |
boolean |
isSingleton() |
void |
setDefaultContentType(MediaType defaultContentType)
Set the default content type to use when no content type was requested.
|
void |
setDefaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)
Configure a custom
ContentNegotiationStrategy to use to determine
the default content type to use when no content type was requested. |
void |
setFavorParameter(boolean favorParameter)
Indicate whether a request parameter should be used to determine the
requested media type with the 2nd highest priority, i.e.
|
void |
setFavorPathExtension(boolean favorPathExtension)
Indicate whether the extension of the request path should be used to determine
the requested media type with the highest priority.
|
void |
setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
Indicate whether the HTTP
Accept header should be ignored altogether. |
void |
setIgnoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)
Whether to ignore requests that have a file extension that does not match
any mapped media types.
|
void |
setMediaTypes(Properties mediaTypes)
Add mappings from file extensions to media types represented as strings.
|
void |
setParameterName(String parameterName)
Set the parameter name that can be used to determine the requested media type
if the
setFavorParameter(boolean) property is true . |
void |
setServletContext(ServletContext servletContext)
Set the
ServletContext that this object runs in. |
void |
setUseJaf(boolean useJaf)
Indicate whether to use the Java Activation Framework as a fallback option
to map from file extensions to media types.
|
public ContentNegotiationManagerFactoryBean()
public void setFavorPathExtension(boolean favorPathExtension)
By default this value 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)
When this mapping is not set or when an extension is not found, the Java
Action Framework, if available, may be used if enabled via
setFavorPathExtension(boolean)
.
public void addMediaType(String fileExtension, MediaType mediaType)
If no mapping is added or when an extension is not found, the Java
Action Framework, if available, may be used if enabled via
setFavorPathExtension(boolean)
.
public void addMediaTypes(Map<String,MediaType> mediaTypes)
If no mappings are added or when an extension is not found, the Java
Action Framework, if available, may be used if enabled via
setFavorPathExtension(boolean)
.
public void setIgnoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)
false
will result in a
HttpMediaTypeNotAcceptableException
when there is no match.
By default this is set to true
.
public void setUseJaf(boolean useJaf)
setFavorPathExtension(boolean)
is set to true
.
The default value is true
.
public void setFavorParameter(boolean favorParameter)
Accept
header.
The default value is false
. If set to to true
, a request
for /hotels?format=pdf
will be interpreted as a request for
"application/pdf"
regardless of the Accept
header.
To use this option effectively you must also configure the MediaType
type mappings via setMediaTypes(Properties)
.
setParameterName(java.lang.String)
public void setParameterName(String parameterName)
setFavorParameter(boolean)
property is true
.
The default parameter name is "format"
.
public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
Accept
header should be ignored altogether.
If set the Accept
header is checked at the
3rd highest priority, i.e. after the request path extension and
possibly a request parameter if configured.
By default this value is set to false
.
public void setDefaultContentType(MediaType defaultContentType)
Note that internally this method creates and adds a
FixedContentNegotiationStrategy
. Alternatively you can also provide a
custom strategy via setDefaultContentTypeStrategy(org.springframework.web.accept.ContentNegotiationStrategy)
.
public void setDefaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)
ContentNegotiationStrategy
to use to determine
the default content type to use when no content type was requested.
However also consider using setDefaultContentType(org.springframework.http.MediaType)
which
provides a simpler alternative to doing the same.
public void setServletContext(ServletContext servletContext)
ServletContextAware
ServletContext
that this object runs in.
Invoked after population of normal bean properties but before an init
callback like InitializingBean's afterPropertiesSet
or a
custom init-method. Invoked after ApplicationContextAware's
setApplicationContext
.
setServletContext
in interface ServletContextAware
servletContext
- 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 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>