|
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.XmlrpcdConfigFactory
This is the singleton class used to load the configuration for the OpenNMS xmlrpcd service from the xmlrpcd-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 XmlrpcdConfiguration |
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 XmlrpcdConfigFactory |
m_singleton
The singleton instance of this factory |
Constructor Summary | |
private |
XmlrpcdConfigFactory(java.lang.String configFile)
Private constructor |
Method Summary | |
boolean |
eventSubscribed(java.lang.String uei)
This method is used to determine if an event of the named represented is subscribed by the external XMLRPC server. |
XmlrpcdConfiguration |
getConfiguration()
Return the xmlrpcd configuration object. |
int |
getElapseTime()
Retrieves configured elapse time between retries for xmlrpc communication. |
java.util.Enumeration |
getEventEnumeration()
Retrieves configured list of subscribed event uei. |
static XmlrpcdConfigFactory |
getInstance()
Return the singleton instance of this factory. |
int |
getMaxQueueSize()
Retrieves the max event queue size from configuration. |
int |
getRetries()
Retrieves configured retry number for xmlrpc communication. |
XmlrpcServer[] |
getXmlrpcServer()
Retrieves configured list of external xmlrpc servers. |
java.util.Enumeration |
getXmlrpcServerEnumeration()
Retrieves configured list of external xmlrpc servers. |
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 XmlrpcdConfigFactory m_singleton
private static boolean m_loaded
private XmlrpcdConfiguration m_config
Constructor Detail |
private XmlrpcdConfigFactory(java.lang.String 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 XmlrpcdConfigFactory getInstance()
java.lang.IllegalStateException
- Thrown if the factory has not yet been initialized.public XmlrpcdConfiguration getConfiguration()
public boolean eventSubscribed(java.lang.String uei)
uei
- The uei to test against the subscribed events in the
configuration file.
public java.util.Enumeration getEventEnumeration()
public java.util.Enumeration getXmlrpcServerEnumeration()
public XmlrpcServer[] getXmlrpcServer()
public int getRetries()
public int getElapseTime()
public int getMaxQueueSize()
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |