Uses of Class
org.snmp4j.smi.OctetString
Package
Description
Provides classes and interfaces for creating, sending, and receiving SNMP
messages.
Provides classes and interfaces for SNMP4J event processing.
Provides classes and interfaces for the SNMP message processing.
Provides classes and interfaces for authentication and privacy of SNMP(v3)
messages.
Provides classes for the representation of SMIv1/v2 data types (which also
includes some basic ASN.1 primitive data types).
Provides transport protocol mappings for SNMP.
Contains table retrieval utilities and multi-threading support classes as
well as miscellaneous utility classes.
-
Uses of OctetString in org.snmp4j
Modifier and TypeMethodDescriptionSnmp.getCachedContextEngineId
(Address targetAddress) Get a cached RFC 5343 context engine ID for the specified address.CertifiedIdentity.getClientFingerprint()
CertifiedTarget.getClientFingerprint()
CommunityTarget.getCommunity()
Gets the community octet string (which is the same as the security name).ScopedPDU.getContextEngineID()
Gets the context engine ID of this scoped PDU.ScopedPDU.getContextName()
Gets the context name of this scoped PDU.CertifiedIdentity.getIdentity()
CertifiedTarget.getIdentity()
final OctetString
AbstractTarget.getSecurityName()
Target.getSecurityName()
Gets the security name associated with this target.TransportStateReference.getSecurityName()
CertifiedIdentity.getServerFingerprint()
CertifiedTarget.getServerFingerprint()
Snmp.removeCachedContextEngineId
(Address target) Remove a cached RFC 5343 context engine ID for the specified address and return it.Modifier and TypeMethodDescriptionvoid
CommunityTarget.setCommunity
(OctetString community) Sets the community octet sting.void
ScopedPDU.setContextEngineID
(OctetString contextEngineID) Sets the context engine ID field of the scoped PDU.void
ScopedPDU.setContextName
(OctetString contextName) Sets the context name field of this scoped PDU.final void
AbstractTarget.setSecurityName
(OctetString securityName) Sets the security name to be used with this target.void
Target.setSecurityName
(OctetString securityName) Sets the security name to be used with this target.void
TransportStateReference.setSecurityName
(OctetString securityName) ModifierConstructorDescriptionprotected
AbstractTarget
(Address address, OctetString securityName) CertifiedTarget
(Address address, OctetString identity, OctetString serverFingerprint, OctetString clientFingerprint) CertifiedTarget
(OctetString identity) CommunityTarget
(Address address, OctetString community) Creates a fully specified community target.protected
SecureTarget
(Address address, OctetString securityName) Creates a SNMPv3 secure target with an address and security name.TransportStateReference
(TransportMapping transport, Address address, OctetString securityName, SecurityLevel requestedSecurityLevel, SecurityLevel transportSecurityLevel, boolean sameSecurity, Object sessionID) TransportStateReference
(TransportMapping transport, Address address, OctetString securityName, SecurityLevel requestedSecurityLevel, SecurityLevel transportSecurityLevel, boolean sameSecurity, Object sessionID, CertifiedIdentity certifiedIdentity) UserTarget
(Address address, OctetString securityName, byte[] authoritativeEngineID) Creates a SNMPv3 USM target with security level noAuthNoPriv, one second time-out without retries.UserTarget
(Address address, OctetString securityName, byte[] authoritativeEngineID, int securityLevel) Creates a SNMPv3 USM target with the supplied security level, one second time-out without retries. -
Uses of OctetString in org.snmp4j.event
Modifier and TypeMethodDescriptionSnmpEngineEvent.getEngineID()
Returns the engine ID associated with this event.ModifierConstructorDescriptionSnmpEngineEvent
(MPv3 source, int type, OctetString engineID, Address engineAddress) -
Uses of OctetString in org.snmp4j.mp
Modifier and TypeFieldDescriptionstatic final OctetString
MPv3.LOCAL_ENGINE_ID
Local engine ID constant for context engineID discovery as defined by RFC 5343.Modifier and TypeMethodDescriptionprotected OctetString
MPv3.addEngineIdToCache
(Address address, OctetString engineID) Put the engine ID for the given address into the internal cache.MPv3.getEngineID
(Address address) Gets the engine ID associated with the supplied address from the local storage and fires the correspondingSnmpEngineEvent
.MPv3.removeEngineID
(Address address) Removes an engine ID association from the local storage and fires the correspondingSnmpEngineEvent
.Modifier and TypeMethodDescriptionMPv3.EngineIdCacheFactory.createEngineIdMap
(EngineIdCacheSize maximumCapacity) Create a engine ID map with the given maximum capacity.Modifier and TypeMethodDescriptionboolean
MPv3.addEngineID
(Address address, OctetString engineID) Adds an engine ID (other than the local engine ID) to the internal storage.protected OctetString
MPv3.addEngineIdToCache
(Address address, OctetString engineID) Put the engine ID for the given address into the internal cache.static byte[]
MPv3.createLocalEngineID
(OctetString id) Creates a local engine ID based on the ID string suppliedint
MessageProcessingModel.prepareDataElements
(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, TransportStateReference tmStateReference, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference mutableStateReference) Prepare data elements from an incoming SNMP message as described in RFC3412 ยง7.2.int
MPv1.prepareDataElements
(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, TransportStateReference tmStateReference, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference mutableStateReference) int
MPv2c.prepareDataElements
(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, TransportStateReference tmStateReference, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference mutableStateReference) int
MPv3.prepareDataElements
(MessageDispatcher messageDispatcher, Address transportAddress, BERInputStream wholeMsg, TransportStateReference tmStateReference, Integer32 messageProcessingModel, Integer32 securityModel, OctetString securityName, Integer32 securityLevel, MutablePDU pdu, PduHandle sendPduHandle, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, MutableStateReference mutableStateReference) int
MPv3.sendReport
(MessageDispatcher messageDispatcher, ScopedPDU pdu, int securityLevel, int securityModel, OctetString securityName, int maxSizeResponseScopedPDU, StateReference<?> stateReference, VariableBinding payload) Sends a report message. -
Uses of OctetString in org.snmp4j.security
Modifier and TypeClassDescriptionclass
SecurityParameters
implementation for theTSM
security model.Modifier and TypeMethodDescriptionUsmSecurityParameters.getAuthenticationParameters()
UsmUser.getAuthenticationPassphrase()
Gets the authentication passphrase.UsmTimeEntry.getEngineID()
UsmUserEntry.getEngineID()
SNMPv3SecurityModel.getLocalEngineID()
Returns the local engine ID.UsmUser.getLocalizationEngineID()
Returns the localization engine ID for which this USM user has been already localized.UsmSecurityParameters.getPrivacyParameters()
UsmUser.getPrivacyPassphrase()
Gets the privacy passphrase.UsmUser.getSecurityName()
Gets the user's security name.UsmSecurityParameters.getUserName()
UsmUserEntry.getUserName()
Modifier and TypeMethodDescriptionUSM.addLocalizedUser
(byte[] engineID, OctetString userName, OID authProtocol, byte[] authKey, OID privProtocol, byte[] privKey) Adds a localized user to the USM.void
USM.addUser
(OctetString userName, UsmUser user) Adds an USM user to the internal username table.void
USM.addUser
(OctetString userName, OctetString engineID, UsmUser user) Adds an USM user to the internal user name table and associates it with an authoritative engine ID.int
UsmTimeTable.checkEngineID
(OctetString engineID, boolean discoveryAllowed, int engineBoots, int engineTime) byte[]
Priv3DES.extendShortKey
(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol) byte[]
PrivacyProtocol.extendShortKey
(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol) Extend a localized key that is too short.byte[]
PrivAES.extendShortKey
(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol) byte[]
PrivDES.extendShortKey
(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol) UsmTimeTable.getEntry
(OctetString engineID) UsmTimeTable.getTime
(OctetString engineID) USM.getUser
(OctetString engineID, OctetString securityName) Looks up aUsmUserEntry
by an engine ID and security name.UsmUserTable.getUser
(OctetString securityName) UsmUserTable.getUser
(OctetString engineID, OctetString securityName) UsmUserTable.getUserEntries
(OctetString userName) Gets all user entries with the supplied user name.boolean
USM.hasUser
(OctetString engineID, OctetString securityName) Checks if the specified user is known by this USM.byte[]
AuthenticationProtocol.passwordToKey
(OctetString passwordString, byte[] engineID) Generates the localized key for the given password and engine id.byte[]
AuthGeneric.passwordToKey
(OctetString passwordString, byte[] engineID) byte[]
SecurityProtocols.passwordToKey
(OID authProtocolID, OctetString passwordString, byte[] engineID) Generates the localized key for the given password and engine id for the authentication protocol specified by the supplied OID.byte[]
SecurityProtocols.passwordToKey
(OID privProtocolID, OID authProtocolID, OctetString passwordString, byte[] engineID) Generates the localized key for the given password and engine id for the privacy protocol specified by the supplied OID.int
SecurityModel.processIncomingMsg
(int messageProcessingModel, int maxMessageSize, SecurityParameters securityParameters, SecurityModel securityModel, int securityLevel, BERInputStream wholeMsg, TransportStateReference tmStateReference, OctetString securityEngineID, OctetString securityName, BEROutputStream scopedPDU, Integer32 maxSizeResponseScopedPDU, SecurityStateReference securityStateReference, StatusInformation statusInfo) Processes an incoming message and returns its plaintext payload.int
TSM.processIncomingMsg
(int messageProcessingModel, int maxMessageSize, SecurityParameters securityParameters, SecurityModel securityModel, int securityLevel, BERInputStream wholeMsg, TransportStateReference tmStateReference, OctetString securityEngineID, OctetString securityName, BEROutputStream scopedPDU, Integer32 maxSizeResponseScopedPDU, SecurityStateReference securityStateReference, StatusInformation statusInfo) int
USM.processIncomingMsg
(int snmpVersion, int maxMessageSize, SecurityParameters securityParameters, SecurityModel securityModel, int securityLevel, BERInputStream wholeMsg, TransportStateReference tmStateReference, OctetString securityEngineID, OctetString securityName, BEROutputStream scopedPDU, Integer32 maxSizeResponseScopedPDU, SecurityStateReference securityStateReference, StatusInformation statusInfo) USM.removeAllUsers
(OctetString userName) Removes all USM user from the internal user name table with the specified user name.USM.removeAllUsers
(OctetString userName, OctetString engineID) Removes all USM user from the internal user name table with the specified user name and (optional) engine ID.UsmUserTable.removeAllUsers
(OctetString securityName, OctetString engineID) void
USM.removeEngineTime
(OctetString engineID) Removes the specified engine ID from the internal time cache and thus forces an engine time rediscovery the next time the SNMP engine with the supplied ID is contacted.void
UsmTimeTable.removeEntry
(OctetString engineID) Removes the specified engine ID from the time cache.USM.removeUser
(OctetString engineID, OctetString userName) Deprecated.UsmUserTable.removeUser
(OctetString engineID, OctetString securityName) void
UsmSecurityParameters.setAuthenticationParameters
(OctetString authenticationParameters) void
UsmUserEntry.setEngineID
(OctetString engineID) void
USM.setLocalEngine
(OctetString localEngineID, int engineBoots, int engineTime) Sets the local engine ID, number of boots, and time after boot.void
TSM.setLocalEngineID
(OctetString localEngineID) void
UsmSecurityParameters.setPrivacyParameters
(OctetString privacyParameters) void
UsmSecurityParameters.setUserName
(OctetString userName) void
UsmUserEntry.setUserName
(OctetString userName) ModifierConstructorDescriptionTSM
(OctetString localEngineID, boolean usePrefix) USM
(SecurityProtocols securityProtocols, OctetString localEngineID, int engineBoots) Creates a USM with the support for the supplied security protocols.UsmSecurityParameters
(OctetString authoritativeEngineID, Integer32 authoritativeEngineBoots, Integer32 authoritativeEngineTime, OctetString userName, AuthenticationProtocol authenticationProtocol, PrivacyProtocol privacyProtocol) UsmTimeEntry
(OctetString engineID, int engineBoots, int engineTime) Creates a time entry with engine ID, engine boots and time.UsmTimeTable
(OctetString localEngineID, int engineBoots) UsmUser
(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase) Creates a USM user.UsmUser
(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase, OctetString localizationEngineID) Creates a localized USM user.UsmUserEntry
(byte[] engineID, OctetString securityName, OID authProtocol, byte[] authKey, OID privProtocol, byte[] privKey) Creates a localized user entry.UsmUserEntry
(OctetString userName, UsmUser user) Creates a user with user name and associatedUsmUser
.UsmUserEntry
(OctetString userName, OctetString engineID, UsmUser user) Creates a user with user name and associatedUsmUser
.UsmUserKey
(OctetString engineID, OctetString securityName) -
Uses of OctetString in org.snmp4j.security.dh
Modifier and TypeMethodDescriptionstatic OctetString
DHOperations.derivePrivateKey
(KeyPair keyPair) static OctetString
DHOperations.derivePublicKey
(KeyPair keyPair) static OctetString
DHParameters.encodeBER
(BigInteger prime, BigInteger generator, int privateValueLength) DHOperations.DHKeyInfo.getUserName()
Modifier and TypeMethodDescriptionstatic Map<OctetString,
OctetString[]> DHOperations.getDHKickstartPublicKeys
(Session session, PDUFactory pduFactory, Target target, Set<OctetString> managerPublic) Get the public keys of the agent's kickstart table that match the local public keys provided from a remote agent.Modifier and TypeMethodDescriptionstatic KeyPair
DHOperations.createKeyPair
(OctetString publicKeyOctets, OctetString privateKeyOctets, DHParameters dhParameters) static DHParameters
DHParameters.getDHParametersFromBER
(OctetString berValue) Modifier and TypeMethodDescriptionstatic Map<OctetString,
OctetString[]> DHOperations.getDHKickstartPublicKeys
(Session session, PDUFactory pduFactory, Target target, Set<OctetString> managerPublic) Get the public keys of the agent's kickstart table that match the local public keys provided from a remote agent.ModifierConstructorDescriptionDHKeyInfo
(OctetString userName, byte[] privateKey, OID authProtocol, OID privProtocol) -
Uses of OctetString in org.snmp4j.security.nonstandard
Modifier and TypeMethodDescriptionbyte[]
PrivAESWith3DESKeyExtension.extendShortKey
(byte[] shortKey, OctetString password, byte[] engineID, AuthenticationProtocol authProtocol) -
Uses of OctetString in org.snmp4j.smi
Modifier and TypeClassDescriptionclass
TheBitString
class represents the obsolete SMI type BIT STRING which has been defined in RFC 1442 (an SNMPv2 draft) but which has been obsoleteted by RFC 1902 and RFC 2578.class
TheOpaque
class represents the SMI type Opaque which is used to transparently exchange BER encoded values.Modifier and TypeMethodDescriptionstatic OctetString
OctetString.fromByteArray
(byte[] value) Creates anOctetString
from an byte array.static OctetString
OctetString.fromHexString
(String hexString) static OctetString
OctetString.fromHexString
(String hexString, char delimiter) static OctetString
OctetString.fromHexStringPairs
(String hexString) Create an OctetString from a hexadecimal string of 2-byte pairs without delimiter.static OctetString
OctetString.fromString
(String string, char delimiter, int radix) static OctetString
OctetString.fromString
(String string, int radix) Creates an OctetString from a string representation in the specified radix.OctetString.mask
(OctetString mask) Returns a copy of this OctetString where each bit not set in the supplied mask zeros the corresponding bit in the returned OctetString.OctetString.substring
(int beginIndex, int endIndex) Returns a new string that is a substring of this string.Modifier and TypeMethodDescriptionstatic Collection<OctetString>
OctetString.split
(OctetString octetString, OctetString delimOctets) Splits anOctetString
using a set of delimiter characters similar to how a StringTokenizer would do it.Modifier and TypeMethodDescriptionvoid
OctetString.append
(OctetString octetString) Appends an octet string.OctetString.mask
(OctetString mask) Returns a copy of this OctetString where each bit not set in the supplied mask zeros the corresponding bit in the returned OctetString.OID.mask
(OctetString mask) Returns a copy of this OID where sub-identifiers have been set to zero for all n-th sub-identifier where the n-th bit of mask is zero.void
TransportIpAddress.setTransportAddress
(OctetString transportAddress) Sets this transport address from an OcetString containing the address value in format as specified by the TRANSPORT-ADDRESS-MIB.void
Opaque.setValue
(OctetString value) void
VariantVariable.setValue
(OctetString value) static Collection<OctetString>
OctetString.split
(OctetString octetString, OctetString delimOctets) Splits anOctetString
using a set of delimiter characters similar to how a StringTokenizer would do it.boolean
OctetString.startsWith
(OctetString prefix) Tests if this octet string starts with the specified prefix.ModifierConstructorDescriptionOctetString
(OctetString other) Creates an octet string from another OctetString by cloning its value. -
Uses of OctetString in org.snmp4j.tools.console
Modifier and TypeMethodDescriptionSnmpRequest.getAuthoritativeEngineID()
SnmpRequest.getAuthPassphrase()
SnmpRequest.getCommunity()
SnmpRequest.getContextEngineID()
SnmpRequest.getContextName()
SnmpRequest.getPrivPassphrase()
SnmpRequest.getSecurityName()
Modifier and TypeMethodDescriptionvoid
SnmpRequest.setAuthoritativeEngineID
(OctetString authoritativeEngineID) void
SnmpRequest.setAuthPassphrase
(OctetString authPassphrase) void
SnmpRequest.setCommunity
(OctetString community) void
SnmpRequest.setContextEngineID
(OctetString contextEngineID) void
SnmpRequest.setContextName
(OctetString contextName) void
SnmpRequest.setPrivPassphrase
(OctetString privPassphrase) void
SnmpRequest.setSecurityName
(OctetString securityName) -
Uses of OctetString in org.snmp4j.transport
-
Uses of OctetString in org.snmp4j.transport.tls
Modifier and TypeMethodDescriptionSecurityNameMapping.getData()
SecurityNameMapping.getFingerprint()
static OctetString
TLSTMUtil.getFingerprint
(X509Certificate cert) static OctetString
TLSTMUtil.getIpAddressFromSubjAltName
(Collection<List<?>> altNames) DefaultTlsTmSecurityCallback.getSecurityName
(X509Certificate[] peerCertificateChain) PropertiesTlsTmSecurityCallback.getSecurityName
(X509Certificate[] peerCertificateChain) SecurityNameMapping.getSecurityName()
TlsTmSecurityCallback.getSecurityName
(C[] peerCertificateChain) Gets the tmSecurityName (see RFC 5953) from the certificate chain of the communication peer that needs to be authenticated.TlsTmSecurityCallbackProxy.getSecurityName
(C[] peerCertificateChain) DefaultTlsTmSecurityCallback.removeSecurityNameMapping
(OctetString fingerprint, SecurityNameMapping.CertMappingType type, OctetString data) Modifier and TypeMethodDescriptionvoid
DefaultTlsTmSecurityCallback.addSecurityNameMapping
(OctetString fingerprint, SecurityNameMapping.CertMappingType type, OctetString data, OctetString securityName) Adds a mapping to derive a security name from a certificate.static boolean
TLSTMUtil.isMatchingFingerprint
(X509Certificate[] x509Certificates, OctetString fingerprint, boolean useClientMode, CounterSupport tlstmCounters, LogAdapter logger, Object eventSource) DefaultTlsTmSecurityCallback.removeSecurityNameMapping
(OctetString fingerprint, SecurityNameMapping.CertMappingType type, OctetString data) ModifierConstructorDescriptionSecurityNameMapping
(OctetString fingerprint, OctetString data, SecurityNameMapping.CertMappingType type, OctetString securityName) TlsX509CertifiedTarget
(Address address, OctetString identity, OctetString serverFingerprint, OctetString clientFingerprint, TlsTmSecurityCallback<X509Certificate> tlsTmSecurityCallback) -
Uses of OctetString in org.snmp4j.util
Modifier and TypeMethodDescriptionstatic OctetString
SnmpConfigurator.createOctetString
(String s, String defaultString) Create an OctetString from a String value.DefaultPDUFactory.getContextEngineID()
Gets the context engine ID forScopedPDU
instances created by this factory.DefaultPDUFactory.getContextName()
Gets the context name forScopedPDU
instances created by this factory.Modifier and TypeMethodDescriptionvoid
DefaultPDUFactory.setContextEngineID
(OctetString contextEngineID) Sets the context engine ID forScopedPDU
instances created by this factory.void
DefaultPDUFactory.setContextName
(OctetString contextName) Sets the context name forScopedPDU
instances created by this factory.ModifierConstructorDescriptionDefaultPDUFactory
(int pduType, OctetString contextEngineID, OctetString contextName) Creates aPDUFactory
with type and context information.
null
is provided this method does only delete the generic user.