com.hcl.voltmx.middleware.session

Interface Session

All Superinterfaces:

Serializable

public interface Session
extends Serializable

An abstraction over the actual server session which may or may not have an underlying HTTP session.

Method Summary

Modifier and Type	Method and Description
void	addEISCookie(org.apache.http.cookie.Cookie cookie) Adds the cookie to the session.
void	addEISCookie(String name, String value) Adds the cookie to the session.
void	addEISCookie(String name, String value, String path, String domain, boolean secure) Adds the cookie to the session.
void	addEISCookie(String name, String value, String path, String domain, boolean secure, Date expiryDate) Adds the cookie to the session.
void	addEISCookies(List<org.apache.http.cookie.Cookie> cookieList) Adds the list of cookies to the session.
boolean	containsKey(String name) Gets whether an attribute (an Object scoped to this session) exists or not.
Object	getAttribute(String name) Gets an attribute value, an Object previously stored in the scope of this session.
Enumeration<?>	getAttributeNames() Gets name of all the attributes stored in the scope of this session.
long	getCreationTime() Gets the session creation time.
org.apache.http.cookie.Cookie	getEISCookieByName_Domain_Path(String name, String domain, String path) Gets the cookie with the specified name, domain and path.
org.apache.http.cookie.Cookie	getEISCookieByName(String name) Gets the cookie with the specified name from the session.
List<org.apache.http.cookie.Cookie>	getEISCookies() Gets a read-only copy of list of cookies present in this session.
String	getId() Gets the session Id.
long	getLastAccessedTime() Gets the time when the session was last accessed.
long	getMaxInactiveInterval() Gets the maximum time the session can be inactive.
void	invalidate() Invalidates the session.
void	removeAttribute(String name) Removes the specified attribute from session, if a attribute by that name exists.
void	removeEISCookieFromSession(org.apache.http.cookie.Cookie cookie) Remove the cookie from the session cookies.
void	removeEISCookiesFromSession(List<org.apache.http.cookie.Cookie> cookies) Removes all the cookies in the list from the session cookies.
void	setAttribute(String name, Object value) Sets an attribute value, an Object storied in the scope of this session.
void	setMaxInactiveInterval(int interval) Sets the maximum inactive interval to the specified value.

Method Detail

getAttribute

Object getAttribute(String name)

Gets an attribute value, an Object previously stored in the scope of this session.

Parameters:

name - The attribute name

Returns:

The attribute value if it exists, null otherwise

getCreationTime

long getCreationTime()

Gets the session creation time. This is not supported when cache is used.

Returns:

long, time in epoch seconds

getId

String getId()

Gets the session Id. This is not supported when cache is used.

Returns:

The session Id

getLastAccessedTime

long getLastAccessedTime()

Gets the time when the session was last accessed. This is not supported when cache is used.

Returns:

long, time in epoch seconds

getMaxInactiveInterval

long getMaxInactiveInterval()

Gets the maximum time the session can be inactive. This is not supported when cache is used.

Returns:

long, time in epoch seconds

invalidate

void invalidate()

Invalidates the session.

removeAttribute

void removeAttribute(String name)

Removes the specified attribute from session, if a attribute by that name exists.

Parameters:

name - The name of the attribute to remove

setAttribute

void setAttribute(String name,
                  Object value)

Sets an attribute value, an Object storied in the scope of this session.

Parameters:

name - The attribute name

value - The attribute value

setMaxInactiveInterval

void setMaxInactiveInterval(int interval)

Sets the maximum inactive interval to the specified value. This is not supported when cache is used.

Parameters:

interval - The interval

containsKey

boolean containsKey(String name)

Gets whether an attribute (an Object scoped to this session) exists or not.

Parameters:

name - The attribute name

Returns:

True if the attribute with given name exists, false otherwise

See Also:

getAttribute(String), setAttribute(String, Object)

getAttributeNames

Enumeration<?> getAttributeNames()

Gets name of all the attributes stored in the scope of this session.

Returns:

Name of all attributes

getEISCookies

List<org.apache.http.cookie.Cookie> getEISCookies()

Gets a read-only copy of list of cookies present in this session.

Returns:

List of all cookies

getEISCookieByName

org.apache.http.cookie.Cookie getEISCookieByName(String name)

Gets the cookie with the specified name from the session.

Parameters:

name - The name of the cookie to get

Returns:

Cookie with the given name if exists, null otherwise

getEISCookieByName_Domain_Path

org.apache.http.cookie.Cookie getEISCookieByName_Domain_Path(String name,
                                                             String domain,
                                                             String path)

Gets the cookie with the specified name, domain and path.

Parameters:

name - The name of the cookie to get

domain - The domain of the cookie to get

path - The path of the cookie to get

Returns:

Cookie with matching name, domain and path if exists, null otherwise

addEISCookies

void addEISCookies(List<org.apache.http.cookie.Cookie> cookieList)

Adds the list of cookies to the session. All cookies are passed in subsequent request based on domain, path and expiry date.

Parameters:

cookieList - The list of cookies to add

addEISCookie

void addEISCookie(org.apache.http.cookie.Cookie cookie)

Adds the cookie to the session. All cookies are passed in subsequent request based on domain, path and expiry date.

Parameters:

cookie - The cookie to add

addEISCookie

void addEISCookie(String name,
                  String value)

Adds the cookie to the session. All cookies are passed in subsequent request based on domain, path and expiry date.

Parameters:

name - The name of the cookie to add

value - The value of the cookie to add

addEISCookie

void addEISCookie(String name,
                  String value,
                  String path,
                  String domain,
                  boolean secure)

Adds the cookie to the session. All cookies are passed in subsequent request based on domain, path and expiry date.

Parameters:

name - The name of the cookie to add

value - The value of the cookie to add

path - The path of the cookie to add

domain - The domain of the cookie to add

secure - Whether the cookie is secure or not

addEISCookie

void addEISCookie(String name,
                  String value,
                  String path,
                  String domain,
                  boolean secure,
                  Date expiryDate)

Adds the cookie to the session. All cookies are passed in subsequent request based on domain, path and expiry date.

Parameters:

name - The name of the cookie to add

value - The value of the cookie to add

path - The path of the cookie to add

domain - The domain of the cookie to add

secure - Whether the cookie is secure or not

expiryDate - The expiry date of the cookie to add

removeEISCookieFromSession

void removeEISCookieFromSession(org.apache.http.cookie.Cookie cookie)

Remove the cookie from the session cookies.

Parameters:

cookie - The cookie to remove

removeEISCookiesFromSession

void removeEISCookiesFromSession(List<org.apache.http.cookie.Cookie> cookies)

Removes all the cookies in the list from the session cookies.

Parameters:

cookies - The list of cookies to remove