Package nablarch.fw.web
Class HttpCookie
- Direct Known Subclasses:
MockHttpCookie
Httpクッキーのパーサー及びその内容を保持するデータオブジェクト。
-
Nested Class Summary
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,
V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object, V extends Object> -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionList<jakarta.servlet.http.Cookie>
Cookie
オブジェクトのリストに変換して返す。static HttpCookie
fromServletCookie
(jakarta.servlet.http.Cookie cookie) Cookie
からHttpCookie
を生成する。static HttpCookie
fromSetCookieHeader
(String header) RFC6265に従い、Set-CookieヘッダをパースしてHttpCookie
を生成する。HttpCookie
はPath、Domain、Max-Age、Secure、HttpOnly属性のみをサポートしているため、それ以外の属性はパース時に無視する。このラッパーが処理を委譲するMap
オブジェクトを返す。このクッキーが送信されるドメイン階層を返す。このクッキーの最長の存続期間(秒)を返す。(未設定の場合はnull)getPath()
このクッキーが送信されるURIのパス階層を返す。boolean
HttpOnly Cookieか否か。boolean
isSecure()
Secure Cookieか否か。このクッキーが送信されるドメイン階層を指定する。setHttpOnly
(boolean httpOnly) HttpOnly Cookieか否かを設定する。このクッキーの最長の存続期間(秒)を指定する。このクッキーが送信されるURIのパス階層を指定する。setSecure
(boolean secure) Secure Cookieか否かを設定する。Methods inherited from class nablarch.core.util.map.MapWrapper
clear, containsKey, containsValue, entrySet, equals, get, getDelegateMapOfType, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values
Methods inherited from class java.util.AbstractMap
clone
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
HttpCookie
public HttpCookie()デフォルトコンストラクタ。
-
-
Method Details
-
fromServletCookie
Cookie
からHttpCookie
を生成する。- Parameters:
cookie
- JavaEE サーブレットAPIのCookieオブジェクト- Returns:
HttpCookie
オブジェクト
-
fromSetCookieHeader
RFC6265に従い、Set-CookieヘッダをパースしてHttpCookie
を生成する。HttpCookie
はPath、Domain、Max-Age、Secure、HttpOnly属性のみをサポートしているため、それ以外の属性はパース時に無視する。- Parameters:
header
- Set-Cookieヘッダ(Set-Cookie: を含む)- Returns:
HttpCookie
インスタンス- See Also:
-
getMaxAge
このクッキーの最長の存続期間(秒)を返す。(未設定の場合はnull)- Returns:
- このクッキーの最長の存続期間(秒)
-
setMaxAge
このクッキーの最長の存続期間(秒)を指定する。- Parameters:
maxAge
- このクッキーの最長の存続期間(秒)- Returns:
- このオブジェクト自体
-
getPath
このクッキーが送信されるURIのパス階層を返す。- Returns:
- このクッキーが送信されるURI階層
-
setPath
このクッキーが送信されるURIのパス階層を指定する。- Parameters:
path
- このクッキーが送信されるURI階層- Returns:
- このオブジェクト自体
-
getDomain
このクッキーが送信されるドメイン階層を返す。- Returns:
- このクッキーが送信されるドメイン階層
-
setDomain
このクッキーが送信されるドメイン階層を指定する。- Parameters:
domain
- このクッキーが送信されるドメイン階層- Returns:
- このオブジェクト自体
-
isSecure
public boolean isSecure()Secure Cookieか否か。- Returns:
- trueの場合は、Secure Cookie
-
setSecure
Secure Cookieか否かを設定する。- Parameters:
secure
- trueの場合は、Secure Cookie
-
isHttpOnly
public boolean isHttpOnly()HttpOnly Cookieか否か。- Returns:
- trueの場合は、HttpOnly Cookie
-
setHttpOnly
HttpOnly Cookieか否かを設定する。- Parameters:
httpOnly
- trueの場合は、HttpOnly Cookie- Returns:
- このオブジェクト自体
-
convertServletCookies
Cookie
オブジェクトのリストに変換して返す。- Returns:
Cookie
リスト
-
getDelegateMap
Description copied from class:MapWrapper
このラッパーが処理を委譲するMap
オブジェクトを返す。- Specified by:
getDelegateMap
in classMapWrapper<String,
String> - Returns:
- 処理を委譲するMapオブジェクト
-