程序包 cn.taketoday.web.accept

类 ContentNegotiationManager

java.lang.Object

cn.taketoday.web.accept.ContentNegotiationManager

所有已实现的接口:

ContentNegotiationStrategy, MediaTypeFileExtensionResolver

public class ContentNegotiationManager
extends Object
implements ContentNegotiationStrategy, MediaTypeFileExtensionResolver

Central class to determine requested media types for a request. This is done by delegating to a list of configured ContentNegotiationStrategy instances.

Also provides methods to look up file extensions for a media type. This is done by delegating to the list of configured MediaTypeFileExtensionResolver instances.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Juergen Hoeller, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private final LinkedHashSet<MediaTypeFileExtensionResolver>	resolvers
private final ArrayList<ContentNegotiationStrategy>	strategies

从接口继承的字段 cn.taketoday.web.accept.ContentNegotiationStrategy

MEDIA_TYPE_ALL_LIST

构造器概要

构造器

构造器	说明
ContentNegotiationManager()	Create a default instance with a HeaderContentNegotiationStrategy.
ContentNegotiationManager(ContentNegotiationStrategy... strategies)	Create an instance with the given list of ContentNegotiationStrategy strategies each of which may also be an instance of MediaTypeFileExtensionResolver.
ContentNegotiationManager(Collection<ContentNegotiationStrategy> strategies)	A collection-based alternative to ContentNegotiationManager(ContentNegotiationStrategy...).

方法概要

修饰符和类型	方法	说明
void	addFileExtensionResolvers(MediaTypeFileExtensionResolver... resolvers)	Register more MediaTypeFileExtensionResolver instances in addition to those detected at construction.
private List<String>	doResolveExtensions(Function<MediaTypeFileExtensionResolver,List<String>> extractor)
List<String>	getAllFileExtensions()	Get all registered file extensions.
Map<String,MediaType>	getMediaTypeMappings()	Return all registered lookup key to media type mappings by iterating MediaTypeFileExtensionResolvers.
List<ContentNegotiationStrategy>	getStrategies()	Return the configured content negotiation strategies.
<T extends ContentNegotiationStrategy> T	getStrategy(Class<T> strategyType)	Find a ContentNegotiationStrategy of the given type.
List<String>	resolveFileExtensions(MediaType mediaType)	Resolve the given media type to a list of file extensions.
List<MediaType>	resolveMediaTypes(RequestContext request)	Resolve the given request to a list of media types.

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

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

字段详细资料

strategies

private final ArrayList<ContentNegotiationStrategy> strategies

resolvers

private final LinkedHashSet<MediaTypeFileExtensionResolver> resolvers

构造器详细资料

ContentNegotiationManager

public ContentNegotiationManager(ContentNegotiationStrategy... strategies)

Create an instance with the given list of ContentNegotiationStrategy strategies each of which may also be an instance of MediaTypeFileExtensionResolver.

参数:

strategies - the strategies to use

ContentNegotiationManager

public ContentNegotiationManager(Collection<ContentNegotiationStrategy> strategies)

A collection-based alternative to ContentNegotiationManager(ContentNegotiationStrategy...).

参数:

strategies - the strategies to use

ContentNegotiationManager

public ContentNegotiationManager()

Create a default instance with a HeaderContentNegotiationStrategy.

方法详细资料

getStrategies

public List<ContentNegotiationStrategy> getStrategies()

Return the configured content negotiation strategies.

getStrategy

@Nullable
public <T extends ContentNegotiationStrategy> T getStrategy(Class<T> strategyType)

Find a ContentNegotiationStrategy of the given type.

参数:

strategyType - the strategy type

返回:

the first matching strategy, or null if none

addFileExtensionResolvers

public void addFileExtensionResolvers(MediaTypeFileExtensionResolver... resolvers)

Register more MediaTypeFileExtensionResolver instances in addition to those detected at construction.

参数:

resolvers - the resolvers to add

resolveMediaTypes

public List<MediaType> resolveMediaTypes(RequestContext request)
                                  throws HttpMediaTypeNotAcceptableException

从接口复制的说明: ContentNegotiationStrategy

Resolve the given request to a list of media types. The returned list is ordered by specificity first and by quality parameter second.

指定者:

resolveMediaTypes 在接口中 ContentNegotiationStrategy

参数:

request - the current request context

返回:

the requested media types, or ContentNegotiationStrategy.MEDIA_TYPE_ALL_LIST if none were requested.

抛出:

HttpMediaTypeNotAcceptableException - if the requested media types cannot be parsed

resolveFileExtensions

public List<String> resolveFileExtensions(MediaType mediaType)

从接口复制的说明: MediaTypeFileExtensionResolver

Resolve the given media type to a list of file extensions.

指定者:

resolveFileExtensions 在接口中 MediaTypeFileExtensionResolver

参数:

mediaType - the media type to resolve

返回:

a list of extensions or an empty list (never null)

getAllFileExtensions

public List<String> getAllFileExtensions()

Get all registered file extensions.

At startup this method returns extensions explicitly registered with ParameterContentNegotiationStrategy. MediaType and cached.

指定者:

getAllFileExtensions 在接口中 MediaTypeFileExtensionResolver

返回:

a list of extensions or an empty list (never null)

doResolveExtensions

private List<String> doResolveExtensions(Function<MediaTypeFileExtensionResolver,List<String>> extractor)

getMediaTypeMappings

public Map<String,MediaType> getMediaTypeMappings()

Return all registered lookup key to media type mappings by iterating MediaTypeFileExtensionResolvers.