程序包 cn.taketoday.web.config

类 ContentNegotiationConfigurer

java.lang.Object

cn.taketoday.web.config.ContentNegotiationConfigurer

public class ContentNegotiationConfigurer
extends Object

Creates a ContentNegotiationManager and configures it with one or more ContentNegotiationStrategy instances.

This factory offers properties that in turn result in configuring the underlying strategies. The table below shows the property names, their default settings, as well as the strategies that they help to configure:

Property Setter	Default Value	Underlying Strategy	Enabled Or Not
favorParameter(boolean)	false	ParameterContentNegotiationStrategy	Off
ignoreAcceptHeader(boolean)	false	HeaderContentNegotiationStrategy	Enabled
defaultContentType(cn.taketoday.http.MediaType...)	null	FixedContentNegotiationStrategy	Off
defaultContentTypeStrategy(cn.taketoday.web.accept.ContentNegotiationStrategy)	null	ContentNegotiationStrategy	Off

you can set the exact strategies to use via strategies(List).

从以下版本开始:

4.0 2022/1/28 16:10

作者:

Rossen Stoyanchev, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private final ContentNegotiationManagerFactoryBean	factory
private final Map<String,MediaType>	mediaTypes

构造器概要

构造器

构造器	说明
ContentNegotiationConfigurer()
ContentNegotiationConfigurer(Object servletContext)

方法概要

修饰符和类型	方法	说明
protected ContentNegotiationManager	buildContentNegotiationManager()	Build a ContentNegotiationManager based on this configurer's settings.
ContentNegotiationConfigurer	defaultContentType(MediaType... defaultContentTypes)	Set the default content type(s) to use when no content type is requested in order of priority.
ContentNegotiationConfigurer	defaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)	Set a custom ContentNegotiationStrategy to use to determine the content type to use when no content type is requested.
ContentNegotiationConfigurer	favorParameter(boolean favorParameter)	Whether a request parameter ("format" by default) should be used to determine the requested media type.
ContentNegotiationConfigurer	ignoreAcceptHeader(boolean ignoreAcceptHeader)	Whether to disable checking the 'Accept' request header.
ContentNegotiationConfigurer	mediaType(String extension, MediaType mediaType)	Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType.
ContentNegotiationConfigurer	mediaTypes(Map<String,MediaType> mediaTypes)	An alternative to mediaType(java.lang.String, cn.taketoday.http.MediaType).
ContentNegotiationConfigurer	parameterName(String parameterName)	Set the query parameter name to use when favorParameter(boolean) is on.
ContentNegotiationConfigurer	replaceMediaTypes(Map<String,MediaType> mediaTypes)	Similar to mediaType(java.lang.String, cn.taketoday.http.MediaType) but for replacing existing mappings.
void	strategies(List<ContentNegotiationStrategy> strategies)	Set the exact list of strategies to use.
ContentNegotiationConfigurer	useRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly)	this property determines whether to use only registered MediaType mappings to resolve a path extension to a specific MediaType.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

factory

private final ContentNegotiationManagerFactoryBean factory

mediaTypes

private final Map<String,MediaType> mediaTypes

构造器详细资料

ContentNegotiationConfigurer

public ContentNegotiationConfigurer()

ContentNegotiationConfigurer

public ContentNegotiationConfigurer(@Nullable
 Object servletContext)

方法详细资料

strategies

public void strategies(@Nullable
 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.

参数:

strategies - the strategies to use

favorParameter

public ContentNegotiationConfigurer favorParameter(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.

另请参阅:

• parameterName(String)

parameterName

public ContentNegotiationConfigurer parameterName(String parameterName)

Set the query parameter name to use when favorParameter(boolean) is on.

The default parameter name is "format".

mediaType

public ContentNegotiationConfigurer mediaType(String extension,
 MediaType mediaType)

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 treated as safe for the purpose of Reflected File Download attack detection.

The path extension strategy will also try to use ServletContext.getMimeType(java.lang.String) and MediaType.fromFileName(String) to resolve path extensions. To change this behavior see the useRegisteredExtensionsOnly(boolean) property.

参数:

extension - the key to look up

mediaType - the media type

另请参阅:

• mediaTypes(Map)
• replaceMediaTypes(Map)

mediaTypes

public ContentNegotiationConfigurer mediaTypes(@Nullable
 Map<String,MediaType> mediaTypes)

An alternative to mediaType(java.lang.String, cn.taketoday.http.MediaType).

另请参阅:

• mediaType(String, MediaType)
• replaceMediaTypes(Map)

replaceMediaTypes

public ContentNegotiationConfigurer replaceMediaTypes(Map<String,MediaType> mediaTypes)

Similar to mediaType(java.lang.String, cn.taketoday.http.MediaType) but for replacing existing mappings.

另请参阅:

• mediaType(String, MediaType)
• mediaTypes(Map)

useRegisteredExtensionsOnly

public ContentNegotiationConfigurer useRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly)

this property determines whether to use only registered MediaType mappings to resolve a path extension to a specific MediaType.

ignoreAcceptHeader

public ContentNegotiationConfigurer ignoreAcceptHeader(boolean ignoreAcceptHeader)

Whether to disable checking the 'Accept' request header.

By default this value is set to false.

defaultContentType

public ContentNegotiationConfigurer defaultContentType(MediaType... defaultContentTypes)

Set the default content type(s) to use when no content type is requested in order of priority.

If destinations are present that do not support any of the given media types, consider appending MediaType.ALL at the end.

By default this is not set.

另请参阅:

• defaultContentTypeStrategy(cn.taketoday.web.accept.ContentNegotiationStrategy)

defaultContentTypeStrategy

public ContentNegotiationConfigurer defaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)

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.

另请参阅:

• defaultContentType(cn.taketoday.http.MediaType...)

buildContentNegotiationManager

protected ContentNegotiationManager buildContentNegotiationManager()

Build a ContentNegotiationManager based on this configurer's settings.

另请参阅:

• ContentNegotiationManagerFactoryBean.getObject()