OpenNMS API 1.2.3

org.opennms.netmgt.config
Class EventsArchiverConfigFactory

java.lang.Object
  extended byorg.opennms.netmgt.config.EventsArchiverConfigFactory

public final class EventsArchiverConfigFactory
extends java.lang.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

Field Summary
private  EventsArchiverConfiguration m_config
          The config class loaded from the config file
private static boolean m_loaded
          This member is set to true if the configuration file has been loaded.
private static EventsArchiverConfigFactory m_singleton
          The singleton instance of this factory
 
Constructor Summary
private EventsArchiverConfigFactory(java.lang.String configFile)
          Private constructor
 
Method Summary
 java.lang.String getArchiveAge()
          Return the archive age.
static EventsArchiverConfigFactory getInstance()
          Return the singleton instance of this factory.
 java.lang.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
 

Field Detail

m_singleton

private static EventsArchiverConfigFactory m_singleton
The singleton instance of this factory


m_config

private EventsArchiverConfiguration m_config
The config class loaded from the config file


m_loaded

private static boolean m_loaded
This member is set to true if the configuration file has been loaded.

Constructor Detail

EventsArchiverConfigFactory

private EventsArchiverConfigFactory(java.lang.String configFile)
                             throws java.io.IOException,
                                    org.exolab.castor.xml.MarshalException,
                                    org.exolab.castor.xml.ValidationException
Private constructor

Throws:
java.io.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.
Method Detail

init

public static void init()
                 throws java.io.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:
java.io.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 java.io.IOException,
                          org.exolab.castor.xml.MarshalException,
                          org.exolab.castor.xml.ValidationException
Reload the config from the default config file

Throws:
java.io.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:
java.lang.IllegalStateException - Thrown if the factory has not yet been initialized.

getArchiveAge

public java.lang.String getArchiveAge()
Return the archive age. Note: events created before this time are to be removed.

Returns:
the archive age of events

getSeparator

public java.lang.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

OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.