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.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.
|
Modifier and Type | Method and Description |
---|---|
OID |
PDUv1.getEnterprise()
Gets the "enterprise" OID of the SNMPv1 trap.
|
Modifier and Type | Method and Description |
---|---|
List<VariableBinding> |
PDU.getBindingList(OID prefix)
Gets a list of
VariableBinding s 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.
|
Modifier and Type | Method and Description |
---|---|
OID |
CounterEvent.getOid()
Gets the instance object identifier of the counter.
|
Constructor and Description |
---|
CounterEvent(Object source,
OID oid)
Creates a
CounterEvent for the specified counter. |
Modifier and Type | Field and Description |
---|---|
static OID |
SnmpConstants.authenticationFailure |
static OID |
SnmpConstants.coldStart |
static OID |
SnmpConstants.linkDown |
static OID |
SnmpConstants.linkUp |
static OID |
SnmpConstants.snmpEngineID |
static OID |
SnmpConstants.snmpInASNParseErrs |
static OID |
SnmpConstants.snmpInBadCommunityNames |
static OID |
SnmpConstants.snmpInBadCommunityUses |
static OID |
SnmpConstants.snmpInBadVersions |
static OID |
SnmpConstants.snmpInPkts |
static OID |
SnmpConstants.snmpInvalidMsgs |
static OID |
SnmpConstants.snmpProxyDrops |
static OID |
SnmpConstants.snmpSetSerialNo |
static OID |
SnmpConstants.snmpSilentDrops |
static OID |
SnmpConstants.snmpSshtmSessionCloses |
static OID |
SnmpConstants.snmpSshtmSessionInvalidCaches |
static OID |
SnmpConstants.snmpSshtmSessionNoChannels |
static OID |
SnmpConstants.snmpSshtmSessionNoSessions |
static OID |
SnmpConstants.snmpSshtmSessionNoSubsystems |
static OID |
SnmpConstants.snmpSshtmSessionOpenErrors |
static OID |
SnmpConstants.snmpSshtmSessionOpens |
static OID |
SnmpConstants.snmpSshtmSessionUserAuthFailures |
static OID |
SnmpConstants.snmpTlstmSessionAccepts |
static OID |
SnmpConstants.snmpTlstmSessionClientCloses |
static OID |
SnmpConstants.snmpTlstmSessionInvalidCaches |
static OID |
SnmpConstants.snmpTlstmSessionInvalidClientCertificates |
static OID |
SnmpConstants.snmpTlstmSessionInvalidServerCertificates |
static OID |
SnmpConstants.snmpTlstmSessionNoSessions |
static OID |
SnmpConstants.snmpTlstmSessionOpenErrors |
static OID |
SnmpConstants.snmpTlstmSessionOpens |
static OID |
SnmpConstants.snmpTlstmSessionServerCloses |
static OID |
SnmpConstants.snmpTlstmSessionUnknownServerCertificate |
static OID |
SnmpConstants.snmpTrapAddress |
static OID |
SnmpConstants.snmpTrapCommunity |
static OID |
SnmpConstants.snmpTrapEnterprise |
static OID |
SnmpConstants.snmpTrapOID |
static OID |
SnmpConstants.snmpTraps |
static OID |
SnmpConstants.snmpTsmConfigurationUsePrefix |
static OID |
SnmpConstants.snmpTsmInadequateSecurityLevels |
static OID |
SnmpConstants.snmpTsmInvalidCaches |
static OID |
SnmpConstants.snmpTsmInvalidPrefixes |
static OID |
SnmpConstants.snmpTsmUnknownPrefixes |
static OID |
SnmpConstants.snmpUnavailableContexts |
static OID |
SnmpConstants.snmpUnknownContexts |
static OID |
SnmpConstants.snmpUnknownPDUHandlers |
static OID |
SnmpConstants.snmpUnknownSecurityModels |
static OID |
SnmpConstants.sysContact |
static OID |
SnmpConstants.sysDescr |
static OID |
SnmpConstants.sysLocation |
static OID |
SnmpConstants.sysName |
static OID |
SnmpConstants.sysObjectID |
static OID |
SnmpConstants.sysOREntry |
static OID |
SnmpConstants.sysServices |
static OID |
SnmpConstants.sysUpTime |
static OID |
SnmpConstants.usmStatsDecryptionErrors |
static OID |
SnmpConstants.usmStatsNotInTimeWindows |
static OID |
SnmpConstants.usmStatsUnknownEngineIDs |
static OID |
SnmpConstants.usmStatsUnknownUserNames |
static OID |
SnmpConstants.usmStatsUnsupportedSecLevels |
static OID |
SnmpConstants.usmStatsWrongDigests |
static OID |
SnmpConstants.warmStart |
static OID |
SnmpConstants.zeroDotZero |
Modifier and Type | Method and Description |
---|---|
static OID |
SnmpConstants.getTrapOID(OID enterprise,
int genericID,
int specificID) |
Modifier and Type | Method and 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.
|
Modifier and Type | Field and Description |
---|---|
static OID |
PrivAES128.ID
Unique ID of this privacy protocol.
|
static OID |
Priv3DES.ID
Unique ID of this privacy protocol.
|
static OID |
AuthHMAC384SHA512.ID |
static OID |
PrivDES.ID
Unique ID of this privacy protocol.
|
static OID |
PrivAES192.ID
Unique ID of this privacy protocol.
|
static OID |
AuthSHA.ID |
static OID |
AuthHMAC128SHA224.ID |
static OID |
PrivAES256.ID
Unique ID of this privacy protocol.
|
static OID |
AuthHMAC256SHA384.ID |
static OID |
AuthHMAC192SHA256.ID |
static OID |
AuthMD5.ID |
Modifier and Type | Method and Description |
---|---|
OID |
UsmUser.getAuthenticationProtocol()
Gets the authentication protocol ID.
|
OID |
PrivacyProtocol.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
AuthSHA2.getID() |
OID |
PrivAES128.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
Priv3DES.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
PrivDES.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
PrivAES192.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
AuthSHA.getID() |
OID |
PrivAES256.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
AuthenticationProtocol.getID()
Gets the OID uniquely identifying the authentication protocol.
|
OID |
SecurityProtocol.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
AuthMD5.getID() |
OID |
UsmUser.getPrivacyProtocol()
Gets the privacy protocol ID.
|
Modifier and Type | Method and 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.
|
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.
|
Constructor and Description |
---|
AuthSHA2(String protocolName,
OID protocolOID,
int digestLength,
int authenticationCodeLength)
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.
|
Modifier and Type | Field and Description |
---|---|
static OID |
PrivAES256With3DESKeyExtension.ID
Unique ID of this privacy protocol.
|
static OID |
PrivAES192With3DESKeyExtension.ID
Unique ID of this privacy protocol.
|
Modifier and Type | Method and Description |
---|---|
OID |
PrivAES256With3DESKeyExtension.getID()
Gets the OID uniquely identifying the privacy protocol.
|
OID |
PrivAES192With3DESKeyExtension.getID()
Gets the OID uniquely identifying the privacy protocol.
|
Modifier and Type | Method and Description |
---|---|
OID |
OID.append(int subID)
Appends a sub-identifier to this OID.
|
OID |
OID.append(OID oid)
Appends an
OID to this OID. |
OID |
OID.append(String oid)
Appends a dotted String OID to this
OID . |
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.
|
OID |
OID.nextPeer()
Returns the next following OID with the same or lesser size (length).
|
OID |
OID.predecessor()
Returns the predecessor OID for this OID.
|
OID |
OID.successor()
Returns the successor OID for this OID.
|
OID |
IpAddress.toSubIndex(boolean impliedLength) |
OID |
OID.toSubIndex(boolean impliedLength) |
OID |
VariantVariable.toSubIndex(boolean impliedLength) |
OID |
Null.toSubIndex(boolean impliedLength) |
OID |
GenericAddress.toSubIndex(boolean impliedLength) |
OID |
Counter64.toSubIndex(boolean impliedLength) |
OID |
OctetString.toSubIndex(boolean impliedLength) |
OID |
UnsignedInteger32.toSubIndex(boolean impliedLength) |
abstract OID |
AbstractVariable.toSubIndex(boolean impliedLength)
Converts the value of this
Variable to a (sub-)index
value. |
OID |
Integer32.toSubIndex(boolean impliedLength) |
OID |
Variable.toSubIndex(boolean impliedLength)
Converts the value of this
Variable to a (sub-)index
value. |
OID |
Counter32.toSubIndex(boolean impliedLength) |
OID |
OID.trim()
Returns a new copy of this OID with the last sub-indentifier removed.
|
Modifier and Type | Method and Description |
---|---|
OID |
OID.append(OID oid)
Appends an
OID to this OID. |
static VariableBinding[] |
VariableBinding.createFromOIDs(OID[] oids)
Create an array of
VariableBinding s based on the
provided OIDs. |
void |
IpAddress.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
OID.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
VariantVariable.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
Null.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
GenericAddress.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
Counter64.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
OctetString.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
UnsignedInteger32.fromSubIndex(OID subIndex,
boolean impliedLength) |
abstract void |
AbstractVariable.fromSubIndex(OID subIndex,
boolean impliedLength)
Sets the value of this
Variable from the supplied (sub-)index. |
void |
Integer32.fromSubIndex(OID subIndex,
boolean impliedLength) |
void |
Variable.fromSubIndex(OID subIndex,
boolean impliedLength)
Sets the value of this
Variable from the supplied (sub-)index. |
void |
Counter32.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.
|
Constructor and 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.
|
Modifier and Type | Field and Description |
---|---|
static OID[] |
LogControl.SNMP4J_LOGGER_OIDS |
Modifier and Type | Method and Description |
---|---|
OID |
SnmpRequest.getAuthProtocol() |
OID |
SnmpRequest.getLowerBoundIndex() |
OID |
SnmpRequest.getPrivProtocol() |
OID |
SnmpRequest.getTrapOID() |
OID |
SnmpRequest.getUpperBoundIndex() |
Modifier and Type | Method and 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) |
Modifier and Type | Field and Description |
---|---|
protected Vector<OID> |
TableUtils.TableRequest.lastReceived |
Modifier and Type | Method and Description |
---|---|
OID |
TableEvent.getIndex()
Gets the row index OID.
|
Modifier and Type | Method and 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) |
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 |
VariableTextFormat.format(OID instanceOID,
Variable variable,
boolean withOID)
Returns a textual representation of the supplied variable against the
optionally supplied instance OID.
|
String |
SimpleVariableTextFormat.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.
|
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.
|
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.
|
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 |
VariableTextFormat.parse(OID classOrInstanceOID,
String text)
Parses a textual representation of a variable against its associated
OBJECT-TYPE OID.
|
Variable |
SimpleVariableTextFormat.parse(OID classOrInstanceOID,
String text)
This operation is not supported by
SimpleVariableTextFormat . |
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.
|
Constructor and 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) |
TableRequest(Target target,
OID[] columnOIDs,
TableListener listener,
Object userObject,
OID lowerBoundIndex,
OID upperBoundIndex) |
Copyright © 2024 SNMP4J.org. All rights reserved.