HttpCookie (Nablarch-API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - nablarch.core.util.map.MapWrapper<java.lang.String,java.lang.String>
  - - nablarch.fw.web.HttpCookie

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>

Direct Known Subclasses:

MockHttpCookie
```
@Published(tag="architect")
public class HttpCookie
extends MapWrapper<java.lang.String,java.lang.String>
```
Httpクッキーのパーサー及びその内容を保持するデータオブジェクト。

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<javax.servlet.http.Cookie>`	`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<java.lang.String,java.lang.String>`	`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, 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 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<javax.servlet.http.Cookie> convertServletCookies()
```
    Cookieオブジェクトのリストに変換して返す。
    
    Returns:
    
    Cookieリスト
  - getDelegateMap
```
public java.util.Map<java.lang.String,java.lang.String> getDelegateMap()
```
    Description copied from class: MapWrapper
    
    このラッパーが処理を委譲するMapオブジェクトを返す。
    
    Specified by:
    
    getDelegateMap in class MapWrapper<java.lang.String,java.lang.String>
    
    Returns:
    
    処理を委譲するMapオブジェクト

Class HttpCookie

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HttpCookie

Method Detail

fromServletCookie

fromSetCookieHeader

getMaxAge

setMaxAge

getPath

setPath

getDomain

setDomain

isSecure

setSecure

isHttpOnly

setHttpOnly

supportsHttpOnly

convertServletCookies

getDelegateMap