Class OpenTsdbSystemHistorianConfig


  • public class OpenTsdbSystemHistorianConfig
    extends java.lang.Object
    Configuration class for the OpenTSDB SystemHistorian.
    • Constructor Summary

      Constructors 
      Constructor Description
      OpenTsdbSystemHistorianConfig​(java.lang.String openTsdbHost, java.lang.Integer openTsdbPort, com.elastisys.scale.commons.json.types.TimeInterval pushInterval)
      Creates a new instance with the specified configuration values
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getOpenTsdbHost()
      Returns the hostname or IP address of the OpenTSDB server to use.
      int getOpenTsdbPort()
      Returns the IP port number of the OpenTSDB server to use.
      com.elastisys.scale.commons.json.types.TimeInterval getPushInterval()
      Returns the time interval between two successive report attempts.
      int hashCode()  
      java.lang.String toString()  
      void validate()
      Validates the configuration (checks if there are any obvious errors).
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • DEFAULT_PUSH_INTERVAL

        public static final com.elastisys.scale.commons.json.types.TimeInterval DEFAULT_PUSH_INTERVAL
        Default pushInterval.
    • Constructor Detail

      • OpenTsdbSystemHistorianConfig

        public OpenTsdbSystemHistorianConfig​(java.lang.String openTsdbHost,
                                             java.lang.Integer openTsdbPort,
                                             com.elastisys.scale.commons.json.types.TimeInterval pushInterval)
        Creates a new instance with the specified configuration values
        Parameters:
        openTsdbHost - The hostname or IP address of the OpenTSDB server to use.
        openTsdbPort - The IP port number of the OpenTSDB server to use. May be null. Default: DEFAULT_OPENTSDB_PORT.
        pushInterval - The time interval between two successive report attempts. May be null. Default: DEFAULT_PUSH_INTERVAL.
    • Method Detail

      • getOpenTsdbHost

        public java.lang.String getOpenTsdbHost()
        Returns the hostname or IP address of the OpenTSDB server to use.
        Returns:
      • getOpenTsdbPort

        public int getOpenTsdbPort()
        Returns the IP port number of the OpenTSDB server to use.
        Returns:
      • getPushInterval

        public com.elastisys.scale.commons.json.types.TimeInterval getPushInterval()
        Returns the time interval between two successive report attempts.
        Returns:
      • validate

        public void validate()
                      throws java.lang.IllegalArgumentException
        Validates the configuration (checks if there are any obvious errors).
        Throws:
        java.lang.IllegalArgumentException - Thrown if there are obvious errors, such as missing values the values are out of permissible ranges.
      • 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
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object