|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tangosol.util.Base
com.tangosol.util.AbstractKeyBasedMap
com.tangosol.util.AbstractKeySetBasedMap
com.tangosol.util.WrapperObservableMap
com.tangosol.net.partition.ObservableSplittingBackingMap
com.tangosol.net.partition.ObservableSplittingBackingCache
public class ObservableSplittingBackingCache
The ObservableSplittingBackingCache is an implementation of the ConfigurableCacheMap interface that works as an observable backing map in a partitioned system. In other words, it acts like a LocalCache
, but it internally partitions its data across any number of caches that implement the ConfigurableCacheMap interface. Note that the underlying backing maps must implement the ConfigurableCacheMap interface or a runtime exception will occur.
Nested Class Summary | |
---|---|
protected static class |
ObservableSplittingBackingCache.CapacityAwareMap A subclass of PartitionSplittingBackingMap which allows an injected instance of ObservableSplittingBackingMap to be called immediately before inserting a value(s) in a partition map. |
class |
ObservableSplittingBackingCache.EntrySet A set of ConfigurableCacheMap entries backed by this map. |
Nested classes/interfaces inherited from class com.tangosol.util.WrapperObservableMap |
---|
WrapperObservableMap.InternalListener |
Nested classes/interfaces inherited from class com.tangosol.util.AbstractKeySetBasedMap |
---|
AbstractKeySetBasedMap.KeyIterator, AbstractKeySetBasedMap.KeySet, AbstractKeySetBasedMap.ValuesCollection |
Nested classes/interfaces inherited from class com.tangosol.util.AbstractKeyBasedMap |
---|
AbstractKeyBasedMap.DeferredCacheEvent |
Nested classes/interfaces inherited from interface com.tangosol.net.cache.ConfigurableCacheMap |
---|
ConfigurableCacheMap.Entry, ConfigurableCacheMap.EvictionApprover, ConfigurableCacheMap.EvictionPolicy, ConfigurableCacheMap.UnitCalculator |
Field Summary | |
---|---|
protected ConfigurableCacheMap[] |
m_acache A cached array of the backing ConfigurableCacheMap instances. |
protected ConfigurableCacheMap.EvictionApprover |
m_apprvrEvict An optional EvictionApprover registered with this cache. |
protected ConfigurableCacheMap.UnitCalculator |
m_calculator The unit calculator. |
protected int |
m_cExpiryDelayMillis The expiry delay. |
protected int |
m_cHighUnitFairShare The fair share of high units for each partition map. |
protected int |
m_cHighUnits High units is the number of units that triggers eviction. |
protected int |
m_cHighUnitsCalibrated The high units adjusted based on the partition unit factor . |
protected int |
m_cLowUnitFairShare The fair share of low units for each partition map. |
protected int |
m_cLowUnits Low units is the number of units to evict down to. |
protected int |
m_cLowUnitsCalibrated The low units adjusted based on the partition unit factor . |
protected java.lang.Class |
m_clzPartitionMap |
protected int |
m_nUnitFactor The unit factor. |
protected ConfigurableCacheMap.EvictionPolicy |
m_policy The eviction policy. |
protected static int |
MAX_PARTITION_MAP_UNIT_FACTOR |
protected static int |
PROP_HIGH_UNITS The "HighUnits" property. |
protected static int |
PROP_LOW_UNITS The "LowUnits" property. |
protected static int |
PROP_UNITS The "Units" property. |
Fields inherited from class com.tangosol.util.WrapperObservableMap |
---|
m_fDeferredEvent, m_fTranslateEvents, m_listenerInternal, m_listenerSupport, m_map, m_stats |
Fields inherited from interface com.tangosol.net.cache.CacheMap |
---|
EXPIRY_DEFAULT, EXPIRY_NEVER |
Constructor Summary | |
---|---|
ObservableSplittingBackingCache(BackingMapManager bmm, java.lang.String sName) Create a ObservableSplittingBackingCache that adds ConfigurableCacheMap functionality to an ObservableSplittingBackingMap. |
Method Summary | |
---|---|
protected void |
adjustUnits(int cUnits) Adjust the number of units for each map with the pool of units provided. |
protected int |
calculateUnits(int nProp) Aggregate the number of units across all of the partition backing maps. |
protected int |
calcUnitFairShare(int cUnits) Return the fair share of units for each child maps. |
protected void |
claimAll(ConfigurableCacheMap mapRequestor) Claim the full entitlement of units for mapRequestor. |
protected void |
claimUnused(ConfigurableCacheMap mapRequestor) Claim as many units as possible from existing maps without causing over-allocated maps to evict. |
void |
createPartition(int nPid) Add a partition to the PartitionAwareBackingMap. |
void |
destroyPartition(int nPid) Remove a partition from the PartitionAwareBackingMap. |
void |
evict() Evict all entries from the cache that are no longer valid, and potentially prune the cache size if the cache is size-limited and its size is above the caching low water mark. |
void |
evict(java.lang.Object oKey) Evict a specified key from the cache, as if it had expired from the cache. |
void |
evictAll(java.util.Collection colKeys) Evict the specified keys from the cache, as if they had each expired from the cache. |
ConfigurableCacheMap.Entry |
getCacheEntry(java.lang.Object oKey) Locate a cache Entry in the cache based on its key. |
protected int |
getCalibratedHighUnits() Determine the high units adjusted based on the partition unit factor . |
protected int |
getCalibratedLowUnits() Determine the low units adjusted based on the partition unit factor . |
ConfigurableCacheMap.EvictionApprover |
getEvictionApprover() Obtain the registered EvictionApprover. |
ConfigurableCacheMap.EvictionPolicy |
getEvictionPolicy() Obtain the current EvictionPolicy used by the cache. |
int |
getExpiryDelay() Determine the default "time to live" for each individual cache entry. |
protected ConfigurableCacheMap |
getFirstPartitionCache() Obtain the first one of the backing caches. |
protected int |
getHighUnitFairShare() Return the fair share of high-units per partition map. |
int |
getHighUnits() Determine the limit of the cache size in units. |
protected int |
getLowUnitFairShare() Return the fair share of low-units per partition map. |
int |
getLowUnits() Determine the point to which the cache will shrink when it prunes. |
protected ConfigurableCacheMap |
getPartitionCache(java.lang.Object oKey) Obtain the backing cache for a particular key. |
protected ConfigurableCacheMap[] |
getPartitionCacheArray() Obtain the array of backing caches. |
java.lang.Class |
getPartitionMapType() Return the uniform type used by each partition map. |
protected int |
getPartitionUnitFactor() Determine the unit factor for individual partition maps. |
ConfigurableCacheMap.UnitCalculator |
getUnitCalculator() Obtain the current UnitCalculator used by the cache. |
int |
getUnitFactor() Determine the factor by which the Units, LowUnits and HighUnits properties are adjusted. |
int |
getUnits() Determine the number of units that the cache currently stores. |
protected void |
initializeConfiguredProperties() Initialize the configurable properties of this cache-map. |
protected java.util.Set |
instantiateEntrySet() Factory pattern: Create a Set that represents the entries in the Map. |
protected void |
prepareUpdate(java.util.Map mapPartition, java.util.Map mapUpdate) Prepare mapPart, a map representing a partition, for the impending changes in which all of the mappings from mapUpdate will be copied to mapPart. |
void |
setEvictionApprover(ConfigurableCacheMap.EvictionApprover approver) Set the EvictionApprover for this ConfigurableCacheMap. |
void |
setEvictionPolicy(ConfigurableCacheMap.EvictionPolicy policy) Set the EvictionPolicy for the cache to use. |
void |
setExpiryDelay(int cMillis) Specify the default "time to live" for cache entries. |
void |
setHighUnits(int cMax) Update the maximum size of the cache in units. |
void |
setLowUnits(int cUnits) Specify the point to which the cache will shrink when it prunes. |
void |
setUnitCalculator(ConfigurableCacheMap.UnitCalculator calculator) Set the UnitCalculator for the cache to use. |
void |
setUnitFactor(int nFactor) Determine the factor by which the Units, LowUnits and HighUnits properties are adjusted. |
Methods inherited from class com.tangosol.net.partition.ObservableSplittingBackingMap |
---|
addMapListener, addMapListener, dispose, getBackingMapManager, getCacheStatistics, getName, getPartitionMap, getPartitionMap, getPartitionSplittingBackingMap, isCollectStats, isEventFabricator, put, removeMapListener, removeMapListener, setTranslateEvents, toString |
Methods inherited from class com.tangosol.util.WrapperObservableMap |
---|
addMapListener, clear, containsValue, dispatchEvent, dispatchPendingEvent, ensureInternalListener, ensureMapListenerSupport, get, getDescription, getInternalKeySet, getMap, getMapListenerSupport, hasListeners, instantiateInternalListener, isInternalKeySetIteratorMutable, isSynthetic, isTranslateEvents, put, putAll, remove, removeBlind, removeMapListener, setCollectStats |
Methods inherited from class com.tangosol.util.AbstractKeySetBasedMap |
---|
containsKey, instantiateKeyIterator, instantiateKeySet, instantiateValues, isEmpty, iterateKeys, size |
Methods inherited from class com.tangosol.util.AbstractKeyBasedMap |
---|
clone, entrySet, equals, getAll, hashCode, keySet, values |
Methods inherited from interface com.tangosol.net.cache.CacheMap |
---|
getAll, put, put |
Methods inherited from interface com.tangosol.util.ObservableMap |
---|
addMapListener, addMapListener, addMapListener, removeMapListener, removeMapListener, removeMapListener |
Methods inherited from interface java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values |
Field Detail |
---|
protected static final int PROP_UNITS
protected static final int PROP_HIGH_UNITS
protected static final int PROP_LOW_UNITS
protected static final int MAX_PARTITION_MAP_UNIT_FACTOR
protected int m_cHighUnits
protected int m_cLowUnits
protected int m_cHighUnitsCalibrated
partition unit factor
.protected int m_cLowUnitsCalibrated
partition unit factor
.protected int m_nUnitFactor
protected int m_cExpiryDelayMillis
protected int m_cHighUnitFairShare
protected int m_cLowUnitFairShare
protected ConfigurableCacheMap.EvictionPolicy m_policy
protected ConfigurableCacheMap.UnitCalculator m_calculator
protected ConfigurableCacheMap[] m_acache
protected ConfigurableCacheMap.EvictionApprover m_apprvrEvict
protected java.lang.Class m_clzPartitionMap
Constructor Detail |
---|
public ObservableSplittingBackingCache(BackingMapManager bmm, java.lang.String sName)
bmm
- a callback that knows how to create and release the backing maps that this ObservableSplittingBackingCache is responsible forsName
- the cache name for which this backing map existsMethod Detail |
---|
public void createPartition(int nPid)
createPartition
in interface PartitionAwareBackingMap
createPartition
in class ObservableSplittingBackingMap
nPid
- the partition id that the PartitionAwareBackingMap will be responsible for, starting at this instantpublic void destroyPartition(int nPid)
destroyPartition
in interface PartitionAwareBackingMap
destroyPartition
in class ObservableSplittingBackingMap
nPid
- the partition id that the PartitionAwareBackingMap will no longer be responsible for, starting at this instantpublic int getUnits()
Note: It is expected that the return type will be widened to a long in Coherence 4.
getUnits
in interface ConfigurableCacheMap
public int getHighUnits()
Note: It is expected that the return type will be widened to a long in Coherence 4.
getHighUnits
in interface ConfigurableCacheMap
public void setHighUnits(int cMax)
Note: It is expected that the parameter will be widened to a long in Coherence 4.
setHighUnits
in interface ConfigurableCacheMap
cMax
- the new maximum size of the cache, in unitspublic int getLowUnits()
Note: It is expected that the parameter will be widened to a long in Coherence 4.
getLowUnits
in interface ConfigurableCacheMap
public void setLowUnits(int cUnits)
Note: It is expected that the parameter will be widened to a long in Coherence 4.
setLowUnits
in interface ConfigurableCacheMap
cUnits
- the number of units that the cache prunes topublic int getUnitFactor()
Note: This property exists only to avoid changing the type of the units, low units and high units properties from 32-bit values to 64-bit values. It is expected that the parameter will be dropped in Coherence 4.
getUnitFactor
in interface ConfigurableCacheMap
public void setUnitFactor(int nFactor)
Note: This property exists only to avoid changing the type of the units, low units and high units properties from 32-bit values to 64-bit values. It is expected that the parameter will be dropped in Coherence 4.
setUnitFactor
in interface ConfigurableCacheMap
nFactor
- the units factor; the default is 1public ConfigurableCacheMap.EvictionPolicy getEvictionPolicy()
getEvictionPolicy
in interface ConfigurableCacheMap
public void setEvictionPolicy(ConfigurableCacheMap.EvictionPolicy policy)
setEvictionPolicy
in interface ConfigurableCacheMap
policy
- an EvictionPolicypublic void evict(java.lang.Object oKey)
evict
in interface ConfigurableCacheMap
oKey
- the key to evict from the cachepublic void evictAll(java.util.Collection colKeys)
The result of this method is defined to be semantically the same as the following implementation:
for (Iterator iter = colKeys.iterator(); iter.hasNext(); ) { Object oKey = iter.next(); evict(oKey); }
evictAll
in interface ConfigurableCacheMap
colKeys
- a collection of keys to evict from the cachepublic void evict()
evict
in interface ConfigurableCacheMap
public ConfigurableCacheMap.EvictionApprover getEvictionApprover()
getEvictionApprover
in interface ConfigurableCacheMap
public void setEvictionApprover(ConfigurableCacheMap.EvictionApprover approver)
setEvictionApprover
in interface ConfigurableCacheMap
approver
- the EvictionApproverpublic int getExpiryDelay()
getExpiryDelay
in interface ConfigurableCacheMap
public void setExpiryDelay(int cMillis)
setExpiryDelay
in interface ConfigurableCacheMap
cMillis
- the number of milliseconds that cache entries will live, or zero to disable automatic expirypublic ConfigurableCacheMap.Entry getCacheEntry(java.lang.Object oKey)
getCacheEntry
in interface ConfigurableCacheMap
oKey
- the key object to search forpublic ConfigurableCacheMap.UnitCalculator getUnitCalculator()
getUnitCalculator
in interface ConfigurableCacheMap
public void setUnitCalculator(ConfigurableCacheMap.UnitCalculator calculator)
setUnitCalculator
in interface ConfigurableCacheMap
calculator
- a UnitCalculatorpublic java.lang.Class getPartitionMapType()
protected void prepareUpdate(java.util.Map mapPartition, java.util.Map mapUpdate)
This implementation will check if mapPart is under-allocated for high units. If this is the case, demand the entitled unit amount from other maps.
prepareUpdate
in class ObservableSplittingBackingMap
mapPartition
- the map to be mutated with the contents of mapUpdatemapUpdate
- the map of changes to be appliedprotected void claimUnused(ConfigurableCacheMap mapRequestor)
mapRequestor
- the map requesting its fair share of unitsprotected void claimAll(ConfigurableCacheMap mapRequestor)
mapRequestor
- the map demanding its entitled fair shareprotected void adjustUnits(int cUnits)
The provided units may be positive or negative, with the latter suggesting that this number of units should be retrieved, thus decremented, from child maps. If the provided units is positive, maps that are over-allocated may consumer the provided amount. If the provided units is negative maintain a positive delta between the fair share and their current high units may consume the minimum between what is available from the provided units and the determined delta. If the provided units is negative, those maps whose current high unit allocation is more than the fair share will have this delta decremented until the debt (cUnits) is reclaimed.
cUnits
- the number of units to either disseminate (positive unit value) or retract across the mapsprotected void initializeConfiguredProperties()
protected ConfigurableCacheMap getPartitionCache(java.lang.Object oKey)
oKey
- the key of the desired entryprotected ConfigurableCacheMap getFirstPartitionCache()
protected ConfigurableCacheMap[] getPartitionCacheArray()
protected int calculateUnits(int nProp)
nProp
- one of the PROP_* values that specifies whether to aggregate the Units, HighUnits or LowUnits propertyprotected int getCalibratedHighUnits()
partition unit factor
.protected int getCalibratedLowUnits()
partition unit factor
.protected int getPartitionUnitFactor()
protected int getLowUnitFairShare()
protected int getHighUnitFairShare()
protected int calcUnitFairShare(int cUnits)
cUnits
- the units to distribute across all child mapsprotected java.util.Set instantiateEntrySet()
instantiateEntrySet
in class AbstractKeySetBasedMap
|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |