ContentNegotiationManagerFactoryBean (spring-web 4.2.8.RELEASE API)

java.lang.Object
- org.springframework.web.accept.ContentNegotiationManagerFactoryBean

All Implemented Interfaces:: org.springframework.beans.factory.Aware, org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, org.springframework.beans.factory.InitializingBean, ServletContextAware

public class ContentNegotiationManagerFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, ServletContextAware, org.springframework.beans.factory.InitializingBean

Factory to create a ContentNegotiationManager and configure it with one or more ContentNegotiationStrategy 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 may suppress the use of JAF.

Since:: 3.2
Author:: Rossen Stoyanchev

Constructor Summary

Constructors
Constructor and Description

ContentNegotiationManagerFactoryBean()

Constructors
Constructor and Description
`ContentNegotiationManagerFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMediaType(String fileExtension, MediaType mediaType)` An alternative to `setMediaTypes(java.util.Properties)` for use in Java code.
`void`	`addMediaTypes(Map<String,MediaType> mediaTypes)` An alternative to `setMediaTypes(java.util.Properties)` for use in Java code.
`void`	`afterPropertiesSet()`
`ContentNegotiationManager`	`getObject()`
`Class<?>`	`getObjectType()`
`boolean`	`isSingleton()`
`void`	`setDefaultContentType(MediaType contentType)` Set the default content type 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(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 when `setFavorParameter(boolean)` is on.
`void`	`setServletContext(ServletContext servletContext)` Invoked by Spring to inject the ServletContext.
`void`	`setUseJaf(boolean useJaf)` When `favorPathExtension` is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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 the useJaf property.
    
    Parameters:
    
    mediaTypes - media type mappings
    
    See Also:
    
    addMediaType(String, MediaType), addMediaTypes(Map)
  - addMediaType
```
public void addMediaType(String fileExtension,
                         MediaType mediaType)
```
    An alternative to setMediaTypes(java.util.Properties) for use in Java code.
    
    See Also:
    
    setMediaTypes(java.util.Properties), addMediaTypes(java.util.Map<java.lang.String, org.springframework.http.MediaType>)
  - addMediaTypes
```
public void addMediaTypes(Map<String,MediaType> mediaTypes)
```
    An alternative to setMediaTypes(java.util.Properties) for use in Java code.
    
    See Also:
    
    setMediaTypes(java.util.Properties), addMediaType(java.lang.String, org.springframework.http.MediaType)
  - setIgnoreUnknownPathExtensions
```
public void setIgnoreUnknownPathExtensions(boolean ignore)
```
    Whether to ignore requests with path extension that cannot be resolved to any media type. Setting this to false will result in an HttpMediaTypeNotAcceptableException if there is no match.
    By default this is set to true.
  - setUseJaf
```
public void setUseJaf(boolean useJaf)
```
    When favorPathExtension 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 register media 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 when setFavorParameter(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.
    
    See Also:
    
    setDefaultContentTypeStrategy(org.springframework.web.accept.ContentNegotiationStrategy)
  - setDefaultContentTypeStrategy
```
public void setDefaultContentTypeStrategy(ContentNegotiationStrategy strategy)
```
    Set a custom ContentNegotiationStrategy 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 interface ServletContextAware
    
    Parameters:
    
    servletContext - ServletContext object to be used by this object
    
    See Also:
    
    InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
  - getObject
```
public ContentNegotiationManager getObject()
```
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>
  - getObjectType
```
public Class<?> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>

Class ContentNegotiationManagerFactoryBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContentNegotiationManagerFactoryBean

Method Detail

setFavorPathExtension

setMediaTypes

addMediaType

addMediaTypes

setIgnoreUnknownPathExtensions

setUseJaf

setFavorParameter

setParameterName

setIgnoreAcceptHeader

setDefaultContentType

setDefaultContentTypeStrategy

setServletContext

afterPropertiesSet

getObject

getObjectType

isSingleton