nablarch.common.web.handler.threadcontext

クラス CookieSupport

java.lang.Object

nablarch.common.web.handler.threadcontext.CookieSupport

public class CookieSupport
extends java.lang.Object

クッキーに対するアクセスをサポートするクラス。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
CookieSupport(java.lang.String cookieName) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
javax.servlet.http.Cookie	createCookie(ServletExecutionContext ctx, java.lang.String value) 指定された値をクッキーに設定するためのCookieを作成する。
java.lang.String	getCookieValue(ServletExecutionContext ctx) クッキーの値を取得する。
void	setCookieDomain(java.lang.String cookieDomain) 値を保持するクッキーが送信されるドメイン階層を設定する。
void	setCookieMaxAge(java.lang.Integer cookieMaxAge) 値を保持するクッキーの最長存続期間(秒単位)を設定する。
void	setCookieName(java.lang.String cookieName) 値を保持するクッキーの名前を設定する。
void	setCookiePath(java.lang.String cookiePath) 値を保持するクッキーが送信されるURIのパス階層を設定する。
void	setCookieSecure(boolean secure) 保持するクッキーのsecure属性有無を指定する。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

CookieSupport

public CookieSupport(java.lang.String cookieName)

コンストラクタ。

パラメータ:

cookieName - 値を保持するクッキーの名前

メソッドの詳細

setCookieName

public void setCookieName(java.lang.String cookieName)

値を保持するクッキーの名前を設定する。

パラメータ:

cookieName - 値を保持するクッキーの名前

setCookiePath

public void setCookiePath(java.lang.String cookiePath)

値を保持するクッキーが送信されるURIのパス階層を設定する。

パラメータ:

cookiePath - 値を保持するクッキーが送信されるURIのパス階層

setCookieDomain

public void setCookieDomain(java.lang.String cookieDomain)

値を保持するクッキーが送信されるドメイン階層を設定する。

パラメータ:

cookieDomain - 値を保持するクッキーが送信されるドメイン階層

setCookieMaxAge

public void setCookieMaxAge(java.lang.Integer cookieMaxAge)

値を保持するクッキーの最長存続期間(秒単位)を設定する。

パラメータ:

cookieMaxAge - 値を保持するクッキーの最長存続期間(秒単位)

setCookieSecure

public void setCookieSecure(boolean secure)

保持するクッキーのsecure属性有無を指定する。 （デフォルトではsecure属性を設定しない）

パラメータ:

secure - secure属性を設定するか否か（真の場合、secure属性を設定する）

createCookie

public javax.servlet.http.Cookie createCookie(ServletExecutionContext ctx,
                                              java.lang.String value)

指定された値をクッキーに設定するためのCookieを作成する。

クッキーのパス階層が指定されていない場合はコンテキストパスをパス階層に指定する。

パラメータ:

ctx - 実行コンテキスト

value - クッキーに設定する値

戻り値:

Cookie

getCookieValue

public java.lang.String getCookieValue(ServletExecutionContext ctx)

クッキーの値を取得する。

パラメータ:

ctx - 実行コンテキスト

戻り値:

クッキーの値。送信されてない場合はnull