InterceptorMBean


1   /*
2    * JBoss, Home of Professional Open Source
3    * Copyright 2005, JBoss Inc., and individual contributors as indicated
4    * by the @authors tag. See the copyright.txt in the distribution for a
5    * full listing of individual contributors.
6    *
7    * This is free software; you can redistribute it and/or modify it
8    * under the terms of the GNU Lesser General Public License as
9    * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22  package org.jboss.cache.interceptors;
23  
24  import java.util.Map  ;
25  
26  /**
27   * Interface containing common cache management operations
28   *
29   * @author Jerry Gauthier
30   * @version $Id: InterceptorMBean.java,v 1.2 2006/09/05 18:09:56 msurtani Exp $
31   */
32  public interface InterceptorMBean
33  {
34     /**
35      * Returns whether an interceptor's statistics are
36      * being captured.
37      *
38      * @return true if statistics are captured
39      */
40     boolean getStatisticsEnabled();
41  
42     /**
43      * Enables an interceptor's cache statistics
44      * If true, the interceptor will capture statistics
45      * and make them available through the mbean.
46      *
47      * @param enabled true if statistics should be captured
48      */
49     void setStatisticsEnabled(boolean enabled);
50  
51     /**
52      * Returns a map of the cache interceptor's statistics
53      * Map is keyed on statistic names (which are Strings) and values are Objects.
54      *
55      * @return a map containing statistics
56      */
57     Map  <String  , Object  > dumpStatistics();
58  
59     /**
60      * Resets an interceptor's cache statistics
61      */
62     void resetStatistics();
63  }
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags