Module org.snmp4j
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):

-
Interface Summary Interface Description CommonTimer ThisCommonTimer
defines the subset interface used fromTimer
by SNMP4J.OIDTextFormat TheOIDTextFormat
provides a textual representation of a raw object ID.PDUFactory PDUFactory
defines the interface for PDU factories.SchedulerTask TheSchedulerTask
extends theRunnable
interface by methods that are needed for recurrent execution of a task.TableListener TheTableListener
interface is implemented by objects listening for table events.ThreadFactory TheThreadFactory
describes a factory for threads of execution modeled asWorkerTask
s.TimerFactory TheTimerFactory
describes a factory forCommonTimer
instances.TreeListener TheTreeListener
interface is implemented by objects listening for tree events.VariableTextFormat TheVariableTextFormat
provides a textual representation of SNMPVariable
s, in dependence of their associated (instance) OID.WorkerPool TheWorkerPool
interface models an abstract pool of workers (threads) which can executeWorkerTask
s concurrently.WorkerTask This models aWorkerTask
instance that would be executed by aWorkerPool
upon submission. -
Class Summary Class Description AbstractSnmpUtility TheAbstractSnmpUtility
is an abstract base class for convenience utility classes to retrieve SNMP data.ArgumentParser 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.ArgumentParser.ArgumentFormat ArgumentParser.ArgumentParameter DefaultPDUFactory TheDefaultPDUFactory
is a default implementation of thePDUFactory
interface.DefaultThreadFactory TheDefaultThreadFactory
createsWorkerTask
instances that allow concurrent execution of tasks.DefaultTimerFactory ThisDefaultTimerFactory
creates a newTimer
which is configured to run as daemon.DictionaryOIDTextFormat TheDictionaryOIDTextFormat
provides a simple OID formatter based on a dictionary of object name to object identifier mappings.EnumerationIterator<E> TheEnumerationIterator
provides an iterator from anEnumeration
.MultiThreadedMessageDispatcher TheMultiThreadedMessageDispatcher
class is a decorator for anyMessageDispatcher
instances that processes incoming message with a suppliedThreadPool
.RetrievalEvent TheRetrievalEvent
is an abstract class representing the result of one or more GET/GETNEXT/GETBULK requests.SimpleOIDTextFormat TheSimpleOIDTextFormat
implements a simple textual representation for object IDs as dotted string.SimpleVariableTextFormat TheSimpleVariableTextFormat
implements a simple textual representation for SNMP variables based on their type only.SnmpConfigurator TheSnmpConfigurator
class configures aSnmp
instance with settings taken from aMap
conforming to the format returned byArgumentParser.parse(String[] args)
.TableEvent TheTableEvent
class reports events in a table retrieval operation.TableUtils TheTableUtils
class provides utility functions to retrieve SNMP tabular data.TaskScheduler TheTaskScheduler
uses aThreadPool
to recurrent executeSchedulerTask
s.ThreadPool TheThreadPool
provides a pool of a fixed number of threads that are capable to execute tasks that implement theRunnable
interface concurrently.TreeEvent TheTreeEvent
class reports events in a tree retrieval operation.TreeUtils -
Enum Summary Enum Description TableUtils.SparseTableMode -
Exception Summary Exception Description ArgumentParser.ArgumentParseException