Package com.azure.spring.cloud.config

Interface AppConfigurationRefresh

All Superinterfaces:
org.springframework.context.ApplicationEventPublisherAware, org.springframework.beans.factory.Aware
public interface AppConfigurationRefresh extends org.springframework.context.ApplicationEventPublisherAware
Enables checking of Configuration updates.

  • Method Details

    • refreshConfigurations

      @Async Future<Boolean> refreshConfigurations() throws Exception
      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:
      Future with a boolean of if a RefreshEvent was published. If refreshConfigurations is currently being run elsewhere this method will return right away as false.
      Throws:
      Exception - re-throws any exception caught

    • expireRefreshInterval

      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

      Map<String,AppConfigurationStoreHealth> getAppConfigurationStoresHealth()
      Gets the latest Health connection info for refresh.
      Returns:
      Map of String, endpoint, and Health information.