org.opennms.netmgt.config
Class NSClientDataCollectionConfigFactory

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

public class NSClientDataCollectionConfigFactory
extends Object

NSClientDataCollectionConfigFactory class.

Version:

$Id: $

Author:

Craig Miskell

Field Summary

protected boolean	initialized Boolean indicating if the init() method has been called.
protected static long	m_lastModified Timestamp of the nsclient collection config, used to know when to reload from disk.

Constructor Summary

NSClientDataCollectionConfigFactory(Reader rdr)
Deprecated.

NSClientDataCollectionConfigFactory(String configFile)
Constructor for NSClientDataCollectionConfigFactory.

Method Summary

static NsclientDatacollectionConfig	getConfig() getConfig
static NSClientDataCollectionConfigFactory	getInstance() Singleton static call to get the only instance that should exist
NsclientCollection	getNSClientCollection(String collectionName) getNSClientCollection
List<String>	getRRAList(String cName) getRRAList
String	getRrdPath() getRrdPath
RrdRepository	getRrdRepository(String collectionName) getRrdRepository
int	getStep(String cName) getStep
static void	init() Be sure to call this method before calling getInstance().
void	reload() reload
static void	setConfig(NsclientDatacollectionConfig config) setConfig
static void	setInstance(NSClientDataCollectionConfigFactory instance) setInstance
protected void	updateFromFile() Reload the nsclient-datacollection-config.xml file if it has been changed since we last read it.

Methods inherited from class java.lang.Object

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

Field Detail

initialized

protected boolean initialized

Boolean indicating if the init() method has been called.

m_lastModified

protected static long m_lastModified

Timestamp of the nsclient collection config, used to know when to reload from disk.

Constructor Detail

NSClientDataCollectionConfigFactory

public NSClientDataCollectionConfigFactory(String configFile)
                                    throws org.exolab.castor.xml.MarshalException,
                                           org.exolab.castor.xml.ValidationException,
                                           IOException

Constructor for NSClientDataCollectionConfigFactory.

Parameters:

configFile - a String object.

Throws:

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

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

IOException - if any.

NSClientDataCollectionConfigFactory

@Deprecated
public NSClientDataCollectionConfigFactory(Reader rdr)
                                    throws org.exolab.castor.xml.MarshalException,
                                           org.exolab.castor.xml.ValidationException

Deprecated.

Constructor for NSClientDataCollectionConfigFactory.

Parameters:

rdr - a Reader 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,
                        FileNotFoundException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

Be sure to call this method before calling getInstance().

Throws:

IOException - if any.

FileNotFoundException - if any.

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

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

getInstance

public static NSClientDataCollectionConfigFactory getInstance()

Singleton static call to get the only instance that should exist

Returns:

the single factory instance

Throws:

IllegalStateException - if init has not been called

setInstance

public static void setInstance(NSClientDataCollectionConfigFactory instance)

setInstance

Parameters:

instance - a NSClientDataCollectionConfigFactory object.

reload

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

reload

Throws:

IOException - if any.

FileNotFoundException - if any.

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

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

updateFromFile

protected void updateFromFile()
                       throws IOException,
                              org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException

Reload the nsclient-datacollection-config.xml file if it has been changed since we last read it.

Throws:

IOException - if any.

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

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

getConfig

public static NsclientDatacollectionConfig getConfig()

getConfig

Returns:

a NsclientDatacollectionConfig object.

setConfig

public static void setConfig(NsclientDatacollectionConfig config)

setConfig

Parameters:

m_config - a NsclientDatacollectionConfig object.

getNSClientCollection

public NsclientCollection getNSClientCollection(String collectionName)

getNSClientCollection

Parameters:

collectionName - a String object.

Returns:

a NsclientCollection object.

getRrdRepository

public RrdRepository getRrdRepository(String collectionName)

getRrdRepository

Parameters:

collectionName - a String object.

Returns:

a RrdRepository object.

getStep

public int getStep(String cName)

getStep

Parameters:

cName - a String object.

Returns:

a int.

getRRAList

public List<String> getRRAList(String cName)

getRRAList

Parameters:

cName - a String object.

Returns:

a List object.

getRrdPath

public String getRrdPath()

getRrdPath

Returns:

a String object.