protected class

AbstractConfigurableContainerServices.CookieWrapper

extends Object
implements GenericCookie
java.lang.Object
   ↳ com.microstrategy.web.platform.AbstractConfigurableContainerServices.CookieWrapper

Class Overview

A implementation of GenericCookies.

Summary

Public Constructors
CookieWrapper(String name, String wholeValue, ContainerServicesNamespace namespace)
Public Methods
int getMaxAge()
Returns the maximum age of the current cookie.
String getName()
Returns the name of the cookie.
String getNativeName()
Returns the native cookie name.
String getNativeValue()
Returns the native cookie value.
String getPath()
Returns the path associated with the current cookie.
String getValue()
Returns the value of the cookie.
boolean isHttpOnly()
Set the http only flag
boolean isSecure()
Indicates if the client is only to return the cookie in subsequent requests if those requests use Secure Hypertext Transfer Protocol (HTTPS); The default is false.
void setHttpOnly(boolean value)
get the http only flag
void setMaxAge(int maxAge)
Set the maximum age for a cookie.
void setPath(String path)
This method modifies the path associated with the cookie.
void setSecure(boolean value)
Sets the security level of a cookie
void setValue(String value)
This method modifies the value of the cookie in current namespace.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.platform.GenericCookie

Public Constructors

public CookieWrapper (String name, String wholeValue, ContainerServicesNamespace namespace)

Public Methods

public int getMaxAge ()

Returns the maximum age of the current cookie.

Returns
  • the maximum age of the current cookie.

public String getName ()

Returns the name of the cookie.

Returns
  • A String which is the name of the cookie. In non-namespace mode, this name is the same as the native cookie name using in browser. In namespace mode, the name is the native name without MicroStrategy prefix. The namespace mode can be configured in ContainerServices.properties.

public String getNativeName ()

Returns the native cookie name.

Returns
  • The native cookie name. The native name is the cookie name that is used in Application Server's environment. If the cookie contains namespace information, the cookie name has a special MicroStrategy's prefix.

public String getNativeValue ()

Returns the native cookie value.

Returns
  • The native cookie value. The native name is the cookie value that is used in Application Server's environment. If the cookie contains namespace information, the cookie value containers all the cookie value of all namespaces.

public String getPath ()

Returns the path associated with the current cookie.

Returns
  • the path associated with the current cookie.

public String getValue ()

Returns the value of the cookie.

Returns
  • A String which is the value of the cookie. In non-namespace mode, this value is the same as the native cookie value stored in browser. In namespace mode, the value contains only the cookie value in current namespace. The namespace mode can be configured in ContainerServices.properties.

public boolean isHttpOnly ()

Set the http only flag

Returns
  • true means this cookie is http only

public boolean isSecure ()

Indicates if the client is only to return the cookie in subsequent requests if those requests use Secure Hypertext Transfer Protocol (HTTPS); The default is false.

Returns
  • true is the cookie is secure

public void setHttpOnly (boolean value)

get the http only flag

public void setMaxAge (int maxAge)

Set the maximum age for a cookie.

Parameters
maxAge The age in terms of a number of seconds.

public void setPath (String path)

This method modifies the path associated with the cookie.

Parameters
path The String for the path.

public void setSecure (boolean value)

Sets the security level of a cookie

Parameters
value true if the client is to return the cookie only if the request is using HTTPS.

public void setValue (String value)

This method modifies the value of the cookie in current namespace.

Parameters
value The String value to assign to the cookie.