クラス ContentNegotiationConfigurer

メソッドの詳細

• strategies

  public void strategies(@Nullable ListSE<ContentNegotiationStrategy> strategies)

  使用する戦略の正確なリストを設定します。

  注意 : このメソッドの使用は、デフォルトの固定された戦略セットをカスタマイズするこのクラスの他のすべての setter の使用と相互に排他的です。詳細については、クラスレベルのドキュメントを参照してください。

  パラメーター:

  strategies - 使用する戦略

  導入:

  5.0

• favorParameter

  public ContentNegotiationConfigurer favorParameter(boolean favorParameter)

  リクエストされたメディア型を判別するためにリクエストパラメーター（デフォルトでは「フォーマット」）を使用する必要があるかどうか。このオプションを機能させるには、media type mappings を登録する必要があります。

  デフォルトでは、これは false に設定されています。

  関連事項:

  • parameterName(String)

• parameterName

  public ContentNegotiationConfigurer parameterName(StringSE parameterName)

  favorParameter(boolean) がオンのときに使用するクエリパラメーター名を設定します。

  デフォルトのパラメーター名は "format" です。

• favorPathExtension

  @DeprecatedSE public ContentNegotiationConfigurer favorPathExtension(boolean favorPathExtension)

  使用すべきではありません。

  5.2.4 以降。ContentNegotiationManagerFactoryBean.setFavorPathExtension(boolean) の非推奨の注記を参照してください。

  リクエストされたメディア型を判別するために、URL パスのパス拡張子を使用する必要があるかどうか。

  デフォルトでは、これは false に設定されています。この場合、パス拡張はコンテンツネゴシエーションに影響を与えません。

• mediaType

  public ContentNegotiationConfigurer mediaType(StringSE extension, MediaType mediaType)

  パス拡張またはクエリパラメーターから抽出されたキーからのマッピングを MediaType に追加します。これは、パラメーター戦略が機能するために必要です。ここで明示的に登録された拡張機能も、Reflected File Download 攻撃検出の目的で安全として扱われます（RFD 攻撃保護の詳細については、Spring Framework リファレンスドキュメントを参照してください）。

  パス拡張戦略は、ServletContext.getMimeType(java.lang.String)EE および MediaTypeFactory を使用してパス拡張を解決しようとします。この動作を変更するには、useRegisteredExtensionsOnly(boolean) プロパティを参照してください。

  パラメーター:

  extension - 見上げる鍵

  mediaType - メディア型

  関連事項:

  • mediaTypes(Map)
  • replaceMediaTypes(Map)

• mediaTypes

  public ContentNegotiationConfigurer mediaTypes(@Nullable 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

  @DeprecatedSE public ContentNegotiationConfigurer ignoreUnknownPathExtensions(boolean ignore)

  使用すべきではありません。

  5.2.4 以降。ContentNegotiationManagerFactoryBean.setIgnoreUnknownPathExtensions(boolean) の非推奨の注記を参照してください。

  どのメディア型にも解決できないパス拡張子を持つリクエストを無視するかどうか。これを false に設定すると、一致するものがなければ HttpMediaTypeNotAcceptableException になります。

  デフォルトでは、これは true に設定されています。

• useJaf

  @DeprecatedSE public ContentNegotiationConfigurer useJaf(boolean useJaf)

  使用すべきではありません。

  5.0 以降、逆の動作をする useRegisteredExtensionsOnly(boolean) を推奨

  favorPathExtension(boolean) が設定されている場合、このプロパティは、パス拡張を特定の MediaType に解決するために JAF（Java Activation フレームワーク）の使用を許可するかどうかを決定します。

• useRegisteredExtensionsOnly

  public ContentNegotiationConfigurer useRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly)

  favorPathExtension が設定されている場合、このプロパティは、登録された MediaType マッピングのみを使用して特定の MediaType へのパス拡張を解決するかどうかを決定します。

  デフォルトでは、これは設定されていません。その場合、PathExtensionContentNegotiationStrategy は使用可能な場合はデフォルトを使用します。

• ignoreAcceptHeader

  public ContentNegotiationConfigurer ignoreAcceptHeader(boolean ignoreAcceptHeader)

  "Accept" リクエストヘッダーのチェックを無効にするかどうか。

  デフォルトでは、この値は false に設定されています。

• defaultContentType

  public ContentNegotiationConfigurer defaultContentType(MediaType... defaultContentTypes)

  コンテンツ型が優先度順にリクエストされない場合に使用するデフォルトのコンテンツ型を設定します。

  指定されたメディア型のいずれもサポートしない宛先が存在する場合、最後に MediaType.ALL を追加することを検討してください。

  デフォルトでは、これは設定されていません。

  関連事項:

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