0N/A/*
2362N/A * Copyright (c) 1999, 2007, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage javax.management.monitor;
0N/A
0N/A// jmx imports
0N/A//
0N/Aimport javax.management.ObjectName;
0N/A
0N/A/**
0N/A * Exposes the remote management interface of monitor MBeans.
0N/A *
0N/A *
0N/A * @since 1.5
0N/A */
0N/Apublic interface MonitorMBean {
0N/A
0N/A /**
0N/A * Starts the monitor.
0N/A */
0N/A public void start();
0N/A
0N/A /**
0N/A * Stops the monitor.
0N/A */
0N/A public void stop();
0N/A
0N/A // GETTERS AND SETTERS
0N/A //--------------------
0N/A
0N/A /**
0N/A * Adds the specified object in the set of observed MBeans.
0N/A *
0N/A * @param object The object to observe.
0N/A * @exception java.lang.IllegalArgumentException the specified object is null.
0N/A *
0N/A */
0N/A public void addObservedObject(ObjectName object) throws java.lang.IllegalArgumentException;
0N/A
0N/A /**
0N/A * Removes the specified object from the set of observed MBeans.
0N/A *
0N/A * @param object The object to remove.
0N/A *
0N/A */
0N/A public void removeObservedObject(ObjectName object);
0N/A
0N/A /**
0N/A * Tests whether the specified object is in the set of observed MBeans.
0N/A *
0N/A * @param object The object to check.
0N/A * @return <CODE>true</CODE> if the specified object is in the set, <CODE>false</CODE> otherwise.
0N/A *
0N/A */
0N/A public boolean containsObservedObject(ObjectName object);
0N/A
0N/A /**
0N/A * Returns an array containing the objects being observed.
0N/A *
0N/A * @return The objects being observed.
0N/A *
0N/A */
0N/A public ObjectName[] getObservedObjects();
0N/A
0N/A /**
0N/A * Gets the object name of the object being observed.
0N/A *
0N/A * @return The object being observed.
0N/A *
0N/A * @see #setObservedObject
0N/A *
0N/A * @deprecated As of JMX 1.2, replaced by {@link #getObservedObjects}
0N/A */
0N/A @Deprecated
0N/A public ObjectName getObservedObject();
0N/A
0N/A /**
0N/A * Sets the object to observe identified by its object name.
0N/A *
0N/A * @param object The object to observe.
0N/A *
0N/A * @see #getObservedObject
0N/A *
0N/A * @deprecated As of JMX 1.2, replaced by {@link #addObservedObject}
0N/A */
0N/A @Deprecated
0N/A public void setObservedObject(ObjectName object);
0N/A
0N/A /**
0N/A * Gets the attribute being observed.
0N/A *
0N/A * @return The attribute being observed.
0N/A *
0N/A * @see #setObservedAttribute
0N/A */
0N/A public String getObservedAttribute();
0N/A
0N/A /**
0N/A * Sets the attribute to observe.
0N/A *
0N/A * @param attribute The attribute to observe.
0N/A *
0N/A * @see #getObservedAttribute
0N/A */
0N/A public void setObservedAttribute(String attribute);
0N/A
0N/A /**
0N/A * Gets the granularity period (in milliseconds).
0N/A *
0N/A * @return The granularity period.
0N/A *
0N/A * @see #setGranularityPeriod
0N/A */
0N/A public long getGranularityPeriod();
0N/A
0N/A /**
0N/A * Sets the granularity period (in milliseconds).
0N/A *
0N/A * @param period The granularity period.
0N/A * @exception java.lang.IllegalArgumentException The granularity
0N/A * period is less than or equal to zero.
0N/A *
0N/A * @see #getGranularityPeriod
0N/A */
0N/A public void setGranularityPeriod(long period) throws java.lang.IllegalArgumentException;
0N/A
0N/A /**
0N/A * Tests if the monitor MBean is active.
0N/A * A monitor MBean is marked active when the {@link #start start} method is called.
0N/A * It becomes inactive when the {@link #stop stop} method is called.
0N/A *
0N/A * @return <CODE>true</CODE> if the monitor MBean is active, <CODE>false</CODE> otherwise.
0N/A */
0N/A public boolean isActive();
0N/A}