Package org.opennms.netmgt.config.snmp

Class Configuration

    • Constructor Summary

      Constructors 
      Constructor Description
      Configuration()  
      Configuration​(java.lang.Integer port, java.lang.Integer retry, java.lang.Integer timeout, java.lang.String readCommunity, java.lang.String writeCommunity, java.lang.String proxyHost, java.lang.String version, java.lang.Integer maxVarsPerPdu, java.lang.Integer maxRepetitions, java.lang.Integer maxRequestSize, java.lang.String securityName, java.lang.Integer securityLevel, java.lang.String authPassphrase, java.lang.String authProtocol, java.lang.String engineId, java.lang.String contextEngineId, java.lang.String contextName, java.lang.String privacyPassphrase, java.lang.String privacyProtocol, java.lang.String enterpriseId)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deleteMaxRepetitions()  
      void deleteMaxRequestSize()  
      void deleteMaxVarsPerPdu()  
      void deletePort()  
      void deleteRetry()  
      void deleteSecurityLevel()  
      void deleteTimeout()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAuthPassphrase()
      Returns the value of field 'authPassphrase'.
      java.lang.String getAuthProtocol()
      Returns the value of field 'authProtocol'.
      java.lang.String getContextEngineId()
      Returns the value of field 'contextEngineId'.
      java.lang.String getContextName()
      Returns the value of field 'contextName'.
      java.lang.String getEngineId()
      Returns the value of field 'engineId'.
      java.lang.String getEnterpriseId()
      Returns the value of field 'enterpriseId'.
      java.lang.Integer getMaxRepetitions()
      Returns the value of field 'maxRepetitions'.
      java.lang.Integer getMaxRequestSize()
      Returns the value of field 'maxRequestSize'.
      java.lang.Integer getMaxVarsPerPdu()
      Returns the value of field 'maxVarsPerPdu'.
      java.lang.Integer getPort()
      Returns the value of field 'port'.
      java.lang.String getPrivacyPassphrase()
      Returns the value of field 'privacyPassphrase'.
      java.lang.String getPrivacyProtocol()
      Returns the value of field 'privacyProtocol'.
      java.lang.String getProxyHost()
      Returns the value of field 'proxyHost'.
      java.lang.String getReadCommunity()
      Returns the value of field 'readCommunity'.
      java.lang.Integer getRetry()
      Returns the value of field 'retry'.
      java.lang.Integer getSecurityLevel()
      Returns the value of field 'securityLevel'.
      java.lang.String getSecurityName()
      Returns the value of field 'securityName'.
      java.lang.Integer getTimeout()
      Returns the value of field 'timeout'.
      java.lang.Long getTTL()  
      java.lang.String getVersion()
      Returns the value of field 'version'.
      java.lang.String getWriteCommunity()
      Returns the value of field 'writeCommunity'.
      int hashCode()  
      boolean hasMaxRepetitions()
      Method hasMaxRepetitions.
      boolean hasMaxRequestSize()
      Method hasMaxRequestSize.
      boolean hasMaxVarsPerPdu()
      Method hasMaxVarsPerPdu.
      boolean hasPort()
      Method hasPort.
      boolean hasRetry()
      Method hasRetry.
      boolean hasSecurityLevel()
      Method hasSecurityLevel.
      boolean hasTimeout()
      Method hasTimeout.
      boolean hasTTL()  
      void setAuthPassphrase​(java.lang.String authPassphrase)
      Sets the value of field 'authPassphrase'.
      void setAuthProtocol​(java.lang.String authProtocol)
      Sets the value of field 'authProtocol'.
      void setContextEngineId​(java.lang.String contextEngineId)
      Sets the value of field 'contextEngineId'.
      void setContextName​(java.lang.String contextName)
      Sets the value of field 'contextName'.
      void setEngineId​(java.lang.String engineId)
      Sets the value of field 'engineId'.
      void setEnterpriseId​(java.lang.String enterpriseId)
      Sets the value of field 'enterpriseId'.
      void setMaxRepetitions​(java.lang.Integer maxRepetitions)
      Sets the value of field 'maxRepetitions'.
      void setMaxRequestSize​(java.lang.Integer maxRequestSize)
      Sets the value of field 'maxRequestSize'.
      void setMaxVarsPerPdu​(java.lang.Integer maxVarsPerPdu)
      Sets the value of field 'maxVarsPerPdu'.
      void setPort​(java.lang.Integer port)
      Sets the value of field 'port'.
      void setPrivacyPassphrase​(java.lang.String privacyPassphrase)
      Sets the value of field 'privacyPassphrase'.
      void setPrivacyProtocol​(java.lang.String privacyProtocol)
      Sets the value of field 'privacyProtocol'.
      void setProxyHost​(java.lang.String proxyHost)
      Sets the value of field 'proxyHost'.
      void setReadCommunity​(java.lang.String readCommunity)
      Sets the value of field 'readCommunity'.
      void setRetry​(java.lang.Integer retry)
      Sets the value of field 'retry'.
      void setSecurityLevel​(java.lang.Integer securityLevel)
      Sets the value of field 'securityLevel'.
      void setSecurityName​(java.lang.String securityName)
      Sets the value of field 'securityName'.
      void setTimeout​(java.lang.Integer timeout)
      Sets the value of field 'timeout'.
      void setTTL​(java.lang.Long ttl)  
      void setVersion​(java.lang.String version)
      Sets the value of field 'version'.
      void setWriteCommunity​(java.lang.String writeCommunity)
      Sets the value of field 'writeCommunity'.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Configuration

        public Configuration()

      • Configuration

        public Configuration​(java.lang.Integer port,
                     java.lang.Integer retry,
                     java.lang.Integer timeout,
                     java.lang.String readCommunity,
                     java.lang.String writeCommunity,
                     java.lang.String proxyHost,
                     java.lang.String version,
                     java.lang.Integer maxVarsPerPdu,
                     java.lang.Integer maxRepetitions,
                     java.lang.Integer maxRequestSize,
                     java.lang.String securityName,
                     java.lang.Integer securityLevel,
                     java.lang.String authPassphrase,
                     java.lang.String authProtocol,
                     java.lang.String engineId,
                     java.lang.String contextEngineId,
                     java.lang.String contextName,
                     java.lang.String privacyPassphrase,
                     java.lang.String privacyProtocol,
                     java.lang.String enterpriseId)

    • Method Detail

      • deleteMaxRepetitions

        public void deleteMaxRepetitions()

      • deleteMaxRequestSize

        public void deleteMaxRequestSize()

      • deleteMaxVarsPerPdu

        public void deleteMaxVarsPerPdu()

      • deletePort

        public void deletePort()

      • deleteRetry

        public void deleteRetry()

      • deleteSecurityLevel

        public void deleteSecurityLevel()

      • deleteTimeout

        public void deleteTimeout()

      • getAuthPassphrase

        public final java.lang.String getAuthPassphrase()
        Returns the value of field 'authPassphrase'. The field 'authPassphrase' has the following description: SNMPv3
        Returns:
        the value of field 'AuthPassphrase'.

      • getAuthProtocol

        public final java.lang.String getAuthProtocol()
        Returns the value of field 'authProtocol'. The field 'authProtocol' has the following description: SNMPv3
        Returns:
        the value of field 'AuthProtocol'.

      • getContextEngineId

        public final java.lang.String getContextEngineId()
        Returns the value of field 'contextEngineId'. The field 'contextEngineId' has the following description: SNMPv3
        Returns:
        the value of field 'ContextEngineId'.

      • getContextName

        public final java.lang.String getContextName()
        Returns the value of field 'contextName'. The field 'contextName' has the following description: SNMPv3
        Returns:
        the value of field 'ContextName'.

      • getEngineId

        public final java.lang.String getEngineId()
        Returns the value of field 'engineId'. The field 'engineId' has the following description: SNMPv3
        Returns:
        the value of field 'EngineId'.

      • getEnterpriseId

        public final java.lang.String getEnterpriseId()
        Returns the value of field 'enterpriseId'. The field 'enterpriseId' has the following description: SNMPv3
        Returns:
        the value of field 'EnterpriseId'.

      • getMaxRepetitions

        public final java.lang.Integer getMaxRepetitions()
        Returns the value of field 'maxRepetitions'. The field 'maxRepetitions' has the following description: Number of repetitions to send per get-bulk request.
        Returns:
        the value of field 'MaxRepetitions'.

      • getMaxRequestSize

        public final java.lang.Integer getMaxRequestSize()
        Returns the value of field 'maxRequestSize'. The field 'maxRequestSize' has the following description: (SNMP4J specific) Specifies the maximum number of bytes that may be encoded into an individual SNMP PDU request by Collectd. Provides a means to limit the size of outgoing PDU requests. Default is 65535, must be at least 484.
        Returns:
        the value of field 'MaxRequestSize'.

      • getMaxVarsPerPdu

        public final java.lang.Integer getMaxVarsPerPdu()
        Returns the value of field 'maxVarsPerPdu'. The field 'maxVarsPerPdu' has the following description: Number of variables to send per SNMP request.
        Returns:
        the value of field 'MaxVarsPerPdu'.

      • getPort

        public final java.lang.Integer getPort()
        Returns the value of field 'port'. The field 'port' has the following description: If set, overrides UDP port 161 as the port where SNMP GET/GETNEXT/GETBULK requests are sent.
        Returns:
        the value of field 'Port'.

      • getPrivacyPassphrase

        public final java.lang.String getPrivacyPassphrase()
        Returns the value of field 'privacyPassphrase'. The field 'privacyPassphrase' has the following description: SNMPv3
        Returns:
        the value of field 'PrivacyPassphrase'.

      • getPrivacyProtocol

        public final java.lang.String getPrivacyProtocol()
        Returns the value of field 'privacyProtocol'. The field 'privacyProtocol' has the following description: SNMPv3
        Returns:
        the value of field 'PrivacyProtocol'.

      • getProxyHost

        public final java.lang.String getProxyHost()
        Returns the value of field 'proxyHost'. The field 'proxyHost' has the following description: The proxy host to use when communiciating with this agent
        Returns:
        the value of field 'ProxyHost'.

      • getReadCommunity

        public final java.lang.String getReadCommunity()
        Returns the value of field 'readCommunity'. The field 'readCommunity' has the following description: Default read community string
        Returns:
        the value of field 'ReadCommunity'.

      • getRetry

        public final java.lang.Integer getRetry()
        Returns the value of field 'retry'. The field 'retry' has the following description: Default number of retries
        Returns:
        the value of field 'Retry'.

      • getSecurityLevel

        public final java.lang.Integer getSecurityLevel()
        Returns the value of field 'securityLevel'. The field 'securityLevel' has the following description: SNMPv3
        Returns:
        the value of field 'SecurityLevel'.

      • getSecurityName

        public final java.lang.String getSecurityName()
        Returns the value of field 'securityName'. The field 'securityName' has the following description: SNMPv3
        Returns:
        the value of field 'SecurityName'.

      • getTimeout

        public final java.lang.Integer getTimeout()
        Returns the value of field 'timeout'. The field 'timeout' has the following description: Default timeout (in milliseconds)
        Returns:
        the value of field 'Timeout'.

      • getVersion

        public final java.lang.String getVersion()
        Returns the value of field 'version'. The field 'version' has the following description: If set, forces SNMP data collection to the specified version.
        Returns:
        the value of field 'Version'.

      • getWriteCommunity

        public final java.lang.String getWriteCommunity()
        Returns the value of field 'writeCommunity'. The field 'writeCommunity' has the following description: Default write community string
        Returns:
        the value of field 'WriteCommunity'.

      • hasMaxRepetitions

        public boolean hasMaxRepetitions()
        Method hasMaxRepetitions.
        Returns:
        true if at least one MaxRepetitions has been added

      • hasMaxRequestSize

        public boolean hasMaxRequestSize()
        Method hasMaxRequestSize.
        Returns:
        true if at least one MaxRequestSize has been added

      • hasMaxVarsPerPdu

        public boolean hasMaxVarsPerPdu()
        Method hasMaxVarsPerPdu.
        Returns:
        true if at least one MaxVarsPerPdu has been added

      • hasPort

        public boolean hasPort()
        Method hasPort.
        Returns:
        true if at least one Port has been added

      • hasRetry

        public boolean hasRetry()
        Method hasRetry.
        Returns:
        true if at least one Retry has been added

      • hasSecurityLevel

        public boolean hasSecurityLevel()
        Method hasSecurityLevel.
        Returns:
        true if at least one SecurityLevel has been added

      • hasTimeout

        public boolean hasTimeout()
        Method hasTimeout.
        Returns:
        true if at least one Timeout has been added

      • hasTTL

        public boolean hasTTL()
        Returns:
        true if there is ttl defined

      • setAuthPassphrase

        public final void setAuthPassphrase​(java.lang.String authPassphrase)
        Sets the value of field 'authPassphrase'. The field 'authPassphrase' has the following description: SNMPv3
        Parameters:
        authPassphrase - the value of field 'authPassphrase'.

      • setAuthProtocol

        public final void setAuthProtocol​(java.lang.String authProtocol)
        Sets the value of field 'authProtocol'. The field 'authProtocol' has the following description: SNMPv3
        Parameters:
        authProtocol - the value of field 'authProtocol'.

      • setContextEngineId

        public final void setContextEngineId​(java.lang.String contextEngineId)
        Sets the value of field 'contextEngineId'. The field 'contextEngineId' has the following description: SNMPv3
        Parameters:
        contextEngineId - the value of field 'contextEngineId'.

      • setContextName

        public final void setContextName​(java.lang.String contextName)
        Sets the value of field 'contextName'. The field 'contextName' has the following description: SNMPv3
        Parameters:
        contextName - the value of field 'contextName'.

      • setEngineId

        public final void setEngineId​(java.lang.String engineId)
        Sets the value of field 'engineId'. The field 'engineId' has the following description: SNMPv3
        Parameters:
        engineId - the value of field 'engineId'.

      • setEnterpriseId

        public final void setEnterpriseId​(java.lang.String enterpriseId)
        Sets the value of field 'enterpriseId'. The field 'enterpriseId' has the following description: SNMPv3
        Parameters:
        enterpriseId - the value of field 'enterpriseId'.

      • setMaxRepetitions

        public final void setMaxRepetitions​(java.lang.Integer maxRepetitions)
        Sets the value of field 'maxRepetitions'. The field 'maxRepetitions' has the following description: Number of repetitions to send per get-bulk request.
        Parameters:
        maxRepetitions - the value of field 'maxRepetitions'.

      • setMaxRequestSize

        public final void setMaxRequestSize​(java.lang.Integer maxRequestSize)
        Sets the value of field 'maxRequestSize'. The field 'maxRequestSize' has the following description: (SNMP4J specific) Specifies the maximum number of bytes that may be encoded into an individual SNMP PDU request by Collectd. Provides a means to limit the size of outgoing PDU requests. Default is 65535, must be at least 484.
        Parameters:
        maxRequestSize - the value of field 'maxRequestSize'.

      • setMaxVarsPerPdu

        public final void setMaxVarsPerPdu​(java.lang.Integer maxVarsPerPdu)
        Sets the value of field 'maxVarsPerPdu'. The field 'maxVarsPerPdu' has the following description: Number of variables to send per SNMP request.
        Parameters:
        maxVarsPerPdu - the value of field 'maxVarsPerPdu'.

      • setPort

        public final void setPort​(java.lang.Integer port)
        Sets the value of field 'port'. The field 'port' has the following description: If set, overrides UDP port 161 as the port where SNMP GET/GETNEXT/GETBULK requests are sent.
        Parameters:
        port - the value of field 'port'.

      • setPrivacyPassphrase

        public final void setPrivacyPassphrase​(java.lang.String privacyPassphrase)
        Sets the value of field 'privacyPassphrase'. The field 'privacyPassphrase' has the following description: SNMPv3
        Parameters:
        privacyPassphrase - the value of field 'privacyPassphrase'.

      • setPrivacyProtocol

        public final void setPrivacyProtocol​(java.lang.String privacyProtocol)
        Sets the value of field 'privacyProtocol'. The field 'privacyProtocol' has the following description: SNMPv3
        Parameters:
        privacyProtocol - the value of field 'privacyProtocol'.

      • setProxyHost

        public final void setProxyHost​(java.lang.String proxyHost)
        Sets the value of field 'proxyHost'. The field 'proxyHost' has the following description: The proxy host to use when communiciating with this agent
        Parameters:
        proxyHost - the value of field 'proxyHost'.

      • setReadCommunity

        public final void setReadCommunity​(java.lang.String readCommunity)
        Sets the value of field 'readCommunity'. The field 'readCommunity' has the following description: Default read community string
        Parameters:
        readCommunity - the value of field 'readCommunity'.

      • setRetry

        public final void setRetry​(java.lang.Integer retry)
        Sets the value of field 'retry'. The field 'retry' has the following description: Default number of retries
        Parameters:
        retry - the value of field 'retry'.

      • setSecurityLevel

        public final void setSecurityLevel​(java.lang.Integer securityLevel)
        Sets the value of field 'securityLevel'. The field 'securityLevel' has the following description: SNMPv3
        Parameters:
        securityLevel - the value of field 'securityLevel'.

      • setSecurityName

        public final void setSecurityName​(java.lang.String securityName)
        Sets the value of field 'securityName'. The field 'securityName' has the following description: SNMPv3
        Parameters:
        securityName - the value of field 'securityName'.

      • setTimeout

        public final void setTimeout​(java.lang.Integer timeout)
        Sets the value of field 'timeout'. The field 'timeout' has the following description: Default timeout (in milliseconds)
        Parameters:
        timeout - the value of field 'timeout'.

      • setVersion

        public final void setVersion​(java.lang.String version)
        Sets the value of field 'version'. The field 'version' has the following description: If set, forces SNMP data collection to the specified version.
        Parameters:
        version - the value of field 'version'.

      • setWriteCommunity

        public final void setWriteCommunity​(java.lang.String writeCommunity)
        Sets the value of field 'writeCommunity'. The field 'writeCommunity' has the following description: Default write community string
        Parameters:
        writeCommunity - the value of field 'writeCommunity'.

      • getTTL

        public java.lang.Long getTTL()

      • setTTL

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

      • hashCode

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

      • equals

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

      • toString

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