Package growthbook.sdk.java.repository

Class NativeJavaGbFeatureRepository

java.lang.Object

growthbook.sdk.java.repository.NativeJavaGbFeatureRepository

All Implemented Interfaces:

IGBFeaturesRepository

public class NativeJavaGbFeatureRepository
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(). Get the savedGroups JSON with getSavedGroupsJson(). You would provide the features JSON when creating the GBContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NativeJavaGbFeatureRepository.NativeJavaGbFeatureRepositoryBuilder

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
NativeJavaGbFeatureRepository(String apiHost, String clientKey, String encryptionKey, FeatureRefreshStrategy refreshStrategy, Integer swrTtlSeconds, Boolean isCacheDisabled, RequestBodyForRemoteEval requestBodyForRemoteEval)	Create a new GBFeaturesRepository

Method Summary

Modifier and Type	Method	Description
static NativeJavaGbFeatureRepository.NativeJavaGbFeatureRepositoryBuilder	builder()
void	clearCallbacks()	Clears the feature refresh callbacks
void	fetchFeatures()
String	getEncryptionKey()	The key used to decrypt encrypted features from the API
String	getEventsEndpoint()	Endpoint for SSE request
AtomicLong	getExpiresAt()	Seconds after that cache is expired
String	getFeaturesEndpoint()	Endpoint for GET request
String	getFeaturesJson()	Method for getting Feature from API call once if it STALE_WHILE_REVALIDATE or be updated if SERVER_SENT_EVENTS strategy
FeatureRefreshStrategy	getRefreshStrategy()	Strategy for building url
String	getRemoteEvalEndPoint()	Endpoint for POST request
RequestBodyForRemoteEval	getRequestBodyForRemoteEval()	Request body that be sent with POST request for remote eval feature
String	getSavedGroupsJson()	Get method for saved Group json
AtomicInteger	getSwrTtlSeconds()	The standard cache TTL to use (60 seconds)
void	initialize()	Method for initialize NativeJavaGbFeatureRepository.
void	initialize(Boolean retryOnFailure)	Method for initialize NativeJavaGbFeatureRepository.
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	onRefreshFailed(Throwable throwable)
void	onRefreshSuccess(String featuresJson)

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

NativeJavaGbFeatureRepository

public NativeJavaGbFeatureRepository(@Nullable
 String apiHost,
 String clientKey,
 @Nullable
 String encryptionKey,
 @Nullable
 FeatureRefreshStrategy refreshStrategy,
 @Nullable
 Integer swrTtlSeconds,
 @Nullable
 Boolean isCacheDisabled,
 @Nullable
 RequestBodyForRemoteEval requestBodyForRemoteEval)

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)

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

Method Details

initialize

public void initialize()
                throws FeatureFetchException

Method for initialize NativeJavaGbFeatureRepository. Depends on FeatureRefreshStrategy connection would be established for SSE or for just GET request

Specified by:

initialize in interface IGBFeaturesRepository

Throws:

FeatureFetchException - while initialize function

getSavedGroupsJson

@Nullable
public String getSavedGroupsJson()

Get method for saved Group json

Returns:

saved Group Json in format of String type

initialize

public void initialize(Boolean retryOnFailure)
                throws FeatureFetchException

Method for initialize NativeJavaGbFeatureRepository. Depends on FeatureRefreshStrategy connection would be established for SSE or for just GET request

Specified by:

initialize in interface IGBFeaturesRepository

Parameters:

retryOnFailure - : Boolean argument that responsible whether SSE connection need to be reconnected

Throws:

FeatureFetchException - during fetchFeatures function

getFeaturesJson

public String getFeaturesJson()

Method for getting Feature from API call once if it STALE_WHILE_REVALIDATE or be updated if SERVER_SENT_EVENTS strategy

Specified by:

getFeaturesJson in interface IGBFeaturesRepository

Returns:

Feature Json in format of String

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()

Clears the feature refresh callbacks

Specified by:

clearCallbacks in interface IGBFeaturesRepository

fetchFeatures

public void fetchFeatures()
                   throws FeatureFetchException

Throws:

FeatureFetchException

onRefreshSuccess

public void onRefreshSuccess(String featuresJson)

onRefreshFailed

public void onRefreshFailed(Throwable throwable)

builder

public static NativeJavaGbFeatureRepository.NativeJavaGbFeatureRepositoryBuilder builder()

getFeaturesEndpoint

public String getFeaturesEndpoint()

Endpoint for GET request

getRemoteEvalEndPoint

public String getRemoteEvalEndPoint()

Endpoint for POST request

getEventsEndpoint

public String getEventsEndpoint()

Endpoint for SSE request

getRefreshStrategy

public FeatureRefreshStrategy getRefreshStrategy()

Strategy for building url

getEncryptionKey

@Nullable
public String getEncryptionKey()

The key used to decrypt encrypted features from the API

getSwrTtlSeconds

public AtomicInteger getSwrTtlSeconds()

The standard cache TTL to use (60 seconds)

getExpiresAt

public AtomicLong getExpiresAt()

Seconds after that cache is expired

getRequestBodyForRemoteEval

@Nullable
public RequestBodyForRemoteEval getRequestBodyForRemoteEval()

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