Class AbstractMonitoredThing

  • All Implemented Interfaces:
    UseDefaultConverter, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,​java.lang.String>>
    Direct Known Subclasses:
    Metric

    public abstract class AbstractMonitoredThing
    extends java.lang.Object
    implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,​java.lang.String>>, java.io.Serializable, UseDefaultConverter, java.lang.Cloneable
    See Also:
    Serialized Form
    • Constructor Detail

      • AbstractMonitoredThing

        public AbstractMonitoredThing()
      • AbstractMonitoredThing

        public AbstractMonitoredThing​(java.lang.String subsystem,
                                      java.lang.String description)
    • Method Detail

      • getId

        public long getId()
      • setId

        public void setId​(long id)
      • getSubsystem

        public java.lang.String getSubsystem()
        The AIE subsytem that caused the event. This can be used by snmp filters for easily classifying events String (as opposed to enum) to allow for new event types by modules and/or customers.
      • setSubsystem

        public void setSubsystem​(java.lang.String subsystem)
      • getMetadata

        public BaseTypesMap<java.lang.String,​java.lang.String> getMetadata()
      • setMetadata

        public void setMetadata​(BaseTypesMap<java.lang.String,​java.lang.String> metadata)
      • getDescription

        public java.lang.String getDescription()
      • setDescription

        public void setDescription​(java.lang.String message)
      • addMetadata

        public AbstractMonitoredThing addMetadata​(java.lang.String key,
                                                  java.lang.String value)
        Returns this event.
      • addMetadata

        public AbstractMonitoredThing addMetadata​(java.lang.String key,
                                                  int value)
        Returns this event.
      • addMetadata

        public AbstractMonitoredThing addMetadata​(java.lang.String key,
                                                  long value)
        Returns this event.
      • addMetadata

        public AbstractMonitoredThing addMetadata​(java.lang.String key,
                                                  double value)
        Returns this event.
      • addMetadata

        public AbstractMonitoredThing addMetadata​(java.lang.String key,
                                                  boolean value)
        Returns this event.
      • addMetadata

        public AbstractMonitoredThing addMetadata​(java.lang.String key,
                                                  float value)
        Returns this event.
      • addMetadata

        public void addMetadata​(java.lang.String key,
                                java.lang.Throwable t)
        Adds the Exception's messages and all messages of all causes to the event in the form:
         key.message.0 = top level exception message
         key.message.1 = cause of top level message
         key.message.2 = cause of first caused exception
         key.message.n = root cause message
         
      • containsMetadata

        public boolean containsMetadata​(java.lang.String key)
        True if the specified metdata key has a value in this event.
      • getMetadata

        public java.lang.String getMetadata​(java.lang.String key)
        Returns the value of the metadata key or null if it does not exist.
      • getMetadata

        public java.lang.String getMetadata​(java.lang.String key,
                                            java.lang.String defaultValue)
        Returns the value of the metadata key or null if it does not exist.
      • getMetadata

        public int getMetadata​(java.lang.String key,
                               int defaultValue)
        Returns the value of the metadata key or null if it does not exist.
      • getMetadata

        public long getMetadata​(java.lang.String key,
                                long defaultValue)
        Returns the value of the metadata key or null if it does not exist.
      • getMetadata

        public float getMetadata​(java.lang.String key,
                                 float defaultValue)
        Returns the value of the metadata key or null if it does not exist.
      • getMetadata

        public double getMetadata​(java.lang.String key,
                                  double defaultValue)
        Returns the value of the metadata key or null if it does not exist.
      • getMetadata

        public boolean getMetadata​(java.lang.String key,
                                   boolean defaultValue)
        Returns the value of the metadata key or null if it does not exist.
      • iterator

        public java.util.Iterator<java.util.Map.Entry<java.lang.String,​java.lang.String>> iterator()
        metadata about the event. we will define rules for how certain data types (ContainterPropertyReference, double, List-of-list, etc) get converted to SNMP data types
        Specified by:
        iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,​java.lang.String>>
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object