フィールドの詳細

• DEFAULT_COOKIE_PATH

  public static final StringSE DEFAULT_COOKIE_PATH

  Cookie が表示されるデフォルトのパス: "/"、つまりサーバー全体。

  関連事項:

  定数フィールド値

• logger

  protected final Log logger

コンストラクターの詳細

• CookieGenerator

  public CookieGenerator()

メソッドの詳細

• setCookieName

  public void setCookieName(@Nullable
                            StringSE cookieName)

  このジェネレーターによって作成された Cookie には、指定された名前を使用してください。

  関連事項:

  Cookie.getName()EE

• getCookieName

  @Nullable
  public StringSE getCookieName()

  このジェネレーターによって作成された Cookie の名前を返します。

• setCookieDomain

  public void setCookieDomain(@Nullable
                              StringSE cookieDomain)

  このジェネレーターによって作成された Cookie には、指定されたドメインを使用します。Cookie は、このドメインのサーバーにのみ表示されます。

  関連事項:

  Cookie.setDomain(java.lang.String)EE

• getCookieDomain

  @Nullable
  public StringSE getCookieDomain()

  このジェネレーターによって作成された Cookie がある場合は、そのドメインを返します。

• setCookiePath

  public void setCookiePath(StringSE cookiePath)

  このジェネレーターによって作成された Cookie には、指定されたパスを使用します。Cookie は、このパス以下の URL にのみ表示されます。

  関連事項:

  Cookie.setPath(java.lang.String)EE

• getCookiePath

  public StringSE getCookiePath()

  このジェネレーターによって作成された Cookie のパスを返します。

• setCookieMaxAge

  public void setCookieMaxAge(@Nullable
                              IntegerSE cookieMaxAge)

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

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

  関連事項:

  Cookie.setMaxAge(int)EE

• getCookieMaxAge

  @Nullable
  public IntegerSE getCookieMaxAge()

  このジェネレーターによって作成された Cookie の最大経過時間を返します。

• setCookieSecure

  public void setCookieSecure(boolean cookieSecure)

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

  デフォルトは「false」。

  関連事項:

  Cookie.setSecure(boolean)EE

• isCookieSecure

  public boolean isCookieSecure()

  Cookie を HTTPS（SSL）などの安全なプロトコルを使用してのみ送信するかどうかを返します。

• setCookieHttpOnly

  public void setCookieHttpOnly(boolean cookieHttpOnly)

  Cookie が "HttpOnly" 属性でマークされることになっているかどうかを設定します。

  デフォルトは「false」。

  関連事項:

  Cookie.setHttpOnly(boolean)EE

• 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 の値

  関連事項:

  setCookieName(java.lang.String), setCookieDomain(java.lang.String), setCookiePath(java.lang.String), setCookieMaxAge(java.lang.Integer)

• removeCookie

  public void removeCookie(HttpServletResponseEE response)

  このジェネレーターが記述する Cookie をレスポンスから削除します。空の値と最大年齢 0 の Cookie を生成します。

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

  パラメーター:

  response - Cookie を削除する HTTP レスポンス

  関連事項:

  setCookieName(java.lang.String), setCookieDomain(java.lang.String), setCookiePath(java.lang.String)

• createCookie

  protected CookieEE createCookie(StringSE cookieValue)

  このジェネレーターの Cookie 記述子設定 ( "cookieMaxAge" を除く) を使用して、指定された値の Cookie を作成します。

  パラメーター:

  cookieValue - クレートする Cookie の値

  戻り値:

  クッキー

  関連事項:

  setCookieName(java.lang.String), setCookieDomain(java.lang.String), setCookiePath(java.lang.String)