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
TableUtilscan be used to asynchronously retrieve table data efficiently row by row. -
Classes for support of multi-threaded message dispatching. The class
MultiThreadedMessageDispatcherimplements theMessageDispatcherinterface and uses theMessageDispatcherImplclass 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 ThisCommonTimerdefines the subset interface used fromTimerby SNMP4J.OIDTextFormat TheOIDTextFormatprovides a textual representation of a raw object ID.PDUFactory PDUFactorydefines the interface for PDU factories.SchedulerTask TheSchedulerTaskextends theRunnableinterface by methods that are needed for recurrent execution of a task.TableListener TheTableListenerinterface is implemented by objects listening for table events.ThreadFactory TheThreadFactorydescribes a factory for threads of execution modeled asWorkerTasks.TimerFactory TheTimerFactorydescribes a factory forCommonTimerinstances.TreeListener TheTreeListenerinterface is implemented by objects listening for tree events.VariableTextFormat TheVariableTextFormatprovides a textual representation of SNMPVariables, in dependence of their associated (instance) OID.WorkerPool TheWorkerPoolinterface models an abstract pool of workers (threads) which can executeWorkerTasks concurrently.WorkerTask This models aWorkerTaskinstance that would be executed by aWorkerPoolupon submission. -
Class Summary Class Description AbstractSnmpUtility TheAbstractSnmpUtilityis an abstract base class for convenience utility classes to retrieve SNMP data.ArgumentParser TheArgumentParserparsers 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 TheDefaultPDUFactoryis a default implementation of thePDUFactoryinterface.DefaultThreadFactory TheDefaultThreadFactorycreatesWorkerTaskinstances that allow concurrent execution of tasks.DefaultTimerFactory ThisDefaultTimerFactorycreates a newTimerwhich is configured to run as daemon.EnumerationIterator<E> TheEnumerationIteratorprovides an iterator from anEnumeration.MultiThreadedMessageDispatcher TheMultiThreadedMessageDispatcherclass is a decorator for anyMessageDispatcherinstances that processes incoming message with a suppliedThreadPool.RetrievalEvent TheRetrievalEventis an abstract class representing the result of one or more GET/GETNEXT/GETBULK requests.SimpleOIDTextFormat TheSimpleOIDTextFormatimplements a simple textual representation for object IDs as dotted string.SimpleVariableTextFormat TheSimpleVariableTextFormatimplements a simple textual representation for SNMP variables based on their type only.SnmpConfigurator TheSnmpConfiguratorclass configures aSnmpinstance with settings taken from aMapconforming to the format returned byArgumentParser.parse(String[] args).TableEvent TheTableEventclass reports events in a table retrieval operation.TableUtils TheTableUtilsclass provides utility functions to retrieve SNMP tabular data.TaskScheduler TheTaskScheduleruses aThreadPoolto recurrent executeSchedulerTasks.ThreadPool TheThreadPoolprovides a pool of a fixed number of threads that are capable to execute tasks that implement theRunnableinterface concurrently.TreeEvent TheTreeEventclass reports events in a tree retrieval operation.TreeUtils -
Enum Summary Enum Description TableUtils.SparseTableMode -
Exception Summary Exception Description ArgumentParser.ArgumentParseException