Package com.azure.spring.cloud.config.stores

Class ClientStore

java.lang.Object

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

public final class ClientStore
extends Object

Client for connecting to and getting keys from an Azure App Configuration Instance

Constructor Summary

Constructors

Constructor	Description
ClientStore(AppConfigurationProviderProperties appProperties, ConnectionPool pool, AppConfigurationCredentialProvider tokenCredentialProvider, ConfigurationClientBuilderSetup clientProvider, Boolean isDev, Boolean isKeyVaultConfigured)	Creates Client store for connecting to App Configuration

Method Summary

Modifier and Type	Method	Description
com.azure.core.http.rest.PagedIterable<com.azure.data.appconfiguration.models.ConfigurationSetting>	getFeatureFlagWatchKey(com.azure.data.appconfiguration.models.SettingSelector settingSelector, String storeName)	Used to load all feature flags to track changes for reload.
com.azure.data.appconfiguration.models.ConfigurationSetting	getWatchKey(String key, String label, String storeName)	Gets the Configuration Setting for the given config store that match the Setting Selector criteria.
com.azure.core.http.rest.PagedIterable<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.
void	updateSyncToken(String storeName, String syncToken)	Update the sync token for a client store.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientStore

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

Creates Client store for connecting to App Configuration

Parameters:

appProperties - App Configuration Provider Properties

pool - Connections to App Configuration

tokenCredentialProvider - optional Credential provider

clientProvider - optional Client Provider

isDev - is running in Dev profile

isKeyVaultConfigured - is running with Key Vault configured

Method Details

getWatchKey

public com.azure.data.appconfiguration.models.ConfigurationSetting getWatchKey(String key,
 String label,
 String storeName)

Gets the Configuration Setting for the given config store that match the Setting Selector criteria. Follows retry-after-ms header.

Parameters:

key - String value of the watch key

label - String value of the watch key, use \0 for null.

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

Returns:

The first returned configuration.

getFeatureFlagWatchKey

public com.azure.core.http.rest.PagedIterable<com.azure.data.appconfiguration.models.ConfigurationSetting> getFeatureFlagWatchKey(com.azure.data.appconfiguration.models.SettingSelector settingSelector,
 String storeName)

Used to load all feature flags to track changes for reload.

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 com.azure.core.http.rest.PagedIterable<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.

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.

updateSyncToken

public void updateSyncToken(String storeName,
 String syncToken)

Update the sync token for a client store.

Parameters:

storeName - the name of the client store.

syncToken - the sync token.