org.opennms.netmgt.config.dhcpd

Class DhcpdConfigFactory

java.lang.Object

org.opennms.netmgt.config.dhcpd.DhcpdConfigFactory

public final class DhcpdConfigFactory
extends Object

This is the singleton class used to load the configuration for the OpenNMS DHCP client deamon from the dhcpd-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:

Mike Davidson , OpenNMS

Method Summary

Methods

Modifier and Type	Method and Description
String	getExtendedMode() Return the string value of the extended mode option for the DHCP client daemon.
static DhcpdConfigFactory	getInstance() Return the singleton instance of this factory.
String	getMacAddress() Return the MAC address to be used in outgoing DHCP packets generated by the DHCP client daemon.
String	getMyIpAddress() Return the IP address to be used as the relay address in outgoing DHCP packets generated by the DHCP client daemon.
int	getPort() Return the TCP port on which the DHCP client daemon is to listen for incoming client connections.
String	getRequestIpAddress() Return the IP address to be used in outgoing DHCP REQUEST packets generated by the DHCP client daemon.
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

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

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

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 DhcpdConfigFactory getInstance()

Return the singleton instance of this factory.

Returns:

The current factory instance.

Throws:

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

getPort

public int getPort()

Return the TCP port on which the DHCP client daemon is to listen for incoming client connections.

Returns:

the DHCP client daemon port.

getMacAddress

public String getMacAddress()

Return the MAC address to be used in outgoing DHCP packets generated by the DHCP client daemon.

Returns:

string mac address

getMyIpAddress

public String getMyIpAddress()

Return the IP address to be used as the relay address in outgoing DHCP packets generated by the DHCP client daemon.

Returns:

string ip address

getRequestIpAddress

public String getRequestIpAddress()

Return the IP address to be used in outgoing DHCP REQUEST packets generated by the DHCP client daemon.

Returns:

string ip address

getExtendedMode

public String getExtendedMode()

Return the string value of the extended mode option for the DHCP client daemon.

Returns:

string extended mode