Interface SnmpConnectionHandlerCfg

  • All Superinterfaces:
    Configuration, ConnectionHandlerCfg

    public interface SnmpConnectionHandlerCfg
    extends ConnectionHandlerCfg
    A server-side interface for querying SNMP Connection Handler settings.

    The SNMP Connection Handler can be used to process SNMP requests to retrieve monitoring information described by the MIB 2605. Supported protocol are SNMP V1, V2c and V3.

    • Method Detail

      • addSnmpChangeListener

        void addSnmpChangeListener​(ConfigurationChangeListener<SnmpConnectionHandlerCfg> listener)
        Register to be notified when this SNMP Connection Handler is changed.
        Parameters:
        listener - The SNMP Connection Handler configuration change listener.
      • removeSnmpChangeListener

        void removeSnmpChangeListener​(ConfigurationChangeListener<SnmpConnectionHandlerCfg> listener)
        Deregister an existing SNMP Connection Handler configuration change listener.
        Parameters:
        listener - The SNMP Connection Handler configuration change listener.
      • getAllowedManager

        SortedSet<String> getAllowedManager()
        Gets the "allowed-manager" property.

        Specifies the hosts of the managers to be granted the access rights. This property is required for SNMP v1 and v2 security configuration. An asterisk (*) opens access to all managers.

        Default value: *

        Returns:
        Returns an unmodifiable set containing the values of the "allowed-manager" property.
      • getAllowedUser

        SortedSet<String> getAllowedUser()
        Gets the "allowed-user" property.

        Specifies the users to be granted the access rights. This property is required for SNMP v3 security configuration. An asterisk (*) opens access to all users.

        Default value: *

        Returns:
        Returns an unmodifiable set containing the values of the "allowed-user" property.
      • getCommunity

        String getCommunity()
        Gets the "community" property.

        Specifies the v1,v2 community or the v3 context name allowed to access the MIB 2605 monitoring information or the USM MIB. The mapping between "community" and "context name" is set.

        Default value: OpenDJ

        Returns:
        Returns the value of the "community" property.
      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.

        Default value: org.opends.server.snmp.SNMPConnectionHandler

        Specified by:
        getJavaClass in interface ConnectionHandlerCfg
        Returns:
        Returns the value of the "java-class" property.
      • getListenAddress

        SortedSet<com.forgerock.opendj.util.Host> getListenAddress()
        Gets the "listen-address" property.

        Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.

        Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the SNMP Connection Handler listens on all interfaces.

        Default value: 0.0.0.0

        Returns:
        Returns an unmodifiable set containing the values of the "listen-address" property.
      • getListenPort

        int getListenPort()
        Gets the "listen-port" property.

        Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.

        Only a single port number may be provided.

        Returns:
        Returns the value of the "listen-port" property.
      • isRegisteredMbean

        boolean isRegisteredMbean()
        Gets the "registered-mbean" property.

        Indicates whether the SNMP objects have to be registered in the directory server MBeanServer or not allowing to access SNMP Objects with RMI connector if enabled.

        Default value: false

        Returns:
        Returns the value of the "registered-mbean" property.
      • getSecurityAgentFile

        String getSecurityAgentFile()
        Gets the "security-agent-file" property.

        Specifies the USM security configuration to receive authenticated only SNMP requests.

        Default value: config/snmp/security/opendj-snmp.security

        Returns:
        Returns the value of the "security-agent-file" property.
      • getSecurityLevel

        SnmpConnectionHandlerCfgDefn.SecurityLevel getSecurityLevel()
        Gets the "security-level" property.

        Specifies the type of security level : NoAuthNoPriv : No security mechanisms activated, AuthNoPriv : Authentication activated with no privacy, AuthPriv : Authentication with privacy activated. This property is required for SNMP V3 security configuration.

        Default value: authnopriv

        Returns:
        Returns the value of the "security-level" property.
      • getTrapPort

        int getTrapPort()
        Gets the "trap-port" property.

        Specifies the port to use to send SNMP Traps.

        Returns:
        Returns the value of the "trap-port" property.
      • getTrapsCommunity

        String getTrapsCommunity()
        Gets the "traps-community" property.

        Specifies the community string that must be included in the traps sent to define managers (trap-destinations). This property is used in the context of SNMP v1, v2 and v3.

        Default value: OpenDJ

        Returns:
        Returns the value of the "traps-community" property.
      • getTrapsDestination

        SortedSet<String> getTrapsDestination()
        Gets the "traps-destination" property.

        Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.

        If this list is empty, V1 traps are sent to "localhost". Each host in the list must be identifed by its name or complete IP Addess.

        Returns:
        Returns an unmodifiable set containing the values of the "traps-destination" property.