KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > monitor > BeanCacheMonitorMBean


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.monitor;
23
24 import java.util.Collection JavaDoc;
25 import javax.management.JMException JavaDoc;
26 import org.jboss.monitor.client.BeanCacheSnapshot;
27
28 /**
29  * The JMX management interface for the {@link BeanCacheMonitor} MBean.
30  *
31  * @see Monitorable
32  * @author <a HREF="mailto:simone.bordet@compaq.com">Simone Bordet</a>
33  * @version $Revision: 37459 $
34  */

35 public interface BeanCacheMonitorMBean
36 {
37    /**
38     * Returns the cache data at the call instant.
39     * @return null if a problem is encountered while sampling the cache,
40     *
41     * otherwise an array (possibly of size 0) with the cache data.
42     */

43    BeanCacheSnapshot[] getSnapshots();
44
45    /**
46     * Describe <code>listSnapshots</code> method here.
47     * Returns as a collection, throws JMException on problem
48     *
49     * @return a <code>Collection</code> value
50     */

51    Collection JavaDoc listSnapshots() throws JMException JavaDoc;
52 }
53
Popular Tags