DefaultSharedCache (Tammi Framework API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.norther.tammi.core.cache
Class DefaultSharedCache

java.lang.Object
  org.norther.tammi.acorn.cache.CachedMapAdapter
      org.norther.tammi.core.cache.DefaultCache
          org.norther.tammi.core.cache.DefaultSharedCache

All Implemented Interfaces:: Serializable, ConcurrentMap, Map, NotificationBroadcaster, NotificationEmitter, CachedMap, Manageable, Cache, SharedCache

public class DefaultSharedCache
extends DefaultCache
implements SharedCache, NotificationEmitter
extends DefaultCache
implements SharedCache, NotificationEmitter

A default implementation of SharedCache.

Author:: Ilkka Priha
See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map
`Map.Entry<K,V>`

Field Summary
`static String`	`SHARED_CACHE_NOTIF_DESCRIPTION` The notification description.
`static ModelMBeanNotificationInfo[]`	`SHARED_CACHE_NOTIFICATIONS` Shared cache notifications.

Fields inherited from class org.norther.tammi.core.cache.DefaultCache
`DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR`

Fields inherited from class org.norther.tammi.acorn.cache.CachedMapAdapter
`DEFAULT_EXPIRATION_SLEEP_INTERVAL, DEFAULT_EXPIRATION_TIME`

Constructor Summary
`DefaultSharedCache()` Constructs a new cache.
`DefaultSharedCache(int max)` Constructs a new cache with a max expiration time.
`DefaultSharedCache(int max, int def)` Constructs a new cache with max and default expiration times.
`DefaultSharedCache(int max, int def, int sleep)` Constructs a new cache with max and default expiration times and expiration sleep interval.
`DefaultSharedCache(int max, int def, int sleep, int capacity)` Constructs a new cache with max and default expiration times, an expiration sleep interval and initial capacity.
`DefaultSharedCache(int max, int def, int sleep, int capacity, float loadFactor)` Constructs a new cache with max and default expiration times, an expiration sleep interval, initial capacity and load factor.

Method Summary
`void`	`clear(String domain)` Clears the specified domain map.
`void`	`clearDomains()` Clears all domain caches.
`boolean`	`containsDomain(String domain)` Checks whether a domain has a cache.
`boolean`	`containsKey(String domain, Object key)` Checks a key from the specified domain map.
`boolean`	`containsValue(String domain, Object obj)` Checks a value from the specified domain map.
`Set`	`domainSet()` Returns a set of defined domains.
`Set`	`entrySet(String domain)` Gets an entry set from the specified domain map.
`Object`	`expire(String domain, Object key)` Expires and removes a value from the specified domain map.
`void`	`expireAll(String domain)` Expires all values from the specified domain map.
`void`	`expireAllDomains()` Expires all values from all domain caches.
`void`	`expireFraction(String domain, float fraction)` Expires a fraction of entries.
`Object`	`get(String domain, Object key)` Gets a value from the specified domain map.
`Object`	`get(String domain, Object key, int freq)` Gets a value from the the specified domain map and refreshes it with a specified expiration frequency.
`int`	`getDefaultExpirationTime(String domain)` Gets the default expiration time of the domain in seconds.
`CachedMap`	`getDomainCache(String domain)` Gets the cache of the specified domain.
`CachedMap`	`getDomainCache(String domain, boolean create)` Gets and optionally creates the cache of the specified domain.
`int`	`getExpirationLimit(String domain)` Gets the expiration limit in the domain.
`int`	`getExpirationSleepInterval(String domain)` Gets the expiration sleep interval of the domain in seconds.
`float`	`getExpirationThreshold(String domain)` Gets the expiration threshold in the domain.
`int`	`getMaxExpirationTime(String domain)` Gets the maximum expiration time of the domain in seconds.
`MBeanNotificationInfo[]`	`getNotificationInfo()`
`boolean`	`isAllowExpired(String domain)` Gets the allow expired option of the domain.
`boolean`	`isDiscardOverloaded(String domain)` Gets the discard overloaded option of the domain.
`boolean`	`isEmpty(String domain)` Checks if the specified domain map is empty.
`Set`	`keySet(String domain)` Gets a key set from the specified domain map.
`Object`	`put(String domain, Object key, Object obj)` Puts a value to the specified domain map.
`Object`	`put(String domain, Object key, Object obj, int freq)` Puts a value to the specified domain map with a value specific expiration frequency.
`void`	`putAll(String domain, Map map)` Puts a map to the specified domain map.
`boolean`	`refresh(String domain, Object key)` Refreshes a value in the specified domain map.
`boolean`	`refresh(String domain, Object key, int freq)` Refreshes a value in the specified domain map with a new frequency.
`Object`	`remove(String domain, Object key)` Removes a value from the specified domain map.
`void`	`removeDomain(String domain)` Removes the specified domain.
`void`	`setAllowExpired(String domain, boolean flag)` Sets the allow expired option of the domain allowing gets of entries already expired but not yet removed by the expiration handler.
`void`	`setDefaultExpirationTime(String domain, int t)` Sets the default expiration time of the domain in seconds.
`void`	`setDiscardOverloaded(String domain, boolean flag)` Sets the discard overloaded option of the domain.
`void`	`setExpirationLimit(String domain, int c)` Sets the expiration limit in the domain.
`void`	`setExpirationSleepInterval(String domain, int t)` Sets the expiration sleep interval of the domain in seconds.
`void`	`setExpirationThreshold(String domain, float h)` Gets the expiration threshold in the domain.
`void`	`setMaxExpirationTime(String domain, int t)` Sets the maximum expiration time of the domain in seconds.
`int`	`size(String domain)` Gets the size of the specified domain map.
`void`	`unmanaged()` This method is called when the implementing adaptee is unmanaged either during pre-deregistration of the corresponding adapter MBean or just before it is explicitly removed from the adapter MBean during run-time.
`Collection`	`values(String domain)` Gets a collection of values from the specified domain map.

Methods inherited from class org.norther.tammi.core.cache.DefaultCache
`addNotificationListener, getMBeanDelegate, postmanaged, premanaged, removeNotificationListener, removeNotificationListener, setAllowExpired, setDefaultExpirationTime, setDiscardOverloaded, setExpirationLimit, setExpirationSleepInterval, setExpirationThreshold, setMaxExpirationTime, toString`

Methods inherited from class org.norther.tammi.acorn.cache.CachedMapAdapter
add, add, clear, containsKey, containsValue, entrySet, equals, expire, expireAll, expireFraction, get, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getExpirationTimer, getMaxExpirationTime, getSwapOutHandler, hashCode, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, isEmpty, keySet, put, put, putAll, putIfAbsent, putIfAbsent, refresh, refresh, remove, remove, replace, replace, setAutoRefreshDeclined, setExpirationTimer, setSwapOutHandler, size, values

Methods inherited from class org.norther.tammi.acorn.cache.CachedMapAdapter

add, add, clear, containsKey, containsValue, entrySet, equals, expire, expireAll, expireFraction, get, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getExpirationTimer, getMaxExpirationTime, getSwapOutHandler, hashCode, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, isEmpty, keySet, put, put, putAll, putIfAbsent, putIfAbsent, refresh, refresh, remove, remove, replace, replace, setAutoRefreshDeclined, setExpirationTimer, setSwapOutHandler, size, values

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.norther.tammi.acorn.cache.CachedMap
`add, add, expire, expireAll, expireFraction, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getMaxExpirationTime, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, put, putIfAbsent, refresh, refresh, setAllowExpired, setAutoRefreshDeclined, setDefaultExpirationTime, setDiscardOverloaded, setExpirationLimit, setExpirationSleepInterval, setExpirationThreshold, setMaxExpirationTime`

Methods inherited from interface org.norther.tammi.acorn.cache.CachedMap

add, add, expire, expireAll, expireFraction, get, getDefaultExpirationTime, getExpirationLimit, getExpirationSleepInterval, getExpirationThreshold, getMaxExpirationTime, isAllowExpired, isAutoRefreshDeclined, isDiscardOverloaded, put, putIfAbsent, refresh, refresh, setAllowExpired, setAutoRefreshDeclined, setDefaultExpirationTime, setDiscardOverloaded, setExpirationLimit, setExpirationSleepInterval, setExpirationThreshold, setMaxExpirationTime

Methods inherited from interface java.util.concurrent.ConcurrentMap
`putIfAbsent, remove, replace, replace`

Methods inherited from interface java.util.Map
`clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values`

Methods inherited from interface javax.management.NotificationEmitter
`removeNotificationListener`

Methods inherited from interface javax.management.NotificationBroadcaster
`addNotificationListener, removeNotificationListener`

Field Detail

SHARED_CACHE_NOTIF_DESCRIPTION

public static final String SHARED_CACHE_NOTIF_DESCRIPTION

The notification description.

See Also:: Constant Field Values

SHARED_CACHE_NOTIFICATIONS

public static final ModelMBeanNotificationInfo[] SHARED_CACHE_NOTIFICATIONS

Shared cache notifications.

Constructor Detail

DefaultSharedCache

public DefaultSharedCache()

Constructs a new cache.

DefaultSharedCache

public DefaultSharedCache(int max)

Constructs a new cache with a max expiration time.

Parameters:: max - a max expiration time (0 = default, -1 = infinite).

DefaultSharedCache

public DefaultSharedCache(int max,
                          int def)

Constructs a new cache with max and default expiration times.

Parameters:: max - a max expiration time (0 = default, -1 = infinite).; def - a default expiration time (0 = default, -1 = infinite).

DefaultSharedCache

public DefaultSharedCache(int max,
                          int def,
                          int sleep)

Constructs a new cache with max and default expiration times and expiration sleep interval.

Parameters:: max - a max expiration time (0 = default, -1 = infinite).; def - a default expiration time (0 = default, -1 = infinite).; sleep - an expiration sleep interval (0 = default, -1 = infinite).

DefaultSharedCache

public DefaultSharedCache(int max,
                          int def,
                          int sleep,
                          int capacity)

Constructs a new cache with max and default expiration times, an expiration sleep interval and initial capacity.

Parameters:: max - a max expiration time (0 = default, -1 = infinite).; def - a default expiration time (0 = default, -1 = infinite).; sleep - an expiration sleep interval (0 = default, -1 = infinite).; capacity - an initial capacity.

DefaultSharedCache

public DefaultSharedCache(int max,
                          int def,
                          int sleep,
                          int capacity,
                          float loadFactor)

Constructs a new cache with max and default expiration times, an expiration sleep interval, initial capacity and load factor.

Parameters:: max - a max expiration time (0 = default, -1 = infinite).; def - a default expiration time (0 = default, -1 = infinite).; sleep - an expiration sleep interval (0 = default, -1 = infinite).; capacity - an initial capacity.; loadFactor - a load factor.

Method Detail

unmanaged

public void unmanaged()
               throws Exception

Description copied from interface: Manageable

This method is called when the implementing adaptee is unmanaged either during pre-deregistration of the corresponding adapter MBean or just before it is explicitly removed from the adapter MBean during run-time.

Specified by:: unmanaged in interface Manageable
Overrides:: unmanaged in class DefaultCache

Throws:: Exception - if the adaptee refused to be unmanaged.