クラス StandardApiVersionDeprecationHandler.VersionSpec

java.lang.ObjectSE
org.springframework.web.accept.StandardApiVersionDeprecationHandler.VersionSpec
含まれているクラス:
StandardApiVersionDeprecationHandler
public final class StandardApiVersionDeprecationHandler.VersionSpec extends ObjectSE
API バージョンの廃止の詳細を構成する仕様。
導入:
7.0
作成者:
Rossen Stoyanchev

  • メソッドの詳細

    • setRequestPredicate

      public StandardApiVersionDeprecationHandler.VersionSpec setRequestPredicate(PredicateSE<jakarta.servlet.http.HttpServletRequest> predicate)
      非推奨情報を送信するリクエストをフィルタリングするための述語を設定します。

      デフォルトでは、非推奨バージョンへのリクエストはすべて処理されます。この述語は、非推奨情報を公開する必要があるリクエストを絞り込むためのものです。

      パラメーター:
      predicate - リクエストをチェックするための述語
      戻り値:
      同じ仕様インスタンス

    • setDeprecationDate

      public StandardApiVersionDeprecationHandler.VersionSpec setDeprecationDate(ZonedDateTimeSE date)
      "Deprecation" レスポンスヘッダーに廃止日を指定します。
      パラメーター:
      date - 廃止日
      戻り値:
      同じ仕様インスタンス

    • setDeprecationLink

      public StandardApiVersionDeprecationHandler.VersionSpec setDeprecationLink(URISE uri)
      rel="deprecation" と type="text/html" を使用して、"Link" レスポンスヘッダーの URL を指定します。
      パラメーター:
      uri - リンク値
      戻り値:
      同じ仕様インスタンス

    • setDeprecationLink

      public StandardApiVersionDeprecationHandler.VersionSpec setDeprecationLink(URISE uri, MediaType mediaType)
      "text/html" 以外のメディア型で使用するための setDeprecationLink(URI) のバリエーション。
      パラメーター:
      uri - リンク値
      mediaType - 使用するメディア型
      戻り値:
      同じ仕様インスタンス

    • setSunsetDate

      public StandardApiVersionDeprecationHandler.VersionSpec setSunsetDate(ZonedDateTimeSE date)
      "Sunset" レスポンスヘッダーの廃止日を指定します。
      パラメーター:
      date - 日没日
      戻り値:
      同じ仕様インスタンス

    • setSunsetLink

      public StandardApiVersionDeprecationHandler.VersionSpec setSunsetLink(URISE uri)
      rel="sunset" と type="text/html" を使用して、"Link" レスポンスヘッダーの URL を指定します。
      パラメーター:
      uri - リンク値
      戻り値:
      同じ仕様インスタンス

    • setSunsetLink

      public StandardApiVersionDeprecationHandler.VersionSpec setSunsetLink(URISE uri, MediaType mediaType)
      "text/html" 以外のメディア型で使用するための setSunsetLink(URI) のバリエーション。
      パラメーター:
      uri - リンク値
      mediaType - 使用するメディア型
      戻り値:
      同じ仕様インスタンス