1 /**
2 * Copyright 2003-2007 Greg Luck
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.ehcache.management;
18
19 import net.sf.ehcache.CacheException;
20
21 /**
22 * A management bean for a cache
23 *
24 * @author Greg Luck
25 * @version $Id: CacheMBean.java 512 2007-07-10 09:18:45Z gregluck $
26 * @since 1.3
27 */
28 public interface CacheMBean {
29
30
31 /**
32 * Removes all cached items.
33 *
34 * @throws IllegalStateException if the cache is not {@link net.sf.ehcache.Status#STATUS_ALIVE}
35 */
36 void removeAll() throws IllegalStateException, CacheException;
37
38
39 /**
40 * Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
41 *
42 * @throws IllegalStateException if the cache is not {@link net.sf.ehcache.Status#STATUS_ALIVE}
43 */
44 void flush() throws IllegalStateException, CacheException;
45
46
47 /**
48 * Gets the status attribute of the Cache.
49 *
50 * @return The status value from the Status enum class
51 */
52 String getStatus();
53
54
55 /**
56 * Gets the cache name.
57 */
58 String getName();
59
60
61 /**
62 *
63 * Gets the JMX read-only CacheConfiguration
64 */
65 CacheConfiguration getCacheConfiguration();
66
67
68 /**
69 *
70 * Gets the JMX cache statistics
71 */
72 public CacheStatistics getStatistics();
73
74
75
76 }