パッケージ org.springframework.web.util

クラス CookieGenerator

java.lang.ObjectSE
org.springframework.web.util.CookieGenerator
既知の直属サブクラス
CookieThemeResolver
@DeprecatedSE public class CookieGenerator extends ObjectSE
使用すべきではありません。
6.0 現在、ResponseCookie を推奨
Cookie 生成用のヘルパークラス。Cookie 記述子設定を Bean プロパティとして伝達し、指定されたレスポンスに対して Cookie を追加および削除できます。

特定の Cookie を生成するコンポーネントの基本クラスとして機能できます。

導入:
1.1.4
作成者:
Juergen Hoeller
関連事項:

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    DEFAULT_COOKIE_PATH
    使用すべきではありません。
    Cookie が表示されるデフォルトのパス: "/"、つまり
    protected final Log
    logger
    使用すべきではありません。

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    CookieGenerator()
    使用すべきではありません。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    addCookie(HttpServletResponseEE response, StringSE cookieValue)
    使用すべきではありません。
    このジェネレーターの Cookie 記述子設定を使用して、指定された値の Cookie をレスポンスに追加します。
    protected CookieEE
    createCookie(StringSE cookieValue)
    使用すべきではありません。
    このジェネレーターの Cookie 記述子設定 ( "cookieMaxAge" を除く) を使用して、指定された値の Cookie を作成します。
    StringSE
    getCookieDomain()
    使用すべきではありません。
    このジェネレーターによって作成された Cookie がある場合は、そのドメインを返します。
    IntegerSE
    getCookieMaxAge()
    使用すべきではありません。
    このジェネレーターによって作成された Cookie の最大経過時間を返します。
    StringSE
    getCookieName()
    使用すべきではありません。
    このジェネレーターによって作成された Cookie の名前を返します。
    StringSE
    getCookiePath()
    使用すべきではありません。
    このジェネレーターによって作成された Cookie のパスを返します。
    boolean
    isCookieHttpOnly()
    使用すべきではありません。
    Cookie が "HttpOnly" 属性でマークされることになっているかどうかを返します。
    boolean
    isCookieSecure()
    使用すべきではありません。
    Cookie を HTTPS（SSL）などの安全なプロトコルを使用してのみ送信するかどうかを返します。
    void
    removeCookie(HttpServletResponseEE response)
    使用すべきではありません。
    このジェネレーターが記述する Cookie をレスポンスから削除します。
    void
    setCookieDomain(StringSE cookieDomain)
    使用すべきではありません。
    このジェネレーターによって作成された Cookie には、指定されたドメインを使用します。
    void
    setCookieHttpOnly(boolean cookieHttpOnly)
    使用すべきではありません。
    Cookie が "HttpOnly" 属性でマークされることになっているかどうかを設定します。
    void
    setCookieMaxAge(IntegerSE cookieMaxAge)
    使用すべきではありません。
    このジェネレーターによって作成された Cookie には、指定された最大経過時間（秒単位）を使用します。
    void
    setCookieName(StringSE cookieName)
    使用すべきではありません。
    このジェネレーターによって作成された Cookie には、指定された名前を使用してください。
    void
    setCookiePath(StringSE cookiePath)
    使用すべきではありません。
    このジェネレーターによって作成された Cookie には、指定されたパスを使用します。
    void
    setCookieSecure(boolean cookieSecure)
    使用すべきではありません。
    HTTPS（SSL）などの安全なプロトコルを使用してのみ Cookie を送信するかどうかを設定します。

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • フィールドの詳細

    • logger

      protected final Log logger
      使用すべきではありません。

  • コンストラクターの詳細

    • CookieGenerator

      public CookieGenerator()
      使用すべきではありません。

  • メソッドの詳細

    • setCookieName

      public void setCookieName(@Nullable StringSE cookieName)
      使用すべきではありません。
      このジェネレーターによって作成された Cookie には、指定された名前を使用してください。
      関連事項:

    • getCookieName

      @Nullable public StringSE getCookieName()
      使用すべきではありません。
      このジェネレーターによって作成された Cookie の名前を返します。

    • setCookieDomain

      public void setCookieDomain(@Nullable StringSE cookieDomain)
      使用すべきではありません。
      このジェネレーターによって作成された Cookie には、指定されたドメインを使用します。Cookie は、このドメインのサーバーにのみ表示されます。
      関連事項:

    • getCookieDomain

      @Nullable public StringSE getCookieDomain()
      使用すべきではありません。
      このジェネレーターによって作成された Cookie がある場合は、そのドメインを返します。

    • setCookiePath

      public void setCookiePath(StringSE cookiePath)
      使用すべきではありません。
      このジェネレーターによって作成された Cookie には、指定されたパスを使用します。Cookie は、このパス以下の URL にのみ表示されます。
      関連事項:

    • getCookiePath

      public StringSE getCookiePath()
      使用すべきではありません。
      このジェネレーターによって作成された Cookie のパスを返します。

    • setCookieMaxAge

      public void setCookieMaxAge(@Nullable IntegerSE cookieMaxAge)
      使用すべきではありません。
      このジェネレーターによって作成された Cookie には、指定された最大経過時間（秒単位）を使用します。有用な特殊値: -1... 永続的ではなく、クライアントがシャットダウンすると削除されます。

      デフォルトは、サーブレットコンテナーのデフォルトを使用して、特定の最大経過時間ではありません。

      関連事項:

    • getCookieMaxAge

      @Nullable public IntegerSE getCookieMaxAge()
      使用すべきではありません。
      このジェネレーターによって作成された Cookie の最大経過時間を返します。

    • setCookieSecure

      public void setCookieSecure(boolean cookieSecure)
      使用すべきではありません。
      HTTPS（SSL）などの安全なプロトコルを使用してのみ Cookie を送信するかどうかを設定します。これは受信ブラウザーへの表示であり、HTTP サーバー自体では処理されません。

      デフォルトは「false」。

      関連事項:

    • isCookieSecure

      public boolean isCookieSecure()
      使用すべきではありません。
      Cookie を HTTPS（SSL）などの安全なプロトコルを使用してのみ送信するかどうかを返します。

    • setCookieHttpOnly

      public void setCookieHttpOnly(boolean cookieHttpOnly)
      使用すべきではありません。
      Cookie が "HttpOnly" 属性でマークされることになっているかどうかを設定します。

      デフォルトは「false」。

      関連事項:

    • isCookieHttpOnly

      public boolean isCookieHttpOnly()
      使用すべきではありません。
      Cookie が "HttpOnly" 属性でマークされることになっているかどうかを返します。

    • addCookie

      public void addCookie(HttpServletResponseEE response, StringSE cookieValue)
      使用すべきではありません。
      このジェネレーターの Cookie 記述子設定を使用して、指定された値の Cookie をレスポンスに追加します。

      Cookie を作成するための createCookie(java.lang.String) へのデリゲート。

      パラメーター:
      response - Cookie を追加する HTTP レスポンス
      cookieValue - 追加する Cookie の値
      関連事項:

    • removeCookie

      public void removeCookie(HttpServletResponseEE response)
      使用すべきではありません。
      このジェネレーターが記述する Cookie をレスポンスから削除します。空の値と最大年齢 0 の Cookie を生成します。

      Cookie を作成するための createCookie(java.lang.String) へのデリゲート。

      パラメーター:
      response - Cookie を削除する HTTP レスポンス
      関連事項:

    • createCookie

      protected CookieEE createCookie(StringSE cookieValue)
      使用すべきではありません。
      このジェネレーターの Cookie 記述子設定 ( "cookieMaxAge" を除く) を使用して、指定された値の Cookie を作成します。
      パラメーター:
      cookieValue - クレートする Cookie の値
      戻り値:
      クッキー
      関連事項: