Module org.snmp4j
Package org.snmp4j.security

Class UsmUserEntry

java.lang.Object
org.snmp4j.security.UsmUserEntry
All Implemented Interfaces:
Serializable, Comparable<UsmUserEntry>
public class UsmUserEntry extends Object implements Serializable, Comparable<UsmUserEntry>
The UsmUserEntry class represents a user in the Local Configuration Datastore (LCD). The embedded UsmUser can be localized for an engine ID or not. The localization state is determined by UsmUser.isLocalized(). Adding a non-localized user to the LCD does only makes sense if (1) USM.isEngineDiscoveryEnabled() is true and this user should be used to access command responders without yet unknown engine ID or if (2) this user should be used to receive incoming notifications from agents with (yet) unknown authoritative engine IDs. If a user can be used for discoveries of type (1) and/or (2), then it can be defined by UsmUserEntry(OctetString, UsmUser). Otherwise a constructor wit authoritative engine ID must be used.
Version:
3.8.0
Author:
Frank Fock
See Also:

  • Constructor Details

    • UsmUserEntry

      public UsmUserEntry()
      Creates a new user entry with empty engine ID and empty user.

    • UsmUserEntry

      public UsmUserEntry(OctetString userName, UsmUser user)
      Creates a user with username and associated UsmUser.
      Parameters:
      userName - the username of the new entry.
      user - the UsmUser representing the security information of the user.

    • UsmUserEntry

      public UsmUserEntry(OctetString userName, OctetString engineID, UsmUser user)
      Creates a user with username and associated UsmUser.
      Parameters:
      userName - the username of the new entry.
      engineID - the authoritative engine ID associated with the user.
      user - the UsmUser representing the security information of the user.

    • UsmUserEntry

      public UsmUserEntry(byte[] engineID, OctetString securityName, OID authProtocol, byte[] authKey, OID privProtocol, byte[] privKey)
      Creates a localized user entry.
      Parameters:
      engineID - the engine ID for which the user has been localized.
      securityName - the user and security name of the new entry.
      authProtocol - the authentication protocol ID.
      authKey - the authentication key.
      privProtocol - the privacy protocol ID.
      privKey - the privacy key.

  • Method Details

    • getEngineID

      public OctetString getEngineID()

    • setEngineID

      public void setEngineID(OctetString engineID)

    • setUserName

      public void setUserName(OctetString userName)

    • getUserName

      public OctetString getUserName()

    • setUsmUser

      public void setUsmUser(UsmUser usmUser)

    • getUsmUser

      public UsmUser getUsmUser()

    • setAuthenticationKey

      public void setAuthenticationKey(byte[] authenticationKey)

    • getAuthenticationKey

      public byte[] getAuthenticationKey()

    • setPrivacyKey

      public void setPrivacyKey(byte[] privacyKey)

    • getPrivacyKey

      public byte[] getPrivacyKey()

    • compareTo

      public int compareTo(UsmUserEntry other)
      Compares this user entry with another one by engine ID then by their user names.
      Specified by:
      compareTo in interface Comparable<UsmUserEntry>
      Parameters:
      other - a UsmUserEntry instance.
      Returns:
      a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

    • getStorageType

      public SnmpConstants.StorageTypeEnum getStorageType()

    • setStorageType

      public void setStorageType(SnmpConstants.StorageTypeEnum storageType)

    • getOwnerReference

      public Object getOwnerReference()
      Gets the owner of this user entry (if set).
      Returns:
      an object previously set by setOwnerReference(Object) or null (default).
      Since:
      3.6.3

    • setOwnerReference

      public void setOwnerReference(Object ownerReference)
      Sets the (weak) owner reference of this user entry. If the owner is deleted, this reference disappears and getOwnerReference() returns null.
      Parameters:
      ownerReference - an object identifying itself as owner of this entry (i.e. this object may ignore UsmUserEvents of this object while this reference is present.
      Since:
      3.6.3

    • toString

      public String toString()
      Overrides:
      toString in class Object