Class AmiPeerFactory


  • public class AmiPeerFactory
    extends java.lang.Object
    This class is the main repository for AMI configuration information used by the capabilities daemon. When this class is loaded it reads the AMI configuration into memory, and uses the configuration to find the AmiAgentConfig objects for specific addresses. If an address cannot be located in the configuration then a default peer instance is returned to the caller. 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:
    Jeff Gehlbach, OpenNMS
    • Method Detail

      • getReadLock

        public java.util.concurrent.locks.Lock getReadLock()
      • getWriteLock

        public java.util.concurrent.locks.Lock getWriteLock()
      • init

        public static void init()
                         throws java.io.IOException
        Load the config from the default config file and create the singleton instance of this factory.
        Throws:
        java.io.IOException - Thrown if the specified config file cannot be read
        java.io.IOException - if any.
      • reload

        public static void reload()
                           throws java.io.IOException
        Reload the config from the default config file
        Throws:
        java.io.IOException - Thrown if the specified config file cannot be read/loaded
        java.io.IOException - if any.
      • getInstance

        public static AmiPeerFactory getInstance()
        Return the singleton instance of this factory.
        Returns:
        The current factory instance.
        Throws:
        java.lang.IllegalStateException - Thrown if the factory has not yet been initialized.
      • setAmiConfig

        public static void setAmiConfig​(AmiConfig m_config)

        setAmiConfig

        Parameters:
        m_config - a AmiConfig object.
      • saveCurrent

        public void saveCurrent()
                         throws java.lang.Exception
        Saves the current settings to disk
        Throws:
        java.lang.Exception - if saving settings to disk fails.
      • getAgentConfig

        public AmiAgentConfig getAgentConfig​(java.net.InetAddress agentInetAddress)

        getAgentConfig

        Parameters:
        agentInetAddress - a InetAddress object.
        Returns:
        a org.opennms.protocols.ami.AmiAgentConfig object.
      • getAmiConfig

        public static AmiConfig getAmiConfig()

        getAmiConfig

        Returns:
        a AmiConfig object.