Class ContentNegotiationConfigurer

Constructor Detail

• ContentNegotiationConfigurer

  public ContentNegotiationConfigurer​(@Nullable
                                      ServletContext servletContext)

  Class constructor with ServletContext.

Method Detail

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

  Parameters:

  strategies - the strategies to use

  Since:

  5.0

• favorPathExtension

  @Deprecated
  public ContentNegotiationConfigurer favorPathExtension​(boolean favorPathExtension)

  Deprecated.

  as of 5.2.4. See class-level note in ContentNegotiationManagerFactoryBean on the deprecation of path extension config options. As there is no replacement for this method, for the time being it's necessary to continue using it in order to set it to false. In 5.3 when false becomes the default, use of this property will no longer be necessary.
  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 treated as safe 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. To change this behavior see the useRegisteredExtensionsOnly(boolean) property.

  Parameters:

  extension - the key to look up

  mediaType - the media type

  See Also:

  mediaTypes(Map), replaceMediaTypes(Map)

• mediaTypes

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

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

  See Also:

  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.

  See Also:

  mediaType(String, MediaType), mediaTypes(Map)

• ignoreUnknownPathExtensions

  @Deprecated
  public ContentNegotiationConfigurer ignoreUnknownPathExtensions​(boolean ignore)

  Deprecated.

  as of 5.2.4. See class-level note in ContentNegotiationManagerFactoryBean on the deprecation of path extension config options.
  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

  @Deprecated
  public ContentNegotiationConfigurer useJaf​(boolean useJaf)

  Deprecated.

  as of 5.0, in favor of useRegisteredExtensionsOnly(boolean) which has reverse behavior
  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.

• useRegisteredExtensionsOnly

  public ContentNegotiationConfigurer useRegisteredExtensionsOnly​(boolean useRegisteredExtensionsOnly)

  When favorPathExtension is set, this property determines whether to use only registered MediaType mappings to resolve a path extension to a specific MediaType.

  By default this is not set in which case PathExtensionContentNegotiationStrategy will use defaults 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.

  See Also:

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

  See Also:

  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.

  Since:

  4.1.2

  See Also:

  defaultContentType(org.springframework.http.MediaType...)

• buildContentNegotiationManager

  protected ContentNegotiationManager buildContentNegotiationManager()

  Build a ContentNegotiationManager based on this configurer's settings.

  Since:

  4.3.12

  See Also:

  ContentNegotiationManagerFactoryBean.getObject()