|
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.DhcpdConfigFactory
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.
Field Summary | |
private DhcpdConfiguration |
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 DhcpdConfigFactory |
m_singleton
The singleton instance of this factory |
Constructor Summary | |
private |
DhcpdConfigFactory(java.io.File configFile)
Private constructor |
Method Summary | |
java.lang.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. |
java.lang.String |
getMacAddress()
Return the MAC address to be used in outgoing DHCP packets generated by the DHCP client daemon. |
java.lang.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. |
java.lang.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 |
Field Detail |
private static DhcpdConfigFactory m_singleton
private DhcpdConfiguration m_config
private static boolean m_loaded
Constructor Detail |
private DhcpdConfigFactory(java.io.File 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 |
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 DhcpdConfigFactory getInstance()
java.lang.IllegalStateException
- Thrown if the factory has not yet been initialized.public int getPort()
public java.lang.String getMacAddress()
public java.lang.String getMyIpAddress()
public java.lang.String getRequestIpAddress()
public java.lang.String getExtendedMode()
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |