org.snmp4j.security
Class UsmSecurityParameters

java.lang.Object
  extended by org.snmp4j.security.UsmSecurityParameters
All Implemented Interfaces:
BERSerializable, SecurityParameters

public class UsmSecurityParameters
extends java.lang.Object
implements SecurityParameters


Constructor Summary
UsmSecurityParameters()
           
UsmSecurityParameters(OctetString authoritativeEngineID, Integer32 authoritativeEngineBoots, Integer32 authoritativeEngineTime, OctetString userName, AuthenticationProtocol authenticationProtocol, PrivacyProtocol privacyProtocol)
           
 
Method Summary
 void decodeBER(BERInputStream inputStream)
          Decodes a Variable from an InputStream.
 void encodeBER(java.io.OutputStream outputStream)
          Encodes a Variable to an OutputStream.
 byte[] getAuthenticationKey()
           
 OctetString getAuthenticationParameters()
           
 AuthenticationProtocol getAuthenticationProtocol()
           
 int getAuthoritativeEngineBoots()
           
 byte[] getAuthoritativeEngineID()
           
 int getAuthoritativeEngineTime()
           
 int getAuthParametersPosition()
           
 int getBERLength()
          Returns the length of this BERSerializable 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 this SecurityParameters instance.
 int getBERPayloadLength()
          Returns the length of the payload of this BERSerializable object in bytes when encoded according to the Basic Encoding Rules (BER).
 int getBERUsmPayloadLength()
          getBERUsmPayloadLength
 byte[] getPrivacyKey()
           
 OctetString getPrivacyParameters()
           
 PrivacyProtocol getPrivacyProtocol()
           
 int getScopedPduPosition()
          getScopedPduPosition
 int getSecurityParametersPosition()
          Gets the byte position of the first byte (counted from zero) of the security parameters in the whole message.
 OctetString getUserName()
           
 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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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: BERSerializable
Returns the length of this BERSerializable object in bytes when encoded according to the Basic Encoding Rules (BER).

Specified by:
getBERLength in interface BERSerializable
Returns:
the BER encoded length of this variable.

getBERPayloadLength

public int getBERPayloadLength()
Description copied from interface: BERSerializable
Returns the length of the payload of this BERSerializable object in bytes when encoded according to the Basic Encoding Rules (BER).

Specified by:
getBERPayloadLength in interface BERSerializable
Returns:
the BER encoded length of this variable.

decodeBER

public void decodeBER(BERInputStream inputStream)
               throws java.io.IOException
Description copied from interface: BERSerializable
Decodes a Variable from an InputStream.

Specified by:
decodeBER in interface BERSerializable
Parameters:
inputStream - an InputStream containing a BER encoded byte stream.
Throws:
java.io.IOException - if the stream could not be decoded by using BER rules.

encodeBER

public void encodeBER(java.io.OutputStream outputStream)
               throws java.io.IOException
Description copied from interface: BERSerializable
Encodes a Variable to an OutputStream.

Specified by:
encodeBER in interface BERSerializable
Parameters:
outputStream - an OutputStream.
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: SecurityParameters
Gets the maximum length of the BER encoded representation of this SecurityParameters instance.

Specified by:
getBERMaxLength in interface SecurityParameters
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: SecurityParameters
Gets the byte position of the first byte (counted from zero) of the security parameters in the whole message.

Specified by:
getSecurityParametersPosition in interface SecurityParameters
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 interface SecurityParameters
Parameters:
securityParametersPosition - an integer value >= 0.

getAuthParametersPosition

public int getAuthParametersPosition()

getScopedPduPosition

public int getScopedPduPosition()
getScopedPduPosition

Returns:
int

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.