ContentNegotiationManagerFactoryBean (spring-web 5.0.7.BUILD-SNAPSHOT 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 java.lang.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.

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

Note: if you must use URL-based content type resolution, the use of a query parameter is simpler and preferable to the use of a path extension since the latter can cause issues with URI variables, path parameters, and URI decoding. Consider setting setFavorPathExtension(boolean) to false or otherwise set the strategies to use explicitly via setStrategies(List).

Since:: 3.2
Author:: Rossen Stoyanchev, Brian Clozel

Constructor Summary

Constructors
Constructor and Description

ContentNegotiationManagerFactoryBean()

Constructors
Constructor and Description
`ContentNegotiationManagerFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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()`
`ContentNegotiationManager`	`build()` Actually build the `ContentNegotiationManager`.
`ContentNegotiationManager`	`getObject()`
`java.lang.Class<?>`	`getObjectType()`
`boolean`	`isSingleton()`
`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.

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
  - setStrategies
```
public void setStrategies(@Nullable
                          java.util.List<ContentNegotiationStrategy> strategies)
```
    Set the exact list of strategies to use.
    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.
    
    Parameters:
    
    strategies - the strategies to use
    
    Since:
    
    5.0
  - 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(java.util.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 MediaTypeFactory to resolve path extensions.
    
    Parameters:
    
    mediaTypes - media type mappings
    
    See Also:
    
    addMediaType(String, MediaType), addMediaTypes(Map)
  - addMediaType
```
public void addMediaType(java.lang.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(@Nullable
                          java.util.Map<java.lang.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
```
@Deprecated
public void setUseJaf(boolean useJaf)
```
    Deprecated. as of 5.0, in favor of setUseRegisteredExtensionsOnly(boolean), which has reverse behavior.
  - setUseRegisteredExtensionsOnly
```
public 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. via MediaTypeFactory.
    By default this is not set in which case dynamic resolution is on.
  - 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(java.lang.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)
  - setDefaultContentTypes
```
public void setDefaultContentTypes(java.util.List<MediaType> contentTypes)
```
    Set the default content types to use when no content type is requested.
    By default this is not set.
    
    Since:
    
    5.0
    
    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
  - build
```
public ContentNegotiationManager build()
```
    Actually build the ContentNegotiationManager.
    
    Since:
    
    5.0
  - getObject
```
@Nullable
public ContentNegotiationManager getObject()
```
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>
  - getObjectType
```
public java.lang.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

setStrategies

setFavorPathExtension

setMediaTypes

addMediaType

addMediaTypes

setIgnoreUnknownPathExtensions

setUseJaf

setUseRegisteredExtensionsOnly

setFavorParameter

setParameterName

setIgnoreAcceptHeader

setDefaultContentType

setDefaultContentTypes

setDefaultContentTypeStrategy

setServletContext

afterPropertiesSet

build

getObject

getObjectType

isSingleton