Interface Configuration

All Known Subinterfaces:
LogConfiguration
All Known Implementing Classes:
AbstractLogConfiguration, AppConfiguration, LogbackConfiguration, LogConfigurationBase, ProxySettings

public interface Configuration
Application configuration interface
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Clean up configuration resources.
    void
    Initialize the configuration settings.
    void
    Load the configuration settings.
    void
    Store configuration settings.
  • Field Details

  • Method Details

    • init

      void init() throws IOException
      Initialize the configuration settings.
      Throws:
      IOException - if the configuration settings could not be initialized because of an I/O problem.
    • load

      void load() throws IOException
      Load the configuration settings. Settings will be loaded from a user and application specific location first. If no such settings exists, an attempt will be made to retrieve settings from a resource on the classpath. If no such settings exist either, settings will be loaded from a default resource on the classpath.
      Throws:
      IOException - if the configuration settings could not be loaded due to an I/O problem.
    • save

      void save() throws IOException
      Store configuration settings. Settings will be stored in a user and application specific location.
      Throws:
      IOException - if the configuration settings could not be saved due to an I/O problem.
    • destroy

      void destroy() throws IOException
      Clean up configuration resources.
      Throws:
      IOException - if one or more resources could not be cleaned up. Implementations should attempt to clean up as many resources as possible before returning or throwing an exception.