com.adobe.cq.commerce.common

Class CookieUtil

java.lang.Object

com.adobe.cq.commerce.common.CookieUtil

public class CookieUtil
extends java.lang.Object

The CookieUtil helps in working with cookies on request/response objects.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	HTTP_ONLY
static java.lang.String	SESSION_COOKIE

Constructor Summary

Constructors

Constructor and Description
CookieUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.List<org.apache.commons.httpclient.Cookie>	getSessionCookies(javax.servlet.http.HttpServletRequest request, java.lang.String prefix, java.lang.String remoteHost) Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities
static boolean	hasSessionCookie(java.util.List<org.apache.commons.httpclient.Cookie> cookies) Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities
static boolean	hasUpdatedSessionCookies(org.apache.commons.httpclient.HttpMethod method) Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities
static java.lang.String	hostFromUrl(java.lang.String url) Extracts the host from a given URL.
static void	setCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String name, java.lang.String value, int maxAge, boolean httpOnly) Sets a cookie into the current response.
static void	setSessionCookies(javax.servlet.http.HttpServletResponse response, java.lang.String prefix, java.util.List<org.apache.commons.httpclient.Cookie> cookies) Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_COOKIE

public static final java.lang.String SESSION_COOKIE

See Also:

Constant Field Values

HTTP_ONLY

public static final boolean HTTP_ONLY

See Also:

Constant Field Values

Constructor Detail

CookieUtil

public CookieUtil()

Method Detail

setCookie

public static void setCookie(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             java.lang.String name,
                             java.lang.String value,
                             int maxAge,
                             boolean httpOnly)

Sets a cookie into the current response.

Parameters:

request - The current request.

response - The current response.

name - The cookie name.

value - The cookie value.

maxAge - The expiry (in seconds from now). Pass -1 for no expiry, 0 to remove the cookie immediately.

httpOnly - Indicates the cookie should be accessible only from the server.

hostFromUrl

public static java.lang.String hostFromUrl(java.lang.String url)

Extracts the host from a given URL. This utility method can be used for creating cookies to be set on requests to a remote server.

Parameters:

url - A URL

Returns:

Host part of URL or null for an invalid URL.

getSessionCookies

@Deprecated
public static java.util.List<org.apache.commons.httpclient.Cookie> getSessionCookies(javax.servlet.http.HttpServletRequest request,
                                                                                                 java.lang.String prefix,
                                                                                                 java.lang.String remoteHost)

Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities

Decodes and returns cookies with defined session prefix.

Parameters:

request - The request from which to read the cookies.

prefix - A name prefix filter.

Returns:

A List of cookies matching the prefix filter.

setSessionCookies

@Deprecated
public static void setSessionCookies(javax.servlet.http.HttpServletResponse response,
                                                 java.lang.String prefix,
                                                 java.util.List<org.apache.commons.httpclient.Cookie> cookies)

Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities

Encodes and sets the provided cookies on the response.

Parameters:

response - The response to which the cookies are to be written.

prefix - A string to be prefixed to each cookie name.

cookies - The list of cookies.

hasUpdatedSessionCookies

@Deprecated
public static boolean hasUpdatedSessionCookies(org.apache.commons.httpclient.HttpMethod method)

Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities

Checks if there are any session cookies in the HTTP method's response.

Parameters:

method - The executed HTTP method.

Returns:

true if response contains session cookies. false otherwise.

hasSessionCookie

@Deprecated
public static boolean hasSessionCookie(java.util.List<org.apache.commons.httpclient.Cookie> cookies)

Deprecated. since 6.1; Apache httpClient 3.x has been EOLed and contains security vulnerabilities

Checks to see if there is a session cookie in the list.

Parameters:

cookies - The list of cookies.

Returns:

true if cookies contains a session cookie.