ContentNegotiationConfigurer (Spring Framework 4.3.24.RELEASE API)

java.lang.ObjectSE
- org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer

public class ContentNegotiationConfigurer
extends ObjectSE

ContentNegotiationManager を作成し、1 つ以上の ContentNegotiationStrategy インスタンスで構成します。

別の方法として、このビルダーのメソッドを使用してオンまたはオフにしたりカスタマイズしたりできる、以下で説明するデフォルトのセットに依存することもできます。

構成プロパティ	基礎戦略	デフォルト設定
`favorPathExtension(boolean)`	`Path Extension strategy`	オン
`favorParameter(boolean)`	`Parameter strategy`	オフ
`ignoreAcceptHeader(boolean)`	`Header strategy`	オン
`defaultContentType(org.springframework.http.MediaType)`	`Fixed content strategy`	未設定
`defaultContentTypeStrategy(org.springframework.web.accept.ContentNegotiationStrategy)`	`ContentNegotiationStrategy`	未設定

戦略が設定される順序は固定されており、オンまたはオフにすることしかできません。

パス拡張とパラメーター戦略については、MediaType mappings を明示的に追加できます。これらは、パス拡張や "json" などのクエリパラメーター値を "application/json" などの具体的なメディア型に解決するために使用されます。

パス拡張戦略では、ServletContext.getMimeType(java.lang.String)EE と Java Activation Framework (JAF) (使用可能な場合) も使用して、パス拡張を MediaType に解決します。ただし、JAF の使用は suppress にすることができます。

導入:: 3.2
作成者:: Rossen Stoyanchev, Brian Clozel, Juergen Hoeller
関連事項:: ContentNegotiationManagerFactoryBean

コンストラクターの概要
コンストラクター
コンストラクターと説明
ContentNegotiationConfigurer(ServletContextEE servletContext)
ServletContextEE を使用したクラスコンストラクター。

コンストラクター
コンストラクターと説明
`ContentNegotiationConfigurer(ServletContextEE servletContext)` `ServletContext`EE を使用したクラスコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`protected ContentNegotiationManager`	`buildContentNegotiationManager()` この設定の設定に基づいて `ContentNegotiationManager` を構築します。
`ContentNegotiationConfigurer`	`defaultContentType(MediaType defaultContentType)` コンテンツ型がリクエストされない場合に使用するデフォルトのコンテンツ型を設定します。
`ContentNegotiationConfigurer`	`defaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)` コンテンツ型がリクエストされていないときに使用するコンテンツ型を決定するために使用するカスタム `ContentNegotiationStrategy` を設定します。
`ContentNegotiationConfigurer`	`favorParameter(boolean favorParameter)` リクエストされたメディア型を判別するためにリクエストパラメーター（デフォルトでは "format" ）を使用する必要があるかどうか。
`ContentNegotiationConfigurer`	`favorPathExtension(boolean favorPathExtension)` リクエストされたメディア型を判別するために、URL パスのパス拡張子を使用する必要があるかどうか。
`protected ContentNegotiationManager`	`getContentNegotiationManager()` 使用すべきではありません。 4.3.12 現在、`buildContentNegotiationManager()` を推奨
`ContentNegotiationConfigurer`	`ignoreAcceptHeader(boolean ignoreAcceptHeader)` "Accept" リクエストヘッダーのチェックを無効にするかどうか。
`ContentNegotiationConfigurer`	`ignoreUnknownPathExtensions(boolean ignore)` どのメディア型にも解決できないパス拡張子を持つリクエストを無視するかどうか。
`ContentNegotiationConfigurer`	`mediaType(StringSE extension, MediaType mediaType)` パス拡張またはクエリパラメーターから抽出されたキーから MediaType へのマッピングを追加します。
`ContentNegotiationConfigurer`	`mediaTypes(MapSE<StringSE, MediaType> mediaTypes)` `mediaType(java.lang.String, org.springframework.http.MediaType)` の代替。
`ContentNegotiationConfigurer`	`parameterName(StringSE parameterName)` `favorParameter(boolean)` がオンのときに使用するクエリパラメーター名を設定します。
`ContentNegotiationConfigurer`	`replaceMediaTypes(MapSE<StringSE, MediaType> mediaTypes)` `mediaType(java.lang.String, org.springframework.http.MediaType)` に似ていますが、既存のマッピングを置き換えるためのものです。
`ContentNegotiationConfigurer`	`useJaf(boolean useJaf)` `favorPathExtension(boolean)` が設定されている場合、このプロパティは、パス拡張を特定の MediaType に解決するために JAF（Java Activation フレームワーク）の使用を許可するかどうかを決定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ContentNegotiationConfigurer
```
public ContentNegotiationConfigurer(ServletContextEE servletContext)
```
    ServletContextEE を使用したクラスコンストラクター。
- メソッドの詳細
  - favorPathExtension
```
public ContentNegotiationConfigurer favorPathExtension(boolean favorPathExtension)
```
    リクエストされたメディア型を判別するために、URL パスのパス拡張子を使用する必要があるかどうか。
    デフォルトでは、これは true に設定されます。その場合、/hotels.pdf のリクエストは、"Accept" ヘッダーに関係なく "application/pdf" のリクエストとして解釈されます。
  - mediaType
```
public ContentNegotiationConfigurer mediaType(StringSE extension,
                                              MediaType mediaType)
```
    パス拡張またはクエリパラメーターから抽出されたキーから MediaType へのマッピングを追加します。これは、パラメーター戦略が機能するために必要です。ここに明示的に登録された拡張子は、リフレクトファイルダウンロード攻撃の検出のためにホワイトリストにも登録されます（RFD 攻撃保護の詳細については、Spring Framework リファレンスドキュメントを参照してください）。
    パス拡張戦略では、パス拡張を解決するために ServletContext.getMimeType(java.lang.String)EE と JAF (存在する場合) も使用しようとします。この動作を変更するには、useJaf(boolean) プロパティを参照してください。
    パラメーター:
    extension - 見上げる鍵
    mediaType - メディア型
    関連事項:
    mediaTypes(Map), replaceMediaTypes(Map)
  - mediaTypes
```
public ContentNegotiationConfigurer mediaTypes(MapSE<StringSE,MediaType> mediaTypes)
```
    mediaType(java.lang.String, org.springframework.http.MediaType) の代替。
    関連事項:
    mediaType(String, MediaType), replaceMediaTypes(Map)
  - replaceMediaTypes
```
public ContentNegotiationConfigurer replaceMediaTypes(MapSE<StringSE,MediaType> mediaTypes)
```
    mediaType(java.lang.String, org.springframework.http.MediaType) に似ていますが、既存のマッピングを置き換えるためのものです。
    関連事項:
    mediaType(String, MediaType), mediaTypes(Map)
  - ignoreUnknownPathExtensions
```
public ContentNegotiationConfigurer ignoreUnknownPathExtensions(boolean ignore)
```
    どのメディア型にも解決できないパス拡張子を持つリクエストを無視するかどうか。これを false に設定すると、一致するものがなければ HttpMediaTypeNotAcceptableException になります。
    デフォルトでは、これは true に設定されています。
  - useJaf
```
public ContentNegotiationConfigurer useJaf(boolean useJaf)
```
    favorPathExtension(boolean) が設定されている場合、このプロパティは、パス拡張を特定の MediaType に解決するために JAF（Java Activation フレームワーク）の使用を許可するかどうかを決定します。
    デフォルトではこれは設定されていません。その場合、PathExtensionContentNegotiationStrategy は JAF が使用可能な場合は JAF を使用します。
  - favorParameter
```
public ContentNegotiationConfigurer favorParameter(boolean favorParameter)
```
    リクエストされたメディア型を判別するためにリクエストパラメーター（デフォルトでは「フォーマット」）を使用する必要があるかどうか。このオプションを機能させるには、media type mappings を登録する必要があります。
    デフォルトでは、これは false に設定されています。
    関連事項:
    parameterName(String)
  - parameterName
```
public ContentNegotiationConfigurer parameterName(StringSE parameterName)
```
    favorParameter(boolean) がオンのときに使用するクエリパラメーター名を設定します。
    デフォルトのパラメーター名は "format" です。
  - ignoreAcceptHeader
```
public ContentNegotiationConfigurer ignoreAcceptHeader(boolean ignoreAcceptHeader)
```
    "Accept" リクエストヘッダーのチェックを無効にするかどうか。
    デフォルトでは、この値は false に設定されています。
  - defaultContentType
```
public ContentNegotiationConfigurer defaultContentType(MediaType defaultContentType)
```
    コンテンツ型がリクエストされない場合に使用するデフォルトのコンテンツ型を設定します。
    デフォルトでは、これは設定されていません。
    関連事項:
    defaultContentTypeStrategy(org.springframework.web.accept.ContentNegotiationStrategy)
  - defaultContentTypeStrategy
```
public ContentNegotiationConfigurer defaultContentTypeStrategy(ContentNegotiationStrategy defaultStrategy)
```
    コンテンツ型がリクエストされていないときに使用するコンテンツ型を決定するために使用するカスタム ContentNegotiationStrategy を設定します。
    デフォルトでは、これは設定されていません。
    導入:
    4.1.2
    関連事項:
    defaultContentType(org.springframework.http.MediaType)
  - buildContentNegotiationManager
```
protected ContentNegotiationManager buildContentNegotiationManager()
```
    この設定の設定に基づいて ContentNegotiationManager を構築します。
    導入:
    4.3.12
    関連事項:
    ContentNegotiationManagerFactoryBean.getObject()
  - getContentNegotiationManager
```
@DeprecatedSE
protected ContentNegotiationManager getContentNegotiationManager()
                                                                      throws ExceptionSE
```
    4.3.12 以降は非推奨。buildContentNegotiationManager() に置き換えられました。
    例外:
    ExceptionSE

クラス ContentNegotiationConfigurer

コンストラクターの概要

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

ContentNegotiationConfigurer

メソッドの詳細

favorPathExtension

mediaType

mediaTypes

replaceMediaTypes

ignoreUnknownPathExtensions

useJaf

favorParameter

parameterName

ignoreAcceptHeader

defaultContentType

defaultContentTypeStrategy

buildContentNegotiationManager

getContentNegotiationManager