org.gatein.wsrp.handler

Class CookieUtil

java.lang.Object

org.gatein.wsrp.handler.CookieUtil

public class CookieUtil
extends Object

Version:

$Revision$

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CookieUtil.Cookie An internal representation of Cookie metadata, able to be serialized across cluster nodes (javax.servlet.http.Cookie is not Serializable).

Field Summary

Fields

Modifier and Type	Field and Description
static String	COOKIE
static String	SET_COOKIE

Constructor Summary

Constructors

Constructor and Description
CookieUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static List<String>	asExternalFormList(List<CookieUtil.Cookie> cookies) Converts the specified internal Cookie representations into a list of String representations, ready to be sent over the wire.
static String	coalesceAndExternalizeCookies(List<CookieUtil.Cookie> cookies) Coalesce the list of specified cookies into a single String representation suitable to be used as part of an HTTP response
static String	coalesceCookies(List<String> cookies) Coalesce several externalized Cookies into one and returning the resulting concatenated String.
static javax.servlet.http.Cookie	convertFrom(CookieUtil.Cookie cookie) Converts the specified internal Cookie into a javax.servlet.http.Cookie object.
static List<CookieUtil.Cookie>	extractCookiesFrom(URL remoteAddress, List<String> cookieValues) Extract cookies from the specified list of String representation of cookies, validating them to check if they are valid for the domain associated with the specified URL.
static List<CookieUtil.Cookie>	purgeExpiredCookies(List<CookieUtil.Cookie> cookies) Purges the expired cookies in the specified array.

Methods inherited from class java.lang.Object

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

Field Detail

SET_COOKIE

public static final String SET_COOKIE

See Also:

Constant Field Values

COOKIE

public static final String COOKIE

See Also:

Constant Field Values

Constructor Detail

CookieUtil

public CookieUtil()

Method Detail

extractCookiesFrom

public static List<CookieUtil.Cookie> extractCookiesFrom(URL remoteAddress,
                                         List<String> cookieValues)

Extract cookies from the specified list of String representation of cookies, validating them to check if they are valid for the domain associated with the specified URL.

Parameters:

remoteAddress - the address from which the cookies are supposed to be issued

cookieValues - a list of String representation of cookies

Returns:

a list of CookieUtil.Cookie objects providing the cookie information extracted from the String representations

coalesceAndExternalizeCookies

public static String coalesceAndExternalizeCookies(List<CookieUtil.Cookie> cookies)

Coalesce the list of specified cookies into a single String representation suitable to be used as part of an HTTP response

Parameters:

cookies - the cookies to be output to external form

Returns:

a String representation of the cookies, ready to be sent over the wire.

asExternalFormList

public static List<String> asExternalFormList(List<CookieUtil.Cookie> cookies)

Converts the specified internal Cookie representations into a list of String representations, ready to be sent over the wire.

Parameters:

cookies - the internal Cookies to be output to external form

Returns:

a list of String representations of the input Cookies, one per Cookie

coalesceCookies

public static String coalesceCookies(List<String> cookies)

Coalesce several externalized Cookies into one and returning the resulting concatenated String.

Parameters:

cookies - the array containing the values of the different externalized Cookies to be coalesced

Returns:

the concatenated value that could be used as one externalized Cookie or an empty String

convertFrom

public static javax.servlet.http.Cookie convertFrom(CookieUtil.Cookie cookie)

Converts the specified internal Cookie into a javax.servlet.http.Cookie object.

Parameters:

cookie - the internal Cookie to be converted

Returns:

a javax.servlet.http.Cookie corresponding to the internal representation

purgeExpiredCookies

public static List<CookieUtil.Cookie> purgeExpiredCookies(List<CookieUtil.Cookie> cookies)

Purges the expired cookies in the specified array.

Parameters:

cookies - the cookies to be purged

Returns:

an array of Cookies containing only still valid cookies