メソッドの詳細

• setName

  void setName(StringSE name)

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie に割り当てられる名前を設定します。

  NOTE: セッショントラッキング Cookie の名前を変更すると、Cookie 名がデフォルトの JSESSIONID と等しいと想定する他の層（たとえば、負荷分散フロントエンド）が壊れる可能性があるため、慎重に行う必要があります。

  パラメーター:

  name - 使用する Cookie 名

  例外:

  IllegalStateExceptionSE - この SessionCookieConfig を取得した ServletContext がすでに初期化されている場合

• getName

  StringSE getName()

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie に割り当てられる名前を取得します。

  デフォルトでは、 JSESSIONID が Cookie 名として使用されます。

  戻り値:

  setName(java.lang.String) を介して設定された Cookie 名。setName(java.lang.String) が呼び出されなかった場合は null

  関連事項:

  Cookie.getName()

• setDomain

  void setDomain(StringSE domain)

  この SessionCookieConfig の取得元である ServletContext で表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie に割り当てられるドメイン名を設定します。

  パラメーター:

  domain - 使用する Cookie ドメイン

  例外:

  IllegalStateExceptionSE - この SessionCookieConfig を取得した ServletContext がすでに初期化されている場合

  関連事項:

  Cookie.setDomain(String)

• getDomain

  StringSE getDomain()

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie に割り当てられるドメイン名を取得します。

  戻り値:

  setDomain(java.lang.String) を介して設定された Cookie ドメイン。setDomain(java.lang.String) が呼び出されなかった場合は null

  関連事項:

  Cookie.getDomain()

• setPath

  void setPath(StringSE path)

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie に割り当てられるパスを設定します。

  パラメーター:

  path - 使用する Cookie パス

  例外:

  IllegalStateExceptionSE - この SessionCookieConfig を取得した ServletContext がすでに初期化されている場合

  関連事項:

  Cookie.setPath(String)

• getPath

  StringSE getPath()

  この SessionCookieConfig の取得元である ServletContext で表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie に割り当てられるパスを取得します。

  デフォルトでは、この SessionCookieConfig を取得した ServletContext のコンテキストパスが使用されます。

  戻り値:

  setPath(java.lang.String) を介して設定された Cookie パス、または setPath(java.lang.String) が呼び出されなかった場合は null

  関連事項:

  Cookie.getPath()

• setComment

  void setComment(StringSE comment)

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションに代わって作成されるセッショントラッキング Cookie に割り当てられるコメントを設定します。

  この呼び出しの副作用として、セッション追跡 Cookie は 1 と等しい Version 属性でマークされます。

  パラメーター:

  comment - 使用する Cookie コメント

  例外:

  IllegalStateExceptionSE - この SessionCookieConfig を取得した ServletContext がすでに初期化されている場合

  関連事項:

  Cookie.setComment(String), Cookie.getVersion()

• getComment

  StringSE getComment()

  この SessionCookieConfig の取得元である ServletContext で表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie に割り当てられるコメントを取得します。

  戻り値:

  setComment(java.lang.String) を介して設定された Cookie コメント。setComment(java.lang.String) が呼び出されなかった場合は null

  関連事項:

  Cookie.getComment()

• setHttpOnly

  void setHttpOnly(boolean httpOnly)

  この SessionCookieConfig が HttpOnly として取得された ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie をマークまたはマーク解除します。

  クッキーは、それに HttpOnly 属性を追加することにより、HttpOnly としてマークされています。HttpOnly Cookie はクライアント側のスクリプトコードに公開されていないため、特定の種類のクロスサイトスクリプティング攻撃の緩和に役立つ場合があります。

  パラメーター:

  httpOnly - この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie が HttpOnly としてマークされる場合は true、そうでない場合は false

  例外:

  IllegalStateExceptionSE - この SessionCookieConfig を取得した ServletContext がすでに初期化されている場合

  関連事項:

  Cookie.setHttpOnly(boolean)

• isHttpOnly

  boolean isHttpOnly()

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie が HttpOnly としてマークされるかどうかを確認します。

  戻り値:

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie が HttpOnly としてマークされる場合は true、そうでない場合は false

  関連事項:

  Cookie.isHttpOnly()

• setSecure

  void setSecure(boolean secure)

  この SessionCookieConfig が安全であるとして取得された ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie をマークまたはマーク解除します。

  セッショントラッキング Cookie を secure としてマークする 1 つの使用例は、セッションを開始したリクエストが HTTP 経由で来たとしても、SSL オフロードロードバランサーによって Web コンテナーがフロントエンドであるトポロジをサポートすることです。この場合、クライアントとロードバランサー間のトラフィックは HTTPS を経由しますが、ロードバランサーと Web コンテナー間のトラフィックは HTTP を経由します。

  パラメーター:

  secure - この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie が、対応するセッションを開始したリクエストが HTTPS ではなくプレーン HTTP を使用している場合でもセキュアとしてマークされる場合は true、そうでなければ false 対応するセッションを開始したリクエストも安全だった場合にのみ、 安全とマークされます

  例外:

  IllegalStateExceptionSE - この SessionCookieConfig を取得した ServletContext がすでに初期化されている場合

  関連事項:

  Cookie.setSecure(boolean), ServletRequest.isSecure()

• isSecure

  boolean isSecure()

  対応するセッションを開始したリクエストが HTTPS ではなくプレーン HTTP を使用している場合でも、この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie が安全であるとマークされるかどうかを確認します。

  戻り値:

  対応するセッションを開始したリクエストが HTTPS ではなくプレーン HTTP を使用している場合でも、この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションの代わりに作成されたセッショントラッキング Cookie が安全であるとマークされる場合は true、そうでない場合は false 対応するセッションを開始したリクエストも安全だった場合にのみ、 安全とマークされます

  関連事項:

  Cookie.getSecure(), ServletRequest.isSecure()

• setMaxAge

  void setMaxAge(int maxAge)

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie の有効期間（秒単位）を設定します。

  パラメーター:

  maxAge - この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie の存続時間（秒単位）。

  例外:

  IllegalStateExceptionSE - この SessionCookieConfig を取得した ServletContext がすでに初期化されている場合

  関連事項:

  Cookie.setMaxAge(int)

• getMaxAge

  int getMaxAge()

  この SessionCookieConfig の取得元である ServletContext によって表されるアプリケーションのために作成されたセッショントラッキング Cookie の有効期間（秒単位）を取得します。

  デフォルトでは、 -1 が返されます。

  戻り値:

  この SessionCookieConfig の取得元である ServletContext で表されるアプリケーションに代わって作成されたセッショントラッキング Cookie の存続時間（秒単位）、または -1 (デフォルト)

  関連事項:

  Cookie.getMaxAge()