|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CacheAdminMBean
The CacheAdmin MBean defines the management interface to retrieve usage statistics for a server's DynaCache (also known as the Distributed Map).
The ObjectName for this MBean is "WebSphere:feature=CacheAdmin,type=DynaCache,name=DistributedMap".
Field Summary | |
---|---|
static java.lang.String |
OBJECT_NAME
A String representing the ObjectName that this MBean maps to. |
Method Summary | |
---|---|
void |
clearCache(java.lang.String cacheInstance)
Clear all the memory and disk entries for the named cache instance. |
java.lang.String[] |
getAllCacheStatistics()
Retrieves all of the available cache statistics for the "baseCache" instance. |
java.lang.String[] |
getAllCacheStatistics(java.lang.String cacheInstance)
Retrieves cache statistics specified by the named cache instance. |
java.lang.String |
getCacheDigest(java.lang.String cacheInstance,
boolean useMemoryCacheDigest,
boolean cacheIDOnly,
boolean debug)
Returns an MD5 digest of all the cache entries for the named cache instance. |
java.lang.String |
getCacheEntry(java.lang.String cacheInstance,
java.lang.String cacheId)
Retrieves the CacheEntry which holds metadata information for the cache ID. |
java.lang.String[] |
getCacheIDsInMemory(java.lang.String cacheInstance,
java.lang.String pattern)
Retrieves all of the cache IDs in memory for the named cache instance that matches the specified regular expression. |
java.lang.String[] |
getCacheIDsInPushPullTable(java.lang.String cacheInstance,
java.lang.String pattern)
Retrieves all of the cache IDs in the PushPullTable for the named cache instance that matches the specified regular expression. |
java.lang.String[] |
getCacheIDsOnDisk(java.lang.String cacheInstance,
java.lang.String pattern)
Retrieves all of the cache IDs on disk for the named cache instance that matches the specified regular expression. |
java.lang.String[] |
getCacheInstanceNames()
Retrieves the names of the available cache instances. |
int |
getCacheSize()
Returns the maximum size in entries of the in-memory cache. |
java.lang.String[] |
getCacheStatisticNames()
|
java.lang.String[] |
getCacheStatisticNames(java.lang.String cacheInstance)
|
java.lang.String[] |
getCacheStatistics(java.lang.String[] names)
|
java.lang.String[] |
getCacheStatistics(java.lang.String cacheInstance,
java.lang.String[] names)
Retrieves cache statistics specified by the names array for the named cache instance. |
boolean |
getDiskOverflow()
Indicates whether disk based overflow (disk offload) is enabled. |
int |
getUsedCacheSize()
Return the number of used cache entries in the "baseCache" in-memory cache. |
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. |
Field Detail |
---|
static final java.lang.String OBJECT_NAME
ObjectName
that this MBean maps to.
See also the @Component property.
Note that in many (most?) cases users will want to reference this as "Websphere:type=DynaCache,*",
which will also work with Traditional WAS (which uses a related but different object name)
Method Detail |
---|
int getCacheSize()
int getUsedCacheSize()
boolean getDiskOverflow()
java.lang.String[] getCacheStatisticNames()
java.lang.String[] getCacheStatisticNames(java.lang.String cacheInstance) throws javax.management.AttributeNotFoundException
javax.management.AttributeNotFoundException
java.lang.String[] getCacheInstanceNames()
java.lang.String[] getAllCacheStatistics()
java.lang.String[] getAllCacheStatistics(java.lang.String cacheInstance) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.
javax.management.AttributeNotFoundException
java.lang.String[] getCacheStatistics(java.lang.String[] names) throws javax.management.AttributeNotFoundException
javax.management.AttributeNotFoundException
java.lang.String[] getCacheStatistics(java.lang.String cacheInstance, java.lang.String[] names) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.names
- The array of cache statistic names
javax.management.AttributeNotFoundException
java.lang.String[] getCacheIDsInMemory(java.lang.String cacheInstance, java.lang.String pattern) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.pattern
- A regular expression that is specified as a string.
javax.management.AttributeNotFoundException
java.lang.String[] getCacheIDsOnDisk(java.lang.String cacheInstance, java.lang.String pattern) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.pattern
- A regular expression that is specified as a string.
javax.management.AttributeNotFoundException
java.lang.String[] getCacheIDsInPushPullTable(java.lang.String cacheInstance, java.lang.String pattern) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.pattern
- A regular expression that is specified as a string.
javax.management.AttributeNotFoundException
java.lang.String[] invalidateCacheIDs(java.lang.String cacheInstance, java.lang.String pattern, boolean waitOnInvalidation) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.pattern
- A regular expression that is 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.
javax.management.AttributeNotFoundException
java.lang.String getCacheEntry(java.lang.String cacheInstance, java.lang.String cacheId) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.cacheId
- The name of cache ID
javax.management.AttributeNotFoundException
void clearCache(java.lang.String cacheInstance) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.
javax.management.AttributeNotFoundException
java.lang.String getCacheDigest(java.lang.String cacheInstance, boolean useMemoryCacheDigest, boolean cacheIDOnly, boolean debug) throws javax.management.AttributeNotFoundException
cacheInstance
- The name of the cache instance.useMemoryCacheDigest
- If true, use only the memory cache digest. If false, use the whole cache digest.cacheIDOnly
- If true, get cache ID digest. It also includes ID digest from the PushPullTable. If false, get cache ID/value digest.debug
- If debug is true, a list of the cache IDs and their hashcodes are written to the SystemOut log.
javax.management.AttributeNotFoundException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |