com.microsoft.azure.spring.cloud.config.stores

Class ClientStore

java.lang.Object

com.microsoft.azure.spring.cloud.config.stores.ClientStore

public class ClientStore
extends Object

Constructor Summary

Constructors

Constructor and Description
ClientStore(AppConfigurationProviderProperties appProperties, ConnectionPool pool, AppConfigurationCredentialProvider tokenCredentialProvider, ConfigurationClientBuilderSetup clientProvider)

Method Summary

Modifier and Type	Method and Description
com.azure.data.appconfiguration.models.ConfigurationSetting	getRevison(com.azure.data.appconfiguration.models.SettingSelector settingSelector, String storeName) Gets the latest Configuration Setting from the revisions given config store that match the Setting Selector criteria.
List<com.azure.data.appconfiguration.models.ConfigurationSetting>	listSettings(com.azure.data.appconfiguration.models.SettingSelector settingSelector, String storeName) Gets a list of Configuration Settings from the given config store that match the Setting Selector criteria.
String	watchedKeyNames(ConfigStore store, Map<String,List<String>> storeContextsMap) Composite watched key names separated by comma, the key names is made up of: prefix, context and key name pattern e.g., prefix: /config, context: /application, watched key: my.watch.key will return: /config/application/my.watch.key The returned watched key will be one key pattern, one or multiple specific keys e.g., 1) * 2) /application/abc* 3) /application/abc 4) /application/abc,xyz

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientStore

public ClientStore(AppConfigurationProviderProperties appProperties,
                   ConnectionPool pool,
                   AppConfigurationCredentialProvider tokenCredentialProvider,
                   ConfigurationClientBuilderSetup clientProvider)

Method Detail

getRevison

public final com.azure.data.appconfiguration.models.ConfigurationSetting getRevison(com.azure.data.appconfiguration.models.SettingSelector settingSelector,
                                                                                    String storeName)

Gets the latest Configuration Setting from the revisions given config store that match the Setting Selector criteria.

Parameters:

settingSelector - Information on which setting to pull. i.e. number of results, key value...

storeName - Name of the App Configuration store to query against.

Returns:

List of Configuration Settings.

listSettings

public final List<com.azure.data.appconfiguration.models.ConfigurationSetting> listSettings(com.azure.data.appconfiguration.models.SettingSelector settingSelector,
                                                                                            String storeName)
                                                                                     throws IOException

Gets a list of Configuration Settings from the given config store that match the Setting Selector criteria.

Parameters:

settingSelector - Information on which setting to pull. i.e. number of results, key value...

storeName - Name of the App Configuration store to query against.

Returns:

List of Configuration Settings.

Throws:

IOException - thrown when failed to retrieve values.

watchedKeyNames

public String watchedKeyNames(ConfigStore store,
                              Map<String,List<String>> storeContextsMap)

Composite watched key names separated by comma, the key names is made up of: prefix, context and key name pattern e.g., prefix: /config, context: /application, watched key: my.watch.key will return: /config/application/my.watch.key The returned watched key will be one key pattern, one or multiple specific keys e.g., 1) * 2) /application/abc* 3) /application/abc 4) /application/abc,xyz

Parameters:

store - the store for which to composite watched key names

storeContextsMap - map storing store name and List of context key-value pair

Returns:

the full name of the key mapping to the configuration store