org.snmp4j.security

Class UsmTimeTable

java.lang.Object

org.snmp4j.security.UsmTimeTable

All Implemented Interfaces:

Serializable

public class UsmTimeTable
extends Object
implements Serializable

The UsmTimeTable class is a singleton that stores USM user information as part of the Local Configuration Datastore (LCD).

Version:

1.2

Author:

Frank Fock

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UsmTimeTable(OctetString localEngineID, int engineBoots)

Method Summary

Modifier and Type	Method and Description
void	addEntry(UsmTimeEntry entry)
int	checkEngineID(OctetString engineID, boolean discoveryAllowed, int engineBoots, int engineTime)
int	checkTime(UsmTimeEntry entry)
int	getEngineBoots() The number of times that the SNMP engine has (re-)initialized itself since snmpEngineID was last configured.
int	getEngineTime() Returns the number of seconds since the value of the engineBoots object last changed.
UsmTimeEntry	getEntry(OctetString engineID)
UsmTimeEntry	getLocalTime()
UsmTimeEntry	getTime(OctetString engineID)
void	removeEntry(OctetString engineID) Removes the specified engine ID from the time cache.
void	reset()
void	setEngineBoots(int engineBoots) Sets the number of engine boots.
void	setLocalTime(UsmTimeEntry localTime)

Methods inherited from class java.lang.Object

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

Constructor Detail

UsmTimeTable

public UsmTimeTable(OctetString localEngineID,
                    int engineBoots)

Method Detail

addEntry

public void addEntry(UsmTimeEntry entry)

getEntry

public UsmTimeEntry getEntry(OctetString engineID)

getLocalTime

public UsmTimeEntry getLocalTime()

setLocalTime

public void setLocalTime(UsmTimeEntry localTime)

setEngineBoots

public void setEngineBoots(int engineBoots)

Sets the number of engine boots.

Parameters:

engineBoots - the number of engine boots.

Since:

1.2

getEngineTime

public int getEngineTime()

Returns the number of seconds since the value of the engineBoots object last changed. When incrementing this object's value would cause it to exceed its maximum, engineBoots is incremented as if a re-initialization had occurred, and this object's value consequently reverts to zero.

Returns:

a positive integer value denoting the number of seconds since the engineBoots value has been changed.

Since:

1.2

getEngineBoots

public int getEngineBoots()

The number of times that the SNMP engine has (re-)initialized itself since snmpEngineID was last configured.

Returns:

the number of SNMP engine reboots.

getTime

public UsmTimeEntry getTime(OctetString engineID)

removeEntry

public void removeEntry(OctetString engineID)

Removes the specified engine ID from the time cache.

Parameters:

engineID - the engine ID of the remote SNMP engine to remove from this time cache.

checkEngineID

public int checkEngineID(OctetString engineID,
                         boolean discoveryAllowed,
                         int engineBoots,
                         int engineTime)

checkTime

public int checkTime(UsmTimeEntry entry)

reset

public void reset()