com.atlassian.jira.web.util
Class CookieUtils

java.lang.Object
  com.atlassian.jira.web.util.CookieUtils

public class CookieUtils
extends Object

This class handles utility methods for managing HTTP cookies.

Field Summary

static String

JSESSIONID session id cookie name

Constructor Summary

CookieUtils()

Method Summary

static String	cookiePathFor(javax.servlet.http.HttpServletRequest httpServletRequest) Get path for newly created cookie.
static javax.servlet.http.Cookie	createConglomerateCookie(String cookieName, Map<String,String> map, javax.servlet.http.HttpServletRequest request)
static javax.servlet.http.Cookie	createCookie(String name, String value, javax.servlet.http.HttpServletRequest currentRequest) Creat cookie with path reflecting the context path of currentRequest.
static String	getCookieValue(String cookieName, javax.servlet.http.HttpServletRequest currentRequest) Get value of cookie with given cookieName from currentRequest, or null, if the request does not have such cookie.
static String	getSingleSessionId(javax.servlet.http.Cookie[] cookies) Gets the session id as a string from the given array of Cookie objects if only one JSESSIONID cookie is found.
static boolean	hasSessionId(javax.servlet.http.Cookie[] cookies) Returns true if one or more cookies with name of JSESSIONID is found.
static Map<String,String>	parseConglomerateCookie(String cookieName, javax.servlet.http.HttpServletRequest currentRequest) Parse the key/value pairs out of a conglomerate cookie.
static void	setSessionCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String sessionId) Adds a new JSESSIONID cookie to the HTTP response if the given sessionId is not null.

Methods inherited from class java.lang.Object

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

Field Detail

JSESSIONID

public static final String JSESSIONID

session id cookie name

See Also:

Constant Field Values

Constructor Detail

CookieUtils

public CookieUtils()

Method Detail

getSingleSessionId

public static String getSingleSessionId(javax.servlet.http.Cookie[] cookies)

Gets the session id as a string from the given array of Cookie objects if only one JSESSIONID cookie is found. If none or more than one JSESSIONID cookies are found, returns null.

Parameters:

cookies - the cookies.

Returns:

session value if unique one is found.

hasSessionId

public static boolean hasSessionId(javax.servlet.http.Cookie[] cookies)

Returns true if one or more cookies with name of JSESSIONID is found.

Parameters:

cookies - an array of Cookie objects

Returns:

true if one or more sessionid cookies are found

setSessionCookie

public static void setSessionCookie(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    String sessionId)

Adds a new JSESSIONID cookie to the HTTP response if the given sessionId is not null. No cookie is set if given sessionId is null.

Parameters:

request - HTTP request

response - HTTP response

sessionId - session ID to set as a value of the cookie

cookiePathFor

public static String cookiePathFor(javax.servlet.http.HttpServletRequest httpServletRequest)

Get path for newly created cookie.

Parameters:

httpServletRequest - current request

Returns:

cookie path reflecting the current request's path

createCookie

public static javax.servlet.http.Cookie createCookie(String name,
                                                     String value,
                                                     javax.servlet.http.HttpServletRequest currentRequest)

Creat cookie with path reflecting the context path of currentRequest.

Parameters:

name - new cookie's name

value - new cookie's value

currentRequest - current request

Returns:

new cookie

getCookieValue

public static String getCookieValue(String cookieName,
                                    javax.servlet.http.HttpServletRequest currentRequest)

Get value of cookie with given cookieName from currentRequest, or null, if the request does not have such cookie.

Parameters:

cookieName - name of the cookie to retrieve

currentRequest - current request

Returns:

value of the cookie, or null, if no cookie with such name exists

parseConglomerateCookie

public static Map<String,String> parseConglomerateCookie(String cookieName,
                                                         javax.servlet.http.HttpServletRequest currentRequest)

Parse the key/value pairs out of a conglomerate cookie. The returned map will not contain empty values (zero length strings: they are discarded).

Parameters:

cookieName - the name of the cookie

currentRequest - current request

Returns:

the non-null map of key/value pairs

createConglomerateCookie

public static javax.servlet.http.Cookie createConglomerateCookie(String cookieName,
                                                                 Map<String,String> map,
                                                                 javax.servlet.http.HttpServletRequest request)