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

Constructor Summary

CookieUtils()
Construct.

CookieUtils(CookieDefaults settings)
Construct.

Method Summary

javax.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.
CookieDefaults	getSettings()
protected void	initializeCookie(javax.servlet.http.Cookie cookie) Is called before the Cookie is saved.
protected String	joinValues(String... values) Deprecated. Cookies with multiple values are no more supported (WICKET-5648). This method will be removed in Wicket 7.x
String	load(FormComponent<?> formComponent) Retrieve the cookie value associated with the formComponent and load the model object with the cookie value.
String	load(String key) Retrieve the cookie value by means of its key.
void	remove(FormComponent<?> formComponent) Remove the cookie identified by the form component
void	remove(String key) Remove the cookie identified by the key
void	save(FormComponent<?> formComponent) Save the form components model value in a cookie
void	save(String key, String... values) Create a Cookie with key and value and save it in the browser with the next response
protected String[]	splitValue(String value) Deprecated. Cookies with multiple values are no more supported (WICKET-5648). This method will be removed in Wicket 7.x

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieUtils

public CookieUtils()

Construct.

CookieUtils

public CookieUtils(CookieDefaults settings)

Construct.

Parameters:

settings - the default settings for the saved cookies

Method Detail

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

splitValue

@Deprecated
protected String[] splitValue(String value)

Deprecated. Cookies with multiple values are no more supported (WICKET-5648). This method will be removed in Wicket 7.x

Split the loaded Cookie value

Parameters:

value -

Returns:

The cookie's value split into fragments

joinValues

@Deprecated
protected String joinValues(String... values)

Deprecated. Cookies with multiple values are no more supported (WICKET-5648). This method will be removed in Wicket 7.x

Join all fragments into one Cookie value

Parameters:

values -

Returns:

The cookie's value split into its constituent parts

save

public final void save(String key,
                       String... values)

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

Parameters:

key - The cookie name

values - The cookie values

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 javax.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

initializeCookie

protected void initializeCookie(javax.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 -