Package growthbook.sdk.java.multiusermode.configurations

Class Options

java.lang.Object
growthbook.sdk.java.multiusermode.configurations.Options
public class Options extends Object

  • Constructor Details

  • Method Details

    • setGlobalForcedVariationsMap

      public void setGlobalForcedVariationsMap(@Nullable Map<String,?> globalForcedVariationsMap)

    • getRefreshingStrategy

      public FeatureRefreshStrategy getRefreshingStrategy()

    • getCacheMode

      public CacheMode getCacheMode()

    • getCacheDirectory

      public String getCacheDirectory()

    • isSseReconnectOnFailure

      public boolean isSseReconnectOnFailure()

    • getStickyBucketService

      @Nullable public StickyBucketService getStickyBucketService()

    • setInMemoryStickyBucketService

      public void setInMemoryStickyBucketService()

    • setGlobalAttributes

      public void setGlobalAttributes(@Nullable String attributesJson)

    • isRemoteEvalEnabled

      public boolean isRemoteEvalEnabled()

    • builder

      public static Options.OptionsBuilder builder()

    • getEnabled

      @Nullable public Boolean getEnabled()
      Whether globally all experiments are enabled (default: true) Switch to globally disable all experiments.

    • getIsQaMode

      public Boolean getIsQaMode()
      If true, random assignment is disabled and only explicitly forced variations are used.

    • getIsCacheDisabled

      public Boolean getIsCacheDisabled()

    • getAllowUrlOverrides

      public Boolean getAllowUrlOverrides()
      Boolean flag to allow URL overrides (default: false)

    • getUrl

      @Nullable public String getUrl()

    • getApiHost

      @Nullable public String getApiHost()

    • getClientKey

      @Nullable public String getClientKey()

    • getDecryptionKey

      @Nullable public String getDecryptionKey()
      Optional decryption Key. If this is not null, featuresJson should be an encrypted payload.

    • getStickyBucketIdentifierAttributes

      @Nullable public List<String> getStickyBucketIdentifierAttributes()
      List of user's attributes keys.

    • getTrackingCallBackWithUser

      @Nullable public TrackingCallbackWithUser getTrackingCallBackWithUser()
      A function that takes Experiment and ExperimentResult as arguments.

    • getFeatureUsageCallbackWithUser

      @Nullable public FeatureUsageCallbackWithUser getFeatureUsageCallbackWithUser()
      A function that takes String and FeatureResult as arguments. A callback that will be invoked every time a feature is viewed. Listen for feature usage events

    • getRefreshStrategy

      @Nullable public FeatureRefreshStrategy getRefreshStrategy()
      Strategy for building url

    • getSwrTtlSeconds

      @Nullable public Integer getSwrTtlSeconds()
      The standard cache TTL to use.

    • getGlobalAttributes

      @Nullable public com.google.gson.JsonObject getGlobalAttributes()
      Map of user attributes that are used to assign variations

    • getAttributesJson

      @Nullable public String getAttributesJson()
      String format of user attributes that are used to assign variations

    • getGlobalForcedFeatureValues

      @Nullable public Map<String,Object> getGlobalForcedFeatureValues()
      Manual force feature values

    • getGlobalForcedVariationsMap

      @Nullable public Map<String,Integer> getGlobalForcedVariationsMap()
      Force specific experiments to always assign a specific variation (used for QA)

    • getFeatureRefreshCallback

      @Deprecated @Nullable public FeatureRefreshCallback getFeatureRefreshCallback()
      Deprecated.
      Use GrowthBookClient.addFeatureRefreshListener(...) or GrowthBookClient.subscribeFeatureRefreshListener(...) after constructing the client.
      Legacy feature refresh callback.

    • getCacheManager

      @Nullable public GbCacheManager getCacheManager()

    • getFeatureRefreshListenerExecutor

      @Nullable public Executor getFeatureRefreshListenerExecutor()
      Optional executor for client-level feature refresh listeners. When not supplied, the client dispatches listener callbacks on a dedicated daemon thread it owns and shuts down.

    • getPlugins

      @Nullable public List<GrowthBookPlugin> getPlugins()
      Plugins registered with the GrowthBook client. See GrowthBookPlugin and GrowthBookTrackingPlugin. The owning client builds a per-instance PluginRegistry from this list; the registry itself is carried on EvaluationContext, not here, so reusing one Options across clients stays isolated.

    • getBackgroundFetchInterval

      @Nullable public Duration getBackgroundFetchInterval()
      Optional minimum interval between non-forced background feature refreshes.

    • getRetryPolicy

      @Nullable public FeatureFetchRetryPolicy getRetryPolicy()
      Optional bounded retry policy. Repositories use the default policy when null.

    • getRemoteEval

      public Boolean getRemoteEval()

    • getCacheKeyAttributes

      @Nullable public List<String> getCacheKeyAttributes()

    • getRemoteEvalCacheSize

      public Integer getRemoteEvalCacheSize()

    • getRemoteEvalCacheTtlSeconds

      @Nullable public Integer getRemoteEvalCacheTtlSeconds()
      Hard expiry (seconds) for cached remote-eval responses; null disables time-based expiry.

    • getSseReconnectOnFailure

      @Nullable public Boolean getSseReconnectOnFailure()
      Whether the multi-user client reconnects the SSE stream after an abnormal failure or a server close. Reconnect attempts are bounded by retryPolicy. Defaults to true.

    • setEnabled

      public void setEnabled(@Nullable Boolean enabled)
      Whether globally all experiments are enabled (default: true) Switch to globally disable all experiments.

    • setIsQaMode

      public void setIsQaMode(Boolean isQaMode)
      If true, random assignment is disabled and only explicitly forced variations are used.

    • setIsCacheDisabled

      public void setIsCacheDisabled(Boolean isCacheDisabled)

    • setAllowUrlOverrides

      public void setAllowUrlOverrides(Boolean allowUrlOverrides)
      Boolean flag to allow URL overrides (default: false)

    • setUrl

      public void setUrl(@Nullable String url)

    • setApiHost

      public void setApiHost(@Nullable String apiHost)

    • setClientKey

      public void setClientKey(@Nullable String clientKey)

    • setDecryptionKey

      public void setDecryptionKey(@Nullable String decryptionKey)
      Optional decryption Key. If this is not null, featuresJson should be an encrypted payload.

    • setStickyBucketIdentifierAttributes

      public void setStickyBucketIdentifierAttributes(@Nullable List<String> stickyBucketIdentifierAttributes)
      List of user's attributes keys.

    • setStickyBucketService

      public void setStickyBucketService(@Nullable StickyBucketService stickyBucketService)
      Service that provide functionality of Sticky Bucketing

    • setTrackingCallBackWithUser

      public void setTrackingCallBackWithUser(@Nullable TrackingCallbackWithUser trackingCallBackWithUser)
      A function that takes Experiment and ExperimentResult as arguments.

    • setFeatureUsageCallbackWithUser

      public void setFeatureUsageCallbackWithUser(@Nullable FeatureUsageCallbackWithUser featureUsageCallbackWithUser)
      A function that takes String and FeatureResult as arguments. A callback that will be invoked every time a feature is viewed. Listen for feature usage events

    • setRefreshStrategy

      public void setRefreshStrategy(@Nullable FeatureRefreshStrategy refreshStrategy)
      Strategy for building url

    • setSwrTtlSeconds

      public void setSwrTtlSeconds(@Nullable Integer swrTtlSeconds)
      The standard cache TTL to use.

    • setAttributesJson

      public void setAttributesJson(@Nullable String attributesJson)
      String format of user attributes that are used to assign variations

    • setGlobalForcedFeatureValues

      public void setGlobalForcedFeatureValues(@Nullable Map<String,Object> globalForcedFeatureValues)
      Manual force feature values

    • setFeatureRefreshCallback

      @Deprecated public void setFeatureRefreshCallback(@Nullable FeatureRefreshCallback featureRefreshCallback)
      Deprecated.
      Use GrowthBookClient.addFeatureRefreshListener(...) or GrowthBookClient.subscribeFeatureRefreshListener(...) after constructing the client.
      Legacy feature refresh callback.

    • setCacheManager

      public void setCacheManager(@Nullable GbCacheManager cacheManager)

    • setCacheMode

      public void setCacheMode(CacheMode cacheMode)

    • setCacheDirectory

      public void setCacheDirectory(@Nullable String cacheDirectory)

    • setFeatureRefreshListenerExecutor

      public void setFeatureRefreshListenerExecutor(@Nullable Executor featureRefreshListenerExecutor)
      Optional executor for client-level feature refresh listeners. When not supplied, the client dispatches listener callbacks on a dedicated daemon thread it owns and shuts down.

    • setPlugins

      public void setPlugins(@Nullable List<GrowthBookPlugin> plugins)
      Plugins registered with the GrowthBook client. See GrowthBookPlugin and GrowthBookTrackingPlugin. The owning client builds a per-instance PluginRegistry from this list; the registry itself is carried on EvaluationContext, not here, so reusing one Options across clients stays isolated.

    • setBackgroundFetchInterval

      public void setBackgroundFetchInterval(@Nullable Duration backgroundFetchInterval)
      Optional minimum interval between non-forced background feature refreshes.

    • setRetryPolicy

      public void setRetryPolicy(@Nullable FeatureFetchRetryPolicy retryPolicy)
      Optional bounded retry policy. Repositories use the default policy when null.

    • setRemoteEval

      public void setRemoteEval(Boolean remoteEval)

    • setCacheKeyAttributes

      public void setCacheKeyAttributes(@Nullable List<String> cacheKeyAttributes)

    • setRemoteEvalCacheSize

      public void setRemoteEvalCacheSize(Integer remoteEvalCacheSize)

    • setRemoteEvalCacheTtlSeconds

      public void setRemoteEvalCacheTtlSeconds(@Nullable Integer remoteEvalCacheTtlSeconds)
      Hard expiry (seconds) for cached remote-eval responses; null disables time-based expiry.

    • setSseReconnectOnFailure

      public void setSseReconnectOnFailure(@Nullable Boolean sseReconnectOnFailure)
      Whether the multi-user client reconnects the SSE stream after an abnormal failure or a server close. Reconnect attempts are bounded by retryPolicy. Defaults to true.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object