Modifier and Type	Class and Description
private static class	ConfigFileReader.ConfigAccumulator
public static class	ConfigFileReader.ConfigFile ConfigFile represents a simple lookup mechanism for a OCI config file.

Modifier and Type	Field and Description
public static final String	DEFAULT_FILE_PATH Default location of the config file.
private static final String	DEFAULT_PROFILE_NAME
public static final String	FALLBACK_DEFAULT_FILE_PATH The fallback default location of the config file.
private static final Logger	LOG
public static final String	OCI_CONFIG_FILE_PATH_ENV_VAR_NAME Environment variable name for the config file location

Access	Constructor and Description
private	ConfigFileReader()

Method Summary

Modifier and Type	Method and Description
public static ConfigFileReader.ConfigFile	Returns: A new ConfigFile instance. parse(String The path to the config file. configurationFilePath) Create a new instance using a file at a given location.
public static ConfigFileReader.ConfigFile	Returns: A new ConfigFile instance. parse(String The path to the config file. configurationFilePath, String The profile name to load, or null if you want to load the "DEFAULT" profile. profile) Create a new instance using a file at a given location.
public static ConfigFileReader.ConfigFile	Returns: A new ConfigFile instance. parse(InputStream The path to the config file. configurationStream, String The profile name to load, or null if you want to load the "DEFAULT" profile. profile) Create a new instance using an UTF-8 input stream.
public static ConfigFileReader.ConfigFile	Returns: A new ConfigFile instance. parse(InputStream The path to the config file. configurationStream, String The profile name to load, or null if you want to load the "DEFAULT" profile. profile, Charset The charset used when parsing the input stream charset) Create a new instance using an input stream.
public static ConfigFileReader.ConfigFile	Returns: A new ConfigFile instance. parseDefault() Creates a new ConfigFile instance using the configuration at the default location, using the default profile.
public static ConfigFileReader.ConfigFile	Returns: A new ConfigFile instance. parseDefault(String The profile name to load, or null if you want to load the "DEFAULT" profile. profile) Creates a new ConfigFile instance using the configuration at the default location, using the given profile.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_FILE_PATH	back to summary
public static final String DEFAULT_FILE_PATH Default location of the config file.

DEFAULT_PROFILE_NAME	back to summary
private static final String DEFAULT_PROFILE_NAME

FALLBACK_DEFAULT_FILE_PATH	back to summary
public static final String FALLBACK_DEFAULT_FILE_PATH The fallback default location of the config file. If and only if the `DEFAULT_FILE_PATH` does not exist, this fallback default location will be used.

LOG	back to summary
private static final Logger LOG

OCI_CONFIG_FILE_PATH_ENV_VAR_NAME	back to summary
public static final String OCI_CONFIG_FILE_PATH_ENV_VAR_NAME Environment variable name for the config file location

Constructor Detail

ConfigFileReader	back to summary
private ConfigFileReader()

Method Detail

parse back to summary

parse	back to summary
public static ConfigFileReader.ConfigFile parse(String configurationFilePath) throws IOException Create a new instance using a file at a given location. This method is the same as calling `parse(String, String)` with "DEFAULT" as the profile. Parameters configurationFilePath:String The path to the config file. Returns:ConfigFileReader.ConfigFile A new ConfigFile instance. Exceptions IOException: if the file could not be read.

public static ConfigFileReader.ConfigFile parse(String configurationFilePath) throws IOException

Create a new instance using a file at a given location.

This method is the same as calling parse(String, String) with "DEFAULT" as the profile.

Parameters

configurationFilePath:String: The path to the config file.

Returns:ConfigFileReader.ConfigFile

A new ConfigFile instance.

Exceptions

IOException:: if the file could not be read.

parse	back to summary
public static ConfigFileReader.ConfigFile parse(String configurationFilePath, String profile) throws IOException Create a new instance using a file at a given location. Parameters configurationFilePath:String The path to the config file. profile:String The profile name to load, or null if you want to load the "DEFAULT" profile. Returns:ConfigFileReader.ConfigFile A new ConfigFile instance. Exceptions IOException: if the file could not be read.

parse

back to summary

public static ConfigFileReader.ConfigFile parse(String configurationFilePath, String profile) throws IOException

Create a new instance using a file at a given location.

Parameters

configurationFilePath:String: The path to the config file.
profile:String: The profile name to load, or null if you want to load the "DEFAULT" profile.

Returns:ConfigFileReader.ConfigFile

A new ConfigFile instance.

Exceptions

IOException:: if the file could not be read.

parse	back to summary
public static ConfigFileReader.ConfigFile parse(InputStream configurationStream, String profile) throws IOException Create a new instance using an UTF-8 input stream. Parameters configurationStream:InputStream The path to the config file. profile:String The profile name to load, or null if you want to load the "DEFAULT" profile. Returns:ConfigFileReader.ConfigFile A new ConfigFile instance. Exceptions IOException: if the file could not be read.

parse

back to summary

public static ConfigFileReader.ConfigFile parse(InputStream configurationStream, String profile) throws IOException

Create a new instance using an UTF-8 input stream.

Parameters

configurationStream:InputStream: The path to the config file.
profile:String: The profile name to load, or null if you want to load the "DEFAULT" profile.

Returns:ConfigFileReader.ConfigFile

A new ConfigFile instance.

Exceptions

IOException:: if the file could not be read.

parse	back to summary
public static ConfigFileReader.ConfigFile parse(InputStream configurationStream, String profile, Charset charset) throws IOException Create a new instance using an input stream. Parameters configurationStream:InputStream The path to the config file. profile:String The profile name to load, or null if you want to load the "DEFAULT" profile. charset:Charset The charset used when parsing the input stream Returns:ConfigFileReader.ConfigFile A new ConfigFile instance. Exceptions IOException: if the file could not be read.

parse

back to summary

public static ConfigFileReader.ConfigFile parse(InputStream configurationStream, String profile, Charset charset) throws IOException

Create a new instance using an input stream.

Parameters

configurationStream:InputStream: The path to the config file.
profile:String: The profile name to load, or null if you want to load the "DEFAULT" profile.
charset:Charset: The charset used when parsing the input stream

Returns:ConfigFileReader.ConfigFile

A new ConfigFile instance.

Exceptions

IOException:: if the file could not be read.

parseDefault back to summary

parseDefault	back to summary
public static ConfigFileReader.ConfigFile parseDefault() throws IOException Creates a new ConfigFile instance using the configuration at the default location, using the default profile. See `DEFAULT_FILE_PATH`. Returns:ConfigFileReader.ConfigFile A new ConfigFile instance. Exceptions IOException: if the file could not be read.

public static ConfigFileReader.ConfigFile parseDefault() throws IOException

Creates a new ConfigFile instance using the configuration at the default location, using the default profile. See DEFAULT_FILE_PATH.

Returns:ConfigFileReader.ConfigFile

A new ConfigFile instance.

Exceptions

IOException:: if the file could not be read.

parseDefault back to summary

parseDefault	back to summary
public static ConfigFileReader.ConfigFile parseDefault(String profile) throws IOException Creates a new ConfigFile instance using the configuration at the default location, using the given profile. See `DEFAULT_FILE_PATH`. Parameters profile:String The profile name to load, or null if you want to load the "DEFAULT" profile. Returns:ConfigFileReader.ConfigFile A new ConfigFile instance. Exceptions IOException: if the file could not be read.

public static ConfigFileReader.ConfigFile parseDefault(String profile) throws IOException

Creates a new ConfigFile instance using the configuration at the default location, using the given profile. See DEFAULT_FILE_PATH.

Parameters

profile:String: The profile name to load, or null if you want to load the "DEFAULT" profile.

Returns:ConfigFileReader.ConfigFile

A new ConfigFile instance.

Exceptions

IOException:: if the file could not be read.

com.oracle.bmc back to summary

private final Class ConfigFileReader.ConfigAccumulator

Class Inheritance

extends Object

java.lang.Object
com.oracle.bmc.ConfigFileReader.ConfigAccumulator

Field Summary

Modifier and Type	Field and Description
pack-priv final Map<String, Map<String, String>>	configurationsByProfile
private String	currentProfile
private boolean	foundDefaultProfile

Constructor Summary

Access	Constructor and Description
private	ConfigAccumulator()

Method Summary

Modifier and Type	Method and Description
private void	accept(String line)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

configurationsByProfile	back to summary
pack-priv final Map<String, Map<String, String>> configurationsByProfile

currentProfile	back to summary
private String currentProfile

foundDefaultProfile	back to summary
private boolean foundDefaultProfile

Constructor Detail

ConfigAccumulator	back to summary
private ConfigAccumulator()

Method Detail

accept	back to summary
private void accept(String line)

com.oracle.bmc back to summary

public final Class ConfigFileReader.ConfigFile

Class Inheritance

extends Object

java.lang.Object
com.oracle.bmc.ConfigFileReader.ConfigFile

ConfigFile represents a simple lookup mechanism for a OCI config file.

Field Summary

Modifier and Type	Field and Description
private final ConfigFileReader.ConfigAccumulator	accumulator
private final String	profile

Constructor Summary

Access	Constructor and Description
private	ConfigFile(ConfigFileReader.ConfigAccumulator accumulator, String profile)

Method Summary

Modifier and Type	Method and Description
public String	Returns: The value, or null if it didn't exist. get(String The key to look up. key) Gets the value associated with a given key.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

accumulator	back to summary
private final ConfigFileReader.ConfigAccumulator accumulator

profile	back to summary
private final String profile

Constructor Detail

ConfigFile	back to summary
private ConfigFile(ConfigFileReader.ConfigAccumulator accumulator, String profile) Annotations @java.beans.ConstructorProperties

Method Detail

get	back to summary
public String get(String key) Gets the value associated with a given key. The value returned will be the one for the selected profile (if available), else the value in the DEFAULT profile (if specified), else null. Parameters key:String The key to look up. Returns:String The value, or null if it didn't exist.

get

back to summary

public String get(String key)

Gets the value associated with a given key. The value returned will be the one for the selected profile (if available), else the value in the DEFAULT profile (if specified), else null.

Parameters

key:String: The key to look up.

Returns:String

The value, or null if it didn't exist.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public final Class ConfigFileReader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ConfigFileReader.ConfigAccumulator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class ConfigFileReader.ConfigFile

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail