io.smallrye.config

Class PropertiesConfigSourceProvider

java.lang.Object

io.smallrye.config.AbstractLocationConfigSourceLoader

io.smallrye.config.PropertiesConfigSourceProvider

All Implemented Interfaces:

org.eclipse.microprofile.config.spi.ConfigSourceProvider

public class PropertiesConfigSourceProvider
extends AbstractLocationConfigSourceLoader
implements org.eclipse.microprofile.config.spi.ConfigSourceProvider

Author:

Jeff Mesnil (c) 2017 Red Hat inc.

Constructor Summary

Constructors

Constructor and Description
PropertiesConfigSourceProvider(String location, boolean optional, ClassLoader classLoader) Deprecated.
PropertiesConfigSourceProvider(String location, ClassLoader classLoader, boolean includeFileSystem)

Method Summary

Modifier and Type	Method and Description
static PropertiesConfigSourceProvider	classPathResource(String location, ClassLoader classLoader)
static List<org.eclipse.microprofile.config.spi.ConfigSource>	classPathSources(String location, ClassLoader classLoader)
List<org.eclipse.microprofile.config.spi.ConfigSource>	getConfigSources(ClassLoader forClassLoader)
protected String[]	getFileExtensions() The file extensions to filter the locations to load.
protected org.eclipse.microprofile.config.spi.ConfigSource	loadConfigSource(URL url, int ordinal) Loads a ConfigSource from an URL.
static List<org.eclipse.microprofile.config.spi.ConfigSource>	propertiesSources(String location, ClassLoader classLoader)
static PropertiesConfigSourceProvider	resource(String location, ClassLoader classLoader)
protected List<org.eclipse.microprofile.config.spi.ConfigSource>	tryFileSystem(URI uri, int ordinal)

Methods inherited from class io.smallrye.config.AbstractLocationConfigSourceLoader

fallbackToUnknownProtocol, loadConfigSources, loadConfigSources, loadConfigSources, loadConfigSources, tryClassPath, tryHttpResource, tryJar, tryProfiles

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertiesConfigSourceProvider

public PropertiesConfigSourceProvider(String location,
                                      ClassLoader classLoader,
                                      boolean includeFileSystem)

PropertiesConfigSourceProvider

@Deprecated
public PropertiesConfigSourceProvider(String location,
                                                  boolean optional,
                                                  ClassLoader classLoader)

Deprecated.

Method Detail

getConfigSources

public List<org.eclipse.microprofile.config.spi.ConfigSource> getConfigSources(ClassLoader forClassLoader)

Specified by:

getConfigSources in interface org.eclipse.microprofile.config.spi.ConfigSourceProvider

getFileExtensions

protected String[] getFileExtensions()

Description copied from class: AbstractLocationConfigSourceLoader

The file extensions to filter the locations to load. It does not require to include the dot separator.

Specified by:

getFileExtensions in class AbstractLocationConfigSourceLoader

Returns:

an array with the file extensions.

loadConfigSource

protected org.eclipse.microprofile.config.spi.ConfigSource loadConfigSource(URL url,
                                                                            int ordinal)
                                                                     throws IOException

Description copied from class: AbstractLocationConfigSourceLoader

Loads a ConfigSource from an URL. Implementations must construct the ConfigSource to load.

Specified by:

loadConfigSource in class AbstractLocationConfigSourceLoader

Parameters:

url - the URL to load the ConfigSource.

ordinal - the ordinal of the ConfigSource.

Returns:

the loaded ConfigSource.

Throws:

IOException - if an error occurred when reading from the the URL.

tryFileSystem

protected List<org.eclipse.microprofile.config.spi.ConfigSource> tryFileSystem(URI uri,
                                                                               int ordinal)

Overrides:

tryFileSystem in class AbstractLocationConfigSourceLoader

resource

public static PropertiesConfigSourceProvider resource(String location,
                                                      ClassLoader classLoader)

classPathResource

public static PropertiesConfigSourceProvider classPathResource(String location,
                                                               ClassLoader classLoader)

propertiesSources

public static List<org.eclipse.microprofile.config.spi.ConfigSource> propertiesSources(String location,
                                                                                       ClassLoader classLoader)

classPathSources

public static List<org.eclipse.microprofile.config.spi.ConfigSource> classPathSources(String location,
                                                                                      ClassLoader classLoader)