Class ContentNegotiationManagerFactoryBean
- java.lang.Object
- org.springframework.web.accept.ContentNegotiationManagerFactoryBean
- All Implemented Interfaces:
Aware
,FactoryBean<ContentNegotiationManager>
,InitializingBean
,ServletContextAware
public class ContentNegotiationManagerFactoryBean extends Object implements FactoryBean<ContentNegotiationManager>, ServletContextAware, InitializingBean
Factory to create aContentNegotiationManager
and configure it with one or moreContentNegotiationStrategy
instances via simple setters. The following table shows setters, resulting strategy instances, and if in use by default:Property Setter Underlying Strategy Default Setting setFavorPathExtension(boolean)
Path Extension strategy
On favorParameter
Parameter strategy
Off ignoreAcceptHeader
Header strategy
On defaultContentType
Fixed content strategy
Not set defaultContentTypeStrategy
ContentNegotiationStrategy
Not set The order in which strategies are configured is fixed. Setters may only turn individual strategies on or off. If you need a custom order for any reason simply instantiate
ContentNegotiationManager
directly.For the path extension and parameter strategies you may explicitly add
MediaType mappings
. This will be used to resolve path extensions or a parameter value such as "json" to a media type such as "application/json".The path extension strategy will also use
ServletContext.getMimeType(java.lang.String)
and the Java Activation framework (JAF), if available, to resolve a path extension to a MediaType. You maysuppress
the use of JAF.- Since:
- 3.2
- Author:
- Rossen Stoyanchev, Brian Clozel
Constructor Summary
Constructors Constructor Description ContentNegotiationManagerFactoryBean()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addMediaType(String fileExtension, MediaType mediaType)
An alternative tosetMediaTypes(java.util.Properties)
for use in Java code.void
addMediaTypes(Map<String,MediaType> mediaTypes)
An alternative tosetMediaTypes(java.util.Properties)
for use in Java code.void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.ContentNegotiationManager
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
isSingleton()
Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()
always return the same object (a reference that can be cached)?void
setDefaultContentType(MediaType contentType)
Set the default content type to use when no content type is requested.void
setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy)
Set a customContentNegotiationStrategy
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)
Whether the path extension in the URL path should be used to determine the requested media type.void
setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
Whether to disable checking the 'Accept' request header.void
setIgnoreUnknownPathExtensions(boolean ignore)
Whether to ignore requests with path extension that cannot be resolved to any media type.void
setMediaTypes(Properties mediaTypes)
Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType.void
setParameterName(String parameterName)
Set the query parameter name to use whensetFavorParameter(boolean)
is on.void
setServletContext(ServletContext servletContext)
Invoked by Spring to inject the ServletContext.void
setUseJaf(boolean useJaf)
WhenfavorPathExtension
is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType.
Constructor Detail
ContentNegotiationManagerFactoryBean
public ContentNegotiationManagerFactoryBean()
Method Detail
setFavorPathExtension
public void setFavorPathExtension(boolean favorPathExtension)
Whether the path extension in the URL path should be used to determine the requested media type.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.
setMediaTypes
public void setMediaTypes(Properties mediaTypes)
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 whitelisted 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(java.lang.String)
and JAF (if present) to resolve path extensions. To change this behavior see theuseJaf
property.- Parameters:
mediaTypes
- media type mappings- See Also:
addMediaType(String, MediaType)
,addMediaTypes(Map)
addMediaType
public void addMediaType(String fileExtension, MediaType mediaType)
An alternative tosetMediaTypes(java.util.Properties)
for use in Java code.
addMediaTypes
public void addMediaTypes(Map<String,MediaType> mediaTypes)
An alternative tosetMediaTypes(java.util.Properties)
for use in Java code.
setIgnoreUnknownPathExtensions
public void setIgnoreUnknownPathExtensions(boolean ignore)
Whether to ignore requests with path extension that cannot be resolved to any media type. Setting this tofalse
will result in anHttpMediaTypeNotAcceptableException
if there is no match.By default this is set to
true
.
setUseJaf
public void setUseJaf(boolean useJaf)
WhenfavorPathExtension
is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType.By default this is not set in which case
PathExtensionContentNegotiationStrategy
will use JAF if available.
setFavorParameter
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 registermedia type mappings
.By default this is set to
false
.- See Also:
setParameterName(java.lang.String)
setParameterName
public void setParameterName(String parameterName)
Set the query parameter name to use whensetFavorParameter(boolean)
is on.The default parameter name is
"format"
.
setIgnoreAcceptHeader
public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
Whether to disable checking the 'Accept' request header.By default this value is set to
false
.
setDefaultContentType
public void setDefaultContentType(MediaType contentType)
Set the default content type to use when no content type is requested.By default this is not set.
setDefaultContentTypeStrategy
public void setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy)
Set a customContentNegotiationStrategy
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(org.springframework.http.MediaType)
setServletContext
public void setServletContext(ServletContext servletContext)
Invoked by Spring to inject the ServletContext.- Specified by:
setServletContext
in interfaceServletContextAware
- Parameters:
servletContext
- ServletContext object to be used by this object- See Also:
InitializingBean.afterPropertiesSet()
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
afterPropertiesSet
public void afterPropertiesSet()
Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,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.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
getObject
public ContentNegotiationManager getObject()
Description copied from interface:FactoryBean
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.- Specified by:
getObject
in interfaceFactoryBean<ContentNegotiationManager>
- Returns:
- an instance of the bean (can be
null
) - See Also:
FactoryBeanNotInitializedException
getObjectType
public Class<?> getObjectType()
Description copied from interface:FactoryBean
Return the type of object that this FactoryBean creates, ornull
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.- Specified by:
getObjectType
in interfaceFactoryBean<ContentNegotiationManager>
- Returns:
- the type of object that this FactoryBean creates, or
null
if not known at the time of the call - See Also:
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
isSingleton
public boolean isSingleton()
Description copied from interface:FactoryBean
Is the object managed by this factory a singleton? That is, willFactoryBean.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 returntrue
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 extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.- Specified by:
isSingleton
in interfaceFactoryBean<ContentNegotiationManager>
- Returns:
- whether the exposed object is a singleton
- See Also:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()