Interface MonitoringAttributes

  • All Known Implementing Classes:
    BasicMonitoringAttributes

    public interface MonitoringAttributes
    An interface defining the different methods required by the UI components to display monitoring attributes data.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean canHaveAverage()
      Returns true if the average for this attribute makes sense and false otherwise.
      String getAttributeName()
      Returns the name of the attribute.
      org.forgerock.i18n.LocalizableMessage getMessage()
      Returns the message associated with the attribute (basically is the localized name of the operation associated with the attribute).
      boolean isGMTDate()
      Return whether this attribute contains a GMT date value or not.
      boolean isNumeric()
      Return whether this attribute contains a numeric value or not.
      boolean isNumericDate()
      Return whether this attribute contains a numeric date value or not.
      boolean isTime()
      Return whether this attribute contains a time value or not.
      boolean isValueInBytes()
      Return whether this attribute represents a value in bytes or not.
    • Method Detail

      • getMessage

        org.forgerock.i18n.LocalizableMessage getMessage()
        Returns the message associated with the attribute (basically is the localized name of the operation associated with the attribute).
        Returns:
        the message associated with the attribute.
      • getAttributeName

        String getAttributeName()
        Returns the name of the attribute.
        Returns:
        the name of the attribute.
      • isNumeric

        boolean isNumeric()
        Return whether this attribute contains a numeric value or not.
        Returns:
        true if the value is numeric and false otherwise.
      • isTime

        boolean isTime()
        Return whether this attribute contains a time value or not.
        Returns:
        true if the value is a time and false otherwise.
      • isNumericDate

        boolean isNumericDate()
        Return whether this attribute contains a numeric date value or not. The date is a long value in milliseconds.
        Returns:
        true if the value is date and false otherwise.
      • isGMTDate

        boolean isGMTDate()
        Return whether this attribute contains a GMT date value or not. The date has a format of type ServerConstants.DATE_FORMAT_GMT_TIME.
        Returns:
        true if the value is a GMT date and false otherwise.
      • isValueInBytes

        boolean isValueInBytes()
        Return whether this attribute represents a value in bytes or not.
        Returns:
        true if the value represents a value in bytes and false otherwise.
      • canHaveAverage

        boolean canHaveAverage()
        Returns true if the average for this attribute makes sense and false otherwise.
        Returns:
        true if the average for this attribute makes sense and false otherwise.