org.opennms.netmgt.config
Class EventsArchiverConfigFactory

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

public final class EventsArchiverConfigFactory
extends Object

This is the singleton class used to load the configuration for the OpenNMS Events Archiver from the events-archiver-configuration xml file. 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.

Author:

Sowmya Nataraj , OpenNMS

Method Summary

String	getArchiveAge() Return the archive age.
static EventsArchiverConfigFactory	getInstance() Return the singleton instance of this factory.
String	getSeparator() Return the seperator to be used between column values in the archive file.
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

Methods inherited from class java.lang.Object

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

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.

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.

getInstance

public static EventsArchiverConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

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

getArchiveAge

public String getArchiveAge()

Return the archive age. Note: events created before this time are to be removed.

Returns:

the archive age of events

getSeparator

public String getSeparator()

Return the seperator to be used between column values in the archive file.

Returns:

the seperator to be used between column values in the archive file