com.configcat

Class RefreshPolicy

java.lang.Object

com.configcat.RefreshPolicy

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

AutoPollingPolicy, LazyLoadingPolicy, ManualPollingPolicy

public abstract class RefreshPolicy
extends java.lang.Object
implements java.io.Closeable

The public interface of a refresh policy which's implementors should describe the configuration update rules.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RefreshPolicy(ConfigFetcher configFetcher, ConfigCache cache) Constructor used by the child classes.

Method Summary

Modifier and Type	Method and Description
protected ConfigCache	cache() Through this getter, child classes can use the cache to control the cached configuration.
void	close()
protected ConfigFetcher	fetcher() Through this getter, child classes can use the fetcher to get the latest configuration over HTTP.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getConfigurationJsonAsync() Child classes has to implement this method, the ConfigCatClient uses it to read the current configuration value through the applied policy.
java.util.concurrent.CompletableFuture<java.lang.Void>	refreshAsync() Initiates a force refresh on the cached configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshPolicy

protected RefreshPolicy(ConfigFetcher configFetcher,
                        ConfigCache cache)

Constructor used by the child classes.

Parameters:

configFetcher - the internal config fetcher instance.

cache - the internal cache instance.

Method Detail

fetcher

protected ConfigFetcher fetcher()

Through this getter, child classes can use the fetcher to get the latest configuration over HTTP.

Returns:

the config fetcher.

cache

protected ConfigCache cache()

Through this getter, child classes can use the cache to control the cached configuration.

Returns:

the config cache.

getConfigurationJsonAsync

public abstract java.util.concurrent.CompletableFuture<java.lang.String> getConfigurationJsonAsync()

Child classes has to implement this method, the ConfigCatClient uses it to read the current configuration value through the applied policy.

Returns:

the future which computes the configuration.

refreshAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> refreshAsync()

Initiates a force refresh on the cached configuration.

Returns:

the future which executes the refresh.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException