クラス WebContentGenerator

メソッドの詳細

• setSupportedMethods

  public final void setSupportedMethods(StringSE @Nullable ... methods)

  このコンテンツジェネレーターがサポートする HTTP メソッドを設定します。

  デフォルトは、単純なフォームコントローラー型の GET、HEAD、POST です。一般的なコントローラーとインターセプターには制限がありません。

• getSupportedMethods

  public final StringSE @Nullable [] getSupportedMethods()

  このコンテンツジェネレーターがサポートする HTTP メソッドを返します。

• getAllowHeader

  protected @Nullable StringSE getAllowHeader()

  構成済みの supported methods に基づく HTTP OPTIONS リクエストへのレスポンスで使用する "Allow" ヘッダー値を返します。サポートされるメソッドとして存在しない場合でも、リストに "OPTIONS" を自動的に追加します。これは、checkRequest(HttpServletRequest) を呼び出す前に HTTP OPTIONS リクエストが処理される限り、サブクラスがサポートされているメソッドとして "OPTIONS" を明示的にリストする必要がないことを意味します。

  導入:

  4.3

• setRequireSession

  public final void setRequireSession(boolean requireSession)

  リクエストを処理するためにセッションが必要かどうかを設定します。

• isRequireSession

  public final boolean isRequireSession()

  リクエストの処理にセッションが必要かどうかを返します。

• setCacheControl

  public final void setCacheControl(@Nullable CacheControl cacheControl)

  CacheControl インスタンスを設定して、Cache-Control HTTP レスポンスヘッダーを構築します。

  導入:

  4.2

• getCacheControl

  public final @Nullable CacheControl getCacheControl()

  Cache-Control HTTP レスポンスヘッダーを作成する CacheControl インスタンスを取得します。

  導入:

  4.2

• setCacheSeconds

  public final void setCacheSeconds(int seconds)

  レスポンスにキャッシュ関連の HTTP ヘッダーを書き込むことにより、指定された秒数の間コンテンツをキャッシュします。

  • 秒 == -1（デフォルト値）: 生成キャッシュ関連のヘッダーなし
  • 秒 == 0: 「キャッシュ制御: no-store」はキャッシュを防ぎます
  • 秒> 0: 「キャッシュ制御: max-age = seconds」はコンテンツのキャッシュを要求します

  より具体的なニーズについては、カスタム CacheControl を使用する必要があります。

  関連事項:

  • setCacheControl(CacheControl)

• getCacheSeconds

  public final int getCacheSeconds()

  コンテンツがキャッシュされる秒数を返します。

• setVaryByRequestHeaders

  public final void setVaryByRequestHeaders(StringSE @Nullable ... varyByRequestHeaders)

  レスポンスがコンテンツネゴシエーションの対象であり、指定されたリクエストヘッダーの値に基づいて変更されることをクライアントに通知するために、"Vary" レスポンスヘッダーに追加する 1 つ以上のリクエストヘッダー名 ( "Accept-Language" など) を構成します。構成されたリクエストヘッダー名は、レスポンス "Vary" ヘッダーにまだ存在しない場合にのみ追加されます。

  パラメーター:

  varyByRequestHeaders - 1 つ以上のリクエストヘッダー名

  導入:

  4.3

• getVaryByRequestHeaders

  public final StringSE @Nullable [] getVaryByRequestHeaders()

  "Vary" レスポンスヘッダーの構成済みリクエストヘッダー名を返します。

  導入:

  4.3

• checkRequest

  protected final void checkRequest(jakarta.servlet.http.HttpServletRequest request) throws jakarta.servlet.ServletException

  サポートされているメソッドと必要なセッションがある場合は、指定されたリクエストを確認してください。

  パラメーター:

  request - 現在の HTTP リクエスト

  例外:

  jakarta.servlet.ServletException - チェックが失敗したためにリクエストを処理できない場合

  導入:

  4.2

• prepareResponse

  protected final void prepareResponse(jakarta.servlet.http.HttpServletResponse response)

  このジェネレーターの設定に従って、指定されたレスポンスを準備します。このジェネレーターに指定されたキャッシュ秒数を適用します。

  パラメーター:

  response - 現在の HTTP レスポンス

  導入:

  4.2

• applyCacheControl

  protected final void applyCacheControl(jakarta.servlet.http.HttpServletResponse response, CacheControl cacheControl)

  指定された設定に従って HTTP Cache-Control ヘッダーを設定します。

  パラメーター:

  response - 現在の HTTP レスポンス

  cacheControl - 事前設定されたキャッシュ制御設定

  導入:

  4.2

• applyCacheSeconds

  protected final void applyCacheSeconds(jakarta.servlet.http.HttpServletResponse response, int cacheSeconds)

  指定されたキャッシュ秒を適用し、対応する HTTP ヘッダーを生成します。つまり、正の値の場合は指定された秒数のキャッシュを許可し、0 の値が指定された場合はキャッシュを禁止します。ブラウザーにリソースの再検証を指示しません。

  パラメーター:

  response - 現在の HTTP レスポンス

  cacheSeconds - レスポンスがキャッシュ可能になる未来の正の秒数、キャッシュを防ぐための 0