com.linkedin.feathr.core.configdataprovider

Interface ConfigDataProvider

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

BaseConfigDataProvider, ManifestConfigDataProvider, ReaderConfigDataProvider, ResourceConfigDataProvider, StringConfigDataProvider, UrlConfigDataProvider

public interface ConfigDataProvider
extends java.io.Closeable

ConfigDataProvider abstracts aways the source of config data which may come from, for example, a resource, or a URL, or as a String. Doing so allows ConfigBuilder API to have a narrow surface area. Further, it also allows clients to plug in their own custom ConfigDataProviders. Example usage:

 ConfigBuilder configBuilder = ConfigBuilder.get();

 try (ConfigDataProvider cdp = new ResourceConfigDataProvider("config/offline/myFeatures.conf")) {
  FeatureDef configObj = configBuilder.buildFeatureDefConfig(cdp);
 } catch (Exception e) {
   // process exception
 }
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigDataInfo() Provides some information about config data.
java.util.List<java.io.Reader>	getConfigDataReaders() Return the config data as a list of Reader objects.

Methods inherited from interface java.io.Closeable

close

Method Detail

getConfigDataReaders

java.util.List<java.io.Reader> getConfigDataReaders()

Return the config data as a list of Reader objects. Clients should ideally provide BufferedReader objects.

Returns:

List of Readers

getConfigDataInfo

java.lang.String getConfigDataInfo()

Provides some information about config data. This information is used in logging and debugging. For example, a UrlConfigDataProvider will provide a list of URLs from which the config data is obtained.

Returns:

A String representing config data