Package org.apache.geode.distributed

Enum Class HttpServiceWebApp

java.lang.Object
java.lang.Enum<HttpServiceWebApp>
org.apache.geode.distributed.HttpServiceWebApp
All Implemented Interfaces:
Serializable, Comparable<HttpServiceWebApp>, Constable
public enum HttpServiceWebApp extends Enum<HttpServiceWebApp>
Built-in web applications on the embedded HTTP port, selected via ConfigurationProperties.HTTP_SERVICES.
Since:
GemFire 10.3

  • Enum Constant Details

    • DEV_API

      public static final HttpServiceWebApp DEV_API
      Developer REST (servers).

    • METRICS

      public static final HttpServiceWebApp METRICS
      Prometheus scrape endpoint (servers and locators).

    • MANAGEMENT

      public static final HttpServiceWebApp MANAGEMENT
      Admin / management REST (locators).

    • PULSE

      public static final HttpServiceWebApp PULSE
      Pulse UI (locators).

  • Field Details

  • Method Details

    • values

      public static HttpServiceWebApp[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HttpServiceWebApp valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • configValue

      public String configValue()
      Token as it appears in http-services.

    • isEnabled

      public static boolean isEnabled(String[] apps, String appName)
      Whether the given web app is enabled. appName is the configuration token. This method is for extensions that deploy webapps not enumerated here.

    • isEnabled

      public static boolean isEnabled(String[] apps, HttpServiceWebApp webapp)
      Whether the given built-in web app is enabled.