org.opennms.netmgt.config
Class JMXDataCollectionConfigFactory

java.lang.Object
  org.opennms.netmgt.config.JMXDataCollectionConfigFactory

public final class JMXDataCollectionConfigFactory
extends Object

This class is the main respository for JMX data collection configuration information used by the an instance of the JMX service monitor. When this class is loaded it reads the jmx data collection configuration into memory. Note: Users of this class should make sure the init() is called before calling any other method to ensure the config is loaded before accessing other convenience methods.

Version:

$Id: $

Author:

Mike Jamison , OpenNMS , Mike Jamison , OpenNMS

Constructor Summary

JMXDataCollectionConfigFactory(InputStream stream)
Constructor for JMXDataCollectionConfigFactory.

Method Summary

Map<String,List<Attrib>>	getAttributeMap(String cName, String aSysoid, String anAddress) This method returns the list of MIB objects associated with a particular system object id, IP address, and ifType for the specified collection.
static JMXDataCollectionConfigFactory	getInstance() Return the singleton instance of this factory.
Map<String,String[]>	getMBeanInfo_save(String cName) getMBeanInfo_save
Map<String,BeanInfo>	getMBeanInfo(String cName) getMBeanInfo
List<String>	getRRAList(String cName) Retrieves configured list of RoundRobin Archive statements.
String	getRrdPath() getRrdPath
RrdRepository	getRrdRepository(String collectionName) Retrieves the configured path to the RRD file repository.
int	getStep(String cName) Retrieves configured RRD step size.
static void	init() Load the config from the default config file and create the singleton instance of this factory.
static void	reload() Reload the config from the default config file
static void	setInstance(JMXDataCollectionConfigFactory singleton) setInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMXDataCollectionConfigFactory

public JMXDataCollectionConfigFactory(InputStream stream)
                               throws org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Constructor for JMXDataCollectionConfigFactory.

Parameters:

stream - a InputStream object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

Method Detail

init

public static void init()
                 throws IOException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

Load the config from the default config file and create the singleton instance of this factory.

Throws:

IOException - Thrown if the specified config file cannot be read

org.exolab.castor.xml.MarshalException - Thrown if the file does not conform to the schema.

org.exolab.castor.xml.ValidationException - Thrown if the contents do not match the required schema.

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

reload

public static void reload()
                   throws IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException

Reload the config from the default config file

Throws:

IOException - Thrown if the specified config file cannot be read/loaded

org.exolab.castor.xml.MarshalException - Thrown if the file does not conform to the schema.

org.exolab.castor.xml.ValidationException - Thrown if the contents do not match the required schema.

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getInstance

public static JMXDataCollectionConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

IllegalStateException - Thrown if the factory has not yet been initialized.

setInstance

public static void setInstance(JMXDataCollectionConfigFactory singleton)

setInstance

Parameters:

singleton - a JMXDataCollectionConfigFactory object.

getAttributeMap

public Map<String,List<Attrib>> getAttributeMap(String cName,
                                                String aSysoid,
                                                String anAddress)

This method returns the list of MIB objects associated with a particular system object id, IP address, and ifType for the specified collection.

Parameters:

cName - name of the data collection from which to retrieve oid information.

aSysoid - system object id to look up in the collection

anAddress - IP address to look up in the collection

Returns:

a list of MIB objects

getMBeanInfo

public Map<String,BeanInfo> getMBeanInfo(String cName)

getMBeanInfo

Parameters:

cName - a String object.

Returns:

a Map object.

getMBeanInfo_save

public Map<String,String[]> getMBeanInfo_save(String cName)

getMBeanInfo_save

Parameters:

cName - a String object.

Returns:

a Map object.

getStep

public int getStep(String cName)

Retrieves configured RRD step size.

Parameters:

cName - Name of the data collection

Returns:

RRD step size for the specified collection

getRRAList

public List<String> getRRAList(String cName)

Retrieves configured list of RoundRobin Archive statements.

Parameters:

cName - Name of the data collection

Returns:

list of RRA strings.

getRrdRepository

public RrdRepository getRrdRepository(String collectionName)

Retrieves the configured path to the RRD file repository.

Parameters:

collectionName - a String object.

Returns:

RRD repository path.

getRrdPath

public String getRrdPath()

getRrdPath

Returns:

a String object.