com.sun.management.snmp.usm
Interface SnmpUsmSecureUser

public interface SnmpUsmSecureUser

This interface models an Usm user. This is the interface that is known from the SnmpUsmLcd

Since:

Java DMK 5.1

Method Summary

void	cloneAuthPair(SnmpUsmAuthPair pair) Clones the passed pair.
void	clonePrivPair(SnmpUsmPrivPair pair) Clones the passed pair.
byte[]	getAuthDelta(byte[] newKey, byte[] random) Gets the authentication key delta needed when processing key change.
SnmpUsmAuthPair	getAuthPair() Gets the authentication pair.
SnmpEngineId	getEngineId() Gets the authoritative engine Id.
String	getName() Gets the user name.
byte[]	getPrivDelta(byte[] newKey, byte[] random) Gets the privacy key delta needed when processing key change.
SnmpUsmPrivPair	getPrivPair() Gets the privacy pair.
int	getSecurityLevel() Gets the security level.
String	getSecurityName() Gets the user security name.
int	getStorageType() Gets the storage type.
boolean	isTemplate() checks if the user is a template.
void	setAuthAlgorithm(String name) Sets the authentication algorithm.
void	setAuthKeyChange(byte[] randomdelta) Sets the random delta value that comes from remote configuration.
void	setPrivAlgorithm(String name) Sets the privacy algorithm.
void	setPrivKeyChange(byte[] randomdelta) Sets the random delta value that comes from remote configuration.
void	setSecurityName(String s) Sets the security name.
void	setStorageType(int storage) Sets the storage type.
void	setTemplateStatus(boolean state) Set the template status.
void	updateConfiguration() Update the configuration.

Method Detail

getName

String getName()

Gets the user name.

Returns:

The user name.

getSecurityName

String getSecurityName()

Gets the user security name.

Returns:

The user security name.

getEngineId

SnmpEngineId getEngineId()

Gets the authoritative engine Id.

Returns:

The authoritative engine Id.

getStorageType

int getStorageType()

Gets the storage type.

Returns:

The storage type (PERMANENT or VOLATILE).

setAuthAlgorithm

void setAuthAlgorithm(String name)

Sets the authentication algorithm.

Parameters:

name - The algorithm name.

cloneAuthPair

void cloneAuthPair(SnmpUsmAuthPair pair)

Clones the passed pair.

Parameters:

pair - The authentication pair.

clonePrivPair

void clonePrivPair(SnmpUsmPrivPair pair)

Clones the passed pair.

Parameters:

pair - The privacy pair.

setPrivAlgorithm

void setPrivAlgorithm(String name)

Sets the privacy algorithm.

Parameters:

name - The algorithm name.

setSecurityName

void setSecurityName(String s)

Sets the security name.

Parameters:

s - The security name.

setStorageType

void setStorageType(int storage)

Sets the storage type.

Parameters:

storage - The storage type (PERMANENT or VOLATILE).

getAuthDelta

byte[] getAuthDelta(byte[] newKey,
                    byte[] random)

Gets the authentication key delta needed when processing key change.

Parameters:

newKey - The new key.

random - The random part of key change.

Returns:

The computed delta.

getPrivDelta

byte[] getPrivDelta(byte[] newKey,
                    byte[] random)

Gets the privacy key delta needed when processing key change.

Parameters:

newKey - The new key.

random - The random part of key change.

Returns:

The computed delta.

setAuthKeyChange

void setAuthKeyChange(byte[] randomdelta)

Sets the random delta value that comes from remote configuration.

Parameters:

randomdelta - The key change value.

setPrivKeyChange

void setPrivKeyChange(byte[] randomdelta)

Sets the random delta value that comes from remote configuration.

Parameters:

randomdelta - The key change value.

getAuthPair

SnmpUsmAuthPair getAuthPair()

Gets the authentication pair. A pair is an algorithm/key instance. A pair can be null if the algorithm provided in the configuration is not loaded in the agent.

Returns:

The authentication pair.

getPrivPair

SnmpUsmPrivPair getPrivPair()

Gets the privacy pair.

Returns:

The privacy pair.

getSecurityLevel

int getSecurityLevel()

Gets the security level.

Returns:

The security level.

updateConfiguration

void updateConfiguration()

Update the configuration. The persistent area will be updated with user values.

isTemplate

boolean isTemplate()

checks if the user is a template. A template is not registered in USM MIB. By default, secureUser are not template.

Returns:

True, the user is a template.

setTemplateStatus

void setTemplateStatus(boolean state)

Set the template status. A template is not registered in USM MIB. By default, secureUser are not template.

Parameters:

state - The template state.