java.lang.Object
org.snmp4j.smi.AbstractVariable
org.snmp4j.smi.OctetString
org.snmp4j.security.SecretOctetString
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Variable>
,BERSerializable
,AssignableFromByteArray
,AssignableFromString
,Variable
The
SecretOctetString
is an OctetString
for secret data like keys and passwords.
It behaves like a regular OctetString
except that the toString()
method
does not reveal any security information but returns a AuthHMAC192SHA256
hash of the real
security information.- Since:
- 3.6.1
- Version:
- 3.6.1
- Author:
- Frank Fock
- See Also:
-
Field Summary
Fields inherited from class org.snmp4j.smi.AbstractVariable
SMISYNTAXES_PROPERTIES
-
Constructor Summary
ConstructorDescriptionSecretOctetString
(byte[] rawValue) SecretOctetString
(byte[] rawValue, int offset, int length) Creates an octet string from an byte array.SecretOctetString
(OctetString secret) -
Method Summary
Modifier and TypeMethodDescriptionstatic SecretOctetString
fromOctetString
(OctetString octetString) toHexString
(char separator) toString()
Returns a String representation of thisOctetString
.toString
(char separator, int radix) toString
(int radix) Returns a string representation of this octet string in the radix specified.Methods inherited from class org.snmp4j.smi.OctetString
append, append, append, append, clear, clone, compareTo, decodeBER, encodeBER, equals, equalsValue, fromByteArray, fromCharArray, fromCharArray, fromHexString, fromHexString, fromHexStringPairs, fromIndex, fromString, fromString, fromString, fromSubIndex, get, getBERLength, getBERPayloadLength, getSyntax, getValue, hashCode, isPrintable, length, mask, set, setValue, setValue, split, startsWith, substring, toASCII, toByteArray, toByteArray, toInt, toLong, toSubIndex
Methods inherited from class org.snmp4j.smi.AbstractVariable
createFromBER, createFromSyntax, equal, getSyntaxFromString, getSyntaxString, getSyntaxString, isDynamic, isException
-
Constructor Details
-
SecretOctetString
-
SecretOctetString
public SecretOctetString(byte[] rawValue) -
SecretOctetString
public SecretOctetString(byte[] rawValue, int offset, int length) Creates an octet string from an byte array.- Parameters:
rawValue
- an array of bytes.offset
- the position (zero based) of the first byte to be copied fromrawValue
into the newOctetString
.length
- the number of bytes to be copied.
-
SecretOctetString
public SecretOctetString()
-
-
Method Details
-
fromOctetString
- Parameters:
octetString
- anOctetString
whoseto*String
methods needs to be protected against disclosing sensitive information.- Returns:
- the new
SecretOctetString
ornull
.
-
toString
Description copied from class:OctetString
Returns a String representation of thisOctetString
. If theOctetString
contains non-printable characters, a hex-string representation is returned unlessSNMP4JSettings.getDefaultNonPrintableEscapeCharacter()
returns a non-null
character that is then used to replace all non-printable characters in the output.- Specified by:
toString
in interfaceVariable
- Overrides:
toString
in classOctetString
- Returns:
- a String representation of this
OctetString
.
-
toHexString
- Overrides:
toHexString
in classOctetString
-
toHexString
- Overrides:
toHexString
in classOctetString
-
toString
- Overrides:
toString
in classOctetString
-
toString
Description copied from class:OctetString
Returns a string representation of this octet string in the radix specified. There will be no separation characters, but each byte will be represented byround(log(256)/log(radix))
digits.- Overrides:
toString
in classOctetString
- Parameters:
radix
- the radix to use in the string representation.- Returns:
- a string representation of this ocetet string in the specified radix.
-