Package org.snmp4j.util
package org.snmp4j.util
Contains table retrieval utilities and multi-threading support classes as
well as miscellaneous utility classes.
The org.snmp4j.util
contains the following groups of classes:
-
Classes for SNMP table retrieval. The class
TableUtils
can be used to asynchronously retrieve table data efficiently row by row. -
Classes for support of multi-threaded message dispatching. The class
MultiThreadedMessageDispatcher
implements theMessageDispatcher
interface and uses theMessageDispatcherImpl
class to dispatch incoming message using the threads of aThreadPool
.
The following UML class diagram shows the classes of the
org.snmp4j.util
package and their relationships
(relationships to other packages are not shown):
-
ClassDescriptionThe
AbstractSnmpUtility
is an abstract base class for convenience utility classes to retrieve SNMP data.TheArgumentParser
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.ThisCommonTimer
defines the subset interface used fromTimer
by SNMP4J.TheDefaultPDUFactory
is a default implementation of thePDUFactory
interface.TheDefaultThreadFactory
createsWorkerTask
instances that allow concurrent execution of tasks.ThisDefaultTimerFactory
creates a newTimer
which is configured to run as daemon.TheEnumerationIterator
provides an iterator from anEnumeration
.TheMultiThreadedMessageDispatcher
class is a decorator for anyMessageDispatcher
instances that processes incoming message with a suppliedThreadPool
.TheOIDTextFormat
provides a textual representation of a raw object ID.PDUFactory
defines the interface for PDU factories.TheRetrievalEvent
is an abstract class representing the result of one or more GET/GETNEXT/GETBULK requests.TheSchedulerTask
extends theRunnable
interface by methods that are needed for recurrent execution of a task.TheSimpleOIDTextFormat
implements a simple textual representation for object IDs as dotted string.TheSimpleVariableTextFormat
implements a simple textual representation for SNMP variables based on their type only.TheSnmpConfigurator
class configures aSnmp
instance with settings taken from aMap
conforming to the format returned byArgumentParser.parse(String[] args)
.TheTableEvent
class reports events in a table retrieval operation.TheTableListener
interface is implemented by objects listening for table events.TheTableUtils
class provides utility functions to retrieve SNMP tabular data.TheTaskScheduler
uses aThreadPool
to recurrent executeSchedulerTask
s.TheThreadFactory
describes a factory for threads of execution modeled asWorkerTask
s.TheThreadPool
provides a pool of a fixed number of threads that are capable to execute tasks that implement theRunnable
interface concurrently.TheTimerFactory
describes a factory forCommonTimer
instances.TheTreeEvent
class reports events in a tree retrieval operation.TheTreeListener
interface is implemented by objects listening for tree events.TheVariableTextFormat
provides a textual representation of SNMPVariable
s, in dependence of their associated (instance) OID.TheWorkerPool
interface models an abstract pool of workers (threads) which can executeWorkerTask
s concurrently.This models aWorkerTask
instance that would be executed by aWorkerPool
upon submission.