OpenNMS API 1.2.3

org.opennms.netmgt.config
Class OpennmsServerConfigFactory

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

public final class OpennmsServerConfigFactory
extends java.lang.Object

This is the singleton class used to load the configuration for the OpenNMS OutageManager from the outage-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:
James Zuo , OpenNMS

Field Summary
private  LocalServer 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 OpennmsServerConfigFactory m_singleton
          The singleton instance of this factory
 
Constructor Summary
private OpennmsServerConfigFactory(java.lang.String configFile)
          Private constructor
 
Method Summary
static OpennmsServerConfigFactory getInstance()
          Return the singleton instance of this factory.
 java.lang.String getServerName()
          Return the local opennms server name.
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
 boolean verifyServer()
          Return the boolean flag verify server to determine if poller what to use server to restrict services to poll.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_singleton

private static OpennmsServerConfigFactory m_singleton
The singleton instance of this factory


m_config

private LocalServer 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

OpennmsServerConfigFactory

private OpennmsServerConfigFactory(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 OpennmsServerConfigFactory 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.

getServerName

public java.lang.String getServerName()
Return the local opennms server name.

Returns:
the name of the local opennms server

verifyServer

public boolean verifyServer()
Return the boolean flag verify server to determine if poller what to use server to restrict services to poll.

Returns:
boolean flag

OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.