- java.lang.Object
-
- org.snmp4j.security.UsmSecurityParameters
-
- All Implemented Interfaces:
BERSerializable,SecurityParameters
public class UsmSecurityParameters extends java.lang.Object implements SecurityParameters
-
-
Constructor Summary
Constructors Constructor Description UsmSecurityParameters()UsmSecurityParameters(OctetString authoritativeEngineID, Integer32 authoritativeEngineBoots, Integer32 authoritativeEngineTime, OctetString userName, AuthenticationProtocol authenticationProtocol, PrivacyProtocol privacyProtocol)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddecodeBER(BERInputStream inputStream)Decodes aVariablefrom anInputStream.voidencodeBER(java.io.OutputStream outputStream)Encodes aVariableto anOutputStream.byte[]getAuthenticationKey()OctetStringgetAuthenticationParameters()AuthenticationProtocolgetAuthenticationProtocol()intgetAuthoritativeEngineBoots()byte[]getAuthoritativeEngineID()intgetAuthoritativeEngineTime()intgetAuthParametersPosition()intgetBERLength()Returns the length of thisBERSerializableobject in bytes when encoded according to the Basic Encoding Rules (BER).intgetBERMaxLength(int securityLevel)Gets the maximum length of the BER encoded representation of thisSecurityParametersinstance.intgetBERPayloadLength()Returns the length of the payload of thisBERSerializableobject in bytes when encoded according to the Basic Encoding Rules (BER).intgetBERUsmPayloadLength()getBERUsmPayloadLengthbyte[]getPrivacyKey()OctetStringgetPrivacyParameters()PrivacyProtocolgetPrivacyProtocol()intgetScopedPduPosition()getScopedPduPositionintgetSecurityParametersPosition()Gets the byte position of the first byte (counted from zero) of the security parameters in the whole message.intgetSequencePosition()OctetStringgetUserName()voidsetAuthenticationKey(byte[] authenticationKey)voidsetAuthenticationParameters(OctetString authenticationParameters)voidsetAuthenticationProtocol(AuthenticationProtocol authenticationProtocol)voidsetAuthoritativeEngineBoots(int authoritativeEngineBoots)voidsetAuthoritativeEngineID(byte[] authoritativeEngineID)voidsetAuthoritativeEngineTime(int authoritativeEngineTime)voidsetPrivacyKey(byte[] privacyKey)voidsetPrivacyParameters(OctetString privacyParameters)voidsetPrivacyProtocol(PrivacyProtocol privacyProtocol)voidsetSecurityParametersPosition(int securityParametersPosition)Sets the position of the first byte (counted from zero) of the security parameters in the whole SNMP message.voidsetUserName(OctetString userName)
-
-
-
Constructor Detail
-
UsmSecurityParameters
public UsmSecurityParameters()
-
UsmSecurityParameters
public UsmSecurityParameters(OctetString authoritativeEngineID, Integer32 authoritativeEngineBoots, Integer32 authoritativeEngineTime, OctetString userName, AuthenticationProtocol authenticationProtocol, PrivacyProtocol privacyProtocol)
-
-
Method Detail
-
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
public void setUserName(OctetString userName)
-
getUserName
public OctetString getUserName()
-
setAuthenticationProtocol
public void setAuthenticationProtocol(AuthenticationProtocol authenticationProtocol)
-
getAuthenticationProtocol
public AuthenticationProtocol getAuthenticationProtocol()
-
setPrivacyProtocol
public void setPrivacyProtocol(PrivacyProtocol privacyProtocol)
-
getPrivacyProtocol
public PrivacyProtocol getPrivacyProtocol()
-
getBERLength
public int getBERLength()
Description copied from interface:BERSerializableReturns the length of thisBERSerializableobject in bytes when encoded according to the Basic Encoding Rules (BER).- Specified by:
getBERLengthin interfaceBERSerializable- Returns:
- the BER encoded length of this variable.
-
getBERPayloadLength
public int getBERPayloadLength()
Description copied from interface:BERSerializableReturns the length of the payload of thisBERSerializableobject in bytes when encoded according to the Basic Encoding Rules (BER).- Specified by:
getBERPayloadLengthin interfaceBERSerializable- Returns:
- the BER encoded length of this variable.
-
decodeBER
public void decodeBER(BERInputStream inputStream) throws java.io.IOException
Description copied from interface:BERSerializableDecodes aVariablefrom anInputStream.- Specified by:
decodeBERin interfaceBERSerializable- Parameters:
inputStream- anInputStreamcontaining a BER encoded byte stream.- Throws:
java.io.IOException- if the stream could not be decoded by using BER rules.
-
getSequencePosition
public int getSequencePosition()
-
encodeBER
public void encodeBER(java.io.OutputStream outputStream) throws java.io.IOExceptionDescription copied from interface:BERSerializableEncodes aVariableto anOutputStream.- Specified by:
encodeBERin interfaceBERSerializable- Parameters:
outputStream- anOutputStream.- Throws:
java.io.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:SecurityParametersGets the maximum length of the BER encoded representation of thisSecurityParametersinstance.- Specified by:
getBERMaxLengthin 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
public OctetString getPrivacyParameters()
-
setPrivacyParameters
public void setPrivacyParameters(OctetString privacyParameters)
-
getAuthenticationParameters
public OctetString getAuthenticationParameters()
-
setAuthenticationParameters
public void setAuthenticationParameters(OctetString authenticationParameters)
-
getSecurityParametersPosition
public int getSecurityParametersPosition()
Description copied from interface:SecurityParametersGets the byte position of the first byte (counted from zero) of the security parameters in the whole message.- Specified by:
getSecurityParametersPositionin 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:SecurityParametersSets the position of the first byte (counted from zero) of the security parameters in the whole SNMP message.- Specified by:
setSecurityParametersPositionin interfaceSecurityParameters- Parameters:
securityParametersPosition- an integer value greater or equal than zero.
-
getAuthParametersPosition
public int getAuthParametersPosition()
-
getScopedPduPosition
public int getScopedPduPosition()
getScopedPduPosition- Returns:
- int
-
-