public interface

GenericCookie

com.microstrategy.web.platform.GenericCookie
Known Indirect Subclasses

Class Overview

This class represents the features and functionality exposed by a generic Cookie object--independent of the contained web container (e.g., either Java or ASP).

Summary

Public Methods
abstract int getMaxAge()
Returns the maximum age of the current cookie.
abstract String getName()
Returns the name of the cookie.
abstract String getNativeName()
Returns the native cookie name.
abstract String getNativeValue()
Returns the native cookie value.
abstract String getPath()
Returns the path associated with the current cookie.
abstract String getValue()
Returns the value of the cookie.
abstract boolean isHttpOnly()
Set the http only flag
abstract 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.
abstract void setHttpOnly(boolean value)
get the http only flag
abstract void setMaxAge(int maxAge)
Set the maximum age for a cookie.
abstract void setPath(String path)
This method modifies the path associated with the cookie.
abstract void setSecure(boolean value)
Sets the security level of a cookie
abstract void setValue(String value)
This method modifies the value of the cookie in current namespace.

Public Methods

public abstract int getMaxAge ()

Returns the maximum age of the current cookie.

Returns
  • the maximum age of the current cookie.

public abstract 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 abstract 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 abstract 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 abstract String getPath ()

Returns the path associated with the current cookie.

Returns
  • the path associated with the current cookie.

public abstract 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 abstract boolean isHttpOnly ()

Set the http only flag

Returns
  • true means this cookie is http only

public abstract 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 abstract void setHttpOnly (boolean value)

get the http only flag

public abstract void setMaxAge (int maxAge)

Set the maximum age for a cookie.

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

public abstract void setPath (String path)

This method modifies the path associated with the cookie.

Parameters
path The String for the path.

public abstract 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 abstract 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.