Package io.micronaut.controlpanel.core.config

Interface ControlPanelModuleConfiguration

All Superinterfaces:
io.micronaut.core.util.Toggleable
@ConfigurationProperties("micronaut.control-panel") public interface ControlPanelModuleConfiguration extends io.micronaut.core.util.Toggleable
Configuration properties for the control panel module.
Since:
1.0.0
Author:
Álvaro Sánchez-Mariscal

  • Field Details

  • Method Details

    • isEnabled

      @Bindable(defaultValue="true") boolean isEnabled()
      Enables/disables the control panel module. Default value: "true".
      Specified by:
      isEnabled in interface io.micronaut.core.util.Toggleable

    • getAllowedEnvironments

      @Bindable(defaultValue="dev,test") Set<String> getAllowedEnvironments()
      Configures the environments where the control panel module is enabled. By default, it is only enabled in the "dev" and "test" environments.
      Returns:
      the environments where the control panel module is enabled.

    • getPath

      @Bindable(defaultValue="/control-panel") String getPath()
      Configures the path where the control panel can be accessed. Default value: "/control-panel".
      Returns:
      the path where the control panel module is available.