Package com.github.cafapi.common.api

Interface BootstrapConfiguration

All Known Implementing Classes:
SystemBootstrapConfiguration
public interface BootstrapConfiguration
A bootstrap configuration is a method of providing basic, initial startup configuration. This is more crude than a full ConfigurationProvider, and only supports trivial key/value lookups.

  • Field Details

    • CONFIG_APP_NAME

      static final String CONFIG_APP_NAME
      Application identifier configuration parameter key. This must be in the format /a/b.
      See Also:

    • OLD_CONFIG_APP_NAME

      @Deprecated static final String OLD_CONFIG_APP_NAME
      Deprecated.
      Old application identifier configuration parameter key.
      See Also:

  • Method Details

    • isConfigurationPresent

      boolean isConfigurationPresent(String key)
      Determine if a configuration parameter has been set or not.
      Parameters:
      key - the config parameter to check
      Returns:
      whether the config parameter is set or not

    • getConfiguration

      String getConfiguration(String key) throws ConfigurationException
      Return the value of the requested configuration parameter.
      Parameters:
      key - the config parameter to lookup
      Returns:
      the value of the config parameter
      Throws:
      ConfigurationException - if the configuration parameter is not set

    • getConfigurationInteger

      int getConfigurationInteger(String key) throws ConfigurationException
      Return the integer representation of the requested configuration parameter.
      Parameters:
      key - the config parameter to lookup
      Returns:
      the value of the config parameter as an integer
      Throws:
      ConfigurationException - if the configuration parameter is not set

    • getConfigurationInteger

      int getConfigurationInteger(String key, int min, int max) throws ConfigurationException
      Return the integer representation of the requested configuration parameter, between the minimum and maximum integers specified.
      Parameters:
      key - the config parameter to lookup
      min - the lower bound of the integer to be returned
      max - the upper bound of the integer to be returned
      Returns:
      the value of the config parameter as an integer, between the limits specified
      Throws:
      ConfigurationException - if the configuration parameter is not set

    • getConfigurationBoolean

      boolean getConfigurationBoolean(String key) throws ConfigurationException
      Return the boolean representation of the requested configuration parameter.
      Parameters:
      key - the config parameter to lookup
      Returns:
      the value of the config parameter as an integer
      Throws:
      ConfigurationException - if the configuration parameter is not set

    • getServicePath

      ServicePath getServicePath() throws ConfigurationException
      Returns:
      an object representing the fully qualified service path of this instance
      Throws:
      ConfigurationException - if the ServicePath cannot be acquired