public class CookiesImpl extends Object implements Cookies
Cookies service interface.| Constructor and Description |
|---|
CookiesImpl(Request request,
CookieSource cookieSource,
CookieSink cookieSink,
String contextPath,
long defaultMaxAge) |
| Modifier and Type | Method and Description |
|---|---|
CookieBuilder |
getBuilder(String name,
String value)
Returns a
CookieBuilder to build and write a Cookie. |
String |
readCookieValue(String name)
Returns the value of the first cookie whose name matches.
|
void |
removeCookieValue(String name)
Removes a previously written cookie, by writing a new cookie with a maxAge of 0.
|
void |
writeCookieValue(String name,
String value)
Creates or updates a cookie value.
|
void |
writeCookieValue(String name,
String value,
int maxAge)
As with
Cookies.writeCookieValue(String, String) but an explicit maximum age may be set. |
void |
writeCookieValue(String name,
String value,
String path)
As with
Cookies.writeCookieValue(String, String) but an explicit path may be set. |
void |
writeCookieValue(String name,
String value,
String path,
String domain)
As with
Cookies.writeCookieValue(String, String, String) but an explicit domain and path may be set. |
void |
writeDomainCookieValue(String name,
String value,
String domain)
As with
Cookies.writeCookieValue(String, String) but an explicit domain may be set. |
void |
writeDomainCookieValue(String name,
String value,
String domain,
int maxAge)
As with
Cookies.writeCookieValue(String, String) but an explicit domain and maximum age may be set. |
public CookiesImpl(Request request, CookieSource cookieSource, CookieSink cookieSink, @Symbol(value="tapestry.context-path") String contextPath, @Symbol(value="tapestry.default-cookie-max-age") @IntermediateType(value=TimeInterval.class) long defaultMaxAge)
request - cookieSource - cookieSink - contextPath - defaultMaxAge - default cookie expiration time in millisecondspublic String readCookieValue(String name)
CookiesCookies.writeCookieValue(String, String)).readCookieValue in interface Cookiespublic void writeCookieValue(String name, String value)
Cookiesorg.apache.tapestry5.default-cookie-max-age. The factory default for this value is the equivalent of
one week.writeCookieValue in interface Cookiespublic void writeCookieValue(String name, String value, int maxAge)
CookiesCookies.writeCookieValue(String, String) but an explicit maximum age may be set.writeCookieValue in interface Cookiesname - the name of the cookievalue - the value to be stored in the cookiemaxAge - the maximum age, in seconds, to store the cookiepublic void writeCookieValue(String name, String value, String path)
CookiesCookies.writeCookieValue(String, String) but an explicit path may be set.writeCookieValue in interface Cookiespublic void writeDomainCookieValue(String name, String value, String domain)
CookiesCookies.writeCookieValue(String, String) but an explicit domain may be set.writeDomainCookieValue in interface Cookiespublic void writeDomainCookieValue(String name, String value, String domain, int maxAge)
CookiesCookies.writeCookieValue(String, String) but an explicit domain and maximum age may be set.writeDomainCookieValue in interface Cookiespublic void writeCookieValue(String name, String value, String path, String domain)
CookiesCookies.writeCookieValue(String, String, String) but an explicit domain and path may be set.writeCookieValue in interface Cookiespublic void removeCookieValue(String name)
CookiesCookieBuilder.delete().
An instance of the CookieBuilder API can be obtained with Cookies.getBuilder(String, String).removeCookieValue in interface Cookiespublic CookieBuilder getBuilder(String name, String value)
CookiesCookieBuilder to build and write a Cookie. The default
implementation creates a cookie who's value is stored using a max age (in seconds) defined by
the symbol org.apache.tapestry5.default-cookie-max-age. The factory default for
this value is the equivalent of one week. The default path is the context path (see
Request.getContextPath()) of the current Request, the default secure setting is to
send the cookie over secure channels only, if the original request was secure (see
Request.isSecure()getBuilder in interface Cookiesname - the name of the cookievalue - the value of the cookieCookieBuilder for setting additional cookie attributes and writing it out5.6.3 - Copyright © 2003-2021 The Apache Software Foundation.