org.opennms.netmgt.config

Class VulnscandConfigFactory

java.lang.Object

org.opennms.netmgt.config.VulnscandConfigFactory

public final class VulnscandConfigFactory
extends Object

This is the singleton class used to load the configuration for the OpenNMS Vulnscand service from the vulnscand-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:

Seth Leger , Mike Davidson , Weave

Method Summary

Methods

Modifier and Type	Method and Description
void	addRange(int level, InetAddress begin, InetAddress end) addRange
void	addRange(ScanLevel level, InetAddress begin, InetAddress end) addRange
void	addSpecific(int level, InetAddress specific) addSpecific
void	addSpecific(ScanLevel level, InetAddress specific) addSpecific
Set<Serializable>	getAllExcludes() getAllExcludes
Set<InetAddress>	getAllIpAddresses(int level) getAllIpAddresses
Set<InetAddress>	getAllIpAddresses(ScanLevel level) getAllIpAddresses
static VulnscandConfiguration	getConfiguration() Return the Vulnscand configuration object.
long	getInitialSleepTime() getInitialSleepTime
static VulnscandConfigFactory	getInstance() Return the singleton instance of this factory.
static int	getInterfaceDbNodeId(Connection dbConn, InetAddress ifAddress) getInterfaceDbNodeId
int	getManagedInterfacesScanLevel() getManagedInterfacesScanLevel
boolean	getManagedInterfacesStatus() getManagedInterfacesStatus
int	getMaxRescanThreadPoolSize() getMaxRescanThreadPoolSize
int	getMaxSuspectThreadPoolSize() getMaxSuspectThreadPoolSize
String[]	getPluginLists() Gets the cached value of the plugin lists in the config file
long	getRescanFrequency() getRescanFrequency
boolean[]	getSafeChecks() Gets the cached value of the safe checks settings in the config file
InetAddress	getServerAddress() getServerAddress
String	getServerPassword() getServerPassword
int	getServerPort() getServerPort
String	getServerUsername() getServerUsername
boolean	getStatus() getStatus
static void	init() Load the config from the default config file and create the singleton instance of this factory.
static boolean	isInterfaceInDB(Connection dbConn, InetAddress ifAddress) isInterfaceInDB
static void	reload() Reload the config from the default config file
void	removeExcludeRange(InetAddress begin, InetAddress end) removeExcludeRange
void	removeExcludeSpecific(InetAddress specific) removeExcludeSpecific
void	removeRange(int level, InetAddress begin, InetAddress end) removeRange
void	removeRange(ScanLevel level, InetAddress begin, InetAddress end) removeRange
void	removeSpecific(int level, InetAddress specific) removeSpecific
void	removeSpecific(ScanLevel level, InetAddress specific) removeSpecific
static void	saveCurrent() Saves the current settings to disk
static InetAddress	toInetAddress(long address) Converts a 64-bit unsigned quantity to a IPv4 dotted decimal string address.
static long	toLong(InetAddress addr) Deprecated. See org.opennms.core.utils.InetAddressCollection.toLong(InetAddress addr)

Methods inherited from class java.lang.Object

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

Method Detail

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.

saveCurrent

public static void saveCurrent()
                        throws Exception

Saves the current settings to disk

Throws:

Exception - if any.

getInstance

public static VulnscandConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

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

getConfiguration

public static VulnscandConfiguration getConfiguration()

Return the Vulnscand configuration object.

Returns:

a VulnscandConfiguration object.

toLong

public static long toLong(InetAddress addr)

Deprecated. See org.opennms.core.utils.InetAddressCollection.toLong(InetAddress addr)

This method is used to convert the passed IP address to a long value. The address is converted in network byte order (big endian). This is compatible with the number format of the JVM, and thus the return longs can be compared with other converted IP Addresses to determine inclusion.

Parameters:

addr - The IP address to convert.

Returns:

The converted IP address.

toInetAddress

public static InetAddress toInetAddress(long address)
                                 throws UnknownHostException

Converts a 64-bit unsigned quantity to a IPv4 dotted decimal string address.

Parameters:

address - The 64-bit quantity to convert.

Returns:

The dotted decimal IPv4 address string.

Throws:

UnknownHostException - if any.

isInterfaceInDB

public static boolean isInterfaceInDB(Connection dbConn,
                      InetAddress ifAddress)
                               throws SQLException

isInterfaceInDB

Parameters:

dbConn - a Connection object.

ifAddress - a InetAddress object.

Returns:

a boolean.

Throws:

SQLException - if any.

getInterfaceDbNodeId

public static int getInterfaceDbNodeId(Connection dbConn,
                       InetAddress ifAddress)
                                throws SQLException

getInterfaceDbNodeId

Parameters:

dbConn - a Connection object.

ifAddress - a InetAddress object.

Returns:

a int.

Throws:

SQLException - if any.

addSpecific

public void addSpecific(int level,
               InetAddress specific)

addSpecific

Parameters:

level - a int.

specific - a InetAddress object.

addSpecific

public void addSpecific(ScanLevel level,
               InetAddress specific)

addSpecific

Parameters:

level - a ScanLevel object.

specific - a InetAddress object.

addRange

public void addRange(int level,
            InetAddress begin,
            InetAddress end)

addRange

Parameters:

level - a int.

begin - a InetAddress object.

end - a InetAddress object.

addRange

public void addRange(ScanLevel level,
            InetAddress begin,
            InetAddress end)

addRange

Parameters:

level - a ScanLevel object.

begin - a InetAddress object.

end - a InetAddress object.

removeSpecific

public void removeSpecific(int level,
                  InetAddress specific)

removeSpecific

Parameters:

level - a int.

specific - a InetAddress object.

removeSpecific

public void removeSpecific(ScanLevel level,
                  InetAddress specific)

removeSpecific

Parameters:

level - a ScanLevel object.

specific - a InetAddress object.

removeRange

public void removeRange(int level,
               InetAddress begin,
               InetAddress end)

removeRange

Parameters:

level - a int.

begin - a InetAddress object.

end - a InetAddress object.

removeRange

public void removeRange(ScanLevel level,
               InetAddress begin,
               InetAddress end)

removeRange

Parameters:

level - a ScanLevel object.

begin - a InetAddress object.

end - a InetAddress object.

getAllIpAddresses

public Set<InetAddress> getAllIpAddresses(int level)

getAllIpAddresses

Parameters:

level - a int.

Returns:

a Set object.

getAllIpAddresses

public Set<InetAddress> getAllIpAddresses(ScanLevel level)

getAllIpAddresses

Parameters:

level - a ScanLevel object.

Returns:

a Set object.

getAllExcludes

public Set<Serializable> getAllExcludes()

getAllExcludes

Returns:

a Set object.

removeExcludeRange

public void removeExcludeRange(InetAddress begin,
                      InetAddress end)

removeExcludeRange

Parameters:

begin - a InetAddress object.

end - a InetAddress object.

removeExcludeSpecific

public void removeExcludeSpecific(InetAddress specific)

removeExcludeSpecific

Parameters:

specific - a InetAddress object.

getRescanFrequency

public long getRescanFrequency()

getRescanFrequency

Returns:

a long.

getInitialSleepTime

public long getInitialSleepTime()

getInitialSleepTime

Returns:

a long.

getServerAddress

public InetAddress getServerAddress()

getServerAddress

Returns:

a InetAddress object.

getPluginLists

public String[] getPluginLists()

Gets the cached value of the plugin lists in the config file

Returns:

an array of String objects.

getSafeChecks

public boolean[] getSafeChecks()

Gets the cached value of the safe checks settings in the config file

Returns:

an array of boolean.

getServerPort

public int getServerPort()

getServerPort

Returns:

a int.

getServerUsername

public String getServerUsername()

getServerUsername

Returns:

a String object.

getServerPassword

public String getServerPassword()

getServerPassword

Returns:

a String object.

getStatus

public boolean getStatus()

getStatus

Returns:

a boolean.

getManagedInterfacesStatus

public boolean getManagedInterfacesStatus()

getManagedInterfacesStatus

Returns:

a boolean.

getManagedInterfacesScanLevel

public int getManagedInterfacesScanLevel()

getManagedInterfacesScanLevel

Returns:

a int.

getMaxSuspectThreadPoolSize

public int getMaxSuspectThreadPoolSize()

getMaxSuspectThreadPoolSize

Returns:

a int.

getMaxRescanThreadPoolSize

public int getMaxRescanThreadPoolSize()

getMaxRescanThreadPoolSize

Returns:

a int.