DynaCache MBean

All Parent MBeans:
StatisticsProvider

Partial ObjectName:
WebSphere:*,type=DynaCache


MBean DynaCache

Current settings for the running WebSphere Dynamic Cache (DynaCache).


Attribute Summary
java.lang.IntegercacheSize
           The size in entries of the in-memory cache
java.lang.IntegerusedCacheSize
           The number of used cache entries in the in-memory cache
java.lang.BooleandiskOverflow
           Indicates whether disk based overflow is enabled

Attributes inherited from MBean StatisticsProvider
stats

Operation Summary
java.lang.String[]getCacheStatisticNames()
           Retrieve the names of the available cache statistics.
java.lang.String[]getCacheInstanceNames()
           Retrieve the names of the available cache instances.
java.lang.String[]getAllCacheStatistics()
           Retrieve all of the available cache statistics for the base cache instance.
java.lang.String[]getAllCacheStatistics(java.lang.String cacheInstance)
           Retrieve all of the available cache statistics for the named cache instance.
java.lang.String[]getCacheStatistics(java.lang.String[] names)
           Retrieve cache statistics specified by the names array for the base cache instance.
java.lang.String[]getCacheStatistics(java.lang.String cacheInstance, java.lang.String[] names)
           Retrieve cache statistics specified by the names array for the named cache instance.
java.lang.String[]getCacheIDsInMemory(java.lang.String cacheInstance, java.lang.String pattern)
           Retrieve all the cache ids in memory for the named cache instance that match the specified regular expression.
java.lang.String[]getCacheIDsOnDisk(java.lang.String cacheInstance, java.lang.String pattern)
           Retrieve all cache ids on disk for the named cache instance that match the specified regular expression.
java.lang.StringgetCacheEntry(java.lang.String cacheInstance, java.lang.String cacheID)
           Retrieves the CacheEntry which holds metadata information for the cache id.
java.lang.String[]invalidateCacheIDs(java.lang.String cacheInstance, java.lang.String pattern, boolean waitOnInvalidation)
           Invalidates all cache entries that match the pattern mapped cache ids in the named cache instance and all cache entries dependent upon the matched entries in the instance.
voidclearCache(java.lang.String cacheInstance)
           Clear all cache entries for the named cache instance.

Attribute Detail

cacheSize

public java.lang.Integer cacheSize
The size in entries of the in-memory cache
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

usedCacheSize

public java.lang.Integer usedCacheSize
The number of used cache entries in the in-memory cache
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

diskOverflow

public java.lang.Boolean diskOverflow
Indicates whether disk based overflow is enabled
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Operation Detail

getCacheStatisticNames

public java.lang.String[] getCacheStatisticNames()
Retrieve the names of the available cache statistics.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getCacheInstanceNames

public java.lang.String[] getCacheInstanceNames()
Retrieve the names of the available cache instances.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllCacheStatistics

public java.lang.String[] getAllCacheStatistics()
Retrieve all of the available cache statistics for the base cache instance.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllCacheStatistics

public java.lang.String[] getAllCacheStatistics(java.lang.String cacheInstance)
Retrieve all of the available cache statistics for the named cache instance.
Parameters:
cacheInstance - The name of the cache instance.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getCacheStatistics

public java.lang.String[] getCacheStatistics(java.lang.String[] names)
Retrieve cache statistics specified by the names array for the base cache instance.
Parameters:
names - The array of cache statistic names
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getCacheStatistics

public java.lang.String[] getCacheStatistics(java.lang.String cacheInstance, java.lang.String[] names)
Retrieve cache statistics specified by the names array for the named cache instance.
Parameters:
cacheInstance - The name of the cache instance.
names - The array of cache statistic names
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getCacheIDsInMemory

public java.lang.String[] getCacheIDsInMemory(java.lang.String cacheInstance, java.lang.String pattern)
Retrieve all the cache ids in memory for the named cache instance that match the specified regular expression. The java.util.regex libraries are used for matching. The find() method is used for finding the matching IDs.
Parameters:
cacheInstance - The name of the cache instance.
pattern - A regular expression, specified as a string.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getCacheIDsOnDisk

public java.lang.String[] getCacheIDsOnDisk(java.lang.String cacheInstance, java.lang.String pattern)
Retrieve all cache ids on disk for the named cache instance that match the specified regular expression. The java.util.regex libraries are used for matching. The find() method is used for finding the matching IDs. This operation can take a non-deterministic amount of time to complete in some extreme cases.
Parameters:
cacheInstance - The name of the cache instance.
pattern - A regular expression, specified as a string.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getCacheEntry

public java.lang.String getCacheEntry(java.lang.String cacheInstance, java.lang.String cacheID)
Retrieves the CacheEntry which holds metadata information for the cache id. Returns null if the CacheEntry is not found. If the entry is found, the following information is returned: Cache id, User metadata, Priority, Time To Live indicator (TTL), Inactivity, ExpirationTime, Sharing Policy, Best effort determination of the size of the cache entry's value. If it cannot be determined, this will be -1. The actual value of the cache entry is not included in the output for this mbean. Whether or not the entry exists on disk. A boolean that indicates whether the cache entry skipped memory and was written directly to disk cache. Template IDs, Dependency IDs, Alias IDs
Parameters:
cacheInstance - The name of the cache instance.
cacheID - A cacheID typically returned by the getCacheIDsInMemory or getCacheIDsOnDisk methods.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

invalidateCacheIDs

public java.lang.String[] invalidateCacheIDs(java.lang.String cacheInstance, java.lang.String pattern, boolean waitOnInvalidation)
Invalidates all cache entries that match the pattern mapped cache ids in the named cache instance and all cache entries dependent upon the matched entries in the instance. Returns the list of cache ids mapped to the pattern. Dependent cache entries invalidated are not in the list. Matched entries are invalidated in the memory cache and disk cache. To clear a cache, invoke invalidateCacheIDs with a pattern = *. In this case, a list with only the element * is returned.
Parameters:
cacheInstance - The name of the cache instance.
pattern - A regular expression, specified as a string.
waitOnInvalidation - True indicates that this method should not return until the invalidations have taken effect. False indicates that the invalidations will be queued for later batch processing. For waitOnInvalidation = true, this method will take a long time to return and potentially could lock the cache and reduce throughput. If waitOnInvalidation = false, this method returns almost immediately, and the invalidates are handled on a separate thread.
Security Roles:
administrator
operator

clearCache

public void clearCache(java.lang.String cacheInstance)
Clear all cache entries for the named cache instance.
Parameters:
cacheInstance - The name of the cache instance.
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005