public abstract class

ServerCacheBase

extends CacheBase

java.lang.Object
↳	com.microstrategy.utils.cache.CacheBase
	↳	com.microstrategy.web.objects.ServerCacheBase

Known Direct Subclasses

ServerDefBypassAclCache, ServerDefCache

Summary

[Expand]

Inherited Constants

From class com.microstrategy.utils.cache.CacheBase

[Expand]

Inherited Fields

From class com.microstrategy.utils.cache.CacheBase

Protected Constructors
	ServerCacheBase(String pName)
	ServerCacheBase(String pName, String alias)
	ServerCacheBase(String pName, boolean useSoftReferences, int pTimeout, int pRefreshTime, String alias)
	ServerCacheBase(String pName, boolean useSoftReferences, int pTimeout, int pRefreshTime)

Protected Methods
Object	getKey(CacheHint hint) Overridable.
void	store(WebIServerSession session, Object ob)
final void	store(CacheHint hint, Object ob) Overridable.

[Expand]

Inherited Methods

From class com.microstrategy.utils.cache.CacheBase

boolean	canUpdate(CacheHint hint) Overridable.
synchronized void	clear() Clears the cache - all entries are removed.
void	close() Un-register cache from the cache registry.
synchronized void	configure(Properties prop)
boolean	contains(CacheHint hint)
void	delete(CacheHint hint) Removes object from the cache and persistent storage
Object	get(CacheHint hint) Finds and returns cached object based on the hint.
abstract Object	getKey(CacheHint hint) Overridable.
String	getName() Returns cache name.
synchronized int	getRefreshTime() Returns cache refresh time in seconds.
synchronized int	getStatisticTime() Returns the statistic frequency in seconds.
synchronized int	getTimeout() Returns cache timeout in seconds.
abstract Object	load(CacheHint hint) Overridable.
void	logStatistic() Writes cache statistic message to the log.
void	onHintClose(CacheHint hint) This method is supposed to be called by the hint object when it is closed.
void	onTimer() This method is periodically called by the cache registry.
void	put(CacheHint hint, Object ob) Puts the object in the cache.
Object	reLoad(CacheHint hint, Object ob) Overridable.
Object	refresh(CacheHint hint) Re-loads object from the persistent storage
void	remove(CacheHint hint) Removes an object from the cache.
void	save(CacheHint hint, Object ob) Puts the object in the cache and stores it in the memory.
synchronized void	setRefreshTime(int value) Sets cache refresh time in seconds.
synchronized void	setStatisticTime(int value) Sets the statistic frequency in seconds.
synchronized void	setTimeout(int value) Sets cache timeout in seconds.
synchronized int	size() Returns cache size.
void	store(CacheHint hint, Object ob) Overridable.
void	unLoad(CacheHint hint) Overridable.

From class java.lang.Object

From interface com.microstrategy.utils.cache.Cache

abstract void	clear() Clears the cache - all entries are removed.
abstract void	close() Un-register cache from the cache registry.
abstract boolean	contains(CacheHint hint)
abstract void	delete(CacheHint hint) Removes object from the cache and persistent storage
abstract Object	get(CacheHint hint) Finds and returns cached object based on the hint.
abstract String	getName() Returns cache name.
abstract void	onHintClose(CacheHint hint) This method is supposed to be called by the hint object when it is closed.
abstract void	put(CacheHint hint, Object ob) Puts the object in the cache.
abstract Object	refresh(CacheHint hint) Re-loads object from the persistent storage
abstract void	remove(CacheHint hint) Removes an object from the cache.
abstract void	save(CacheHint hint, Object ob) Puts the object in the cache and stores it in the memory.

Protected Constructors

protected ServerCacheBase (String pName)

protected ServerCacheBase (String pName, String alias)

protected ServerCacheBase (String pName, boolean useSoftReferences, int pTimeout, int pRefreshTime, String alias)

protected ServerCacheBase (String pName, boolean useSoftReferences, int pTimeout, int pRefreshTime)

Protected Methods

protected Object getKey (CacheHint hint)

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

Parameters

hint	the hint object.

Returns

the key

Throws

CacheException

protected void store (WebIServerSession session, Object ob)

Throws

CacheException

protected final void store (CacheHint hint, Object ob)

Overridable. Saves cached object in the persistent storage.

Parameters

hint	the hint object.
ob	the object to save.

Throws

CacheException

Interfaces

Classes

Enums

Exceptions

ServerCacheBase

Summary

Protected Constructors

protected ServerCacheBase (String pName)

protected ServerCacheBase (String pName, String alias)

protected ServerCacheBase (String pName, boolean useSoftReferences, int pTimeout, int pRefreshTime, String alias)

protected ServerCacheBase (String pName, boolean useSoftReferences, int pTimeout, int pRefreshTime)

Protected Methods

protected Object getKey (CacheHint hint)

Parameters

Returns

Throws

protected void store (WebIServerSession session, Object ob)

Throws

protected final void store (CacheHint hint, Object ob)

Parameters

Throws