org.opennms.netmgt.config

Class DiscoveryConfigFactory

java.lang.Object

org.opennms.netmgt.config.DiscoveryConfigFactory

All Implemented Interfaces:

DiscoveryConfigurationFactory

public class DiscoveryConfigFactory
extends Object
implements DiscoveryConfigurationFactory

This class is used to load the configuration for the OpenNMS Discovery service from the discovery-configuration.xml file.

Author:

Mike Davidson

Field Summary

Fields

Modifier and Type	Field and Description
static char	COMMENT_CHAR
static String	COMMENT_STR
static int	DEFAULT_CHUNK_SIZE
static int	DEFAULT_INITIAL_SLEEP_TIME
static double	DEFAULT_PACKETS_PER_SECOND
static int	DEFAULT_RESTART_SLEEP_TIME
static int	DEFAULT_RETRIES
static long	DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DiscoveryConfigFactory()
DiscoveryConfigFactory(DiscoveryConfiguration config)

Method Summary

Modifier and Type	Method and Description
static boolean	addToSpecificsFromURL(List<IPPollAddress> specifics, InputStream is, String foreignSource, String location, long timeout, int retries) addToSpecificsFromURL
static boolean	addToSpecificsFromURL(List<IPPollAddress> specifics, String url, String foreignSource, String location, long timeout, int retries) The file URL is read and a 'specific IP' is added for each entry in this file.
DiscoveryConfiguration	getConfiguration() Return the discovery configuration object.
Iterable<IPPollAddress>	getConfiguredAddresses() getConfiguredAddresses
Iterator<IPPollAddress>	getExcludingInterator(Iterator<IPPollAddress> it) getExcludingInterator
String	getForeignSource(InetAddress address) getForeignSource
long	getInitialSleepTime() getInitialSleepTime
static DiscoveryConfigFactory	getInstance() Deprecated. Inject this value instead of using singleton access.
long	getIntraPacketDelay() getIntraPacketDelay
double	getPacketsPerSecond() getPacketsPerSecond
List<IPPollRange>	getRanges() getRanges
Lock	getReadLock()
long	getRestartSleepTime() getRestartSleepTime
List<IPPollAddress>	getSpecifics() getSpecifics
List<IPPollAddress>	getURLSpecifics() getURLSpecifics
Lock	getWriteLock()
boolean	isExcluded(InetAddress address) isExcluded
void	reload() Reload the config from the default config file.
void	saveConfiguration(DiscoveryConfiguration configuration) saveConfiguration
protected void	saveXml(String xml) saveXml

Methods inherited from class java.lang.Object

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

Field Detail

COMMENT_STR

public static final String COMMENT_STR

See Also:

Constant Field Values

COMMENT_CHAR

public static final char COMMENT_CHAR

See Also:

Constant Field Values

DEFAULT_PACKETS_PER_SECOND

public static final double DEFAULT_PACKETS_PER_SECOND

See Also:

Constant Field Values

DEFAULT_INITIAL_SLEEP_TIME

public static final int DEFAULT_INITIAL_SLEEP_TIME

See Also:

Constant Field Values

DEFAULT_RESTART_SLEEP_TIME

public static final int DEFAULT_RESTART_SLEEP_TIME

See Also:

Constant Field Values

DEFAULT_RETRIES

public static final int DEFAULT_RETRIES

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CHUNK_SIZE

public static final int DEFAULT_CHUNK_SIZE

See Also:

Constant Field Values

Constructor Detail

DiscoveryConfigFactory

public DiscoveryConfigFactory()
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException,
                              IOException

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

DiscoveryConfigFactory

public DiscoveryConfigFactory(DiscoveryConfiguration config)

Method Detail

getInstance

public static DiscoveryConfigFactory getInstance()

Deprecated. Inject this value instead of using singleton access.

getReadLock

public Lock getReadLock()

getWriteLock

public Lock getWriteLock()

reload

public void reload()
            throws org.exolab.castor.xml.MarshalException,
                   org.exolab.castor.xml.ValidationException,
                   IOException

Reload the config from the default config file.

Throws:

MarshalException, - ValidationException, IOException

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.

getConfiguration

public DiscoveryConfiguration getConfiguration()

Return the discovery configuration object.

Specified by:

getConfiguration in interface DiscoveryConfigurationFactory

Returns:

a DiscoveryConfiguration object.

saveXml

protected void saveXml(String xml)
                throws IOException

saveXml

Parameters:

xml - a String object.

Throws:

IOException - if any.

saveConfiguration

public void saveConfiguration(DiscoveryConfiguration configuration)
                       throws org.exolab.castor.xml.MarshalException,
                              org.exolab.castor.xml.ValidationException,
                              IOException

saveConfiguration

Parameters:

configuration - a DiscoveryConfiguration object.

Throws:

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

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

IOException - if any.

addToSpecificsFromURL

public static boolean addToSpecificsFromURL(List<IPPollAddress> specifics,
                                            String url,
                                            String foreignSource,
                                            String location,
                                            long timeout,
                                            int retries)

 The file URL is read and a 'specific IP' is added for each entry
  in this file. Each line in the URL file can be one of -
  <IP><space>#<comments>
  or
  <IP>
  or
  #<comments>

  Lines starting with a '#' are ignored and so are characters after
  a '<space>#' in a line.
 

Parameters:

specifics - the list to add to

url - the URL file

timeout - the timeout for all entries in this URL

retries - the retries for all entries in this URL

Returns:

a boolean.

addToSpecificsFromURL

public static boolean addToSpecificsFromURL(List<IPPollAddress> specifics,
                                            InputStream is,
                                            String foreignSource,
                                            String location,
                                            long timeout,
                                            int retries)
                                     throws IOException

addToSpecificsFromURL

Parameters:

specifics - a List object.

is - a InputStream object.

timeout - a long.

retries - a int.

Returns:

a boolean.

Throws:

IOException - if any.

getURLSpecifics

public List<IPPollAddress> getURLSpecifics()

getURLSpecifics

Specified by:

getURLSpecifics in interface DiscoveryConfigurationFactory

Returns:

a List object.

getRanges

public List<IPPollRange> getRanges()

getRanges

Specified by:

getRanges in interface DiscoveryConfigurationFactory

Returns:

a List object.

getSpecifics

public List<IPPollAddress> getSpecifics()

getSpecifics

Specified by:

getSpecifics in interface DiscoveryConfigurationFactory

Returns:

a List object.

isExcluded

public boolean isExcluded(InetAddress address)

isExcluded

Specified by:

isExcluded in interface DiscoveryConfigurationFactory

Parameters:

address - a InetAddress object.

Returns:

a boolean.

getForeignSource

public String getForeignSource(InetAddress address)

Description copied from interface: DiscoveryConfigurationFactory

getForeignSource

Specified by:

getForeignSource in interface DiscoveryConfigurationFactory

Returns:

a String

getPacketsPerSecond

public double getPacketsPerSecond()

getPacketsPerSecond

Specified by:

getPacketsPerSecond in interface DiscoveryConfigurationFactory

Returns:

a int.

getIntraPacketDelay

public long getIntraPacketDelay()

getIntraPacketDelay

Specified by:

getIntraPacketDelay in interface DiscoveryConfigurationFactory

Returns:

a long.

getExcludingInterator

public Iterator<IPPollAddress> getExcludingInterator(Iterator<IPPollAddress> it)

getExcludingInterator

Specified by:

getExcludingInterator in interface DiscoveryConfigurationFactory

Parameters:

it - a Iterator object.

Returns:

a Iterator object.

getConfiguredAddresses

public Iterable<IPPollAddress> getConfiguredAddresses()

getConfiguredAddresses

TODO: This function is inefficient. It has O(n^2) complexity based on the product of the include ranges and exclude ranges. This might cause problems if users are using a large number of excluded ranges.

Specified by:

getConfiguredAddresses in interface DiscoveryConfigurationFactory

Returns:

a Iterable object.

getRestartSleepTime

public long getRestartSleepTime()

getRestartSleepTime

Specified by:

getRestartSleepTime in interface DiscoveryConfigurationFactory

Returns:

a long.

getInitialSleepTime

public long getInitialSleepTime()

getInitialSleepTime

Specified by:

getInitialSleepTime in interface DiscoveryConfigurationFactory

Returns:

a long.