Module org.snmp4j
Package org.snmp4j.util

Class SnmpConfigurator

  • public class SnmpConfigurator
extends java.lang.Object
    The SnmpConfigurator class configures a Snmp instance with settings taken from a Map conforming to the format returned by ArgumentParser.parse(String[] args). In addition, a PDUFactory and Target can be created using settings from a Map too.
    Since:
    1.10
    Version:
    3.0

    • Field Detail

      • O_LOCAL_ENGINE_ID

        public static final java.lang.String O_LOCAL_ENGINE_ID
        See Also:
        Constant Field Values

      • P_LOCAL_ENGINE_ID

        public static final java.lang.String P_LOCAL_ENGINE_ID
        See Also:
        Constant Field Values

      • F_LOCAL_ENGINE_ID

        public static final java.lang.String F_LOCAL_ENGINE_ID
        See Also:
        Constant Field Values

      • O_AUTHORITATIVE_ENGINE_ID

        public static final java.lang.String O_AUTHORITATIVE_ENGINE_ID
        See Also:
        Constant Field Values

      • P_AUTHORITATIVE_ENGINE_ID

        public static final java.lang.String P_AUTHORITATIVE_ENGINE_ID
        See Also:
        Constant Field Values

      • F_AUTHORITATIVE_ENGINE_ID

        public static final java.lang.String F_AUTHORITATIVE_ENGINE_ID
        See Also:
        Constant Field Values

      • O_CONTEXT_ENGINE_ID

        public static final java.lang.String O_CONTEXT_ENGINE_ID
        See Also:
        Constant Field Values

      • P_CONTEXT_ENGINE_ID

        public static final java.lang.String P_CONTEXT_ENGINE_ID
        See Also:
        Constant Field Values

      • F_CONTEXT_ENGINE_ID

        public static final java.lang.String F_CONTEXT_ENGINE_ID
        See Also:
        Constant Field Values

      • O_AUTH_PASSPHRASE

        public static final java.lang.String O_AUTH_PASSPHRASE
        See Also:
        Constant Field Values

      • P_AUTH_PASSPHRASE

        public static final java.lang.String P_AUTH_PASSPHRASE
        See Also:
        Constant Field Values

      • F_AUTH_PASSPHRASE

        public static final java.lang.String F_AUTH_PASSPHRASE
        See Also:
        Constant Field Values

      • O_PRIV_PASSPHRASE

        public static final java.lang.String O_PRIV_PASSPHRASE
        See Also:
        Constant Field Values

      • P_PRIV_PASSPHRASE

        public static final java.lang.String P_PRIV_PASSPHRASE
        See Also:
        Constant Field Values

      • F_PRIV_PASSPHRASE

        public static final java.lang.String F_PRIV_PASSPHRASE
        See Also:
        Constant Field Values

      • O_MAX_REPETITIONS

        public static final java.lang.String O_MAX_REPETITIONS
        See Also:
        Constant Field Values

      • P_MAX_REPETITIONS

        public static final java.lang.String P_MAX_REPETITIONS
        See Also:
        Constant Field Values

      • F_MAX_REPETITIONS

        public static final java.lang.String F_MAX_REPETITIONS
        See Also:
        Constant Field Values

      • O_TRAPV1_AGENT_ADDR

        public static final java.lang.String O_TRAPV1_AGENT_ADDR
        See Also:
        Constant Field Values

      • P_TRAPV1_AGENT_ADDR

        public static final java.lang.String P_TRAPV1_AGENT_ADDR
        See Also:
        Constant Field Values

      • F_TRAPV1_AGENT_ADDR

        public static final java.lang.String F_TRAPV1_AGENT_ADDR
        See Also:
        Constant Field Values

      • O_TRAPV1_ENTERPRISE

        public static final java.lang.String O_TRAPV1_ENTERPRISE
        See Also:
        Constant Field Values

      • P_TRAPV1_ENTERPRISE

        public static final java.lang.String P_TRAPV1_ENTERPRISE
        See Also:
        Constant Field Values

      • F_TRAPV1_ENTERPRISE

        public static final java.lang.String F_TRAPV1_ENTERPRISE
        See Also:
        Constant Field Values

      • O_TRAPV1_SPECIFIC_ID

        public static final java.lang.String O_TRAPV1_SPECIFIC_ID
        See Also:
        Constant Field Values

      • P_TRAPV1_SPECIFIC_ID

        public static final java.lang.String P_TRAPV1_SPECIFIC_ID
        See Also:
        Constant Field Values

      • F_TRAPV1_SPECIFIC_ID

        public static final java.lang.String F_TRAPV1_SPECIFIC_ID
        See Also:
        Constant Field Values

      • O_TRAPV1_GENERIC_ID

        public static final java.lang.String O_TRAPV1_GENERIC_ID
        See Also:
        Constant Field Values

      • P_TRAPV1_GENERIC_ID

        public static final java.lang.String P_TRAPV1_GENERIC_ID
        See Also:
        Constant Field Values

      • F_TRAPV1_GENERIC_ID

        public static final java.lang.String F_TRAPV1_GENERIC_ID
        See Also:
        Constant Field Values

      • O_TLS_CERT_FINGERPRINT

        public static final java.lang.String O_TLS_CERT_FINGERPRINT
        See Also:
        Constant Field Values

      • P_TLS_CERT_FINGERPRINT

        public static final java.lang.String P_TLS_CERT_FINGERPRINT
        See Also:
        Constant Field Values

      • F_TLS_CERT_FINGERPRINT

        public static final java.lang.String F_TLS_CERT_FINGERPRINT
        See Also:
        Constant Field Values

      • oVersion

        private java.lang.String oVersion

      • oLocalEngineID

        private java.lang.String oLocalEngineID

      • oRetries

        private java.lang.String oRetries

      • oTimeout

        private java.lang.String oTimeout

      • oAddress

        private java.lang.String oAddress

      • oBindAddress

        private java.lang.String oBindAddress

      • oCommunity

        private java.lang.String oCommunity

      • oAuthoritativeEngineID

        private java.lang.String oAuthoritativeEngineID

      • oSecurityName

        private java.lang.String oSecurityName

      • oAuthPassphrase

        private java.lang.String oAuthPassphrase

      • oAuthProtocol

        private java.lang.String oAuthProtocol

      • oPrivPassphrase

        private java.lang.String oPrivPassphrase

      • oPrivProtocol

        private java.lang.String oPrivProtocol

      • oOperation

        private java.lang.String oOperation

      • oMaxRepetitions

        private java.lang.String oMaxRepetitions

      • oNonRepeaters

        private java.lang.String oNonRepeaters

      • oBootCounter

        private java.lang.String oBootCounter

      • oContextName

        private java.lang.String oContextName

      • oContextEngineID

        private java.lang.String oContextEngineID

      • oSecLevel

        private java.lang.String oSecLevel

      • oSecModel

        private java.lang.String oSecModel

      • oAgentAddr

        private java.lang.String oAgentAddr

      • oTrapOID

        private java.lang.String oTrapOID

      • oTrapSysUpTime

        private java.lang.String oTrapSysUpTime

      • oGenericID

        private java.lang.String oGenericID

      • oSpecificID

        private java.lang.String oSpecificID

      • oEnterprise

        private java.lang.String oEnterprise

      • oTlsLocalID

        private java.lang.String oTlsLocalID

      • oTlsTrustCA

        private java.lang.String oTlsTrustCA

      • oTlsPeerID

        private java.lang.String oTlsPeerID

      • oTlsVersion

        private java.lang.String oTlsVersion

      • oDtlsVersion

        private java.lang.String oDtlsVersion

      • oTlsCertFingerprint

        private java.lang.String oTlsCertFingerprint

      • commandResponder

        private boolean commandResponder

    • Constructor Detail

      • SnmpConfigurator

        public SnmpConfigurator()

      • SnmpConfigurator

        public SnmpConfigurator​(java.util.Properties props)

      • SnmpConfigurator

        public SnmpConfigurator​(boolean commandResponder)

      • SnmpConfigurator

        public SnmpConfigurator​(java.util.Properties props,
                        boolean commandResponder)

    • Method Detail

      • isCommandResponder

        public boolean isCommandResponder()

      • setCommandResponder

        public void setCommandResponder​(boolean commandResponder)

      • configure

        public void configure​(Snmp snmp,
                      java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings)

      • configure

        public void configure​(Session snmp,
                      USM usm,
                      MessageDispatcher messageDispatcher,
                      java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings)

      • getPrivProtocolOid

        public static OID getPrivProtocolOid​(java.lang.String privP)

      • getAuthProtocolOid

        public static OID getAuthProtocolOid​(java.lang.String authP)

      • configureEngine

        private void configureEngine​(Session snmp,
                             USM usm,
                             java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings)

      • getTlsProperties

        private java.util.Properties getTlsProperties​(java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings)

      • getPDUFactory

        public PDUFactory getPDUFactory​(java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings)

      • getTarget

        public Target<? super Address> getTarget​(java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings)

      • setSecurityLevelOnTarget

        private void setSecurityLevelOnTarget​(java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings,
                                      AbstractTarget<?> target)

      • getBindAddress

        public Address getBindAddress​(java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> settings)

      • createOctetString

        public static OctetString createOctetString​(java.lang.String s,
                                            java.lang.String defaultString)
        Create an OctetString from a String value.
        Parameters:
        s - the string value to convert. If it starts with 0x its trailing value will be interpreted as a hex string with colon (:) separator.
        defaultString - an optional default if s is null.
        Returns:
        an OctetString or null if s is null.
        Since:
        1.10.2