Package org.apache.shiro.web.servlet
Interface Cookie
-
- All Known Implementing Classes:
SimpleCookie
public interface Cookie
Interface representing HTTP cookie operations, supporting pojo-style getters and setters for all attributes which includes HttpOnly support. This allows Shiro to set HttpOnly cookies even on Servlet containers based on the2.4
and2.5
API (Servlet API 'native' support was only introduced in the2.6
specification).- Since:
- 1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Cookie.SameSiteOptions
The SameSite attribute of the Set-Cookie HTTP response header allows you to declare if your cookie should be restricted to a first-party or same-site context.
-
Field Summary
Fields Modifier and Type Field Description static String
DELETED_COOKIE_VALUE
The value of deleted cookie (with the maxAge 0).static int
ONE_YEAR
The number of seconds in one year (= 60 * 60 * 24 * 365).static String
ROOT_PATH
Root path to use when the path hasn't been set and request context root is empty or null.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getComment()
String
getDomain()
int
getMaxAge()
String
getName()
String
getPath()
Cookie.SameSiteOptions
getSameSite()
String
getValue()
int
getVersion()
boolean
isHttpOnly()
boolean
isSecure()
String
readValue(HttpServletRequest request, HttpServletResponse response)
void
removeFrom(HttpServletRequest request, HttpServletResponse response)
void
saveTo(HttpServletRequest request, HttpServletResponse response)
void
setComment(String comment)
void
setDomain(String domain)
void
setHttpOnly(boolean httpOnly)
void
setMaxAge(int maxAge)
void
setName(String name)
void
setPath(String path)
void
setSameSite(Cookie.SameSiteOptions sameSite)
void
setSecure(boolean secure)
void
setValue(String value)
void
setVersion(int version)
-
-
-
Field Detail
-
DELETED_COOKIE_VALUE
static final String DELETED_COOKIE_VALUE
The value of deleted cookie (with the maxAge 0).- See Also:
- Constant Field Values
-
ONE_YEAR
static final int ONE_YEAR
The number of seconds in one year (= 60 * 60 * 24 * 365).- See Also:
- Constant Field Values
-
ROOT_PATH
static final String ROOT_PATH
Root path to use when the path hasn't been set and request context root is empty or null.- See Also:
- Constant Field Values
-
-
Method Detail
-
getComment
String getComment()
-
setComment
void setComment(String comment)
-
getMaxAge
int getMaxAge()
-
setMaxAge
void setMaxAge(int maxAge)
-
isSecure
boolean isSecure()
-
setSecure
void setSecure(boolean secure)
-
getVersion
int getVersion()
-
setVersion
void setVersion(int version)
-
setHttpOnly
void setHttpOnly(boolean httpOnly)
-
isHttpOnly
boolean isHttpOnly()
-
setSameSite
void setSameSite(Cookie.SameSiteOptions sameSite)
-
getSameSite
Cookie.SameSiteOptions getSameSite()
-
saveTo
void saveTo(HttpServletRequest request, HttpServletResponse response)
-
removeFrom
void removeFrom(HttpServletRequest request, HttpServletResponse response)
-
readValue
String readValue(HttpServletRequest request, HttpServletResponse response)
-
-