Package com.microstrategy.web.objects

Class SessionCacheBase

java.lang.Object

com.microstrategy.utils.cache.CacheBase

com.microstrategy.web.objects.SessionCacheBase

All Implemented Interfaces:

Cache

Direct Known Subclasses:

DataServerConnectionInfoCache

public abstract class SessionCacheBase
extends CacheBase

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from class com.microstrategy.utils.cache.CacheBase

alias, DEFAULT_FILE_REFRESH_TIME, DEFAULT_REFRESH_TIME, DEFAULT_STATISTIC_TIME, DEFAULT_SYS_TIMEOUT, DEFAULT_USER_TIMEOUT, NO_KEY, NO_REFRESH, NO_STATISTIC, NO_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SessionCacheBase(java.lang.String pName)
protected	SessionCacheBase(java.lang.String pName, boolean useSoftReferences)
protected	SessionCacheBase(java.lang.String pName, boolean useSoftReferences, int timeout)
protected	SessionCacheBase(java.lang.String pName, boolean useSoftReferences, int timeout, java.lang.String alias)
protected	SessionCacheBase(java.lang.String pName, boolean useSoftReferences, java.lang.String alias)
protected	SessionCacheBase(java.lang.String pName, java.lang.String alias)

Method Summary

Modifier and Type	Method	Description
protected boolean	canLoadFromPersistentStore(CacheHint hint)	Dictates whether load access to persistent storage is permitted.
protected boolean	canUpdate(CacheHint hint)	Overridable.
protected java.lang.Object	getKey(CacheHint hint)	Overridable.
void	onHintClose(CacheHint hint)	This method is supposed to be called by the hint object when it is closed.

Methods inherited from class com.microstrategy.utils.cache.CacheBase

clear, close, configure, contains, delete, get, getName, getRefreshTime, getStatisticTime, getTimeout, getWithoutRefresh, load, logStatistic, onTimer, put, refresh, reLoad, remove, save, setRefreshTime, setStatisticTime, setTimeout, size, store, unLoad

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionCacheBase

protected SessionCacheBase(java.lang.String pName,
                           boolean useSoftReferences,
                           int timeout)

Since:

MicroStrategy Web 9.0.0

SessionCacheBase

protected SessionCacheBase(java.lang.String pName,
                           boolean useSoftReferences,
                           int timeout,
                           java.lang.String alias)

Since:

MicroStrategy Web 9.0.0

SessionCacheBase

protected SessionCacheBase(java.lang.String pName,
                           boolean useSoftReferences)

Since:

MicroStrategy Web 8.0.1

SessionCacheBase

protected SessionCacheBase(java.lang.String pName,
                           boolean useSoftReferences,
                           java.lang.String alias)

Since:

MicroStrategy Web 9.0.0

SessionCacheBase

protected SessionCacheBase(java.lang.String pName,
                           java.lang.String alias)

Since:

MicroStrategy Web 9.0.0

SessionCacheBase

protected SessionCacheBase(java.lang.String pName)

Method Detail

getKey

protected java.lang.Object getKey(CacheHint hint)
                           throws CacheException

Description copied from class: CacheBase

Overridable. Extracts from the hint object the key that shall be used to identify the cached object.

Specified by:

getKey in class CacheBase

Parameters:

hint - the hint object.

Returns:

the key

Throws:

CacheException - if somethig gos wrong.

canUpdate

protected boolean canUpdate(CacheHint hint)
                     throws CacheException

Description copied from class: CacheBase

Overridable. Returns true if the hint allows updates. Default implementation always returns true.

Overrides:

canUpdate in class CacheBase

Parameters:

hint - the hint object.

Returns:

true if the hint allows updates.

Throws:

CacheException

canLoadFromPersistentStore

protected boolean canLoadFromPersistentStore(CacheHint hint)
                                      throws CacheException

Dictates whether load access to persistent storage is permitted.

Throws:

CacheException

onHintClose

public void onHintClose(CacheHint hint)

Description copied from interface: Cache

This method is supposed to be called by the hint object when it is closed. Cache implementations shall use this call to perform proper cache cleanup.

Specified by:

onHintClose in interface Cache

Overrides:

onHintClose in class CacheBase

Parameters:

hint - the hint object.