Package nablarch.fw.web

Class HttpCookie

java.lang.Object
java.util.AbstractMap<K,V>
nablarch.core.util.map.MapWrapper<String,String>
nablarch.fw.web.HttpCookie
All Implemented Interfaces:
Map<String,String>
@Published(tag="architect") public class HttpCookie extends MapWrapper<String,String>
Httpクッキーのパーサー及びその内容を保持するデータオブジェクト。
Author:
Iwauo Tajima <iwauo@tis.co.jp>

  • Constructor Details

    • HttpCookie

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

  • Method Details

    • fromServletCookie

      public static HttpCookie fromServletCookie(jakarta.servlet.http.Cookie cookie)
      CookieからHttpCookieを生成する。
      Parameters:
      cookie - JavaEE サーブレットAPIのCookieオブジェクト
      Returns:
      HttpCookieオブジェクト

    • fromSetCookieHeader

      public static HttpCookie fromSetCookieHeader(String header)
      RFC6265に従い、Set-CookieヘッダをパースしてHttpCookieを生成する。 HttpCookieはPath、Domain、Max-Age、Secure、HttpOnly属性のみをサポートしているため、それ以外の属性はパース時に無視する。
      Parameters:
      header - Set-Cookieヘッダ（Set-Cookie: を含む）
      Returns:
      HttpCookie インスタンス
      See Also:

    • getMaxAge

      public Integer getMaxAge()
      このクッキーの最長の存続期間（秒）を返す。（未設定の場合はnull）
      Returns:
      このクッキーの最長の存続期間（秒）

    • setMaxAge

      public HttpCookie setMaxAge(Integer maxAge)
      このクッキーの最長の存続期間（秒）を指定する。
      Parameters:
      maxAge - このクッキーの最長の存続期間（秒）
      Returns:
      このオブジェクト自体

    • getPath

      public String getPath()
      このクッキーが送信されるURIのパス階層を返す。
      Returns:
      このクッキーが送信されるURI階層

    • setPath

      public HttpCookie setPath(String path)
      このクッキーが送信されるURIのパス階層を指定する。
      Parameters:
      path - このクッキーが送信されるURI階層
      Returns:
      このオブジェクト自体

    • getDomain

      public String getDomain()
      このクッキーが送信されるドメイン階層を返す。
      Returns:
      このクッキーが送信されるドメイン階層

    • setDomain

      public HttpCookie setDomain(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:
      このオブジェクト自体

    • convertServletCookies

      public List<jakarta.servlet.http.Cookie> convertServletCookies()
      Cookieオブジェクトのリストに変換して返す。
      Returns:
      Cookieリスト

    • getDelegateMap

      public Map<String,String> getDelegateMap()
      Description copied from class: MapWrapper
      このラッパーが処理を委譲するMapオブジェクトを返す。
      Specified by:
      getDelegateMap in class MapWrapper<String,String>
      Returns:
      処理を委譲するMapオブジェクト