Package org.snmp4j.security
Class UsmSecurityParameters
java.lang.Object
org.snmp4j.security.UsmSecurityParameters
- All Implemented Interfaces:
BERSerializable
,SecurityParameters
-
Constructor Summary
ConstructorDescriptionUsmSecurityParameters
(OctetString authoritativeEngineID, Integer32 authoritativeEngineBoots, Integer32 authoritativeEngineTime, OctetString userName, AuthenticationProtocol authenticationProtocol, PrivacyProtocol privacyProtocol) -
Method Summary
Modifier and TypeMethodDescriptionvoid
decodeBER
(BERInputStream inputStream) Decodes aVariable
from anInputStream
.void
encodeBER
(OutputStream outputStream) Encodes aVariable
to anOutputStream
.byte[]
int
byte[]
int
int
int
Returns the length of thisBERSerializable
object in bytes when encoded according to the Basic Encoding Rules (BER).int
getBERMaxLength
(int securityLevel) Gets the maximum length of the BER encoded representation of thisSecurityParameters
instance.int
Returns the length of the payload of thisBERSerializable
object in bytes when encoded according to the Basic Encoding Rules (BER).int
getBERUsmPayloadLengthbyte[]
int
getScopedPduPositionint
Gets the byte position of the first byte (counted from zero) of the security parameters in the whole message.int
void
setAuthenticationKey
(byte[] authenticationKey) void
setAuthenticationParameters
(OctetString authenticationParameters) void
setAuthenticationProtocol
(AuthenticationProtocol authenticationProtocol) void
setAuthoritativeEngineBoots
(int authoritativeEngineBoots) void
setAuthoritativeEngineID
(byte[] authoritativeEngineID) void
setAuthoritativeEngineTime
(int authoritativeEngineTime) void
setPrivacyKey
(byte[] privacyKey) void
setPrivacyParameters
(OctetString privacyParameters) void
setPrivacyProtocol
(PrivacyProtocol privacyProtocol) void
setSecurityParametersPosition
(int securityParametersPosition) Sets the position of the first byte (counted from zero) of the security parameters in the whole SNMP message.void
setUserName
(OctetString userName)
-
Constructor Details
-
UsmSecurityParameters
public UsmSecurityParameters() -
UsmSecurityParameters
public UsmSecurityParameters(OctetString authoritativeEngineID, Integer32 authoritativeEngineBoots, Integer32 authoritativeEngineTime, OctetString userName, AuthenticationProtocol authenticationProtocol, PrivacyProtocol privacyProtocol)
-
-
Method Details
-
getAuthoritativeEngineID
public byte[] getAuthoritativeEngineID() -
setAuthoritativeEngineID
public void setAuthoritativeEngineID(byte[] authoritativeEngineID) -
setAuthoritativeEngineBoots
public void setAuthoritativeEngineBoots(int authoritativeEngineBoots) -
getAuthoritativeEngineBoots
public int getAuthoritativeEngineBoots() -
setAuthoritativeEngineTime
public void setAuthoritativeEngineTime(int authoritativeEngineTime) -
getAuthoritativeEngineTime
public int getAuthoritativeEngineTime() -
setUserName
-
getUserName
-
setAuthenticationProtocol
-
getAuthenticationProtocol
-
setPrivacyProtocol
-
getPrivacyProtocol
-
getBERLength
public int getBERLength()Description copied from interface:BERSerializable
Returns the length of thisBERSerializable
object in bytes when encoded according to the Basic Encoding Rules (BER).- Specified by:
getBERLength
in interfaceBERSerializable
- Returns:
- the BER encoded length of this variable.
-
getBERPayloadLength
public int getBERPayloadLength()Description copied from interface:BERSerializable
Returns the length of the payload of thisBERSerializable
object in bytes when encoded according to the Basic Encoding Rules (BER).- Specified by:
getBERPayloadLength
in interfaceBERSerializable
- Returns:
- the BER encoded length of this variable.
-
decodeBER
Description copied from interface:BERSerializable
Decodes aVariable
from anInputStream
.- Specified by:
decodeBER
in interfaceBERSerializable
- Parameters:
inputStream
- anInputStream
containing a BER encoded byte stream.- Throws:
IOException
- if the stream could not be decoded by using BER rules.
-
getSequencePosition
public int getSequencePosition() -
encodeBER
Description copied from interface:BERSerializable
Encodes aVariable
to anOutputStream
.- Specified by:
encodeBER
in interfaceBERSerializable
- Parameters:
outputStream
- anOutputStream
.- Throws:
IOException
- if an error occurs while writing to the stream.
-
getBERUsmPayloadLength
public int getBERUsmPayloadLength()getBERUsmPayloadLength- Returns:
- int
-
getBERMaxLength
public int getBERMaxLength(int securityLevel) Description copied from interface:SecurityParameters
Gets the maximum length of the BER encoded representation of thisSecurityParameters
instance.- Specified by:
getBERMaxLength
in interfaceSecurityParameters
- Parameters:
securityLevel
- the security level to be used.- Returns:
- the maximum BER encoded length in bytes.
-
getAuthenticationKey
public byte[] getAuthenticationKey() -
setAuthenticationKey
public void setAuthenticationKey(byte[] authenticationKey) -
getPrivacyKey
public byte[] getPrivacyKey() -
setPrivacyKey
public void setPrivacyKey(byte[] privacyKey) -
getPrivacyParameters
-
setPrivacyParameters
-
getAuthenticationParameters
-
setAuthenticationParameters
-
getSecurityParametersPosition
public int getSecurityParametersPosition()Description copied from interface:SecurityParameters
Gets the byte position of the first byte (counted from zero) of the security parameters in the whole message.- Specified by:
getSecurityParametersPosition
in interfaceSecurityParameters
- Returns:
- the position of the first byte (counted from zero) of the security parameters in the whole SNMP message. -1 is returned, when the position is unknown (not set).
-
setSecurityParametersPosition
public void setSecurityParametersPosition(int securityParametersPosition) Description copied from interface:SecurityParameters
Sets the position of the first byte (counted from zero) of the security parameters in the whole SNMP message.- Specified by:
setSecurityParametersPosition
in interfaceSecurityParameters
- Parameters:
securityParametersPosition
- an integer value greater or equal than zero.
-
getAuthParametersPosition
public int getAuthParametersPosition() -
getScopedPduPosition
public int getScopedPduPosition()getScopedPduPosition- Returns:
- int
-