|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opennms.netmgt.config.RTCConfigFactory
This is the singleton class used to load the configuration for the OpenNMS RTC from the rtc-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.
Field Summary | |
private RTCConfiguration |
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 RTCConfigFactory |
m_singleton
The singleton instance of this factory |
Constructor Summary | |
private |
RTCConfigFactory(java.lang.String configFile)
Private constructor |
Method Summary | |
int |
getErrorsBeforeUrlUnsubscribe()
Return the number of times posts are tried with errors before an URL is automatically unsubscribed. |
long |
getHighThresholdInterval()
Return the high threshold interval at which data is to be resent. |
java.lang.String |
getHighThresholdIntervalStr()
Return the high threshold interval at which data is to be resent. |
static RTCConfigFactory |
getInstance()
Return the singleton instance of this factory. |
long |
getLowThresholdInterval()
Return the low threshold interval at which data is to be resent. |
java.lang.String |
getLowThresholdIntervalStr()
Return the low threshold interval at which data is to be resent. |
int |
getMaxEventsBeforeResend()
Return the max number of events after which data is to resent. |
long |
getRollingWindow()
Return the rolling window for which availability is to be computed. |
java.lang.String |
getRollingWindowStr()
Return the rolling window for which availability is to be computed. |
int |
getSenders()
Return the number of sender to be started. |
int |
getUpdaters()
Return the number of updater threads to be started. |
long |
getUserRefreshInterval()
Return the user refresh interval at which data is to be resent - this is the interval at which data is resent when no events are received. |
java.lang.String |
getUserRefreshIntervalStr()
Return the user refresh interval at which data is to be resent - this is the interval at which data is resent when no events are received. |
static void |
init()
Load the config from the default config file and create the singleton instance of this factory. |
private long |
parseRollingWindow(java.lang.String rolling)
Parse the rolling window in the properties file in the format |
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 |
private static RTCConfigFactory m_singleton
private RTCConfiguration m_config
private static boolean m_loaded
Constructor Detail |
private RTCConfigFactory(java.lang.String configFile) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
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 |
private long parseRollingWindow(java.lang.String rolling) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public static void init() throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
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.public static void reload() throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
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.public static RTCConfigFactory getInstance()
java.lang.IllegalStateException
- Thrown if the factory has not yet been initialized.public int getUpdaters()
public int getSenders()
public java.lang.String getRollingWindowStr()
public long getRollingWindow()
public int getMaxEventsBeforeResend()
public java.lang.String getLowThresholdIntervalStr()
public long getLowThresholdInterval()
public java.lang.String getHighThresholdIntervalStr()
public long getHighThresholdInterval()
public java.lang.String getUserRefreshIntervalStr()
public long getUserRefreshInterval()
public int getErrorsBeforeUrlUnsubscribe()
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |