Package growthbook.sdk.java.repository

Class GBFeaturesRepository

java.lang.Object

growthbook.sdk.java.repository.GBFeaturesRepository

All Implemented Interfaces:

IGBFeaturesRepository

public class GBFeaturesRepository
extends Object
implements IGBFeaturesRepository

This class can be created with its `builder()` or constructor. It will fetch the features from the endpoint provided. Initialize with initialize() Get the features JSON with getFeaturesJson(). You would provide the features JSON when creating the GBContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GBFeaturesRepository.GBFeaturesRepositoryBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMPTY_JSON_OBJECT_STRING
static final String	FILE_PATH_FOR_CACHE

Constructor Summary

Constructors

Constructor	Description
GBFeaturesRepository(String apiHost, String clientKey, String encryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds)	Deprecated.
GBFeaturesRepository(String apiHost, String clientKey, String encryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds, RequestBodyForRemoteEval requestBodyForRemoteEval)	New constructor that support payload for remote eval
GBFeaturesRepository(String apiHost, String clientKey, String encryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds, Boolean isCacheDisabled)
GBFeaturesRepository(String apiHost, String clientKey, String decryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds, okhttp3.OkHttpClient okHttpClient, Boolean isCacheDisabled, RequestBodyForRemoteEval requestBodyForRemoteEval, GbCacheManager cacheManager)	Create a new GBFeaturesRepository
GBFeaturesRepository(String apiHost, String clientKey, String decryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds, okhttp3.OkHttpClient okHttpClient, Boolean isCacheDisabled, RequestBodyForRemoteEval requestBodyForRemoteEval, GbCacheManager cacheManager, Duration backgroundFetchInterval, FeatureFetchRetryPolicy retryPolicy)
GBFeaturesRepository(String apiHost, String clientKey, String encryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds, okhttp3.OkHttpClient okHttpClient, String decryptionKey, Boolean isCacheDisabled, RequestBodyForRemoteEval requestBodyForRemoteEval, GbCacheManager cacheManager)	New constructor that explicitly supports decryptionKey.
GBFeaturesRepository(String apiHost, String clientKey, String encryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds, okhttp3.OkHttpClient okHttpClient, String decryptionKey, Boolean isCacheDisabled, RequestBodyForRemoteEval requestBodyForRemoteEval, GbCacheManager cacheManager, Duration backgroundFetchInterval, FeatureFetchRetryPolicy retryPolicy)

Method Summary

Modifier and Type	Method	Description
static GBFeaturesRepository.GBFeaturesRepositoryBuilder	builder()
void	clearCallbacks()	Clears the feature refresh callbacks
void	fetchFeatures()	Performs a network request to fetch the features from the GrowthBook API with the provided endpoint.
void	fetchForRemoteEval(RequestBodyForRemoteEval requestBodyForRemoteEval)
Duration	getBackgroundFetchInterval()	Optional minimum interval between non-forced feature refreshes.
GbCacheManager	getCacheManager()	CachingManger allows to cache features data to file
String	getDecryptionKey()	The key used to decrypt encrypted features from the API
String	getEncryptionKey()	Deprecated.
String	getEventsEndpoint()	Endpoint for SSE request
Long	getExpiresAt()	Seconds after that cache is expired
String	getFeaturesEndpoint()	Endpoint for GET request
String	getFeaturesJson()	Allows you to get the features JSON from the provided getFeaturesEndpoint().
Boolean	getInitialized()	Flag to know whether GBFeatureRepository is initialized
Map<String,Feature<?>>	getParsedFeatures()	Keys are unique identifiers for the features and the values are Feature objects.
com.google.gson.JsonObject	getParsedSavedGroups()
FeatureRefreshStrategy	getRefreshStrategy()	Strategy for building url
String	getRemoteEvalEndPoint()	Endpoint for POST request
RequestBodyForRemoteEval	getRequestBodyForRemoteEval()	Request body for that be sent with POST request for remote eval feature
FeatureFetchRetryPolicy	getRetryPolicy()	Bounded retry policy for feature fetch requests.
String	getSavedGroupsJson()	Allows you to get the saved groups JSON from the provided getFeaturesEndpoint().
Integer	getSwrTtlSeconds()	The standard cache TTL to use (60 seconds)
void	initialize()
void	initialize(Boolean retryOnFailure)
void	onFeaturesRefresh(FeatureRefreshCallback callback)	Subscribe to feature refresh events This callback is called when the features are successfully refreshed or there is an error when refreshing.
void	refreshFeatures()
void	refreshFeatures(RefreshMode refreshMode)
void	requestFeatureRefresh(RefreshMode refreshMode)
void	setCacheManager(GbCacheManager cacheManager)
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Details

FILE_PATH_FOR_CACHE

public static final String FILE_PATH_FOR_CACHE

See Also:

• Constant Field Values

EMPTY_JSON_OBJECT_STRING

public static final String EMPTY_JSON_OBJECT_STRING

See Also:

• Constant Field Values

Constructor Details

GBFeaturesRepository

@Deprecated
public GBFeaturesRepository(@Nullable
 String apiHost,
 String clientKey,
 @Deprecated @Nullable
 String encryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds)

Deprecated.

Create a new GBFeaturesRepository

Parameters:

apiHost - The GrowthBook API host (default: ...)

clientKey - Your client ID, e.g. sdk-abc123

encryptionKey - optional key for decrypting encrypted payload

swrTtlSeconds - How often the cache should be invalidated when using FeatureRefreshStrategy.STALE_WHILE_REVALIDATE (default: 60)

GBFeaturesRepository

public GBFeaturesRepository(@Nullable
 String apiHost,
 String clientKey,
 @Deprecated @Nullable
 String encryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds,
 @Nullable
 RequestBodyForRemoteEval requestBodyForRemoteEval)

New constructor that support payload for remote eval

Parameters:

apiHost - The GrowthBook API host (default: ...)

clientKey - Your client ID, e.g. sdk-abc123

encryptionKey - optional key for decrypting encrypted payload

refreshStrategy - Strategy for building url

swrTtlSeconds - How often the cache should be invalidated when using FeatureRefreshStrategy.STALE_WHILE_REVALIDATE (default: 60)

requestBodyForRemoteEval - Payload that would be sent with POST request when repository configure with Remote evalStrategy FeatureRefreshStrategy.REMOTE_EVAL_STRATEGY (default: 60)

GBFeaturesRepository

public GBFeaturesRepository(@Nullable
 String apiHost,
 String clientKey,
 @Deprecated @Nullable
 String encryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds,
 @Nullable
 Boolean isCacheDisabled)

GBFeaturesRepository

public GBFeaturesRepository(@Nullable
 String apiHost,
 String clientKey,
 @Deprecated @Nullable
 String encryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds,
 @Nullable
 okhttp3.OkHttpClient okHttpClient,
 @Nullable
 String decryptionKey,
 @Nullable
 Boolean isCacheDisabled,
 @Nullable
 RequestBodyForRemoteEval requestBodyForRemoteEval,
 @Nullable
 GbCacheManager cacheManager)

New constructor that explicitly supports decryptionKey.

GBFeaturesRepository

public GBFeaturesRepository(@Nullable
 String apiHost,
 String clientKey,
 @Deprecated @Nullable
 String encryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds,
 @Nullable
 okhttp3.OkHttpClient okHttpClient,
 @Nullable
 String decryptionKey,
 @Nullable
 Boolean isCacheDisabled,
 @Nullable
 RequestBodyForRemoteEval requestBodyForRemoteEval,
 @Nullable
 GbCacheManager cacheManager,
 @Nullable
 Duration backgroundFetchInterval,
 @Nullable
 FeatureFetchRetryPolicy retryPolicy)

GBFeaturesRepository

public GBFeaturesRepository(@Nullable
 String apiHost,
 String clientKey,
 @Nullable
 String decryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds,
 @Nullable
 okhttp3.OkHttpClient okHttpClient,
 @Nullable
 Boolean isCacheDisabled,
 @Nullable
 RequestBodyForRemoteEval requestBodyForRemoteEval,
 @Nullable
 GbCacheManager cacheManager)

Create a new GBFeaturesRepository

Parameters:

apiHost - The GrowthBook API host (default: ...)

clientKey - Your client ID, e.g. sdk-abc123

decryptionKey - optional key for decrypting encrypted payload

swrTtlSeconds - How often the cache should be invalidated when using FeatureRefreshStrategy.STALE_WHILE_REVALIDATE (default: 60)

okHttpClient - HTTP client (optional)

isCacheDisabled - Parameter to disable or enable caching in project

requestBodyForRemoteEval - Payload that would be sent with POST request when repository configure with Remote evalStrategy FeatureRefreshStrategy.REMOTE_EVAL_STRATEGY

GBFeaturesRepository

public GBFeaturesRepository(@Nullable
 String apiHost,
 String clientKey,
 @Nullable
 String decryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds,
 @Nullable
 okhttp3.OkHttpClient okHttpClient,
 @Nullable
 Boolean isCacheDisabled,
 @Nullable
 RequestBodyForRemoteEval requestBodyForRemoteEval,
 @Nullable
 GbCacheManager cacheManager,
 @Nullable
 Duration backgroundFetchInterval,
 @Nullable
 FeatureFetchRetryPolicy retryPolicy)

Method Details

setCacheManager

public void setCacheManager(GbCacheManager cacheManager)

getEncryptionKey

@Deprecated
@Nullable
public String getEncryptionKey()

Deprecated.

onFeaturesRefresh

public void onFeaturesRefresh(FeatureRefreshCallback callback)

Subscribe to feature refresh events This callback is called when the features are successfully refreshed or there is an error when refreshing. This is called even if the features have not changed.

Specified by:

onFeaturesRefresh in interface IGBFeaturesRepository

Parameters:

callback - This callback will be called when features are refreshed

clearCallbacks

public void clearCallbacks()

Description copied from interface: IGBFeaturesRepository

Clears the feature refresh callbacks

Specified by:

clearCallbacks in interface IGBFeaturesRepository

initialize

public void initialize()
                throws FeatureFetchException

Specified by:

initialize in interface IGBFeaturesRepository

Throws:

FeatureFetchException

initialize

public void initialize(Boolean retryOnFailure)
                throws FeatureFetchException

Specified by:

initialize in interface IGBFeaturesRepository

Throws:

FeatureFetchException

fetchFeatures

public void fetchFeatures()
                   throws FeatureFetchException

Performs a network request to fetch the features from the GrowthBook API with the provided endpoint. If an encryptionKey is provided, it is assumed the features endpoint is using encrypted features. This method will attempt to decrypt the encrypted features with the provided encryptionKey.

Throws:

FeatureFetchException

refreshFeatures

public void refreshFeatures()
                     throws FeatureFetchException

Throws:

FeatureFetchException

refreshFeatures

public void refreshFeatures(RefreshMode refreshMode)
                     throws FeatureFetchException

Throws:

FeatureFetchException

requestFeatureRefresh

public void requestFeatureRefresh(RefreshMode refreshMode)

shutdown

public void shutdown()

fetchForRemoteEval

public void fetchForRemoteEval(RequestBodyForRemoteEval requestBodyForRemoteEval)
                        throws FeatureFetchException

Throws:

FeatureFetchException

builder

public static GBFeaturesRepository.GBFeaturesRepositoryBuilder builder()

getFeaturesEndpoint

public String getFeaturesEndpoint()

Endpoint for GET request

getEventsEndpoint

public String getEventsEndpoint()

Endpoint for SSE request

getRefreshStrategy

public FeatureRefreshStrategy getRefreshStrategy()

Strategy for building url

getDecryptionKey

@Nullable
public String getDecryptionKey()

The key used to decrypt encrypted features from the API

getSwrTtlSeconds

public Integer getSwrTtlSeconds()

The standard cache TTL to use (60 seconds)

getBackgroundFetchInterval

@Nullable
public Duration getBackgroundFetchInterval()

Optional minimum interval between non-forced feature refreshes.

getRetryPolicy

public FeatureFetchRetryPolicy getRetryPolicy()

Bounded retry policy for feature fetch requests.

getExpiresAt

public Long getExpiresAt()

Seconds after that cache is expired

getInitialized

public Boolean getInitialized()

Flag to know whether GBFeatureRepository is initialized

getSavedGroupsJson

@Nullable
public String getSavedGroupsJson()

Allows you to get the saved groups JSON from the provided getFeaturesEndpoint(). You must call initialize() before calling this method or your saved groups would not have loaded.

getFeaturesJson

public String getFeaturesJson()

Allows you to get the features JSON from the provided getFeaturesEndpoint(). You must call initialize() before calling this method or your features would not have loaded.

Specified by:

getFeaturesJson in interface IGBFeaturesRepository

Returns:

feature data JSON in a type of String. Handle refresh strategy

getParsedFeatures

public Map<String,Feature<?>> getParsedFeatures()

Keys are unique identifiers for the features and the values are Feature objects. Feature definitions - To be pulled from API / Cache

getParsedSavedGroups

public com.google.gson.JsonObject getParsedSavedGroups()

getCacheManager

public GbCacheManager getCacheManager()

CachingManger allows to cache features data to file

getRequestBodyForRemoteEval

@Nullable
public RequestBodyForRemoteEval getRequestBodyForRemoteEval()

Request body for that be sent with POST request for remote eval feature

getRemoteEvalEndPoint

public String getRemoteEvalEndPoint()

Endpoint for POST request