com.sun.management.snmp.usm
Interface SnmpUsm

All Superinterfaces:

com.sun.management.internal.snmp.SnmpModel, com.sun.management.internal.snmp.SnmpSecurityModel

All Known Implementing Classes:

SnmpUserSecurityModel

public interface SnmpUsm
extends com.sun.management.internal.snmp.SnmpSecurityModel

This interface is implemented by User based Security Models. You have to implement this interface when developing your own Usm.

Since:

Java DMK 5.1

Field Summary

static int	ID The User based Security Model Id as defined in RFC 2574.
static int	MAX_NB_BOOTS The User based Security Model max nb boots as defined in RFC 2574.
static int	TIME_WINDOW The User based Security Model time window as defined in RFC 2574.
static String	usmNoAuthProtocol The User based Security Model usmNoAuthProtocol OID "1.3.6.1.6.3.10.1.1.1".
static String	usmNoPrivProtocol The User based Security Model usmNoPrivProtocol OID "1.3.6.1.6.3.10.1.2.1".
static String	usmStatsDecryptionErrors The decryption error report OID "1.3.6.1.6.3.15.1.1.6.0"
static String	usmStatsNotInTimeWindows The not in time report OID "1.3.6.1.6.3.15.1.1.2.0"
static String	usmStatsUnknownEngineIds The unknown engine Id report OID "1.3.6.1.6.3.15.1.1.4.0"
static String	usmStatsUnknownUserNames The unknown user name report OID "1.3.6.1.6.3.15.1.1.3.0"
static String	usmStatsUnsupportedSecLevels The unsupported security level report OID "1.3.6.1.6.3.15.1.1.1.0"
static String	usmStatsWrongDigests The wrong digest report OID "1.3.6.1.6.3.15.1.1.5.0"

Method Summary

SnmpUsmSecurityParameters	createUsmSecurityParameters() Instantiates an SnmpUsmSecurityParameters.
Long	getDecryptionErrorsCounter() Gets the Usm error counter.
SnmpUsmEnginePeer	getEnginePeer(SnmpEngineId id) Gets the peer associated with the passed engine Id.
SnmpUsmLcd	getLcd() Gets the associated Usm local configuration datastore.
Long	getNotInTimeWindowsCounter() Gets the Usm error counter.
int	getTimelinessWindow() Get the time window used for timeliness checks.
Long	getUnknownEngineIdsCounter() Gets the Usm error counter.
Long	getUnknownUserNamesCounter() Gets the Usm error counter.
Long	getUnsupportedSecLevelsCounter() Gets the Usm error counter.
Long	getWrongDigestsCounter() Gets the Usm error counter.
void	setLcd(SnmpUsmLcd lcd) Sets the local configuration datastore.
void	setTimelinessWindow(int t) Set the time window used for timeliness checks.

Methods inherited from interface com.sun.management.internal.snmp.SnmpSecurityModel

createSecurityCache, generateRequestMsg, generateResponseMsg, processIncomingRequest, processIncomingResponse, releaseSecurityCache

Methods inherited from interface com.sun.management.internal.snmp.SnmpModel

getName, getSubSystem

Field Detail

ID

static final int ID

The User based Security Model Id as defined in RFC 2574. The Usm Id number is 3.

See Also:

Constant Field Values

MAX_NB_BOOTS

static final int MAX_NB_BOOTS

The User based Security Model max nb boots as defined in RFC 2574. The max nb boots value is (2e31 - 1)

See Also:

Constant Field Values

TIME_WINDOW

static final int TIME_WINDOW

The User based Security Model time window as defined in RFC 2574. The defined value is 150 seconds.

See Also:

Constant Field Values

usmNoAuthProtocol

static final String usmNoAuthProtocol

The User based Security Model usmNoAuthProtocol OID "1.3.6.1.6.3.10.1.1.1".

See Also:

Constant Field Values

usmNoPrivProtocol

static final String usmNoPrivProtocol

The User based Security Model usmNoPrivProtocol OID "1.3.6.1.6.3.10.1.2.1".

See Also:

Constant Field Values

usmStatsNotInTimeWindows

static final String usmStatsNotInTimeWindows

The not in time report OID "1.3.6.1.6.3.15.1.1.2.0"

See Also:

Constant Field Values

usmStatsUnknownEngineIds

static final String usmStatsUnknownEngineIds

The unknown engine Id report OID "1.3.6.1.6.3.15.1.1.4.0"

See Also:

Constant Field Values

usmStatsUnknownUserNames

static final String usmStatsUnknownUserNames

The unknown user name report OID "1.3.6.1.6.3.15.1.1.3.0"

See Also:

Constant Field Values

usmStatsUnsupportedSecLevels

static final String usmStatsUnsupportedSecLevels

The unsupported security level report OID "1.3.6.1.6.3.15.1.1.1.0"

See Also:

Constant Field Values

usmStatsWrongDigests

static final String usmStatsWrongDigests

The wrong digest report OID "1.3.6.1.6.3.15.1.1.5.0"

See Also:

Constant Field Values

usmStatsDecryptionErrors

static final String usmStatsDecryptionErrors

The decryption error report OID "1.3.6.1.6.3.15.1.1.6.0"

See Also:

Constant Field Values

Method Detail

getTimelinessWindow

int getTimelinessWindow()

Get the time window used for timeliness checks. If non are set, the SnmpUsm.TIMEWINDOW is the default used.

Returns:

The time window in seconds.

setTimelinessWindow

void setTimelinessWindow(int t)

Set the time window used for timeliness checks. If non are set, the SnmpUsm.TIMEWINDOW is the default used.

Parameters:

t - The time window in seconds.

getLcd

SnmpUsmLcd getLcd()

Gets the associated Usm local configuration datastore.

Returns:

The Usm local configuration datastore.

setLcd

void setLcd(SnmpUsmLcd lcd)

Sets the local configuration datastore.

Parameters:

lcd - The Usm local configuration datastore.

getUnsupportedSecLevelsCounter

Long getUnsupportedSecLevelsCounter()

Gets the Usm error counter.

Returns:

The counter.

getNotInTimeWindowsCounter

Long getNotInTimeWindowsCounter()

Gets the Usm error counter.

Returns:

The counter.

getUnknownUserNamesCounter

Long getUnknownUserNamesCounter()

Gets the Usm error counter.

Returns:

The counter.

getUnknownEngineIdsCounter

Long getUnknownEngineIdsCounter()

Gets the Usm error counter.

Returns:

The counter.

getWrongDigestsCounter

Long getWrongDigestsCounter()

Gets the Usm error counter.

Returns:

The counter.

getDecryptionErrorsCounter

Long getDecryptionErrorsCounter()

Gets the Usm error counter.

Returns:

The counter.

getEnginePeer

SnmpUsmEnginePeer getEnginePeer(SnmpEngineId id)

Gets the peer associated with the passed engine Id.

Parameters:

id - The SNMP engine Id.

Returns:

The peer.

createUsmSecurityParameters

SnmpUsmSecurityParameters createUsmSecurityParameters()

Instantiates an SnmpUsmSecurityParameters.

Returns:

Empty security parameters.