javax.servlet

インタフェース SessionCookieConfig

public interface SessionCookieConfig

セッションの追跡に使用されるCookieのさまざまなプロパティを設定するために使用されるクラスです。

このクラスのインスタンスはServletContext.getSessionCookieConfig()を呼び出すことで取得されます。

導入されたバージョン:

Servlet 3.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getComment() このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられるコメントを取得します。
String	getDomain() このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられるドメイン名を取得します。
int	getMaxAge() このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieの生存期間(を秒数で)を取得します。
String	getName() このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられる名前を取得します。
String	getPath() このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられるパスを取得します。
boolean	isHttpOnly() このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieをHttpOnlyとしてマークされているかチェックします。
boolean	isSecure() このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieが対応するセッションを開始したリクエストがHTTPSの代わりにプレーンHTTPを使用していても secureであるとマークされているかどうかチェックします。
void	setComment(String comment) このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられるコメントを設定します。
void	setDomain(String domain) このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられるドメイン名を設定します。
void	setHttpOnly(boolean httpOnly) このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieをHttpOnlyとしてマークもしくはアンマークします。
void	setMaxAge(int maxAge) このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieにの生存期間(を秒数で)を設定します。
void	setName(String name) このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられる名前を設定します。
void	setPath(String path) このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieに割り当てられるパスを設定します。
void	setSecure(boolean secure) このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieをsecureとしてマークもしくはアンマークします。

メソッドの詳細

setName

void setName(String name)

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

注：セッショントラッキングCookieの名前を変更すると、 Cookie名がデフォルトのJSESSIONIDであるとみなされている他の層(たとえば、ロードバランシングフロントエンド) が壊れる可能性があります。したがって、慎重に行う必要がります。

パラメータ:

name - 使われるCookieの名前

例外:

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

getName

String getName()

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

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

戻り値:

setName(java.lang.String)で設定されたCookieの名前、setName(java.lang.String)が呼び出されてない場合はnull

関連項目:

Cookie.getName()

setDomain

void setDomain(String domain)

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

パラメータ:

domain - 使用されるCookieのドメイン

例外:

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

関連項目:

Cookie.setDomain(String)

getDomain

String getDomain()

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

戻り値:

setDomain(java.lang.String)で設定されたCookieのドメイン、setDomain(java.lang.String)が呼び出されてない場合はnull

関連項目:

Cookie.getDomain()

setPath

void setPath(String path)

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

パラメータ:

path - 使用されるCookieのパス

例外:

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

関連項目:

Cookie.setPath(String)

getPath

String getPath()

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

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

戻り値:

setPath(java.lang.String)で設定されたCookieのパス、setPath(java.lang.String)が呼び出されてない場合はnull

関連項目:

Cookie.getPath()

setComment

void setComment(String comment)

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

このメソッドを呼び出すと副作用としてセッショントラッキングCookieのVersion属性に1が設定されます。

パラメータ:

comment - 使用されるCookieのコメント

例外:

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

関連項目:

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

getComment

String getComment()

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

戻り値:

setComment(java.lang.String)で設定されたCookieのコメント、setComment(java.lang.String)が呼び出されてない場合はnull

関連項目:

Cookie.getComment()

setHttpOnly

void setHttpOnly(boolean httpOnly)

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

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

パラメータ:

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

例外:

IllegalStateException - この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をsecureとしてマークもしくはアンマークします。

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

パラメータ:

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

例外:

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

関連項目:

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

isSecure

boolean isSecure()

このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieが対応するセッションを開始したリクエストがHTTPSの代わりにプレーンHTTPを使用していても secureであるとマークされているかどうかチェックします。

戻り値:

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

関連項目:

Cookie.getSecure(), ServletRequest.isSecure()

setMaxAge

void setMaxAge(int maxAge)

このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieにの生存期間(を秒数で)を設定します。

パラメータ:

maxAge - このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieの生存期間(の秒数)

例外:

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

関連項目:

Cookie.setMaxAge(int)

getMaxAge

int getMaxAge()

このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieの生存期間(を秒数で)を取得します。

デフォルトでは-1を返します。

戻り値:

このSessionCookieConfigが取得されたServletContextによって表されるアプリケーションのために 作成されたセッショントラッキングCookieの生存期間(の秒数)、もしくは-1(デフォルト)

関連項目:

Cookie.getMaxAge()