ContentNegotiationManagerFactoryBean (tiny-码云(gitee.com))

java.lang.Object
- org.tinygroup.springmvc.negotiation.ContentNegotiationManagerFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, org.springframework.beans.factory.InitializingBean, org.springframework.web.context.ServletContextAware
```
public class ContentNegotiationManagerFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<ContentNegotiationManager>, org.springframework.web.context.ServletContextAware, org.springframework.beans.factory.InitializingBean
```
通过factorybean方式创建内容协商管理器对象

Author:

renhui

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, org.springframework.http.MediaType mediaType)` Add a mapping from a file extension to a media type.
`void`	`addMediaTypes(Map<String,org.springframework.http.MediaType> mediaTypes)` Add mappings from file extensions to media types.
`void`	`afterPropertiesSet()`
`ContentNegotiationManager`	`getObject()`
`Class<?>`	`getObjectType()`
`boolean`	`isSingleton()`
`void`	`setDefaultContentType(org.springframework.http.MediaType defaultContentType)` Set the default content type to use when no content type was requested.
`void`	`setDefaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)` Configure a custom `ContentNegotiationStrategy` to use to determine the default content type to use when no content type was requested.
`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(Properties mediaTypes)` Add mappings from file extensions to media types represented as strings.
`void`	`setParameterName(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(javax.servlet.ServletContext servletContext)`
`void`	`setUseJaf(boolean useJaf)` Indicate whether to use the Java Activation Framework as a fallback option to map from file extensions to media types.

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)
```
    Indicate whether the extension of the request path should be used to determine the requested media type with the highest priority.
    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.
  - setMediaTypes
```
public void setMediaTypes(Properties mediaTypes)
```
    Add mappings from file extensions to media types represented as strings.
    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).
    
    See Also:
    
    addMediaType(String, MediaType), addMediaTypes(Map)
  - addMediaType
```
public void addMediaType(String fileExtension,
                         org.springframework.http.MediaType mediaType)
```
    Add a mapping from a file extension to a media type.
    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).
  - addMediaTypes
```
public void addMediaTypes(Map<String,org.springframework.http.MediaType> mediaTypes)
```
    Add mappings from file extensions to media types.
    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).
  - setIgnoreUnknownPathExtensions
```
public void setIgnoreUnknownPathExtensions(boolean ignoreUnknownPathExtensions)
```
    Whether to ignore requests that have a file extension that does not match any mapped media types. Setting this to false will result in a HttpMediaTypeNotAcceptableException when there is no match.
    
    By default this is set to true.
  - setUseJaf
```
public void setUseJaf(boolean useJaf)
```
    Indicate whether to use the Java Activation Framework as a fallback option to map from file extensions to media types. This is used only when setFavorPathExtension(boolean) is set to true.
    The default value is true.
    
    See Also:
    
    setParameterName(java.lang.String), setMediaTypes(java.util.Properties)
  - setFavorParameter
```
public 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. after path extensions but before the 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).
    
    See Also:
    
    setParameterName(java.lang.String)
  - setParameterName
```
public void setParameterName(String parameterName)
```
    Set the parameter name that can be used to determine the requested media type if the setFavorParameter(boolean) property is true.
    The default parameter name is "format".
  - setIgnoreAcceptHeader
```
public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader)
```
    Indicate whether the HTTP 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.
  - setDefaultContentType
```
public void setDefaultContentType(org.springframework.http.MediaType defaultContentType)
```
    Set the default content type to use when no content type was requested.
    Note that internally this method creates and adds a FixedContentNegotiationStrategy. Alternatively you can also provide a custom strategy via setDefaultContentTypeStrategy(org.tinygroup.springmvc.negotiation.ContentNegotiationStrategy).
  - setDefaultContentTypeStrategy
```
public void setDefaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)
```
    Configure a custom ContentNegotiationStrategy to use to determine the default content type to use when no content type was requested.
    However also consider using setDefaultContentType(org.springframework.http.MediaType) which provides a simpler alternative to doing the same.
    
    Since:
    
    4.1.2
  - setServletContext
```
public void setServletContext(javax.servlet.ServletContext servletContext)
```
    Specified by:
    
    setServletContext in interface org.springframework.web.context.ServletContextAware
  - 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