public class CookieGenerator extends ObjectSE
CookieLocaleResolver や CookieThemeResolver などの特定の Cookie を生成するコンポーネントの基本クラスとして機能できます。
addCookie(javax.servlet.http.HttpServletResponse, java.lang.String)
, removeCookie(javax.servlet.http.HttpServletResponse)
, CookieLocaleResolver
, CookieThemeResolver
修飾子と型 | フィールドと説明 |
---|---|
static StringSE | DEFAULT_COOKIE_PATH Cookie が表示されるデフォルトのパス: "/"、つまり |
protected Log | logger |
コンストラクターと説明 |
---|
CookieGenerator() |
修飾子と型 | メソッドと説明 |
---|---|
void | addCookie(HttpServletResponseEE response, StringSE cookieValue) このジェネレーターの Cookie 記述子設定を使用して、指定された値の Cookie をレスポンスに追加します。 |
protected CookieEE | createCookie(StringSE cookieValue) このジェネレーターの Cookie 記述子設定 ( "cookieMaxAge" を除く) を使用して、指定された値の Cookie を作成します。 |
StringSE | getCookieDomain() このジェネレーターによって作成された Cookie がある場合は、そのドメインを返します。 |
IntegerSE | getCookieMaxAge() このジェネレーターによって作成された Cookie の最大経過時間を返します。 |
StringSE | getCookieName() このジェネレーターによって作成された Cookie の名前を返します。 |
StringSE | getCookiePath() このジェネレーターによって作成された Cookie のパスを返します。 |
boolean | isCookieHttpOnly() Cookie が "HttpOnly" 属性でマークされることになっているかどうかを返します。 |
boolean | isCookieSecure() Cookie を HTTPS(SSL)などの安全なプロトコルを使用してのみ送信するかどうかを返します。 |
void | removeCookie(HttpServletResponseEE response) このジェネレーターが記述する Cookie をレスポンスから削除します。 |
void | setCookieDomain(StringSE cookieDomain) このジェネレーターによって作成された Cookie には、指定されたドメインを使用します。 |
void | setCookieHttpOnly(boolean cookieHttpOnly) Cookie が "HttpOnly" 属性でマークされることになっているかどうかを設定します。 |
void | setCookieMaxAge(IntegerSE cookieMaxAge) このジェネレーターによって作成された Cookie には、指定された最大経過時間(秒単位)を使用します。 |
void | setCookieName(StringSE cookieName) このジェネレーターによって作成された Cookie には、指定された名前を使用してください。 |
void | setCookiePath(StringSE cookiePath) このジェネレーターによって作成された Cookie には、指定されたパスを使用します。 |
void | setCookieSecure(boolean cookieSecure) HTTPS(SSL)などの安全なプロトコルを使用してのみ Cookie を送信するかどうかを設定します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public static final StringSE DEFAULT_COOKIE_PATH
protected final Log logger
public void setCookieName(@Nullable StringSE cookieName)
Cookie.getName()
EEpublic void setCookieDomain(@Nullable StringSE cookieDomain)
@Nullable public StringSE getCookieDomain()
public void setCookiePath(StringSE cookiePath)
public StringSE getCookiePath()
public void setCookieMaxAge(@Nullable IntegerSE cookieMaxAge)
デフォルトは、サーブレットコンテナーのデフォルトを使用して、特定の最大経過時間ではありません。
public void setCookieSecure(boolean cookieSecure)
デフォルトは「false」。
public boolean isCookieSecure()
public void setCookieHttpOnly(boolean cookieHttpOnly)
デフォルトは「false」。
public boolean isCookieHttpOnly()
public void addCookie(HttpServletResponseEE response, StringSE cookieValue)
Cookie を作成するための createCookie(java.lang.String)
へのデリゲート。
response
- Cookie を追加する HTTP レスポンス cookieValue
- 追加する Cookie の値 setCookieName(java.lang.String)
, setCookieDomain(java.lang.String)
, setCookiePath(java.lang.String)
, setCookieMaxAge(java.lang.Integer)
public void removeCookie(HttpServletResponseEE response)
Cookie を作成するための createCookie(java.lang.String)
へのデリゲート。
response
- Cookie を削除する HTTP レスポンス setCookieName(java.lang.String)
, setCookieDomain(java.lang.String)
, setCookiePath(java.lang.String)
protected CookieEE createCookie(StringSE cookieValue)
cookieValue
- クレートする Cookie の値 setCookieName(java.lang.String)
, setCookieDomain(java.lang.String)
, setCookiePath(java.lang.String)