com.cisco.oss.foundation.monitoring.MonitoringAgentMXBean Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Cisco Systems, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package com.cisco.oss.foundation.monitoring;

import java.util.Date;

/**
 * It is the MXBean interface which will be implemented internally by the
 * FoundationMXAgent.
 *
 * @author manojc
 * @see com.cisco.oss.foundation.monitoring.MonitoringAgent
 */
public interface MonitoringAgentMXBean {
    /**
     * Gets the Date when MonitoringAgent was registered.
     *
     * @return Date when MonitoringAgent was registered.
     */
    Date getAgentStartTime();

    /**
     * Gets Version of the MonitoringAgent.
     *
     * @return Version of the MonitoringAgent.
     */
    String getAgentVersion();

    /**
     * Gets the RMI port on which MonitoringAgent is registered.
     *
     * @return RMI port on which MonitoringAgent is registered.
     */
    int getAgentPort();

    /**
     * Gets the port number on which the Monitoring information is exported.
     *
     * @return The port number on which the Monitoring information is exported.
     */
    int getExportedPort();

    /**
     * Gets the IP of the host machine where MonitoringAgent runs.
     *
     * @return IP of the host machine where MonitoringAgent runs.
     */
    String getHostIP();

    /**
     * Gets the network name of the host machine where MonitoringAgent runs.
     *
     * @return Network name of the host machine where MonitoringAgent runs.
     */
    String getHostName();

    /**
     * Allows the management information attributes to be written remotely.
     *
     * @param path  Path of the attribute to be set.
     * @param value Value to be set with
     * @throws Exception
     */
    void setAttributeValue(String path, String value) throws Exception;

    /**
     * Allows the management information attributes to be written remotely.
     *
     * @param path  Path of the attribute to be set.
     * @param value Value to be set with
     * @throws Exception
     */
    void setAttributeValue(String path, int value) throws Exception;

    /**
     * Allows the management information attributes to be written remotely.
     *
     * @param path  Path of the attribute to be set.
     * @param value Value to be set with
     * @throws Exception
     */
    void setAttributeValue(String path, long value) throws Exception;
}