Module org.snmp4j
Package org.snmp4j.mp

Class DefaultCounterListener

  • All Implemented Interfaces:
    java.util.EventListener, CounterListener

    public class DefaultCounterListener
    extends java.lang.Object
    implements CounterListener
    The DefaultCounterListener is the default implementation of the CounterListener interface. For any counter incrementation event it checks whether the referenced counter object already exists. If not, it will be created and initialized with one. Otherwise, the current value will be incremented by one. In either case, the current value will be returned in the event object.

    To use a DefaultCounterListener with SNMP4J, add it to the default CounterSupport by:

       CounterSupport.getInstance().addCounterListener(new DefaultCounterListener());
     
    Version:
    2.0
    Author:
    Frank Fock
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Counter32 add​(OID oid, Counter32 counter)
      Adds a counter to this counter listener.
      void incrementCounter​(CounterEvent event)
      Increment the supplied counter instance and return the current value (after incrementation) in the event object if the event receiver is the maintainer of the counter value.
      boolean isCountRegisteredOnly()  
      Counter32 remove​(OID oid)
      Removes a counter from this listener and returns it.
      void setCountRegisteredOnly​(boolean countRegisteredOnly)
      Sets the flag which indicates how unregistered counter events should be handled.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultCounterListener

        public DefaultCounterListener()
        Default constructor.
    • Method Detail

      • incrementCounter

        public void incrementCounter​(CounterEvent event)
        Description copied from interface: CounterListener
        Increment the supplied counter instance and return the current value (after incrementation) in the event object if the event receiver is the maintainer of the counter value.
        Specified by:
        incrementCounter in interface CounterListener
        Parameters:
        event - a CounterEvent instance.
      • add

        public Counter32 add​(OID oid,
                             Counter32 counter)
        Adds a counter to this counter listener. If counter events have been received already for the given oid the provided counter will be incremented by the number of events already counted and then counter replaces the old counter.
        Parameters:
        oid - the object identifier of the counter instance (thus including the .0 suffix).
        counter - the counter to register.
        Returns:
        the counter previously associated with oid or null if no such counter exist.
        Since:
        2.0
      • remove

        public Counter32 remove​(OID oid)
        Removes a counter from this listener and returns it.
        Parameters:
        oid - the object identifier of the counter instance (thus including the .0 suffix).
        Returns:
        the counter previously associated with oid or null if no such counter exist.
        Since:
        2.0
      • isCountRegisteredOnly

        public boolean isCountRegisteredOnly()
      • setCountRegisteredOnly

        public void setCountRegisteredOnly​(boolean countRegisteredOnly)
        Sets the flag which indicates how unregistered counter events should be handled.
        Parameters:
        countRegisteredOnly - if true counter events for OIDs which have not been added by add(org.snmp4j.smi.OID, org.snmp4j.smi.Counter32) will be ignored, otherwise a Counter32 will be registered to count corresponding events.
        Since:
        2.0