Module org.snmp4j

Package org.snmp4j.security

Class UsmSecurityStateReference

java.lang.Object

org.snmp4j.security.UsmSecurityStateReference

All Implemented Interfaces:

SecurityStateReference

public class UsmSecurityStateReference
extends java.lang.Object
implements SecurityStateReference

The UsmSecurityStateReference holds cached security data for the USM security model.

Version:

3.4.0

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	authenticationKey
private AuthenticationProtocol	authenticationProtocol
private boolean	isCachedForResponseProcessing
private byte[]	privacyKey
private PrivacyProtocol	privacyProtocol
private byte[]	securityEngineID
private int	securityLevel
private byte[]	securityName

Constructor Summary

Constructors

Constructor	Description
UsmSecurityStateReference()

Method Summary

Modifier and Type	Method	Description
boolean	applyTargetSecurityInformation(Target<?> target)	After a SecurityStateReference has been created for on outgoing message, this method might be called by the MPv3 to apply security information contained in the target object to the security state information.
byte[]	getAuthenticationKey()
AuthenticationProtocol	getAuthenticationProtocol()
byte[]	getPrivacyKey()
PrivacyProtocol	getPrivacyProtocol()
byte[]	getSecurityEngineID()
int	getSecurityLevel()
byte[]	getSecurityName()
boolean	isCachedForResponseProcessing()	Returns the isCachedForResponseProcessing flag indicating whether this security state reference has been cached for response processing which means it can be used later for response or report processing rather than for requests or notifications (traps).
void	setAuthenticationKey(byte[] authenticationKey)
void	setAuthenticationProtocol(AuthenticationProtocol authenticationProtocol)
void	setCachedForResponseProcessing(boolean isCachedForResponseProcessing)	Sets the isCachedForResponseProcessing flag to indicate whether this security state reference has been cached for response processing which means it will be used later for response or report processing rather than for requests or notifications (traps).
void	setPrivacyKey(byte[] privacyKey)
void	setPrivacyProtocol(PrivacyProtocol privacyProtocol)
void	setSecurityEngineID(byte[] securityEngineID)
void	setSecurityLevel(int securityLevel)
void	setSecurityName(byte[] securityName)

Methods inherited from class java.lang.Object

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

Field Detail

securityName

private byte[] securityName

securityEngineID

private byte[] securityEngineID

authenticationProtocol

private AuthenticationProtocol authenticationProtocol

privacyProtocol

private PrivacyProtocol privacyProtocol

authenticationKey

private byte[] authenticationKey

privacyKey

private byte[] privacyKey

securityLevel

private int securityLevel

isCachedForResponseProcessing

private boolean isCachedForResponseProcessing

Constructor Detail

UsmSecurityStateReference

public UsmSecurityStateReference()

Method Detail

setSecurityName

public void setSecurityName(byte[] securityName)

getSecurityName

public byte[] getSecurityName()

setSecurityEngineID

public void setSecurityEngineID(byte[] securityEngineID)

getSecurityEngineID

public byte[] getSecurityEngineID()

setAuthenticationProtocol

public void setAuthenticationProtocol(AuthenticationProtocol authenticationProtocol)

getAuthenticationProtocol

public AuthenticationProtocol getAuthenticationProtocol()

setPrivacyProtocol

public void setPrivacyProtocol(PrivacyProtocol privacyProtocol)

getPrivacyProtocol

public PrivacyProtocol getPrivacyProtocol()

setAuthenticationKey

public void setAuthenticationKey(byte[] authenticationKey)

getAuthenticationKey

public byte[] getAuthenticationKey()

setPrivacyKey

public void setPrivacyKey(byte[] privacyKey)

getPrivacyKey

public byte[] getPrivacyKey()

setSecurityLevel

public void setSecurityLevel(int securityLevel)

getSecurityLevel

public int getSecurityLevel()

setCachedForResponseProcessing

public void setCachedForResponseProcessing(boolean isCachedForResponseProcessing)

Description copied from interface: SecurityStateReference

Sets the isCachedForResponseProcessing flag to indicate whether this security state reference has been cached for response processing which means it will be used later for response or report processing rather than for requests or notifications (traps).

Specified by:

setCachedForResponseProcessing in interface SecurityStateReference

Parameters:

isCachedForResponseProcessing - if true, this security state reference has been cached for response processing.

isCachedForResponseProcessing

public boolean isCachedForResponseProcessing()

Description copied from interface: SecurityStateReference

Returns the isCachedForResponseProcessing flag indicating whether this security state reference has been cached for response processing which means it can be used later for response or report processing rather than for requests or notifications (traps).

Specified by:

isCachedForResponseProcessing in interface SecurityStateReference

Returns:

if true, this security state reference has been cached for response processing.

applyTargetSecurityInformation

public boolean applyTargetSecurityInformation(Target<?> target)

Description copied from interface: SecurityStateReference

After a SecurityStateReference has been created for on outgoing message, this method might be called by the MPv3 to apply security information contained in the target object to the security state information. By default, this method does nothing and defers the security state information initialization the the corresponding SecurityModel and returns false.

Specified by:

applyTargetSecurityInformation in interface SecurityStateReference

Parameters:

target - a Target subclass instance with security information.

Returns:

true if the security information of the supplied target could be applied and false otherwise.