Package org.apache.wicket.util.cookies

Class CookieUtils

java.lang.Object

org.apache.wicket.util.cookies.CookieUtils

public class CookieUtils
extends Object

Helper class to simplify Cookie handling.

Author:

Juergen Donnerstag, Jonathan Locke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SESSIONID_COOKIE_NAME

Constructor Summary

Constructors

Constructor	Description
CookieUtils()	Construct.
CookieUtils(CookieDefaults settings)	Construct.

Method Summary

Modifier and Type	Method	Description
jakarta.servlet.http.Cookie	getCookie(String name)	Gets the cookie with 'name' attached to the latest WebRequest.
protected String	getKey(FormComponent<?> component)	This method gets used when a cookie key needs to be derived from a form component.
protected String	getSaveKey(String key)	Make sure the 'key' does not contain any illegal chars.
String	getSessionIdCookieName(WebApplication application)	Gets the name of the cookie where the session id is stored.
final CookieDefaults	getSettings()
protected void	initializeCookie(jakarta.servlet.http.Cookie cookie)	Is called before the Cookie is saved.
final String	load(String key)	Retrieve the cookie value by means of its key.
final String	load(FormComponent<?> formComponent)	Retrieve the cookie value associated with the formComponent and load the model object with the cookie value.
final void	remove(String key)	Remove the cookie identified by the key
final void	remove(FormComponent<?> formComponent)	Remove the cookie identified by the form component
final void	save(String name, String value)	Create a Cookie with key and value and save it in the browser with the next response
final void	save(FormComponent<?> formComponent)	Save the form components model value in a cookie
static void	setAttribute(jakarta.servlet.http.Cookie cookie, String attributeName, String attributeValue)	Sets a custom attribute on Servlet 6+

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_SESSIONID_COOKIE_NAME

public static final String DEFAULT_SESSIONID_COOKIE_NAME

See Also:

• Constant Field Values

Constructor Details

CookieUtils

public CookieUtils()

Construct.

CookieUtils

public CookieUtils(CookieDefaults settings)

Construct.

Parameters:

settings - the default settings for the saved cookies

Method Details

getSettings

public final CookieDefaults getSettings()

Returns:

Gets the settings for these utils

remove

public final void remove(String key)

Remove the cookie identified by the key

Parameters:

key - The cookie name

remove

public final void remove(FormComponent<?> formComponent)

Remove the cookie identified by the form component

Parameters:

formComponent -

getKey

protected String getKey(FormComponent<?> component)

This method gets used when a cookie key needs to be derived from a form component. By default the component's page relative path is used.

Parameters:

component -

Returns:

cookie key

load

public final String load(String key)

Retrieve the cookie value by means of its key.

Parameters:

key - The cookie name

Returns:

The cookie value associated with the key

load

public final String load(FormComponent<?> formComponent)

Retrieve the cookie value associated with the formComponent and load the model object with the cookie value.

Parameters:

formComponent -

Returns:

The Cookie value which has also been used to set the component's model value

save

public final void save(String name,
 String value)

Create a Cookie with key and value and save it in the browser with the next response

Parameters:

name - The cookie name

value - The cookie value

save

public final void save(FormComponent<?> formComponent)

Save the form components model value in a cookie

Parameters:

formComponent -

getSaveKey

protected String getSaveKey(String key)

Make sure the 'key' does not contain any illegal chars. E.g. for cookies ':' is not allowed.

Parameters:

key - The key to be validated

Returns:

The save key

getCookie

public jakarta.servlet.http.Cookie getCookie(String name)

Gets the cookie with 'name' attached to the latest WebRequest.

Parameters:

name - The name of the cookie to be looked up

Returns:

Any cookies for this request

getSessionIdCookieName

public String getSessionIdCookieName(WebApplication application)

Gets the name of the cookie where the session id is stored.

Parameters:

application - The current we application holding the ServletContext.

Returns:

The name set in SessionCookieConfig or the default value 'JSESSIONID' if not set

initializeCookie

protected void initializeCookie(jakarta.servlet.http.Cookie cookie)

Is called before the Cookie is saved. May be subclassed for different (dynamic) Cookie parameters. Static parameters can also be changed via CookieDefaults.

Parameters:

cookie -

setAttribute

public static void setAttribute(jakarta.servlet.http.Cookie cookie,
 String attributeName,
 String attributeValue)

Sets a custom attribute on Servlet 6+

Parameters:

cookie - The cookie to set the attribute on

attributeName - The name of the attribute

attributeValue - The value of the attribute