org.opennms.netmgt.config

Class RTCConfigFactory

java.lang.Object

org.opennms.netmgt.config.RTCConfigFactory

public final class RTCConfigFactory
extends Object

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.

Version:

$Id: $

Author:

Sowmya Nataraj , OpenNMS , Sowmya Nataraj , OpenNMS

Constructor Summary

Constructors

Constructor and Description
RTCConfigFactory(InputStream stream) Constructor for RTCConfigFactory.

Method Summary

Methods

Modifier and Type	Method and Description
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.
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.
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.
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.
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.
static void	reload() Reload the config from the default config file
static void	setInstance(RTCConfigFactory instance) setInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

RTCConfigFactory

public RTCConfigFactory(InputStream stream)
                 throws IOException,
                        org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException

Constructor for RTCConfigFactory.

Parameters:

stream - a InputStream object.

Throws:

IOException - if any.

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

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

Method Detail

setInstance

public static void setInstance(RTCConfigFactory instance)

setInstance

Parameters:

instance - a RTCConfigFactory object.

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.

IOException - if any.

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

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

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.

IOException - if any.

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

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

getInstance

public static RTCConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

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

getUpdaters

public int getUpdaters()

Return the number of updater threads to be started.

Returns:

the number of updater threads to be started

getSenders

public int getSenders()

Return the number of sender to be started.

Returns:

the number of sender threads to be started

getRollingWindowStr

public String getRollingWindowStr()

Return the rolling window for which availability is to be computed.

Returns:

the rolling window for which availability is to be computed

getRollingWindow

public long getRollingWindow()

Return the rolling window for which availability is to be computed.

Returns:

the rolling window for which availability is to be computed

getMaxEventsBeforeResend

public int getMaxEventsBeforeResend()

Return the max number of events after which data is to resent.

Returns:

the max number of events after which data is to resent

getLowThresholdIntervalStr

public String getLowThresholdIntervalStr()

Return the low threshold interval at which data is to be resent.

Returns:

the low threshold interval at which data is to be resent

getLowThresholdInterval

public long getLowThresholdInterval()

Return the low threshold interval at which data is to be resent.

Returns:

the low threshold interval at which data is to be resent

getHighThresholdIntervalStr

public String getHighThresholdIntervalStr()

Return the high threshold interval at which data is to be resent.

Returns:

the high threshold interval at which data is to be resent

getHighThresholdInterval

public long getHighThresholdInterval()

Return the high threshold interval at which data is to be resent.

Returns:

the high threshold interval at which data is to be resent

getUserRefreshIntervalStr

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

Returns:

the user refresh interval at which data is to be resent

getUserRefreshInterval

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

Returns:

the user refresh interval at which data is to be resent

getErrorsBeforeUrlUnsubscribe

public int getErrorsBeforeUrlUnsubscribe()

Return the number of times posts are tried with errors before an URL is automatically unsubscribed. A negative value means URL is never unsubscribed

Returns:

the number of times posts are tried with errors before an URL is automatically unsubscribed