Module org.snmp4j

Package org.snmp4j.security

Class UsmUserTable

java.lang.Object

org.snmp4j.security.UsmUserTable

All Implemented Interfaces:

Serializable

public class UsmUserTable
extends Object
implements Serializable

The UsmUserTable class stores USM user information as part of the Local Configuration Datastore (LCD).

Version:

1.1

Author:

Frank Fock

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsmUserTable.UsmUserKey	The UsmUserKey class defines the unique key for UsmUserTable by engineID and securityName.

Constructor Summary

Constructors

Constructor	Description
UsmUserTable()

Method Summary

Modifier and Type	Method	Description
UsmUserEntry	addUser(UsmUserEntry user)	Adds or replaces any existing entry with same engineID and securityName combination, see UsmUserTable.UsmUserKey.
void	clear()
UsmUserEntry	getUser(OctetString securityName)
UsmUserEntry	getUser(OctetString engineID, OctetString securityName)
List<UsmUserEntry>	getUserEntries()
List<UsmUserEntry>	getUserEntries(OctetString userName)	Gets all user entries with the supplied user name.
List<UsmUserEntry>	removeAllUsers(OctetString securityName, OctetString engineID)
UsmUserEntry	removeUser(OctetString engineID, OctetString securityName)
void	setUsers(Collection<UsmUserEntry> c)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UsmUserTable

public UsmUserTable()

Method Details

addUser

public UsmUserEntry addUser(UsmUserEntry user)

Adds or replaces any existing entry with same engineID and securityName combination, see UsmUserTable.UsmUserKey.

Parameters:

user - the localized USM user entry.

Returns:

the previously registered entry with same engineID and securityName or otherwise null.

setUsers

public void setUsers(Collection<UsmUserEntry> c)

getUserEntries

public List<UsmUserEntry> getUserEntries(OctetString userName)

Gets all user entries with the supplied user name.

Parameters:

userName - an OctetString denoting the user name.

Returns:

a possibly empty List containing all user entries with the specified userName.

getUserEntries

public List<UsmUserEntry> getUserEntries()

removeAllUsers

public List<UsmUserEntry> removeAllUsers(OctetString securityName,
 OctetString engineID)

removeUser

public UsmUserEntry removeUser(OctetString engineID,
 OctetString securityName)

getUser

public UsmUserEntry getUser(OctetString engineID,
 OctetString securityName)

getUser

public UsmUserEntry getUser(OctetString securityName)

clear

public void clear()