|
IBM WebSphere® DataPower® XC10 Appliance Release 2.0 Client API Specification |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BackingMapConfiguration
A BackingMapConfiguration object can be used to override BackingMap settings on the
client side. The com.ibm.websphere.objectgrid.plugins.Evictor
and the com.ibm.websphere.objectgrid.plugins.MapEventListener
Plugins can be overridden.
Other Evictor related settings can be tweaked.
Use the com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory.createBackingMapConfiguration(String)
method to create a BackingMapConfiguration
Evictor
,
MapEventListener
,
Plugin
,
ObjectGridConfigFactory
Method Summary | |
---|---|
void |
addPlugin(Plugin plugin)
Add a Plugin to this BackingMapConfiguration. |
java.lang.String |
getEvictionTriggers()
Gets the list of eviction triggers for this BackingMapConfiguration. |
java.lang.String |
getName()
Get the name of this BackingMapConfiguration |
int |
getNumberOfBuckets()
Gets the number of buckets defined for this BackingMapConfiguration. |
java.util.List |
getPlugins()
Get the Plugins that have been attached to this BackingMapConfiguration. |
int |
getTimeToLive()
Gets the "time to live" for each map entry. |
TTLType |
getTtlEvictorType()
Gets the "time to live" Evictor type for this BackingMapConfiguration. |
void |
setEvictionTriggers(java.lang.String evictionTriggers)
Sets the eviction triggers for this BackingMapConfiguration. |
void |
setNumberOfBuckets(int numBuckets)
Sets the number of buckets for this BackingMapConfiguration. |
void |
setPlugins(java.util.List pluginList)
Set the Plugins for this BackingMapConfiguration. |
void |
setTimeToLive(int seconds)
Sets "time to live" of each BackingMap entry in seconds. |
void |
setTtlEvictorType(TTLType ttlEvictorType)
Set the "time to live" Evictor type for this BackingMapConfiguration. |
Method Detail |
---|
java.lang.String getName()
void addPlugin(Plugin plugin)
Plugin
to this BackingMapConfiguration. The Plugins that can be overridden on a
client-side BackingMap are com.ibm.websphere.objectgrid.plugins.Evictor
and com.ibm.websphere.objectgrid.plugins.MapEventListener
.
plugin
- setPlugins(List)
void setPlugins(java.util.List pluginList)
pluginList
- - a List of PluginsaddPlugin(Plugin)
java.util.List getPlugins()
Plugin
objectsint getNumberOfBuckets()
void setNumberOfBuckets(int numBuckets)
BackingMap
.
The BackingMap
implementation uses a hash map for its
implementation. If there are a lot of entries in the BackingMap
then more buckets means better performance because the risk of collisions
is lower as the number of buckets grows. More buckets also means more
concurrency.
numBuckets
- BackingMap.setNumberOfBuckets(int)
int getTimeToLive()
void setTimeToLive(int seconds)
If this method is not called, the lifetime of an entry is forever (or until
the application explicitly removes or invalidates the entry, or a user
defined Evictor
evicts the entry).
seconds
- TTLType getTtlEvictorType()
TTLType.NONE
setTtlEvictorType(TTLType) was not called- See Also:
setTimeToLive(int)
void setTtlEvictorType(TTLType ttlEvictorType)
BackingMap
entry is computed.
If this method is not called, TTLType.NONE
is used
to indicate the map entry has no expiration time (e.g. is allowed to live
until explicitly removed or invalidated by the application, or evicted
by a user defined Evictor
).
ttlEvictorType
- BackingMap.setTtlEvictorType(TTLType)
java.lang.String getEvictionTriggers()
See BackingMap
for a list of valid eviction triggers.
setEvictionTriggers(String) was not called- Since:
- WAS XD 6.1.0.3
void setEvictionTriggers(java.lang.String evictionTriggers)
See BackingMap
for a list of valid eviction triggers.
evictionTriggers
- a semicolon separated list of eviction triggers
|
IBM WebSphere® DataPower® XC10 Appliance Release 2.0 Client API Specification |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |