com.endeca.portal.session

Class UserSession

java.lang.Object

com.endeca.portal.session.UserSession

All Implemented Interfaces:

java.io.Serializable

public class UserSession
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static void	caughtParameters(java.lang.String sessionId)
static void	clearAllCacheForExploreDataset(java.lang.String collectionKey) Clears 'Explore outside project context' cache for the given data set.
static void	clearViewTransitionParameters(java.lang.String sessionId)
java.lang.Boolean	containsChartColorMap(PinnedAttribute pinnedAttribute)
protected static UserSession	createTestInstance() Deprecated.
static boolean	deferredLoad(java.lang.String sessionId)
static java.io.Serializable	getAttribute(javax.portlet.PortletRequest request, java.lang.String key) Get an "attribute" (not to be confused with an MDEX attribute) which is a Serializable object that is shared across the whole portal.
java.io.Serializable	getAttribute(java.lang.String key) Get an "attribute" (not to be confused with an MDEX attribute) which is a Serializable object that is shared across the whole portal.
BddSecurityManager	getBddSecurityManager()
java.util.HashMap<java.lang.String,java.lang.Integer>	getChartColorMap(PinnedAttribute pinnedAttribute)
java.util.Map<java.lang.String,java.lang.Long>	getExploreProjectCache()
static UserSession	getInstance(javax.portlet.PortletRequest request) TODO: This whole method just seems a little awkward...can it be cleaned up?
java.util.Map<java.lang.String,MDEXState>	getMDEXStates()
MDEXState	getOrCreateMDEXState(java.lang.Long groupId, javax.portlet.PortletRequest request)
MDEXState	getOrCreateMDEXState(javax.portlet.PortletRequest request)
MDEXState	getOrCreateMDEXState(java.lang.String[] boundDatasets, javax.portlet.PortletRequest request)
java.lang.String	getViewTransitionParameter(java.lang.String key)
java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>>	getViewTransitionParameters()
void	putChartColorMap(PinnedAttribute pinnedAttribute, java.util.HashMap<java.lang.String,java.lang.Integer> value)
java.io.Serializable	removeAttribute(java.lang.String key) Remove an "attribute" associated with the specified key
protected static void	removeInstance(java.lang.String key)
static java.io.Serializable	setAttribute(javax.portlet.PortletRequest request, java.lang.String key, java.io.Serializable value) Set an "attribute" (not to be confused with MDEX attributes) which is a Serializable object that is shared across the whole portal.
java.io.Serializable	setAttribute(java.lang.String key, java.io.Serializable value) Set an "attribute" (not to be confused with MDEX attributes) which is a Serializable object that is shared across the whole portal.
static java.io.Serializable	setIfAbsent(javax.portlet.PortletRequest request, java.lang.String key, java.io.Serializable value) Sets an attribute if it is absent.
java.io.Serializable	setIfAbsent(java.lang.String key, java.io.Serializable value) Sets an attribute if it is absent.
void	setViewTransitionDeferred()
void	setViewTransitionParameter(java.lang.String key, java.lang.String value)
static boolean	throwingParameters(java.lang.String sessionId)
static void	unsetViewTransitionDeferred(java.lang.String sessionId)
static void	updateMDEXStatesByGroupId(java.lang.Long groupId) When add dataset to project or remove dataset from project, we need to update the change to all mdexstates by the group id

Methods inherited from class java.lang.Object

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

Method Detail

createTestInstance

@Deprecated
protected static UserSession createTestInstance()

Deprecated.

removeInstance

protected static void removeInstance(java.lang.String key)

getInstance

public static UserSession getInstance(javax.portlet.PortletRequest request)
                               throws UserSessionException

TODO: This whole method just seems a little awkward...can it be cleaned up?

Throws:

UserSessionException

getMDEXStates

public java.util.Map<java.lang.String,MDEXState> getMDEXStates()

getExploreProjectCache

public java.util.Map<java.lang.String,java.lang.Long> getExploreProjectCache()

getOrCreateMDEXState

public MDEXState getOrCreateMDEXState(javax.portlet.PortletRequest request)

getOrCreateMDEXState

public MDEXState getOrCreateMDEXState(java.lang.Long groupId,
                             javax.portlet.PortletRequest request)

getOrCreateMDEXState

public MDEXState getOrCreateMDEXState(java.lang.String[] boundDatasets,
                             javax.portlet.PortletRequest request)

getBddSecurityManager

public BddSecurityManager getBddSecurityManager()

getAttribute

public java.io.Serializable getAttribute(java.lang.String key)

Get an "attribute" (not to be confused with an MDEX attribute) which is a Serializable object that is shared across the whole portal.

removeAttribute

public java.io.Serializable removeAttribute(java.lang.String key)

Remove an "attribute" associated with the specified key

Parameters:

key -

Returns:

the object associated with the specified key

getAttribute

public static java.io.Serializable getAttribute(javax.portlet.PortletRequest request,
                                java.lang.String key)

Get an "attribute" (not to be confused with an MDEX attribute) which is a Serializable object that is shared across the whole portal. NOTE: Need a request so previous state will get deserialized on restart

updateMDEXStatesByGroupId

public static void updateMDEXStatesByGroupId(java.lang.Long groupId)

When add dataset to project or remove dataset from project, we need to update the change to all mdexstates by the group id

Parameters:

groupId -

clearAllCacheForExploreDataset

public static void clearAllCacheForExploreDataset(java.lang.String collectionKey)

Clears 'Explore outside project context' cache for the given data set. This clearing happens for all usersessions When data set security is updated, this method is called.

Parameters:

collectionKey -

setAttribute

public java.io.Serializable setAttribute(java.lang.String key,
                                java.io.Serializable value)

Set an "attribute" (not to be confused with MDEX attributes) which is a Serializable object that is shared across the whole portal.

See Also:

ConcurrentHashMap.put(Object, Object)

setAttribute

public static java.io.Serializable setAttribute(javax.portlet.PortletRequest request,
                                java.lang.String key,
                                java.io.Serializable value)

Set an "attribute" (not to be confused with MDEX attributes) which is a Serializable object that is shared across the whole portal.

See Also:

NOTE: Need a request so previous state will get deserialized on restart

setIfAbsent

public java.io.Serializable setIfAbsent(java.lang.String key,
                               java.io.Serializable value)

Sets an attribute if it is absent.

See Also:

ConcurrentHashMap.putIfAbsent(Object, Object)

setIfAbsent

public static java.io.Serializable setIfAbsent(javax.portlet.PortletRequest request,
                               java.lang.String key,
                               java.io.Serializable value)

Sets an attribute if it is absent.

See Also:

NOTE: Need a request so previous state will get deserialized on restart

containsChartColorMap

public java.lang.Boolean containsChartColorMap(PinnedAttribute pinnedAttribute)

getChartColorMap

public java.util.HashMap<java.lang.String,java.lang.Integer> getChartColorMap(PinnedAttribute pinnedAttribute)

putChartColorMap

public void putChartColorMap(PinnedAttribute pinnedAttribute,
                    java.util.HashMap<java.lang.String,java.lang.Integer> value)

getViewTransitionParameter

public java.lang.String getViewTransitionParameter(java.lang.String key)

setViewTransitionParameter

public void setViewTransitionParameter(java.lang.String key,
                              java.lang.String value)

getViewTransitionParameters

public java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> getViewTransitionParameters()

clearViewTransitionParameters

public static void clearViewTransitionParameters(java.lang.String sessionId)
                                          throws UserSessionException

Throws:

UserSessionException

throwingParameters

public static boolean throwingParameters(java.lang.String sessionId)
                                  throws UserSessionException

Throws:

UserSessionException

caughtParameters

public static void caughtParameters(java.lang.String sessionId)
                             throws UserSessionException

Throws:

UserSessionException

setViewTransitionDeferred

public void setViewTransitionDeferred()
                               throws UserSessionException

Throws:

UserSessionException

unsetViewTransitionDeferred

public static void unsetViewTransitionDeferred(java.lang.String sessionId)
                                        throws UserSessionException

Throws:

UserSessionException

deferredLoad

public static boolean deferredLoad(java.lang.String sessionId)
                            throws UserSessionException

Throws:

UserSessionException