Top Description Inners Fields Constructors Methods
org.keycloak.common.util

public Class ServerCookie

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@Deprecated
Imports
java.io.Serializable, java.text.DateFormat, .FieldPosition, .SimpleDateFormat, java.util.Date, .Locale, .TimeZone

Deprecated

Should not be used on the Keycloak server-side, or in extensions. Will be removed when no longer used by adapters

Server-side cookie representation. borrowed from Tomcat.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
private static final String
public static final TimeZone
GMT_ZONE

GMT timezone - all HTTP dates are on GMT

private static final Locale
LOCALE_US

US locale - all HTTP dates are in english

private static final String
private static final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static boolean
public static void
appendCookieValue(StringBuilder headerBuf, int version, String name, String value, String path, String domain, String comment, int maxAge, boolean isSecure, boolean httpOnly, ServerCookie.SameSiteAttributeValue sameSite)

public static boolean
checkName(String name)

Deprecated - Not used
public static boolean
containsCTL(String value, int version)

private static String

Returns:

The (possibly) escaped string
escapeDoubleQuotes
(String
the input string
s
,
int
start index inclusive
beginIndex
,
int
exclusive
endIndex
)

Escapes any double quotes in the given string.

public static String
public static void
public static String
getCookieHeaderName(int version)

Return the header name to set the cookie, based on cookie version.

public static boolean
isToken(String value)

public static boolean
public static void
maybeQuote(int version, StringBuffer buf, String value)

Deprecated - Not used
public static void
maybeQuote2(int version, StringBuffer buf, String value)

Quotes values using rules that vary depending on Cookie version.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ancientDateback to summary
private static final String ancientDate
GMT_ZONEback to summary
public static final TimeZone GMT_ZONE

GMT timezone - all HTTP dates are on GMT

LOCALE_USback to summary
private static final Locale LOCALE_US

US locale - all HTTP dates are in english

tspecialsback to summary
private static final String tspecials
tspecials2back to summary
private static final String tspecials2

Constructor Detail

ServerCookieback to summary
public ServerCookie()

Method Detail

alreadyQuotedback to summary
public static boolean alreadyQuoted(String value)
appendCookieValueback to summary
public static void appendCookieValue(StringBuilder headerBuf, int version, String name, String value, String path, String domain, String comment, int maxAge, boolean isSecure, boolean httpOnly, ServerCookie.SameSiteAttributeValue sameSite)
checkNameback to summary
public static boolean checkName(String name)

Deprecated

- Not used

containsCTLback to summary
public static boolean containsCTL(String value, int version)
escapeDoubleQuotesback to summary
private static String escapeDoubleQuotes(String s, int beginIndex, int endIndex)

Escapes any double quotes in the given string.

Parameters
s:String

the input string

beginIndex:int

start index inclusive

endIndex:int

exclusive

Returns:String

The (possibly) escaped string

formatOldCookieback to summary
public static String formatOldCookie(Date d)
formatOldCookieback to summary
public static void formatOldCookie(Date d, StringBuffer sb, FieldPosition fp)
getCookieHeaderNameback to summary
public static String getCookieHeaderName(int version)

Return the header name to set the cookie, based on cookie version.

isTokenback to summary
public static boolean isToken(String value)
isToken2back to summary
public static boolean isToken2(String value)
maybeQuoteback to summary
public static void maybeQuote(int version, StringBuffer buf, String value)

Deprecated

- Not used

Annotations
@Deprecated
maybeQuote2back to summary
public static void maybeQuote2(int version, StringBuffer buf, String value)

Quotes values using rules that vary depending on Cookie version.

org.keycloak.common.util back to summary

public final Enum ServerCookie.SameSiteAttributeValue

extends Enum<ServerCookie.SameSiteAttributeValue>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ServerCookie.SameSiteAttributeValue
public static final ServerCookie.SameSiteAttributeValue
private final String
public static final ServerCookie.SameSiteAttributeValue

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.
public static ServerCookie.SameSiteAttributeValue
public static ServerCookie.SameSiteAttributeValue[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

LAXback to summary
public static final ServerCookie.SameSiteAttributeValue LAX
NONEback to summary
public static final ServerCookie.SameSiteAttributeValue NONE
specValueback to summary
private final String specValue
STRICTback to summary
public static final ServerCookie.SameSiteAttributeValue STRICT

Constructor Detail

SameSiteAttributeValueback to summary
private SameSiteAttributeValue(String specValue)

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static ServerCookie.SameSiteAttributeValue valueOf(String name)
valuesback to summary
public static ServerCookie.SameSiteAttributeValue[] values()