53
48
final String STATISTICS_ENABLED = "StatisticsEnabled";
56
* Gets the actual name of the cache manager. This may be different from the
57
* name used to register this mbean as there can potentially be multiple
58
* cache managers with same name
63
51
* Gets the name used to register this mbean.
65
53
String getMBeanRegisteredName();
68
* Gets the status attribute of the Ehcache
70
* @return The status value, as a String from the Status enum class
75
* Enables/disables each cache contained by this CacheManager
79
void setEnabled(boolean enabled);
82
* Returns if each cache is enabled.
84
* @return boolean indicating that each cache is enabled
89
* Shuts down the CacheManager.
91
* If the shutdown occurs on the singleton, then the singleton is removed, so that if a singleton access method is called, a new
92
* singleton will be created.
97
* Clears the contents of all caches in the CacheManager, but without
98
* removing any caches.
100
* This method is not synchronized. It only guarantees to clear those elements in a cache at the time that the
101
* {@link net.sf.ehcache.Ehcache#removeAll()} mehod on each cache is called.
106
* Gets the cache names managed by the CacheManager
108
String[] getCacheNames() throws IllegalStateException;
111
* Get a map of cache name to performance metrics (hits, misses).
113
* @return a map of cache metrics
115
Map<String, long[]> getCacheMetrics();
118
* @return aggregate hit rate
120
long getCacheHitRate();
123
* @return aggregate in-memory hit rate
125
long getCacheInMemoryHitRate();
128
* @return aggregate off-heap hit rate
130
long getCacheOffHeapHitRate();
133
* @return aggregate on-disk hit rate
135
long getCacheOnDiskHitRate();
138
* @return aggregate miss rate
140
long getCacheMissRate();
143
* @return aggregate in-memory miss rate
145
long getCacheInMemoryMissRate();
148
* @return aggregate off-heap miss rate
150
long getCacheOffHeapMissRate();
153
* @return aggregate on-disk miss rate
155
long getCacheOnDiskMissRate();
158
* @return aggregate put rate
160
long getCachePutRate();
163
* @return aggregate update rate
165
long getCacheUpdateRate();
168
* @return aggregate remove rate
170
long getCacheRemoveRate();
173
* @return aggregate eviction rate
175
long getCacheEvictionRate();
178
* @return aggregate expiration rate
180
long getCacheExpirationRate();
183
* @return aggregate average get time (ms.)
185
float getCacheAverageGetTime();
188
* @return if any contained caches are configured for search
190
boolean getSearchable();
193
* @return aggregate search rate
195
long getCacheSearchRate();
198
* @return aggregate search time
200
long getCacheAverageSearchTime();
203
* Clears statistics of all caches for the associated cacheManager
205
void clearStatistics();
208
* Enable statistics for each cache contained by cacheManager
210
void enableStatistics();
213
* Disable statistics for each cache contained by cacheManager
215
void disableStatistics();
218
* Enables/disables each contained cache
220
void setStatisticsEnabled(boolean enabled);
223
* Returns true iff each contained cache has statistics enabled
225
boolean isStatisticsEnabled();
228
* generateActiveConfigDeclaration
230
* @return CacheManager configuration as String
232
String generateActiveConfigDeclaration();
235
* generateActiveConfigDeclaration
238
* @return Cache configuration as String
240
String generateActiveConfigDeclaration(String cacheName);
243
* Are any of the caches transactional
244
* @see net.sf.ehcache.config.CacheConfiguration.TransactionalMode
246
boolean getTransactional();
249
* Get the committed transactions count
250
* @return the committed transactions count
252
long getTransactionCommittedCount();
255
* @return aggregate Xa commit rate
257
long getTransactionCommitRate();
260
* Get the rolled back transactions count
261
* @return the rolled back transactions count
263
long getTransactionRolledBackCount();
266
* @return aggregate Xa rollback rate
268
long getTransactionRollbackRate();
271
* Get the timed out transactions count. Note that only transactions which failed to
272
* commit due to a timeout are taken into account
273
* @return the timed out transactions count
275
long getTransactionTimedOutCount();
278
* Returns whether any caches are configured for write-behind
280
boolean getHasWriteBehindWriter();
283
* Returns the total length of all write-behind queues across all caches
284
* @return aggregate writer-behind queue length
286
long getWriterQueueLength();
289
* Maximum elements that can be queued for processing by the write-behind writer
290
* @return aggregate of the maximum elements that can be waiting to be processed
291
* by the write-behind writer across all caches
293
int getWriterMaxQueueSize();
296
* Maximum number of bytes of entries in the disk stores of all caches that
297
* did not declare their own max size.
299
* @return maximum number of bytes in the disk stores of all caches that
300
* did not declare their own max size.
302
long getMaxBytesLocalDisk();
307
void setMaxBytesLocalDisk(long maxBytes);
312
void setMaxBytesLocalDiskAsString(String maxBytes);
315
* @return Original input for maxBytesLocalDisk
317
String getMaxBytesLocalDiskAsString();
320
* Maximum number of bytes of entries in the heap memory stores of all caches that
321
* did not declare their own max size.
323
* @return maximum number of bytes in the heap memory stores of all caches that
324
* did not declare their own max size.
326
long getMaxBytesLocalHeap();
329
* @return Original input for maxBytesLocalHeap
331
String getMaxBytesLocalHeapAsString();
336
void setMaxBytesLocalHeap(long maxBytes);
341
void setMaxBytesLocalHeapAsString(String maxBytes);
344
* Maximum number of bytes of entries in the off-heap stores of all caches that
345
* did not declare their own max size.
347
* @return maximum number of bytes in the off-heap stores of all caches that
348
* did not declare their own max size.
350
long getMaxBytesLocalOffHeap();
353
* @return Original input for maxBytesLocalOffHeap
355
String getMaxBytesLocalOffHeapAsString();
b'\\ No newline at end of file'