Package io.hawt.quarkus

Class HawtioConfig

  • @ConfigRoot(name="hawtio",
            phase=BUILD_AND_RUN_TIME_FIXED)
public class HawtioConfig
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Boolean authenticationEnabled
      Enables or disables Hawtio authentication
      static java.lang.String DEFAULT_CONTEXT_PATH  
      static java.lang.String DEFAULT_PLUGIN_PATH  
      java.lang.Boolean disableProxy
      Enable or disable the Hawtio proxy servlet
      java.util.Optional<java.lang.String> keycloakClientConfig
      The location of client-side configuration file for Hawtio Keycloak support
      java.lang.Boolean keycloakEnabled
      Enables or disables Hawtio keycloak support
      java.lang.Boolean localAddressProbing
      Whether local address probing for proxy allowlist is enabled or not upon startup.
      java.util.Map<java.lang.String,​HawtioConfig.PluginConfig> pluginConfigs
      Map of custom Hawtio plugin configurations
      java.util.Optional<java.util.List<java.lang.String>> proxyAllowlist
      Comma separated list for target hosts that the hawtio-jmx Connect plugin can connect to via ProxyServlet.
      java.util.Optional<java.lang.String> role
      The user role required to log in to the console
      java.util.Optional<java.util.List<java.lang.String>> roles
      Comma separated list of user roles required to log in to the console
      java.util.Optional<java.lang.Integer> sessionTimeout
      The maximum time interval, in seconds, that the servlet container will keep this session open between client accesses

    • Constructor Summary

      Constructors 
      Constructor Description
      HawtioConfig()  

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_CONTEXT_PATH

        public static final java.lang.String DEFAULT_CONTEXT_PATH
        See Also:
        Constant Field Values

      • DEFAULT_PLUGIN_PATH

        public static final java.lang.String DEFAULT_PLUGIN_PATH
        See Also:
        Constant Field Values

      • authenticationEnabled

        @ConfigItem(name="authenticationEnabled",
            defaultValue="true")
public java.lang.Boolean authenticationEnabled
        Enables or disables Hawtio authentication

      • role

        @ConfigItem
public java.util.Optional<java.lang.String> role
        The user role required to log in to the console

      • roles

        @ConfigItem
public java.util.Optional<java.util.List<java.lang.String>> roles
        Comma separated list of user roles required to log in to the console

      • keycloakEnabled

        @ConfigItem(name="keycloakEnabled",
            defaultValue="false")
public java.lang.Boolean keycloakEnabled
        Enables or disables Hawtio keycloak support

      • keycloakClientConfig

        @ConfigItem(name="keycloakClientConfig")
public java.util.Optional<java.lang.String> keycloakClientConfig
        The location of client-side configuration file for Hawtio Keycloak support

      • sessionTimeout

        @ConfigItem(name="sessionTimeout",
            defaultValue="1800")
public java.util.Optional<java.lang.Integer> sessionTimeout
        The maximum time interval, in seconds, that the servlet container will keep this session open between client accesses

      • proxyAllowlist

        @ConfigItem(name="proxyAllowlist",
            defaultValue="localhost, 127.0.0.1")
public java.util.Optional<java.util.List<java.lang.String>> proxyAllowlist
        Comma separated list for target hosts that the hawtio-jmx Connect plugin can connect to via ProxyServlet.

        All hosts that are not listed in this allowlist are denied to connect for security reasons. This option can be set to * to restore the old behavior and allow all hosts. Prefixing an element of the list with "r:" allows you to define a regexp (example: localhost,r:myservers[0-9]+.mydomain.com)

      • localAddressProbing

        @ConfigItem(name="localAddressProbing",
            defaultValue="true")
public java.lang.Boolean localAddressProbing
        Whether local address probing for proxy allowlist is enabled or not upon startup. Set this property to false to disable it

      • disableProxy

        @ConfigItem(name="disableProxy",
            defaultValue="false")
public java.lang.Boolean disableProxy
        Enable or disable the Hawtio proxy servlet

      • pluginConfigs

        @ConfigItem(name="plugin")
public java.util.Map<java.lang.String,​HawtioConfig.PluginConfig> pluginConfigs
        Map of custom Hawtio plugin configurations

    • Constructor Detail

      • HawtioConfig

        public HawtioConfig()