All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.welen.jmole.JMoleMBean Maven / Gradle / Ivy

There is a newer version: 1.5.4
Show newest version
package net.welen.jmole;

/*
 * #%L
 * JMole, https://bitbucket.org/awelen/jmole
 * %%
 * Copyright (C) 2015 - 2019 Anders Welén, [email protected]
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import javax.management.MalformedObjectNameException;

import java.util.List;
import java.util.Map;
import java.io.FileNotFoundException;

import javax.management.MBeanException;
import javax.management.AttributeNotFoundException;
import javax.management.InstanceNotFoundException;
import javax.management.ReflectionException;
import javax.management.IntrospectionException;

/**
 * MBean interface for JMole
 */
public interface JMoleMBean {

	/**
	 * Read and parses the config files and construct a new internal java
	 * representation. Also activates any thresholds present in that config
	 * 
	 * @throws MalformedObjectNameException
	 * @throws FileNotFoundException
	 * @throws MBeanException
	 * @throws AttributeNotFoundException
	 * @throws InstanceNotFoundException
	 * @throws ReflectionException
	 * @throws IntrospectionException
	 */
	void configure() throws MalformedObjectNameException,
			FileNotFoundException, MBeanException, AttributeNotFoundException,
			InstanceNotFoundException, ReflectionException,
			IntrospectionException;

	/**
	 * Updates the list of all current matching MBeans
	 * 
	 * @throws MBeanException
	 * @throws AttributeNotFoundException
	 * @throws InstanceNotFoundException
	 * @throws ReflectionException
	 * @throws IntrospectionException
	 */
	void discover() throws MBeanException, AttributeNotFoundException,
			InstanceNotFoundException, ReflectionException,
			IntrospectionException;

	/**
	 * Collects all measurements stated in the current configuration
	 * 
	 * @return A complex Map of data
	 * @throws InstanceNotFoundException
	 * @throws ReflectionException
	 * @throws MBeanException
	 * @throws AttributeNotFoundException
	 */
	Map>>> collectMeasurements()
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	String collectMeasurementsAsJSON()
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	/**
	 * Collects all measurements stated in the current configuration that
	 * matches the provided parameters
	 * 
	 * @param category The category  
	 * 
	 * @return A complex Map of data
	 * @throws InstanceNotFoundException
	 * @throws ReflectionException
	 * @throws MBeanException
	 * @throws AttributeNotFoundException
	 */
	Map> collectMeasurements(String category)
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	String collectMeasurementsAsJSON(String category)
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	/**
	 * Collects all measurements stated in the current configuration that
	 * matches the provided parameters
	 * 
	 * @param category The category
	 * @param name The name of the measurement group  
	 * @return A complex Map of data
	 * 
	 * @throws InstanceNotFoundException
	 * @throws ReflectionException
	 * @throws MBeanException
	 * @throws AttributeNotFoundException
	 */
	Map collectMeasurements(String category, String name)
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	String collectMeasurementsAsJSON(String category, String name)
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	/**
	 * Collects all measurements stated in the current configuration that
	 * matches the provided parameters
	 * 
	 * @param category The category
	 * @param name The name of the measurement group
	 * @param attribute The attribute  
	 * @return A complex Map of data
	 * 
	 * @throws InstanceNotFoundException
	 * @throws ReflectionException
	 * @throws MBeanException
	 * @throws AttributeNotFoundException
	 */
	Object collectMeasurement(String category, String name, String attribute)
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	String collectMeasurementAsJSON(String category, String name, String attribute)
			throws InstanceNotFoundException, ReflectionException,
			MBeanException, AttributeNotFoundException;

	/**
	 * Get all currently triggered warning thresholds
	 * 
	 * @return The warnings
	 * @throws AttributeNotFoundException
	 * @throws InstanceNotFoundException
	 * @throws MBeanException
	 * @throws ReflectionException
	 */
	Map> warningMessages() throws AttributeNotFoundException, InstanceNotFoundException, MBeanException, ReflectionException;
	String warningMessagesAsJSON() throws AttributeNotFoundException, InstanceNotFoundException, MBeanException, ReflectionException;

	/**
	 * Get all currently triggered critical thresholds
	 * 
	 * @return The critical errors
	 * 
	 * @throws AttributeNotFoundException
	 * @throws InstanceNotFoundException
	 * @throws MBeanException
	 * @throws ReflectionException
	 */
	Map> criticalMessages() throws AttributeNotFoundException, InstanceNotFoundException, MBeanException, ReflectionException;
	String criticalMessagesAsJSON() throws AttributeNotFoundException, InstanceNotFoundException, MBeanException, ReflectionException;
	
	long getNumberOfExecutedDiscoveries();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy