All Classes and Interfaces
Class
Description
The
AbstractConnectionOrientedTransportMapping implements generic functions for a connection
oriented transport mapping for server and client connections.The
AbstractServerSocket interface provides methods to manage the sockets of a connection oriented
transport mapping listening for incoming requests.The
AbstractSnmpUtility is an abstract base class for
convenience utility classes to retrieve SNMP data.The
AbstractSocketEntry extends the AbstractServerSocket and implements a generic
Address to SocketChannel mapping to be used by TransportMapping.A
AbstractTarget class is an abstract representation of a remote SNMP entity.The
AbstractTransportMapping provides an abstract
implementation for the message dispatcher list and the maximum inbound
message size.The
AbstractTransportServerThread is a WorkerTask that serves server connections
using Java NIO for ConnectionOrientedTransportMappings.The
Variable abstract class is the base class for all SNMP
variables.The
Address interface serves as a base class for all SNMP transport addresses.The
ArgumentParser parsers a command line array into Java
objects and associates each object with the corresponding command line option
according to predefined schemes for options and parameters.The
AssignableFromByteArray interface describes objects whose
value can be set from a byte array and converted back to a byte array.The
AssignableFromIntArray interface describes objects whose
value can be set from an int array and converted back to an int array.The
AuthenticationFailureEvent class describes the source
and type of an authentication failure as well as the message that caused
the error.The
AuthenticationFailureListener listens for authentication failure events.The
AuthenticationProtocol interface defines a common
interface for all SNMP authentication protocols.The abstract class AuthGeneric implements common operations for SNMP authentication protocols, such as MD5 and SHA.
The class
AuthHMAC128SHA224 implements the usmHMAC128SHA224AuthProtocol defined by RFC 7630.The class
AuthHMAC192SHA256 implements the usmHMAC192SHA256AuthProtocol
defined by RFC 7630.The class
AuthHMAC256SHA384 implements the usmHMAC256SHA384AuthProtocol defined by RFC 7630.The class
AuthHMAC384SHA512 implements the usmHMAC384SHA512AuthProtocol defined by RFC 7630.The AuthMD5 class implements the MD5 authentication protocol.
The
SHA class implements the Secure Hash Authentication.The
SHA-2 class implements the Secure Hash Authentication 2.The BER class provides utility methods for the BER encoding and decoding.
The
MutableByte class serves for exchanging type information
from the various decode* methods.The
BERInputStream class wraps a ByteBuffer and
implements the InputStream abstract class.The
BEROutputStream class wraps a ByteBuffer
to support BER encoding.The interface
BERSerializable has to be implemented by
any data type class that needs to be serialized using the Basic Encoding
Rules (BER) that provides enconding rules for ASN.1 data types.The
BitString 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.The
ByteArrayWindow provides windowed access to a subarray
of a byte array.The
CertifiedIdentity interface describes an identity
that is associated with a client certificate fingerprint and a server
certificate fingerprint.The
CertifiedTarget class implements a SecureTarget for usage with SecurityModels that support secured connections using client and server certificates.The CipherPool class provides service to share and reuse Cipher instances, across
different threads.
CommandResponder process incoming request, report and notification PDUs.The
CommandResponderEvent is fired by the
MessageDispatcher to listeners that potentially can process
the included request, report, or trap/notification.This
CommonTimer defines the subset interface used from
Timer by SNMP4J.A
CommunityTarget represents SNMP target properties for community based message processing models
(SNMPv1 and SNMPv2c).Transport mappings for connection oriented transport protocols have to
implement this interface.
The
ConsoleLogAdapter provides simple logging to the console.The
ConsoleLogFactory implements a SNMP4J LogFactory for
system out.The
Counter32 class allows all the functionality of unsigned
integers but is recognized as a distinct SMI type, which is used for
monotonically increasing values that wrap around at 2^32-1 (4294967295).The
Counter64 class represents a 64bit unsigned integer type.CounterEvent is an event object that indicates that a specific
counter needs to be incremented.The
CounterListener interface has to be implemented by listener
for CounterEvent events.The
CounterSupport class provides support to fire CounterEvent to registered listeners.Parameter class for encrypt and decrypt methods of
SecurityProtocol.The
DefaultCounterListener is the default implementation of
the CounterListener interface.The
DefaultPDUFactory is a default implementation of the
PDUFactory interface.The
DefaultSSLEngineConfiguration implements the SSL engine configuration based on
X509Certificate trust management.The
DefaultTcpTransportMapping implements a TCP transport
mapping with the Java 1.4 new IO API.The
DefaultThreadFactory creates WorkerTask instances
that allow concurrent execution of tasks.The
DefaultTimeoutModel implements a timeout model that uses
constant timeouts between retries.This
DefaultTimerFactory creates a new Timer
which is configured to run as daemon.The
DefaultTlsTmSecurityCallback resolves the
tmSecurityName for incoming requests through
a mapping table based on the peer certificates,
resolves the local certificate alias through a mapping table
based on the target address and accepts peer certificates
based on a list of trusted peer and issuer certificates.The
DefaultUdpTransportMapping implements a UDP transport
mapping based on Java standard IO and using an internal thread for
listening on the inbound socket.The DHOakleyGroups class defines the prime values for use with the Diffie Hellman key exchange as defined
in RFC 2409 section 6.1 and 6.2.
Implementation of Diffie Hellman operations for SNMP as defined by RFC 2786.
The
DHSharedKeyInfo provides DH key exchange information that associates a user name with a key
(private or shared) and authentication and privacy protocol OIDs necessary to create an USM user
during a DH kick-start operation.The Diffie Hellman Parameter interface provides public the parameters needed for doing a Diffie-Hellman
key agreement.
The
DictionaryOIDTextFormat provides a simple OID formatter based on a dictionary of object name to
object identifier mappings.User based target for SNMPv3 User Based Security Model
USM or later that includes any necessary
authentication and privacy information, i.e.The
TlsAddress represents a TLS transport addresses as defined
by RFC 5953 SnmpTSLAddress textual convention.The
DTLSTM implements the Datagram Transport Layer Security Transport Mapping (TLS-TM) as defined by RFC
5953 with the new IO API and SSLEngine.The
DummyTransport is a test TransportMapping for Command Generators
which actually does not sent messages over the network.The
EngineBootsCounterFile is a SnmpEngineIdProvider
that stores the boot counter amd the engine ID of an SNMP entity in a file.An
EngineBootsProvider holds persistently the number of engine
boots.The interface
EngineIdCacheSize defines the maximum engine ID cache size when the cache size
is about to increase.An
EngineIdProvider holds persistently the engine ID of a SNMP engine.The
EnumerationIterator provides an iterator from an
Enumeration.The
Gauge32 class is indistinguishable from UnsignedInteger32.The
GenericAddress implements the decorator and factory
design pattern to provide a generic address type.The
Integer32 represents 32bit signed integer values for SNMP.The
IpAddress class represents an IPv4 address SNMP variable.The
JavaLogAdapter log adapter provides logging for SNMP4J
through the Java logging (java.util.logging).The
JavaLogFactory implements a SNMP4J LogFactory for
Java logging.The
LogAdapter specifies the logging interface used by
SNMP4J.The
LogFactory singleton is used by SNMP4J to determine
the logging framework used to process SNMP4J log messages.A
LogProxy can be used for late binding loggers.The
MaxAccess enumerates the MAX-ACCESS values of SMIv2 and the deprecated MaxAccess.writeOnly
of SMIv1.The
MessageDispatcher interface defines common services of instances that process incoming SNMP messages and
dispatch them to interested CommandResponder instances.The
MessageDispatcherImpl decodes and dispatches incoming
messages using MessageProcessingModel instances and encodes
and sends outgoing messages using an appropriate TransportMapping
instances.The
MessageException represents information about an exception
occurred during message processing.The
MessageID interface defines the characteristics of a SNMP message ID
as defined by RFC 3412 §6.2.The
MessageLength object contains information about the
length of a message and the length of its header.The
MessageLengthDecoder needs to be implemented for connection
oriented transport mappings, because those transport mappings have no message
boundaries.The
MessageProcessingModel interface defines common methods to all SNMP message processing models.The
MPv1 is the message processing model for SNMPv1.The
MPv2c is the message processing model for SNMPv2c (community based SNMPv2).The
MPv3 is the message processing model for SNMPv3.The
Cache stores state reference information for the MPv3.The
CacheEntry class holds state reference information for the MPv3 message processing model for a single
message.The
EngineIdCacheFactory creates an engine ID cache with upper limit.The
HeaderData represents the message header information of SNMPv3 message.The
MultiThreadedMessageDispatcher class is a decorator
for any MessageDispatcher instances that processes incoming
message with a supplied ThreadPool.The
MutablePDU is a container for a PDU
instance.The
MutableStateReference encapsulates a StateReference for read/write access.The
NoLogger implements a LogAdapter that does
not perform any logging.With the
NonStandardSecurityProtocol interface you can modify
the ID of a non-standard security protocol to match the ID that is used
by that protocol in your environment.The
Null class represents SMI Null and the derived
SMIv2 exception syntaxes.The
OctetString class represents the SMI type OCTET STRING.The Object Identifier Class.
The
OIDTextFormat provides a textual representation of a raw
object ID.The
Opaque class represents the SMI type Opaque which is used
to transparently exchange BER encoded values.The
PDU class represents a SNMP protocol data unit.PDUFactory defines the interface for PDU factories.The
PduHandle class represents an unique key for a SNMP PDU.The
PduHandleCallback can be used to get informed about a
PduHandle creation before a request is actually sent out.The
PDUv1 represents SNMPv1 PDUs.Privacy protocol class for Triple DES (DESEDE).
The PrivacyGeneric abstract class implements common functionality of privacy protocols.
The
PrivacyProtocol interface defines a common
interface for all SNMP privacy protocols.Base class for PrivAES128, PrivAES192 and PrivAES256.
Encryption class for AES 128.
Encryption class for AES 192.
This class is provided for interoperability with some broken AES 192bit implementations of major
network device manufactures which use a key extension algorithm that was specified for
Priv3DES but was never specified for AES 192 and 256 bit.Encryption class for AES 256.
This class is provided for interoperability with some broken AES 256bit implementations of major network device
manufactures which use a key extension algorithm that was specified for
Priv3DES but was
never specified for AES 192 and 256 bit.This class is provided for interoperability with some broken AES implementations of major network device manufactures
which use a key extension algorithm that was specified for
Priv3DES but was never
specified for AES 192 and 256 bit.Privacy protocol class for DES.
The
PropertiesTlsTmSecurityCallback resolves the
tmSecurityName for incoming requests by using the
(system) properties
org.snmp4j.arg.securityName
org.snmp4j.arg.tlsLocalID
org.snmp4j.arg.tlsTrustCA
org.snmp4j.arg.tlsPeerIDThis abstract class helps to implement a
VariantVariableCallback
for a read-only Variable.The
RequestStatistics interface defines statistic values about request processing.ResponseEvent associates a request PDU with the corresponding
response and an optional user object.The
ResponseListener interface is implemented by objects that process SNMP response messages.The
RetrievalEvent is an abstract class representing the result
of one or more GET/GETNEXT/GETBULK requests.Class that holds a 64 bit salt value for crypto operations.
The
SchedulerTask extends the Runnable interface
by methods that are needed for recurrent execution of a task.The
ScopedPDU class represents a SNMPv3 scoped PDU.The
SecretOctetString is an OctetString for secret data like keys and passwords.The
SecureTarget is an security model independent abstract class for all targets supporting secure SNMP
communication.The
SecurityLevel interface contains enumerated values
for the different security levels.The
SecurityModel interface as described in RFC3411 section 4.4
and RFC 5590 section 5.The
SecurityModels class is a collection of all
supported security models of a SNMP entity.The
SecurityNameMapping maps a X509 certificate identified by it
fingerprint to a security name based on a mapping defined by
SecurityNameMapping.CertMappingType.The
SecurityParameters interface represents the security
parameters in a SNMPv3 message.The
SecurityProtocol class defines common methods of
authentication and privacy protocols.The
SecurityProtocols class holds all authentication and privacy protocols for a SNMP entity.The
SecurityStateReference interface is an empty marker
interface for security model dependent state references.Session defines a common interface for all classes that
implement SNMP protocol operations based on SNMP4J.The
SimpleMessageID implements the simplest possible MessageID with
a minimum memory footprint.The
SimpleOIDTextFormat implements a simple textual
representation for object IDs as dotted string.The
SimpleVariableTextFormat implements a simple textual
representation for SNMP variables based on their type only.A
SMIAddress is an address that is defined by the Structure
of Management Information (SMI) and can be thereby serialized through the
Basic Encoding Rules (BER) used by the SNMP protocol.The
SMIConstants defines the tag values for SMI syntax types.The
Snmp class is the core of SNMP4J.Interface for handling reports.
The
SNMP4JSettings class implements a central configuration class of the SNMP4J framework.Specifies how the security level of retry requests after a REPORT PDU is set.
Builds a
Snmp instance through step-by-step configuration using a fluent interface design pattern.This
ReportException represents an SNMP PDU.REPORT PDU.This
SnmpErrorException represents an SNMP error status and index.The
SnmpConfigurator class configures a Snmp instance
with settings taken from a Map conforming to the format returned
by ArgumentParser.parse(String[] args).The
SnmpConstants class holds constants, ObjectIDs and
Message strings used within SNMP4J.Enumeration of the textual convention StorageType defined in SNMPv2-TC MIB.
The
SnmpEngineEvent describes events generated on behalf of
the engine ID cache of the SNMPv3 message processing model (MPv3).The
SnmpEngineIdProvider interface combines EngineIdProvider and
EngineBootsProvider to provide all persistently held information for a SNMP engine ID,
i.e.The
SnmpEngineListener interface can be implemented by classes
that need to be informed about changes to the SNMP engine ID cache.The
SnmpURI class provides a SNMP service based on the SNMP URI as defined by RFC 4088.The
SnmpUriCallback interface is used by asynchronous
methods of the SnmpURI class to provide instances of
SnmpUriResponse to the caller.The
SnmpUriResponse contains the data returned by a SNMP URI
operation.The abstract class
SNMPv3SecurityModel implements
common methods and fields for security models for the SNMPv3
message processing model.The
SocketTimeout is a TimerTask that provides means to detect when a socket is not used for
predefined time and then close the socket and free its resources.The
SSLEngineConfigurator interface is implemented by users of the TLSTM or
DTLSTM transport protocols to configure new TLS (SSL) connections.The
StateReference class represents state information associated with SNMP messages.The
StatusInformation class represents status information
of a SNMPv3 message that is needed to return a report message.The
SubIndexInfo interface represents the meta information of a SMI INDEX clause element (= sub-index)
which are relevant for converting an OID index value to an INDEX object and vice versa.The
SubIndexInfoImpl class represents the meta information of a SMI INDEX clause element (= sub-index)
which are relevant for converting an OID index value to an INDEX object and vice versa.The
TableEvent class reports events in a table retrieval
operation.The
TableListener interface is implemented by objects
listening for table events.The
TableUtils class provides utility functions to retrieve
SNMP tabular data.A
Target interface defines an abstract representation of a remote SNMP entity.The
TargetBuilder class creates SNMP Target instances using a fluent flow.The
TaskScheduler uses a ThreadPool to recurrent
execute SchedulerTasks.The
TcpAddress represents TCP/IP transport addresses.The
TcpTransportMapping is the abstract base class for
TCP transport mappings.The
ThreadFactory describes a factory for threads of execution
modeled as WorkerTasks.The
ThreadPool provides a pool of a fixed number of threads
that are capable to execute tasks that implement the Runnable
interface concurrently.The
TimedMessageID adds system time information to the message ID that allows
to measure response times and detect lost messages with SNMPv3.The
TimeoutModel is the common interface for all models
of timing out a SNMP request.The
TimerFactory describes a factory for
CommonTimer instances.The
TimeTicks class represents the time in 1/100 seconds since some epoch (which should be have been
defined in the corresponding MIB specification).The
TlsAddress represents a TLS transport addresses as defined
by RFC 5953 SnmpTSLAddress textual convention.The
TLSTM implements the Transport Layer Security
Transport Mapping (TLS-TM) as defined by RFC 5953
with the new IO API and SSLEngine.TLSTM trust manager that implements the X509ExtendedTrustManager interface.
X509ExtendedTrustManager factory for (D)TLSTM.
The
TlsTmSecurityCallback is implemented by the SnmpTlsMib (of SNMP4J-Agent), for example, to resolve
(lookup) the tmSecurityName for incoming requests.The
TlsTmSecurityCallbackProxy class implements a TlsTmSecurityCallback by using an
internal reference to another TlsTmSecurityCallback instance.The
TlsTransportMappingConfig interface provides means to plug in a TlsTmSecurityCallback into
the TransportMapping implementation and to control other TLS specific settings.Deprecated.
The
TlsCertifiedTarget extends the CertifiedTarget class by means to provide
a TlsTmSecurityCallback reference directly with the target as needed according to RFC 6353 §5.3.1 when
establishing a connection based on the SNMP-TARGET-MIB as client.The
TransportIpAddress is the abstract base class for all
transport addresses on top of IP network addresses.The
TransportListener interface is implemented by objects
that process incoming messages from TransportMappings, for
example MessageDispatcher.The
TransportMapping defines the common interface for SNMP
transport mappings.The
TransportMappings factory can be used to create a transport
mapping for an address class.The
TransportStateEvent describes a state change for
a transport connection.The
TransportStateListener interface can be implemented
to monitor the connection state for connection oriented transport mappings.The
TransportStateReference class holds information defined by RFC 5343 for the tmStateReference ASI
elements.The
TransportType defines the communication capabilities of a TransportMapping
regarding the communication initiation (thus its direction).The
TreeEvent class reports events in a tree retrieval
operation.The
TreeListener interface is implemented by objects
listening for tree events.The
TSM (Transport Security Model) implements a SecurityModel which uses transport security
mechanisms as defined in RFC 5591.SecurityParameters implementation for the TSM security model.The
TsmSecurityStateReference holds cached security data for the TSM
security model.The
UdpAddress represents UDP/IP transport addresses.The
UdpTransportMapping is the abstract base class for
UDP transport mappings.UnsignedInteger32 type is an SNMP type that represents unsigned 32bit integer values (0 to 4294967295).
The
UnsupportedAddressClassException indicates a message
exception caused by unsupported address class.Common interface that has to be implemented by all user based
security models user classes.
User based target for SNMPv3 or later.
The
USM class implements the User Based Security Model (USM) as defined in RFC 3414.The
UsmSecurityStateReference holds cached security data for the USM security model.The
UsmTimeEntry class represents time synchronization
information associated with an engine ID.The
UsmTimeTable class is a singleton that stores USM user information as part of the Local
Configuration Datastore (LCD).The
UsmUser class represents USM user providing information
to secure SNMPv3 message exchange.This enum defines which Localization operations are allowed for a
UsmUser.The
UsmUserEntry class represents a user in the Local Configuration Datastore (LCD).This Event is issued whenever a user of the
USM is created
modified or deleted.The
UsmUserListener interface is implemented by objects that
need to be informed when a USM user is created, modified, or deleted.The
UsmUserTable class stores USM user
information as part of the Local Configuration Datastore (LCD).The
UsmUserKey class defines the unique key for UsmUserTable by engineID and securityName.The
Variable interface defines common attributes of all SNMP variables.The
VariableTextFormat provides a textual representation
of SNMP Variables, in dependence of their associated (instance) OID.The
VariantVariable provides a decorator for any type
of Variable instance, to be able to intercept or monitor variable
value modification by using a VariantVariableCallback.The
VariantVariableCallback can be implemented by
objects that want to intercept/monitor reading and writing of
a VariantVariable's value.The
VersionInfo object returns information about the version of this SNMP4J release.The
WorkerPool interface models an abstract pool of workers
(threads) which can execute WorkerTasks concurrently.This models a
WorkerTask instance that would be executed by a
WorkerPool upon submission.The
TlsTransportMappingConfig interface provides means to plug in a TlsTmSecurityCallback into
a TransportMapping that uses X509Certificates for TLS.
TLSTMExtendedTrustManagerinstead.