Package org.forgerock.opendj.server.config.client

Interface SnmpConnectionHandlerCfgClient

  • All Superinterfaces:
    ConfigurationClient, ConnectionHandlerCfgClient
    public interface SnmpConnectionHandlerCfgClient
extends ConnectionHandlerCfgClient
    A client-side interface for reading and modifying 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

      • getAllowedManager

        SortedSet<ValueOrExpression<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 the values of the "allowed-manager" property.

      • setAllowedManager

        void setAllowedManager​(Collection<ValueOrExpression<String>> values)
                throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "allowed-manager" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getAllowedUser

        SortedSet<ValueOrExpression<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 the values of the "allowed-user" property.

      • setAllowedUser

        void setAllowedUser​(Collection<ValueOrExpression<String>> values)
             throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "allowed-user" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getCommunity

        ValueOrExpression<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.

      • setCommunity

        void setCommunity​(ValueOrExpression<String> value)
           throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "community" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getJavaClass

        @MandatoryProperty
ValueOrExpression<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 ConnectionHandlerCfgClient
        Returns:
        Returns the value of the "java-class" property.

      • getListenAddress

        SortedSet<ValueOrExpression<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 the values of the "listen-address" property.

      • setListenAddress

        void setListenAddress​(Collection<ValueOrExpression<com.forgerock.opendj.util.Host>> values)
               throws PropertyException,
                      PropertyException
        Sets 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.

        This property is read-only and can only be modified during creation of a SNMP Connection Handler.

        Parameters:
        values - The values of the "listen-address" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.
        PropertyException - If this SNMP Connection Handler is not being initialized.

      • getListenPort

        @MandatoryProperty
ValueOrExpression<Integer> 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.

      • setListenPort

        @MandatoryProperty
void setListenPort​(ValueOrExpression<Integer> value)
            throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "listen-port" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isRegisteredMbean

        ValueOrExpression<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.

      • setRegisteredMbean

        void setRegisteredMbean​(ValueOrExpression<Boolean> value)
                 throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "registered-mbean" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getSecurityAgentFile

        ValueOrExpression<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.

      • setSecurityAgentFile

        void setSecurityAgentFile​(ValueOrExpression<String> value)
                   throws PropertyException
        Sets the "security-agent-file" property.

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

        Parameters:
        value - The value of the "security-agent-file" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getSecurityLevel

        ValueOrExpression<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.

      • setSecurityLevel

        void setSecurityLevel​(ValueOrExpression<SnmpConnectionHandlerCfgDefn.SecurityLevel> value)
               throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "security-level" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTrapsCommunity

        ValueOrExpression<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.

      • setTrapsCommunity

        void setTrapsCommunity​(ValueOrExpression<String> value)
                throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "traps-community" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTrapsDestination

        SortedSet<ValueOrExpression<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 identified by its name or complete IP Address.

        Returns:
        Returns the values of the "traps-destination" property.

      • setTrapsDestination

        void setTrapsDestination​(Collection<ValueOrExpression<String>> values)
                  throws PropertyException
        Sets 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 identified by its name or complete IP Address.

        Parameters:
        values - The values of the "traps-destination" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.