Package com.atlassian.confluence.internal.health

Class HealthCheckAttributes

java.lang.Object
com.atlassian.confluence.internal.health.HealthCheckAttributes
public final class HealthCheckAttributes extends Object
Well-known keys and values of Johnson attributes used by startup health checks.
Since:
6.5.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CAUSE_KEY
    Checks which send analytics can provide a short cause which is analytics safe, i.e.
    static final String
    CHECK_ID_KEY
    Checks that wish to have analytics events raised (e.g.
    static final String
    DISMISSIBLE
    Boolean indicating whether or not an event is dismissible.
    static final String
    EVENT_ID_KEY
    The unique ID of an individual Johnson event arising from a HealthCheck.
    static final String
    HELP_URL_KEY
    Checks that wish to provide a help link to public-facing documentation should set this attribute to the relevant URL on the Johnson event that they return.
    static final String
    I18N_KEY_ATTRIBUTE
    The name of the attribute under which the i18N key to be used is stored for Johnson events where the description requires translation prior to display.
    static final String
    JOHNSON_UI_VERSION
    The Johnson event attribute that if present specifies what version of the Johnson UI is meant to display the events returned by this executor.
    static final String
    MODERN_JOHNSON
    The value of the JOHNSON_UI_VERSION attribute that indicates events are to be displayed in the "modern Johnson" UI added for CONFSRVDEV-2798.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • CHECK_ID_KEY

      public static final String CHECK_ID_KEY
      Checks that wish to have analytics events raised (e.g. about their success or failure) should set this attribute to a unique key, e.g. "my-db-check". The value of this key should remain stable for as long as this check is defined.
      See Also:

    • EVENT_ID_KEY

      public static final String EVENT_ID_KEY
      The unique ID of an individual Johnson event arising from a HealthCheck.
      See Also:

    • HELP_URL_KEY

      public static final String HELP_URL_KEY
      Checks that wish to provide a help link to public-facing documentation should set this attribute to the relevant URL on the Johnson event that they return.
      See Also:

    • CAUSE_KEY

      public static final String CAUSE_KEY
      Checks which send analytics can provide a short cause which is analytics safe, i.e. does not contain any user data.
      See Also:

    • JOHNSON_UI_VERSION

      public static final String JOHNSON_UI_VERSION
      The Johnson event attribute that if present specifies what version of the Johnson UI is meant to display the events returned by this executor.
      See Also:

    • MODERN_JOHNSON

      public static final String MODERN_JOHNSON
      The value of the JOHNSON_UI_VERSION attribute that indicates events are to be displayed in the "modern Johnson" UI added for CONFSRVDEV-2798.
      See Also:

    • I18N_KEY_ATTRIBUTE

      public static final String I18N_KEY_ATTRIBUTE
      The name of the attribute under which the i18N key to be used is stored for Johnson events where the description requires translation prior to display.
      See Also:

    • DISMISSIBLE

      public static final String DISMISSIBLE
      Boolean indicating whether or not an event is dismissible.
      See Also: