类 ContentNegotiationConfigurer

构造器详细资料

• ContentNegotiationConfigurer

  public ContentNegotiationConfigurer​(ServletContext servletContext)

  Class constructor with ServletContext.

方法详细资料

• favorPathExtension

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

• 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 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(boolean) property.

  参数:

  extension - the key to look up

  mediaType - the media type

  另请参阅:

  mediaTypes(Map), replaceMediaTypes(Map)

• mediaTypes

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

  An alternative to mediaType(java.lang.String, org.springframework.http.MediaType).

  另请参阅:

  mediaType(String, MediaType), replaceMediaTypes(Map)

• replaceMediaTypes

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

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

  另请参阅:

  mediaType(String, MediaType), mediaTypes(Map)

• ignoreUnknownPathExtensions

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

• useJaf

  public ContentNegotiationConfigurer useJaf​(boolean useJaf)

  When favorPathExtension(boolean) 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.

• 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".

• 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 defaultContentType)

  Set the default content type to use when no content type is requested.

  By default this is not set.

  另请参阅:

  defaultContentTypeStrategy(org.springframework.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.

  从以下版本开始:

  4.1.2

  另请参阅:

  defaultContentType(org.springframework.http.MediaType)

• buildContentNegotiationManager

  protected ContentNegotiationManager buildContentNegotiationManager()

  Build a ContentNegotiationManager based on this configurer's settings.

  从以下版本开始:

  4.3.12

  另请参阅:

  ContentNegotiationManagerFactoryBean.getObject()

• getContentNegotiationManager

  @Deprecated
  protected ContentNegotiationManager getContentNegotiationManager()
                                                            throws Exception

  已过时。

  as of 4.3.12, in favor of buildContentNegotiationManager()

  抛出:

  Exception