nablarch.common.web.handler.threadcontext

Class CookieSupport

java.lang.Object

nablarch.common.web.handler.threadcontext.CookieSupport

public class CookieSupport
extends java.lang.Object

クッキーに対するアクセスをサポートするクラス。 クッキーのhttpOnly属性はアプリケーションで使用しているServlet APIがサポートしている場合のみ設定する。

Constructor Summary

Constructors

Constructor and Description
CookieSupport(java.lang.String cookieName) コンストラクタ。

Method Summary

Modifier and Type	Method and Description
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	setCookieHttpOnly(boolean httpOnly) 保持するクッキーのhttpOnly属性有無を指定する。 （デフォルトではサポートしていればhttpOnly属性を設定する）
void	setCookieMaxAge(java.lang.Integer cookieMaxAge) 値を保持するクッキーの最長存続期間(秒単位)を設定する。
void	setCookieName(java.lang.String cookieName) 値を保持するクッキーの名前を設定する。
void	setCookiePath(java.lang.String cookiePath) 値を保持するクッキーが送信されるURIのパス階層を設定する。
void	setCookieSecure(boolean secure) 保持するクッキーのsecure属性有無を指定する。 （デフォルトではsecure属性を設定しない）

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieSupport

public CookieSupport(java.lang.String cookieName)

コンストラクタ。

Parameters:

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

Method Detail

setCookieName

public void setCookieName(java.lang.String cookieName)

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

Parameters:

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

setCookiePath

public void setCookiePath(java.lang.String cookiePath)

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

Parameters:

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

setCookieDomain

public void setCookieDomain(java.lang.String cookieDomain)

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

Parameters:

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

setCookieMaxAge

public void setCookieMaxAge(java.lang.Integer cookieMaxAge)

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

Parameters:

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

setCookieSecure

public void setCookieSecure(boolean secure)

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

Parameters:

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

setCookieHttpOnly

public void setCookieHttpOnly(boolean httpOnly)

保持するクッキーのhttpOnly属性有無を指定する。 （デフォルトではサポートしていればhttpOnly属性を設定する）

Parameters:

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

createCookie

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

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

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

Parameters:

ctx - 実行コンテキスト

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

Returns:

Cookie

getCookieValue

public java.lang.String getCookieValue(ServletExecutionContext ctx)

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

Parameters:

ctx - 実行コンテキスト

Returns:

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