Interface DHKickstartParameters

  • All Known Implementing Classes:
    DHKickstartParametersImpl


    public interface DHKickstartParameters
    The DHKickstartParameters provides the kickstart public parameters needed to initialize Diffie Hellman key exchange. These parameters have to exchanged out-of-band as defined by RFC 2786.
    Since:
    3.0
    Author:
    Frank Fock
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.snmp4j.smi.OID getAuthenticationProtocol​()
      As extension for RFC 2786 this parameter allows to select the authentication protocol to use for the kickstart operation.
      org.snmp4j.smi.OID getPrivacyProtocol​()
      As extension for RFC 2786 this parameter allows to select the privacy protocol to use for the kickstart operation.
      org.snmp4j.smi.OctetString getPublicKey​()
      Gets the public Diffie Hellman public key for this security name (from the command generator).
      org.snmp4j.smi.OctetString getSecurityName​()
      Gets the security name associated with the kickstart parameters.
      String getVacmRole​()
      Returns the (optional) role associated with the security name.
      boolean isResetRequested​()
      Indicates whether an existing user with StorageType nonVolatile or permanent should be replaced by this kickstart user or not.
    • Method Detail

      • getSecurityName

        org.snmp4j.smi.OctetString getSecurityName​()
        Gets the security name associated with the kickstart parameters.
        Returns:
        a SNMPv3 security name.
      • getPublicKey

        org.snmp4j.smi.OctetString getPublicKey​()
        Gets the public Diffie Hellman public key for this security name (from the command generator).
        Returns:
        an octet string.
      • getAuthenticationProtocol

        org.snmp4j.smi.OID getAuthenticationProtocol​()
        As extension for RFC 2786 this parameter allows to select the authentication protocol to use for the kickstart operation. Default is usmHMACMD5AuthProtocol, if null is returned.
        Returns:
        the OID of the authentication protocol or null if the default (usmHMACMD5AuthProtocol) should be used.
      • getPrivacyProtocol

        org.snmp4j.smi.OID getPrivacyProtocol​()
        As extension for RFC 2786 this parameter allows to select the privacy protocol to use for the kickstart operation. Default is usmDESPrivProtocol, if null is returned.
        Returns:
        the OID of the privacy protocol or null if the default (usmDESPrivProtocol) should be used.
      • getVacmRole

        String getVacmRole​()
        Returns the (optional) role associated with the security name. The actual access rights of the role is implementation dependent but should offer at least the following roles:
             admin - unlimited access
             monitor - read-only access
         
        Returns:
        the VACM role that defines the VACM access rights (implementation specific). If no role is provided, the agent will implementation specific select appropriate access rights.
      • isResetRequested

        boolean isResetRequested​()
        Indicates whether an existing user with StorageType nonVolatile or permanent should be replaced by this kickstart user or not.
        Returns:
        true if a reset of an existing user is requested, false otherwise.