public class ContentNegotiationManagerFactoryBean extends java.lang.Object implements FactoryBean<ContentNegotiationManager>, ServletContextAware, 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.
Modifier and Type | Field and Description |
---|---|
private ContentNegotiationManager |
contentNegotiationManager |
private MediaType |
defaultContentType |
private boolean |
favorParameter |
private boolean |
favorPathExtension |
private boolean |
ignoreAcceptHeader |
private boolean |
ignoreUnknownPathExtensions |
private java.util.Map<java.lang.String,MediaType> |
mediaTypes |
private java.lang.String |
parameterName |
private ServletContext |
servletContext |
private java.lang.Boolean |
useJaf |
Constructor and Description |
---|
ContentNegotiationManagerFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
addMediaType(java.lang.String fileExtension,
MediaType mediaType)
Add a mapping from a file extension to a media type.
|
void |
addMediaTypes(java.util.Map<java.lang.String,MediaType> mediaTypes)
Add mappings from file extensions to media types.
|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
ContentNegotiationManager |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
java.lang.Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
void |
setDefaultContentType(MediaType defaultContentType)
Set the default content type.
|
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(java.util.Properties mediaTypes)
Add mappings from file extensions to media types represented as strings.
|
void |
setParameterName(java.lang.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.
|
private boolean favorPathExtension
private boolean favorParameter
private boolean ignoreAcceptHeader
private java.util.Map<java.lang.String,MediaType> mediaTypes
private boolean ignoreUnknownPathExtensions
private java.lang.Boolean useJaf
private java.lang.String parameterName
private MediaType defaultContentType
private ContentNegotiationManager contentNegotiationManager
private ServletContext servletContext
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(java.util.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(java.lang.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(java.util.Map<java.lang.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(java.lang.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)
This content type will be used when neither the request path extension,
nor a request parameter, nor the Accept
header could help
determine the requested content type.
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()
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
public ContentNegotiationManager getObject()
FactoryBean
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.
getObject
in interface FactoryBean<ContentNegotiationManager>
null
)FactoryBeanNotInitializedException
public java.lang.Class<?> getObjectType()
FactoryBean
null
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.
getObjectType
in interface FactoryBean<ContentNegotiationManager>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.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 return true
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 extended SmartFactoryBean
interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype()
method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton()
implementation returns false
.
isSingleton
in interface FactoryBean<ContentNegotiationManager>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()