AppConfigurationRefresh Interface

Package:

com.azure.spring.cloud.appconfiguration.config

Maven Artifact:

com.azure.spring:spring-cloud-azure-appconfiguration-config:5.19.0

Implements

org.springframework.context.ApplicationEventPublisherAware

public interface AppConfigurationRefresh
extends org.springframework.context.ApplicationEventPublisherAware

Enables checking of Configuration updates.

Method Summary

Modifier and Type	Method and Description
abstract void	expireRefreshInterval(String endpoint, String syncToken) Soft expires refresh interval.
abstract Map<String,AppConfigurationStoreHealth>	getAppConfigurationStoresHealth() Gets the latest Health connection info for refresh.
abstract Mono<Boolean>	refreshConfigurations() Checks configurations to see if configurations should be reloaded.

Method Details

expireRefreshInterval

public abstract void expireRefreshInterval(String endpoint, String syncToken)

Soft expires refresh interval. Sets amount of time to next refresh to be a random value between 0 and 15 seconds, unless value is less than the amount of time to the next refresh check.

Parameters:

endpoint - Config Store endpoint to expire refresh interval on.

syncToken - syncToken to verify the latest changes are available on pull

getAppConfigurationStoresHealth

public abstract Map getAppConfigurationStoresHealth()

Gets the latest Health connection info for refresh.

Returns:

Map of String, endpoint, and Health information.

refreshConfigurations

public abstract Mono refreshConfigurations()

Checks configurations to see if configurations should be reloaded. If the refresh interval has passed and a trigger has been updated configuration are reloaded.

Returns:

Mono with a boolean of if a RefreshEvent was published. If refreshConfigurations is currently being run elsewhere this method will return right away as false.