Package org.opennms.netmgt.config

Class SnmpEventInfo

  • public class SnmpEventInfo
extends java.lang.Object
    Class for handling data passed as parms in a configureSNMP event. Provides for generating a config package based SNMP Definition class for merging into a current running config.
    Author:
    David Hustace

    • Constructor Detail

      • SnmpEventInfo

        public SnmpEventInfo()
        Default constructor

      • SnmpEventInfo

        public SnmpEventInfo​(IEvent event)

        Constructor for SnmpEventInfo.

        Parameters:
        event - a IEvent object.

    • Method Detail

      • getCommunityString

        @Deprecated
public java.lang.String getCommunityString()
        Deprecated.
        use getReadCommunityString() instead.
        Returns the read community string if there is any, otherwise null is returned.
        Returns:
        the read community string if there is any, otherwise null is returned.

      • setCommunityString

        @Deprecated
public void setCommunityString​(java.lang.String communityString)
        Deprecated.
        use setReadCommunityString(String) instead.

        sets the read community string.

        Parameters:
        communityString - a read community string.

      • setReadCommunityString

        public void setReadCommunityString​(java.lang.String readCommunityString)

      • getReadCommunityString

        public java.lang.String getReadCommunityString()

      • setWriteCommunityString

        public void setWriteCommunityString​(java.lang.String writeCommunityString)

      • getWriteCommunityString

        public java.lang.String getWriteCommunityString()

      • getFirstIPAddress

        public java.lang.String getFirstIPAddress()

        getFirstIPAddress

        Returns:
        a String object.

      • setFirstIPAddress

        public void setFirstIPAddress​(java.lang.String firstIPAddress)
                       throws java.net.UnknownHostException

        setFirstIPAddress

        Parameters:
        firstIPAddress - a String object.
        Throws:
        java.net.UnknownHostException - if any.

      • setFirstIPAddress

        public void setFirstIPAddress​(java.net.InetAddress firstIPAddress)

        setFirstIPAddress

        Parameters:
        firstIPAddress - a InetAddress object.

      • getLastIPAddress

        public java.lang.String getLastIPAddress()

        getLastIPAddress

        Returns:
        a String object.

      • setLastIPAddress

        public void setLastIPAddress​(java.lang.String lastIPAddress)
                      throws java.net.UnknownHostException

        setLastIPAddress

        Parameters:
        lastIPAddress - a String object.
        Throws:
        java.net.UnknownHostException - if any.

      • setLastIPAddress

        public void setLastIPAddress​(java.net.InetAddress lastIPAddress)

        setLastIPAddress

        Parameters:
        lastIPAddress - a InetAddress object.

      • getMaxVarsPerPdu

        public int getMaxVarsPerPdu()

      • setMaxVarsPerPdu

        public void setMaxVarsPerPdu​(int maxVarsPerPdu)

      • getMaxRepetitions

        public int getMaxRepetitions()

      • setMaxRepetitions

        public void setMaxRepetitions​(int maxRepetitions)

      • getAuthPassphrase

        public java.lang.String getAuthPassphrase()

      • setAuthPassPhrase

        public void setAuthPassPhrase​(java.lang.String authPassPhrase)

      • getAuthProtocol

        public java.lang.String getAuthProtocol()

      • setAuthProtocol

        public void setAuthProtocol​(java.lang.String authProtocol)

      • setPrivProtocol

        public void setPrivProtocol​(java.lang.String privProtocol)

      • getPrivProtocol

        public java.lang.String getPrivProtocol()

      • getPrivPassPhrase

        public java.lang.String getPrivPassPhrase()

      • setPrivPassPhrase

        public void setPrivPassPhrase​(java.lang.String privPassPhrase)

      • getEngineId

        public java.lang.String getEngineId()

      • setEngineId

        public void setEngineId​(java.lang.String engineId)

      • getContextEngineId

        public java.lang.String getContextEngineId()

      • setContextEngineId

        public void setContextEngineId​(java.lang.String contextEngineId)

      • setContextName

        public void setContextName​(java.lang.String contextName)

      • getContextName

        public java.lang.String getContextName()

      • setEnterpriseId

        public void setEnterpriseId​(java.lang.String enterpriseId)

      • getEnterpriseId

        public java.lang.String getEnterpriseId()

      • getSecurityName

        public java.lang.String getSecurityName()

      • setSecurityName

        public void setSecurityName​(java.lang.String securityName)

      • setSecurityLevel

        public void setSecurityLevel​(int securityLevel)

      • getSecurityLevel

        public int getSecurityLevel()

      • getRetryCount

        public int getRetryCount()

        getRetryCount

        Returns:
        a int.

      • setRetryCount

        public void setRetryCount​(int retryCount)

        setRetryCount

        Parameters:
        retryCount - a int.

      • getTimeout

        public int getTimeout()

        getTimeout

        Returns:
        a int.

      • setTimeout

        public void setTimeout​(int timeout)

        setTimeout

        Parameters:
        timeout - a int.

      • getVersion

        public java.lang.String getVersion()

        getVersion

        Returns:
        a String object.

      • setVersion

        public void setVersion​(java.lang.String version)

        setVersion

        Parameters:
        version - a String object.

      • getPort

        public int getPort()

        getPort

        Returns:
        a int.

      • setPort

        public void setPort​(int port)

        setPort

        Parameters:
        port - a int.

      • getMaxRequestSize

        public int getMaxRequestSize()

      • setMaxRequestSize

        public void setMaxRequestSize​(int maxRequestSize)

      • getProxyHost

        public java.lang.String getProxyHost()

      • setProxyHost

        public void setProxyHost​(java.lang.String proxyHost)

      • getLocation

        public java.lang.String getLocation()

      • setLocation

        public void setLocation​(java.lang.String location)

      • getTTL

        public java.lang.Long getTTL()

      • setTTL

        public void setTTL​(java.lang.Long ttl)

      • getRange

        public Range getRange()

        getRange

        Returns:
        a Range object.

      • isSpecific

        public boolean isSpecific()
        Determines if the configureSNMP event is for a specific address.
        Returns:
        true if there is no last IP address specified or if first and last are equal

      • createEvent

        public Event createEvent​(java.lang.String source)
        Creates an event from this.
        Parameters:
        source - The source to set in the Event. Must not be null.
        Returns:
        The event which represents this.

      • createDef

        public Definition createDef()
        Creates an SNMP config definition representing the data in this class. The defintion will either have one specific IP element or one Range element.
        Returns:
        a Definition object.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object