nablarch.fw.web

Class HttpCookie

java.lang.Object

java.util.AbstractMap<K,V>

nablarch.core.util.map.MapWrapper

nablarch.fw.web.HttpCookie

All Implemented Interfaces:

java.util.Map

@Published(tag="architect")
public class HttpCookie
extends MapWrapper

Httpクッキーのパーサー及びその内容を保持するデータオブジェクト。

Author:

Iwauo Tajima

Constructor Summary

Constructors

Constructor and Description
HttpCookie() デフォルトコンストラクタ。

Method Summary

Modifier and Type	Method and Description
java.util.List	convertServletCookies() Cookieオブジェクトのリストに変換して返す。
static HttpCookie	fromServletCookie(javax.servlet.http.Cookie cookie) CookieからHttpCookieを生成する。
static HttpCookie	fromSetCookieHeader(java.lang.String header) RFC6265に従い、Set-CookieヘッダをパースしてHttpCookieを生成する。 HttpCookieはPath、Domain、Max-Age、Secure、HttpOnly属性のみをサポートしているため、それ以外の属性はパース時に無視する。
java.util.Map	getDelegateMap() このラッパーが処理を委譲するMapオブジェクトを返す。
java.lang.String	getDomain() このクッキーが送信されるドメイン階層を返す。
java.lang.Integer	getMaxAge() このクッキーの最長の存続期間（秒）を返す。（未設定の場合はnull）
java.lang.String	getPath() このクッキーが送信されるURIのパス階層を返す。
boolean	isHttpOnly() HttpOnly Cookieか否か。
boolean	isSecure() Secure Cookieか否か。
HttpCookie	setDomain(java.lang.String domain) このクッキーが送信されるドメイン階層を指定する。
HttpCookie	setHttpOnly(boolean httpOnly) HttpOnly Cookieか否かを設定する。
HttpCookie	setMaxAge(java.lang.Integer maxAge) このクッキーの最長の存続期間（秒）を指定する。
HttpCookie	setPath(java.lang.String path) このクッキーが送信されるURIのパス階層を指定する。
HttpCookie	setSecure(boolean secure) Secure Cookieか否かを設定する。
boolean	supportsHttpOnly() HttpOnly Cookieがサポートされている環境か否か。

Methods inherited from class nablarch.core.util.map.MapWrapper

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

HttpCookie

public HttpCookie()

デフォルトコンストラクタ。

Method Detail

fromServletCookie

public static HttpCookie fromServletCookie(javax.servlet.http.Cookie cookie)

CookieからHttpCookieを生成する。

Parameters:

cookie - JavaEE サーブレットAPIのCookieオブジェクト

Returns:

HttpCookieオブジェクト

fromSetCookieHeader

public static HttpCookie fromSetCookieHeader(java.lang.String header)

RFC6265に従い、Set-CookieヘッダをパースしてHttpCookieを生成する。 HttpCookieはPath、Domain、Max-Age、Secure、HttpOnly属性のみをサポートしているため、それ以外の属性はパース時に無視する。

Parameters:

header - Set-Cookieヘッダ（Set-Cookie: を含む）

Returns:

HttpCookie インスタンス

See Also:

RFC6265 4.1.1. Syntax

getMaxAge

public java.lang.Integer getMaxAge()

このクッキーの最長の存続期間（秒）を返す。（未設定の場合はnull）

Returns:

このクッキーの最長の存続期間（秒）

setMaxAge

public HttpCookie setMaxAge(java.lang.Integer maxAge)

このクッキーの最長の存続期間（秒）を指定する。

Parameters:

maxAge - このクッキーの最長の存続期間（秒）

Returns:

このオブジェクト自体

getPath

public java.lang.String getPath()

このクッキーが送信されるURIのパス階層を返す。

Returns:

このクッキーが送信されるURI階層

setPath

public HttpCookie setPath(java.lang.String path)

このクッキーが送信されるURIのパス階層を指定する。

Parameters:

path - このクッキーが送信されるURI階層

Returns:

このオブジェクト自体

getDomain

public java.lang.String getDomain()

このクッキーが送信されるドメイン階層を返す。

Returns:

このクッキーが送信されるドメイン階層

setDomain

public HttpCookie setDomain(java.lang.String domain)

このクッキーが送信されるドメイン階層を指定する。

Parameters:

domain - このクッキーが送信されるドメイン階層

Returns:

このオブジェクト自体

isSecure

public boolean isSecure()

Secure Cookieか否か。

Returns:

trueの場合は、Secure Cookie

setSecure

public HttpCookie setSecure(boolean secure)

Secure Cookieか否かを設定する。

Parameters:

secure - trueの場合は、Secure Cookie

isHttpOnly

public boolean isHttpOnly()

HttpOnly Cookieか否か。

Returns:

trueの場合は、HttpOnly Cookie

setHttpOnly

public HttpCookie setHttpOnly(boolean httpOnly)

HttpOnly Cookieか否かを設定する。

Parameters:

httpOnly - trueの場合は、HttpOnly Cookie

Returns:

このオブジェクト自体

supportsHttpOnly

public boolean supportsHttpOnly()

HttpOnly Cookieがサポートされている環境か否か。

Returns:

HttpOnlyがサポートされている場合true

convertServletCookies

public java.util.List convertServletCookies()

Cookieオブジェクトのリストに変換して返す。

Returns:

Cookieリスト

getDelegateMap

public java.util.Map getDelegateMap()

Description copied from class: MapWrapper

このラッパーが処理を委譲するMapオブジェクトを返す。

Returns:

処理を委譲するMapオブジェクト