Module com.powsybl.config.classic

Package com.powsybl.config.classic

Class ClassicPlatformConfigProvider

java.lang.Object

com.powsybl.config.classic.ClassicPlatformConfigProvider

All Implemented Interfaces:

PlatformConfigProvider

@AutoService(com.powsybl.commons.config.PlatformConfigProvider.class)
public class ClassicPlatformConfigProvider
extends Object
implements PlatformConfigProvider

The classic powsybl PlatformConfig provider. It uses System Properties to get config dirs (powsybl.config.dirs, itools.config.dir; defaults to $HOME/.itools) and reads configuration from yaml, xml or java properties files. The config dir names can use the keywords from PlatformEnv (e.g. app.root, user.home). It also uses EnvironmentModuleConfigRepository to read configuration from environment variables.

Author:

Geoffroy Jamgotchian , Jon Harper

Constructor Summary

Constructors

Constructor	Description
ClassicPlatformConfigProvider()

Method Summary

Modifier and Type	Method	Description
static Path[]	getDefaultConfigDirs(FileSystem fileSystem, String directories, String userHome, String pathSeparator)	Returns the list of default config directories: they are defined by the system properties "powsybl.config.dirs" or "itools.config.dir".
String	getName()
PlatformConfig	getPlatformConfig()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassicPlatformConfigProvider

public ClassicPlatformConfigProvider()

Method Detail

getName

public String getName()

Specified by:

getName in interface PlatformConfigProvider

getDefaultConfigDirs

public static Path[] getDefaultConfigDirs(FileSystem fileSystem,
                                          String directories,
                                          String userHome,
                                          String pathSeparator)

Returns the list of default config directories: they are defined by the system properties "powsybl.config.dirs" or "itools.config.dir". If none is defined, it defaults to the single directory ${HOME}/.itools.

getPlatformConfig

public PlatformConfig getPlatformConfig()

Specified by:

getPlatformConfig in interface PlatformConfigProvider