public class ContentNegotiationManagerFactoryBean extends java.lang.Object implements FactoryBean<ContentNegotiationManager>, ServletContextAware, InitializingBean
ContentNegotiationManager
and configure it with
one or more ContentNegotiationStrategy
instances.
As of 5.0 you can set the exact strategies to use via
setStrategies(List)
.
As an alternative you can also rely on the set of defaults described below which can be turned on or off or customized through the methods of this builder:
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 |
setFavorPathExtension(boolean)
to false or otherwise set the strategies to use explicitly via
setStrategies(List)
.Modifier and Type | Field and Description |
---|---|
private ContentNegotiationManager |
contentNegotiationManager |
private ContentNegotiationStrategy |
defaultNegotiationStrategy |
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.util.List<ContentNegotiationStrategy> |
strategies |
private java.lang.Boolean |
useRegisteredExtensionsOnly |
Constructor and Description |
---|
ContentNegotiationManagerFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
addMediaType(java.lang.String fileExtension,
MediaType mediaType)
An alternative to
setMediaTypes(java.util.Properties) for use in Java code. |
void |
addMediaTypes(java.util.Map<java.lang.String,MediaType> mediaTypes)
An alternative to
setMediaTypes(java.util.Properties) for use in Java code. |
void |
afterPropertiesSet()
Invoked by the containing
BeanFactory after it has set all bean properties
and satisfied BeanFactoryAware , ApplicationContextAware etc. |
ContentNegotiationManager |
build()
Actually build the
ContentNegotiationManager . |
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 contentType)
Set the default content type to use when no content type is requested.
|
void |
setDefaultContentTypes(java.util.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)
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(java.util.Properties mediaTypes)
Add a mapping from a key, extracted from a path extension or a query
parameter, to a MediaType.
|
void |
setParameterName(java.lang.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(java.util.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. |
private boolean |
useRegisteredExtensionsOnly() |
@Nullable private java.util.List<ContentNegotiationStrategy> strategies
private boolean favorPathExtension
private boolean favorParameter
private boolean ignoreAcceptHeader
private java.util.Map<java.lang.String,MediaType> mediaTypes
private boolean ignoreUnknownPathExtensions
@Nullable private java.lang.Boolean useRegisteredExtensionsOnly
private java.lang.String parameterName
@Nullable private ContentNegotiationStrategy defaultNegotiationStrategy
@Nullable private ContentNegotiationManager contentNegotiationManager
@Nullable private ServletContext servletContext
public ContentNegotiationManagerFactoryBean()
public void setStrategies(@Nullable java.util.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 usepublic void setFavorPathExtension(boolean favorPathExtension)
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(java.util.Properties mediaTypes)
The path extension strategy will also try to use
ServletContext#getMimeType
and
MediaTypeFactory
to resolve path extensions.
mediaTypes
- media type mappingsaddMediaType(String, MediaType)
,
addMediaTypes(Map)
public void addMediaType(java.lang.String fileExtension, MediaType mediaType)
setMediaTypes(java.util.Properties)
for use in Java code.public void addMediaTypes(@Nullable java.util.Map<java.lang.String,MediaType> mediaTypes)
setMediaTypes(java.util.Properties)
for use in Java code.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.
private boolean useRegisteredExtensionsOnly()
public void setFavorParameter(boolean favorParameter)
media type mappings
.
By default this is set to false
.
setParameterName(java.lang.String)
public void setParameterName(java.lang.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(java.util.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()
InitializingBean
BeanFactory
after it has set all bean properties
and satisfied BeanFactoryAware
, 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.
afterPropertiesSet
in interface InitializingBean
public ContentNegotiationManager build()
ContentNegotiationManager
.@Nullable 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
.
The default implementation returns true
, since a
FactoryBean
typically manages a singleton instance.
isSingleton
in interface FactoryBean<ContentNegotiationManager>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()