Schnittstelle ConfigurationProvider

Alle bekannten Implementierungsklassen:
AbstractConfigurationProvider, ClasspathConfigurationProvider, DirectoryConfigurationProvider, JarConfigurationProvider

public interface ConfigurationProvider
Defines how the configuration for a generation unit can be accessed. Implementing classes provide InputStreams to access the various parts of the configuration.
  • Methodendetails

    • getControlConfigurationInputStream

      InputStream getControlConfigurationInputStream() throws ConfigurationException
      Creates a reader to access the control configuration. It is the callers responsibility to close the reader after use.
      Gibt zurück:
      a reader to access the control configuration, never null.
      Löst aus:
      ConfigurationException - if the reader can not be created.
    • getControlConfigurationLocation

      String getControlConfigurationLocation() throws ConfigurationException
      Returns the location of the control configuration as human readable String for debugging and error tracking purposes.
      Gibt zurück:
      the location of the control configuration, not null.
      Löst aus:
      ConfigurationException - if the location name can not be created.
    • getTemplateNames

      Collection<String> getTemplateNames() throws ConfigurationException
      Lists all available template names.
      Gibt zurück:
      a collection of all available template names, not null.
      Löst aus:
      ConfigurationException - if the template names cannot be determined.
    • getTemplateInputStream

      InputStream getTemplateInputStream(String name) throws ConfigurationException
      Creates a reader to access a template. It is the callers responsibility to close the reader after use.
      Parameter:
      name - the name (==path to) of the template.
      Gibt zurück:
      a reader to access a template, never null.
      Löst aus:
      ConfigurationException - if the reader can not be created.
    • getOutletConfigurationNames

      Collection<String> getOutletConfigurationNames() throws ConfigurationException
      Returns a list of all found outlet configuration files in the generation unit.
      Gibt zurück:
      a list with the generation configuration files, not null.
      Löst aus:
      ConfigurationException - if the configuration can not be read.
    • getOutletConfigurationInputStream

      InputStream getOutletConfigurationInputStream(String name) throws ConfigurationException
      Creates a reader to access the configuration for one outlet. It is the callers responsibility to close the reader after use.
      Parameter:
      name - the name (==path to) of the outlet configuration.
      Gibt zurück:
      a reader to access the outlet configuration, never null.
      Löst aus:
      ConfigurationException - if the reader can not be created.
    • getOptionsInputStream

      InputStream getOptionsInputStream(String name) throws ConfigurationException
      Creates a reader to access an options file. It is the callers responsibility to close the reader after use.
      Parameter:
      name - the name (==path to) of the options file.
      Gibt zurück:
      a reader to access the options file, never null.
      Löst aus:
      ConfigurationException - if the reader can not be created.
    • getResourceInputStream

      InputStream getResourceInputStream(String path) throws ConfigurationException
      Creates a reader to access a resource file. It is the callers responsibility to close the reader after use.
      Parameter:
      path - the path to of the resource file.
      Gibt zurück:
      a reader to access the options file, never null.
      Löst aus:
      ConfigurationException - if the reader can not be created.