com.atlassian.jira.web.util
Class CookieUtils

java.lang.Object
  extended by 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 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 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


Copyright © 2002-2008 Atlassian. All Rights Reserved.