Uses of Class
org.snmp4j.smi.OID

Packages that use OID

Package	Description
org.snmp4j	Provides classes and interfaces for creating, sending, and receiving SNMP messages.
org.snmp4j.event	Provides classes and interfaces for SNMP4J event processing.
org.snmp4j.mp	Provides classes and interfaces for the SNMP message processing.
org.snmp4j.security	Provides classes and interfaces for authentication and privacy of SNMP(v3) messages.
org.snmp4j.security.dh
org.snmp4j.security.nonstandard
org.snmp4j.smi	Provides classes for the representation of SMIv1/v2 data types (which also includes some basic ASN.1 primitive data types).
org.snmp4j.tools.console
org.snmp4j.util	Contains table retrieval utilities and multi-threading support classes as well as miscellaneous utility classes.

Uses of OID in org.snmp4j

Methods in org.snmp4j that return OID

Modifier and Type	Method	Description
OID	PDUv1.getEnterprise()	Gets the "enterprise" OID of the SNMPv1 trap.

Methods in org.snmp4j with parameters of type OID

Modifier and Type	Method	Description
List<VariableBinding>	PDU.getBindingList(OID prefix)	Gets a list of VariableBindings whose OID prefix matches the supplied prefix.
Variable	PDU.getVariable(OID prefix)	Gets the first variable whose OID starts with the specified OID.
void	PDUv1.setEnterprise(OID enterprise)	Sets the "enterprise" OID of the SNMPv1 trap.

Uses of OID in org.snmp4j.event

Methods in org.snmp4j.event that return OID

Modifier and Type	Method	Description
OID	CounterEvent.getOid()	Gets the instance object identifier of the counter.

Constructors in org.snmp4j.event with parameters of type OID

Modifier	Constructor	Description
	CounterEvent(Object source, OID oid)	Creates a CounterEvent for the specified counter.
	CounterEvent(Object source, OID oid, long increment)	Creates a CounterEvent for the specified counter.
	CounterEvent(Object source, OID oid, Object index, long increment)	Creates a CounterEvent for the specified counter.

Uses of OID in org.snmp4j.mp

Fields in org.snmp4j.mp declared as OID

Modifier and Type	Field	Description
static final OID	SnmpConstants.authenticationFailure
static final OID	SnmpConstants.coldStart
static final OID	SnmpConstants.linkDown
static final OID	SnmpConstants.linkUp
static final OID	SnmpConstants.oosnmpUsmAesCfb192Protocol
static final OID	SnmpConstants.oosnmpUsmAesCfb192ProtocolWith3DESKeyExtension
static final OID	SnmpConstants.oosnmpUsmAesCfb256Protocol
static final OID	SnmpConstants.oosnmpUsmAesCfb256ProtocolWith3DESKeyExtension
static final OID	SnmpConstants.snmp4jStatsReqTableRetries	The total number of retries sent on behalf of requests to this target.
static final OID	SnmpConstants.snmp4jStatsReqTableRuntime	The number of milliseconds a successful request took from sending the request to receiving the corresponding response with the same msgID for this target.
static final OID	SnmpConstants.snmp4jStatsReqTableTimeouts	The total number of requests that timed out for this target (Counter32).
static final OID	SnmpConstants.snmp4jStatsReqTableWaitTime	The total number of milliseconds this SNMP entity spend waiting for responses on its own requests to this target.
static final OID	SnmpConstants.snmp4jStatsRequestRetries	The total number of retries sent on behalf of requests.
static final OID	SnmpConstants.snmp4jStatsRequestRuntime	The number of milliseconds a successful request took from sending the request to receiving the corresponding response with the same msgID.
static final OID	SnmpConstants.snmp4jStatsRequestTimeouts	The total number of requests that timed out (Counter32).
static final OID	SnmpConstants.snmp4jStatsRequestWaitTime	The total number of milliseconds this SNMP entity spend waiting for responses on its own requests (Counter64).
static final OID	SnmpConstants.snmp4jStatsResponseIgnoredRetries	The total number of retries ignored by the command responder while processing requests.
static final OID	SnmpConstants.snmp4jStatsResponseProcessTime	The total number of milliseconds the command responder took to process a request.
static final OID	SnmpConstants.snmp4jStatsResponseTimeouts	The number of response processings that ended due to an internal timeout before that maximum number of response variables (GETBULK) has been reached.
static final OID	SnmpConstants.snmpEngineID
static final OID	SnmpConstants.snmpInASNParseErrs
static final OID	SnmpConstants.snmpInBadCommunityNames
static final OID	SnmpConstants.snmpInBadCommunityUses
static final OID	SnmpConstants.snmpInBadVersions
static final OID	SnmpConstants.snmpInPkts
static final OID	SnmpConstants.snmpInvalidMsgs
static final OID	SnmpConstants.snmpProxyDrops
static final OID	SnmpConstants.snmpSetSerialNo
static final OID	SnmpConstants.snmpSilentDrops
static final OID	SnmpConstants.snmpSshtmSessionCloses
static final OID	SnmpConstants.snmpSshtmSessionInvalidCaches
static final OID	SnmpConstants.snmpSshtmSessionNoChannels
static final OID	SnmpConstants.snmpSshtmSessionNoSessions
static final OID	SnmpConstants.snmpSshtmSessionNoSubsystems
static final OID	SnmpConstants.snmpSshtmSessionOpenErrors
static final OID	SnmpConstants.snmpSshtmSessionOpens
static final OID	SnmpConstants.snmpSshtmSessionUserAuthFailures
static final OID	SnmpConstants.snmpTlstmSessionAccepts
static final OID	SnmpConstants.snmpTlstmSessionClientCloses
static final OID	SnmpConstants.snmpTlstmSessionInvalidCaches
static final OID	SnmpConstants.snmpTlstmSessionInvalidClientCertificates
static final OID	SnmpConstants.snmpTlstmSessionInvalidServerCertificates
static final OID	SnmpConstants.snmpTlstmSessionNoSessions
static final OID	SnmpConstants.snmpTlstmSessionOpenErrors
static final OID	SnmpConstants.snmpTlstmSessionOpens
static final OID	SnmpConstants.snmpTlstmSessionServerCloses
static final OID	SnmpConstants.snmpTlstmSessionUnknownServerCertificate
static final OID	SnmpConstants.snmpTrapAddress
static final OID	SnmpConstants.snmpTrapCommunity
static final OID	SnmpConstants.snmpTrapEnterprise
static final OID	SnmpConstants.snmpTrapOID
static final OID	SnmpConstants.snmpTraps
static final OID	SnmpConstants.snmpTsmConfigurationUsePrefix
static final OID	SnmpConstants.snmpTsmInadequateSecurityLevels
static final OID	SnmpConstants.snmpTsmInvalidCaches
static final OID	SnmpConstants.snmpTsmInvalidPrefixes
static final OID	SnmpConstants.snmpTsmUnknownPrefixes
static final OID	SnmpConstants.snmpUnavailableContexts
static final OID	SnmpConstants.snmpUnknownContexts
static final OID	SnmpConstants.snmpUnknownPDUHandlers
static final OID	SnmpConstants.snmpUnknownSecurityModels
static final OID	SnmpConstants.sysContact
static final OID	SnmpConstants.sysDescr
static final OID	SnmpConstants.sysLocation
static final OID	SnmpConstants.sysName
static final OID	SnmpConstants.sysObjectID
static final OID	SnmpConstants.sysOREntry
static final OID	SnmpConstants.sysServices
static final OID	SnmpConstants.system
static final OID	SnmpConstants.sysUpTime
static final OID	SnmpConstants.usm3DESEDEPrivProtocol
static final OID	SnmpConstants.usmAesCfb128Protocol
static final OID	SnmpConstants.usmDESPrivProtocol
static final OID	SnmpConstants.usmHMACMD5AuthProtocol
static final OID	SnmpConstants.usmHMACSHAAuthProtocol
static final OID	SnmpConstants.usmNoAuthProtocol
static final OID	SnmpConstants.usmNoPrivProtocol
static final OID	SnmpConstants.usmStatsDecryptionErrors
static final OID	SnmpConstants.usmStatsNotInTimeWindows
static final OID	SnmpConstants.usmStatsUnknownEngineIDs
static final OID	SnmpConstants.usmStatsUnknownUserNames
static final OID	SnmpConstants.usmStatsUnsupportedSecLevels
static final OID	SnmpConstants.usmStatsWrongDigests
static final OID	SnmpConstants.warmStart
static final OID	SnmpConstants.zeroDotZero

Methods in org.snmp4j.mp that return OID

Modifier and Type	Method	Description
static OID	SnmpConstants.getTrapOID(OID enterprise, int genericID, int specificID)

Methods in org.snmp4j.mp with parameters of type OID

Modifier and Type	Method	Description
Counter32	DefaultCounterListener.add(OID oid, Counter32 counter)	Adds a counter to this counter listener.
AuthenticationProtocol	MPv3.getAuthProtocol(OID id)	Gets an authentication protocol for the supplied ID.
static int	SnmpConstants.getGenericTrapID(OID oid)	Gets the generic trap ID from a notification OID.
PrivacyProtocol	MPv3.getPrivProtocol(OID id)	Gets an privacy protocol for the supplied ID.
static OID	SnmpConstants.getTrapOID(OID enterprise, int genericID, int specificID)
Counter32	DefaultCounterListener.remove(OID oid)	Removes a counter from this listener and returns it.

Uses of OID in org.snmp4j.security

Fields in org.snmp4j.security declared as OID

Modifier and Type	Field	Description
static final OID	AuthHMAC128SHA224.ID
static final OID	AuthHMAC192SHA256.ID
static final OID	AuthHMAC256SHA384.ID
static final OID	AuthHMAC384SHA512.ID
static final OID	AuthMD5.ID
static final OID	AuthSHA.ID
static final OID	Priv3DES.ID	Unique ID of this privacy protocol.
static final OID	PrivAES128.ID	Unique ID of this privacy protocol.
static OID	PrivAES192.ID	Unique ID of this privacy protocol.
static OID	PrivAES256.ID	Unique ID of this privacy protocol.
static final OID	PrivDES.ID	Unique ID of this privacy protocol.

Methods in org.snmp4j.security that return OID

Modifier and Type	Method	Description
OID	UsmUser.getAuthenticationProtocol()	Gets the authentication protocol ID.
OID	PrivAES192.getDefaultID()
OID	PrivAES256.getDefaultID()
OID	AuthenticationProtocol.getID()	Gets the OID uniquely identifying the authentication protocol.
OID	AuthMD5.getID()
OID	AuthSHA.getID()
OID	AuthSHA2.getID()
OID	Priv3DES.getID()	Gets the OID uniquely identifying the privacy protocol.
OID	PrivacyProtocol.getID()	Gets the OID uniquely identifying the privacy protocol.
OID	PrivAES128.getID()	Gets the OID uniquely identifying the privacy protocol.
OID	PrivAES192.getID()	Gets the OID uniquely identifying the privacy protocol.
OID	PrivAES256.getID()	Gets the OID uniquely identifying the privacy protocol.
OID	PrivDES.getID()	Gets the OID uniquely identifying the privacy protocol.
OID	SecurityProtocol.getID()	Gets the OID uniquely identifying the privacy protocol.
OID	UsmUser.getPrivacyProtocol()	Gets the privacy protocol ID.

Methods in org.snmp4j.security with parameters of type OID

Modifier and Type	Method	Description
UsmUserEntry	USM.addLocalizedUser(byte[] engineID, OctetString userName, OID authProtocol, byte[] authKey, OID privProtocol, byte[] privKey)	Adds a localized user to the USM.
AuthenticationProtocol	SecurityProtocols.getAuthenticationProtocol(OID id)	Get the AuthenticationProtocol with the given ID.
PrivacyProtocol	SecurityProtocols.getPrivacyProtocol(OID id)	Get the PrivacyProtocol with the given ID.
SecurityProtocol	SecurityProtocols.getSecurityProtocol(OID protocolID)	Get the security protocol (AuthenticationProtocol or PrivacyProtocol) for the specified protocol OID.
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.
void	PrivAES192.setID(OID newID)
void	PrivAES256.setID(OID newID)

Constructors in org.snmp4j.security with parameters of type OID

Modifier	Constructor	Description
	AuthSHA2(String protocolName, OID protocolOID, int digestLength, int authenticationCodeLength)	Deprecated. Use AuthSHA2(String, OID, int, int, int) instead to specify the correct HMAC block size
	AuthSHA2(String protocolName, OID protocolOID, int digestLength, int authenticationCodeLength, int hmacBlockSize)	Creates a SHA authentication protocol with the specified digest length.
	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.

Uses of OID in org.snmp4j.security.dh

Fields in org.snmp4j.security.dh declared as OID

Modifier and Type	Field	Description
static final OID	DHOperations.oidUsmDHKickstartMgrPublic
static final OID	DHOperations.oidUsmDHKickstartMyPublic
static final OID	DHOperations.oidUsmDHKickstartSecurityName

Methods in org.snmp4j.security.dh that return OID

Modifier and Type	Method	Description
OID	DHOperations.DHKeyInfo.getAuthProtocol()
OID	DHOperations.DHKeyInfo.getPrivProtocol()

Constructors in org.snmp4j.security.dh with parameters of type OID

Modifier	Constructor	Description
	DHKeyInfo(OctetString userName, byte[] privateKey, OID authProtocol, OID privProtocol)

Uses of OID in org.snmp4j.security.nonstandard

Fields in org.snmp4j.security.nonstandard declared as OID

Modifier and Type	Field	Description
static OID	PrivAES192With3DESKeyExtension.ID	Unique ID of this privacy protocol.
static OID	PrivAES256With3DESKeyExtension.ID	Unique ID of this privacy protocol.
protected OID	PrivAESWith3DESKeyExtension.oid

Methods in org.snmp4j.security.nonstandard that return OID

Modifier and Type	Method	Description
OID	NonStandardSecurityProtocol.getDefaultID()	Gets the default ID for this non-standard privacy protocol.
OID	PrivAES192With3DESKeyExtension.getDefaultID()
OID	PrivAES256With3DESKeyExtension.getDefaultID()
OID	PrivAESWith3DESKeyExtension.getID()

Methods in org.snmp4j.security.nonstandard with parameters of type OID

Modifier and Type	Method	Description
void	NonStandardSecurityProtocol.setID(OID newOID)	Assign a new ID to a non-standard security protocol instance.
void	PrivAESWith3DESKeyExtension.setID(OID newOID)

Uses of OID in org.snmp4j.smi

Methods in org.snmp4j.smi that return OID

Modifier and Type	Method	Description
final OID	OID.append(int subID)	Appends a sub-identifier to this OID.
final OID	OID.append(String oid)	Appends a dotted String OID to this OID.
final OID	OID.append(OID oid)	Appends an OID to this OID.
final OID	OID.appendUnsigned(long subID)	Appends an unsigned long sub-identifier value to this OID.
OID	VariableBinding.getOid()	Gets the object instance identifier of the variable binding.
OID	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.
static OID	OID.max(OID a, OID b)	Returns the greater of the two OID values.
static OID	OID.min(OID a, OID b)	Returns the lesser of the two OID values.
final OID	OID.nextPeer()	Returns the next following OID with the same or lesser size (length).
final OID	OID.predecessor()	Returns the predecessor OID for this OID.
final OID	OID.successor()	Returns the successor OID for this OID.
abstract OID	AbstractVariable.toSubIndex(boolean impliedLength)	Converts the value of this Variable to a (sub-)index value.
OID	Counter32.toSubIndex(boolean impliedLength)
OID	Counter64.toSubIndex(boolean impliedLength)
OID	GenericAddress.toSubIndex(boolean impliedLength)
OID	Integer32.toSubIndex(boolean impliedLength)
OID	IpAddress.toSubIndex(boolean impliedLength)
OID	Null.toSubIndex(boolean impliedLength)
OID	OctetString.toSubIndex(boolean impliedLength)
final OID	OID.toSubIndex(boolean impliedLength)
OID	UnsignedInteger32.toSubIndex(boolean impliedLength)
OID	Variable.toSubIndex(boolean impliedLength)	Converts the value of this Variable to a (sub-)index value.
OID	VariantVariable.toSubIndex(boolean impliedLength)
OID	OID.trim()	Returns a new copy of this OID with the last sub-indentifier removed.

Methods in org.snmp4j.smi with parameters of type OID

Modifier and Type	Method	Description
final OID	OID.append(OID oid)	Appends an OID to this OID.
static VariableBinding[]	VariableBinding.createFromOIDs(OID[] oids)	Create an array of VariableBindings based on the provided OIDs.
abstract void	AbstractVariable.fromSubIndex(OID subIndex, boolean impliedLength)	Sets the value of this Variable from the supplied (sub-)index.
void	Counter32.fromSubIndex(OID subIndex, boolean impliedLength)
void	Counter64.fromSubIndex(OID subIndex, boolean impliedLength)
void	GenericAddress.fromSubIndex(OID subIndex, boolean impliedLength)
void	Integer32.fromSubIndex(OID subIndex, boolean impliedLength)
void	IpAddress.fromSubIndex(OID subIndex, boolean impliedLength)
void	Null.fromSubIndex(OID subIndex, boolean impliedLength)
void	OctetString.fromSubIndex(OID subIndex, boolean impliedLength)
final void	OID.fromSubIndex(OID subIndex, boolean impliedLength)
void	UnsignedInteger32.fromSubIndex(OID subIndex, boolean impliedLength)
void	Variable.fromSubIndex(OID subIndex, boolean impliedLength)	Sets the value of this Variable from the supplied (sub-)index.
void	VariantVariable.fromSubIndex(OID subIndex, boolean impliedLength)
int	OID.leftMostCompare(int n, OID other)	Compares the n leftmost sub-identifiers with the given OID in left-to-right direction.
static OID	OID.max(OID a, OID b)	Returns the greater of the two OID values.
static OID	OID.min(OID a, OID b)	Returns the lesser of the two OID values.
int	OID.rightMostCompare(int n, OID other)	Compares the n rightmost sub-identifiers in direction right-to-left with those of the given OID.
void	VariableBinding.setOid(OID oid)	Sets the object instance identifier for the variable binding.
boolean	OID.startsWith(OID other)	Check if the OID starts with the given OID.

Constructors in org.snmp4j.smi with parameters of type OID

Modifier	Constructor	Description
	OID(OID other)	Copy constructor.
	VariableBinding(OID oid)	Creates a variable binding with the supplied object instance identifier and a Null value.
	VariableBinding(OID oid, String variableText)	Creates a variable binding with the supplied OID and a text value.
	VariableBinding(OID oid, Variable variable)	Creates a variable binding with the supplied OID and value.

Uses of OID in org.snmp4j.tools.console

Fields in org.snmp4j.tools.console declared as OID

Modifier and Type	Field	Description
static final OID[]	LogControl.SNMP4J_LOGGER_OIDS

Methods in org.snmp4j.tools.console that return OID

Modifier and Type	Method	Description
OID	SnmpRequest.getAuthProtocol()
OID	SnmpRequest.getLowerBoundIndex()
OID	SnmpRequest.getPrivProtocol()
OID	SnmpRequest.getTrapOID()
OID	SnmpRequest.getUpperBoundIndex()

Methods in org.snmp4j.tools.console with parameters of type OID

Modifier and Type	Method	Description
void	SnmpRequest.setAuthProtocol(OID authProtocol)
void	SnmpRequest.setLowerBoundIndex(OID lowerBoundIndex)
void	SnmpRequest.setPrivProtocol(OID privProtocol)
void	SnmpRequest.setTrapOID(OID trapOID)
void	SnmpRequest.setUpperBoundIndex(OID upperBoundIndex)

Uses of OID in org.snmp4j.util

Methods in org.snmp4j.util that return OID

Modifier and Type	Method	Description
static OID	SnmpConfigurator.getAuthProtocolOid(String authP)
OID	TableEvent.getIndex()	Gets the row index OID.
static OID	SnmpConfigurator.getPrivProtocolOid(String privP)

Methods in org.snmp4j.util with parameters of type OID

Modifier and Type	Method	Description
ResponseEvent	TableUtils.createRow(Target target, OID rowStatusColumnOID, OID rowIndex, VariableBinding[] values)	Creates a SNMP table row for a table that supports the RowStatus mechanism for row creation.
protected TableUtils.TableRequest	TableUtils.createTableRequest(Target target, OID[] columnOIDs, TableListener listener, Object userObject, OID lowerBoundIndex, OID upperBoundIndex)
ResponseEvent	TableUtils.destroyRow(Target target, OID rowStatusColumnOID, OID rowIndex)	Destroys a SNMP table row from a table that support the RowStatus mechanism for row creation/deletion.
String	SimpleVariableTextFormat.format(OID instanceOID, Variable variable, boolean withOID)	Returns a textual representation of the supplied variable against the optionally supplied instance OID.
String	VariableTextFormat.format(OID instanceOID, Variable variable, boolean withOID)	Returns a textual representation of the supplied variable against the optionally supplied instance OID.
void	TableUtils.getDenseTable(Target target, OID[] columnOIDs, TableListener listener, Object userObject, OID lowerBoundIndex, OID upperBoundIndex)	Gets SNMP tabular data from one or more tables.
org.snmp4j.util.TableUtils.Row	TableUtils.TableRequest.getRow(OID index)
List<TreeEvent>	TreeUtils.getSubtree(Target target, OID rootOID)	Gets a subtree with GETNEXT (SNMPv1) or GETBULK (SNMP2c, SNMPv3) operations from the specified target synchronously.
void	TreeUtils.getSubtree(Target target, OID rootOID, Object userObject, TreeListener listener)	Gets a subtree with GETNEXT (SNMPv1) or GETBULK (SNMP2c, SNMPv3) operations from the specified target asynchronously.
List<TableEvent>	TableUtils.getTable(Target target, OID[] columnOIDs, OID lowerBoundIndex, OID upperBoundIndex)	Gets synchronously SNMP tabular data from one or more tables.
void	TableUtils.getTable(Target target, OID[] columnOIDs, TableListener listener, Object userObject, OID lowerBoundIndex, OID upperBoundIndex)	Gets SNMP tabular data from one or more tables.
Variable	SimpleVariableTextFormat.parse(OID classOrInstanceOID, String text)	This operation is not supported by SimpleVariableTextFormat.
Variable	VariableTextFormat.parse(OID classOrInstanceOID, String text)	Parses a textual representation of a variable against its associated OBJECT-TYPE OID.
List<TreeEvent>	TreeUtils.walk(Target target, OID[] rootOIDs)	Walks a subtree with GETNEXT (SNMPv1) or GETBULK (SNMP2c, SNMPv3) operations from the specified target asynchronously.
void	TreeUtils.walk(Target target, OID[] rootOIDs, Object userObject, TreeListener listener)	Walks a subtree with GETNEXT (SNMPv1) or GETBULK (SNMP2c, SNMPv3) operations from the specified target asynchronously.

Constructors in org.snmp4j.util with parameters of type OID

Modifier	Constructor	Description
	TableEvent(TableUtils.TableRequest source, Object userObject, OID index, VariableBinding[] cols)	Creates a table event with row data.
	TableRequest(Target target, OID[] columnOIDs, TableListener listener, Object userObject, OID lowerBoundIndex, OID upperBoundIndex)