oracle.cabo.share.config
Class UIXCookie

java.lang.Object
  |
  +--oracle.cabo.share.config.UIXCookie

public class UIXCookie

extends java.lang.Object

UIXCookie encapsulates the pieces of UIX global state that can be stored in a cookie. UIXCookie currently supports the following state:

• The accessibility mode chosen by the user
• The TimeZone of the user

The cookie used by UIX contains only values that have no security requirements and apply broadly and persistently. Consequently, it persists across browser sessions, and has its domain and path scoped as broadly as possible.

Method Summary

AccessibilityMode	getAccessibilityMode() Get the AccessibilityMode stored on the cookie.
java.util.TimeZone	getTimeZone() Get the TimeZone stored on the cookie.
static UIXCookie	getUIXCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Gets the UIXCookie, creating it if needed.
static UIXCookie	getUIXCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean createIfNew) Gets the UIXCookie.
void	setAccessibilityMode(AccessibilityMode accessibilityMode) Set the AccessibilityMode on the cookie.
void	setTimeZone(java.util.TimeZone zone) Set the TimeZone on the cookie.

Methods inherited from class java.lang.Object

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

Method Detail

getUIXCookie

public static UIXCookie getUIXCookie(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)

Gets the UIXCookie, creating it if needed. This method must be called before starting to write the response.

Parameters:

request - the current servlet request

response - the current servlet response

getUIXCookie

public static UIXCookie getUIXCookie(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     boolean createIfNew)

Gets the UIXCookie. If "createIfNew" is true, this method must be called before starting to write the response.

Parameters:

request - the current servlet request

response - the current servlet response

createIfNew - if true, the cookie will be created if it does not already exist; otherwise, this function will return null if no cookie is present.

getTimeZone

public java.util.TimeZone getTimeZone()

Get the TimeZone stored on the cookie.

setTimeZone

public void setTimeZone(java.util.TimeZone zone)

Set the TimeZone on the cookie.

The TimeZone cannot be a custom zone. In particular, TimeZone.getTimeZone(zone.getID()) must return the time zone.

getAccessibilityMode

public AccessibilityMode getAccessibilityMode()

Get the AccessibilityMode stored on the cookie.

setAccessibilityMode

public void setAccessibilityMode(AccessibilityMode accessibilityMode)

Set the AccessibilityMode on the cookie.