MonitoringManager.java revision 672:2bb058ce572e 
1/*
2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package com.sun.corba.se.spi.monitoring;
26
27import java.io.Closeable;
28import com.sun.corba.se.spi.orb.ORB;
29import com.sun.corba.se.spi.monitoring.MonitoredObject;
30import java.util.*;
31
32/**
33 * Monitoring Manager will have a 1 to 1 association with the ORB. This
34 * gives access to the top level Monitored Object, using which more
35 * Monitored Objects and Attributes can be added and traversed.
36 *
37 * @author Hemanth Puttaswamy
38 */
39public interface MonitoringManager extends Closeable {
40
41  ///////////////////////////////////////
42  // operations
43
44/**
45 * Gets the Root Monitored Object which contains a Hierarchy Of Monitored
46 * Objects exposing various Monitorable Attributes of Various modules.
47 */
48    public MonitoredObject getRootMonitoredObject();
49/**
50 * Initialize is called whenever there is a start monitoring call to CORBA
51 * MBean. This will result in triaging initialize to all the
52 * MonitoredObjects and it's Monitored Attributes.
53 */
54    public void clearState();
55
56} // end MonitoringManager
57