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  */
  25 package com.sun.corba.se.spi.monitoring;
  26 
  27 import java.io.Closeable;
  28 import com.sun.corba.se.spi.orb.ORB;
  29 import com.sun.corba.se.spi.monitoring.MonitoredObject;
  30 import java.util.*;
  31 
  32 /**
  33  * <p>
  34  * Monitoring Manager will have a 1 to 1 association with the ORB. This
  35  * gives access to the top level Monitored Object, using which more
  36  * Monitored Objects and Attributes can be added and traversed.
  37  * </p>
  38  * <p>
  39  *
  40  * @author Hemanth Puttaswamy
  41  * </p>
  42  */
  43 public interface MonitoringManager extends Closeable {
  44 
  45   ///////////////////////////////////////
  46   // operations
  47 
  48 /**
  49  * <p>
  50  * Gets the Root Monitored Object which contains a Hierarchy Of Monitored
  51  * Objects exposing various Monitorable Attributes of Various modules.
  52  * </p>
  53  * <p>
  54  *
  55  * @param MonitoredObject ...
  56  * </p>
  57  */
  58     public MonitoredObject getRootMonitoredObject();
  59 /**
  60  * <p>
  61  * Initialize is called whenever there is a start monitoring call to CORBA
  62  * MBean. This will result in triaging initialize to all the
  63  * MonitoredObjects and it's Monitored Attributes.
  64  * </p>
  65  *
  66  */
  67     public void clearState();
  68 
  69 } // end MonitoringManager