com.flagsmith

Class FlagsmithClient

java.lang.Object

com.flagsmith.FlagsmithClient

public class FlagsmithClient
extends Object

A client for Flagsmith API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlagsmithClient.Builder

Method Summary

Modifier and Type	Method and Description
FlagsmithCache	getCache() Returns a FlagsmithCache cache object that encapsulates methods to manipulate the cache.
Flags	getEnvironmentFlags() Get all the default for flags for the current environment.
Flags	getIdentityFlags(String identifier) Get all the flags for the current environment for a given identity.
Flags	getIdentityFlags(String identifier, Map<String,Object> traits) Get all the flags for the current environment for a given identity.
List<Segment>	getIdentitySegments(String identifier) Get a list of segments that the given identity is in.
List<Segment>	getIdentitySegments(String identifier, Map<String,Object> traits) Get a list of segments that the given identity is in.
static FlagsmithClient.Builder	newBuilder()
void	updateEnvironment() Load the environment flags in the environment variable from the API.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static FlagsmithClient.Builder newBuilder()

updateEnvironment

public void updateEnvironment()

Load the environment flags in the environment variable from the API.

getEnvironmentFlags

public Flags getEnvironmentFlags()
                          throws FlagsmithApiError

Get all the default for flags for the current environment.

Returns:

Flags object containing environment flags

Throws:

FlagsmithApiError - if error communicating with Flagsmith API

getIdentityFlags

public Flags getIdentityFlags(String identifier)
                       throws FlagsmithClientError

Get all the flags for the current environment for a given identity. Will also upsert all traits to the Flagsmith API for future evaluations. Providing a trait with a value of None will remove the trait from the identity if it exists.

Parameters:

identifier - identifier string

Returns:

Flags object containing flags for identity

Throws:

FlagsmithClientError - if error when retrieving flags for identity

getIdentityFlags

public Flags getIdentityFlags(String identifier,
                              Map<String,Object> traits)
                       throws FlagsmithClientError

Get all the flags for the current environment for a given identity. Will also upsert all traits to the Flagsmith API for future evaluations. Providing a trait with a value of None will remove the trait from the identity if it exists.

Parameters:

identifier - identifier string

traits - list of key value traits

Returns:

Flags object containing flags for identity

Throws:

FlagsmithClientError - if error when retrieving flags for identity

getIdentitySegments

public List<Segment> getIdentitySegments(String identifier)
                                  throws FlagsmithClientError

Get a list of segments that the given identity is in.

Parameters:

identifier - a unique identifier for the identity in the current environment, e.g. email address, username, uuid

Returns:

List of segments that the identity belongs to

Throws:

FlagsmithClientError - if error when retrieving segments for identity

getIdentitySegments

public List<Segment> getIdentitySegments(String identifier,
                                         Map<String,Object> traits)
                                  throws FlagsmithClientError

Get a list of segments that the given identity is in.

Parameters:

identifier - a unique identifier for the identity in the current environment, e.g. email address, username, uuid

traits - a dictionary of traits to add / update on the identity in Flagsmith, e.g. {"num_orders": 10}

Returns:

List of segments that the identity belongs to

Throws:

FlagsmithClientError - if error when retrieving segments for identity

getCache

public FlagsmithCache getCache()

Returns a FlagsmithCache cache object that encapsulates methods to manipulate the cache.

Returns:

a FlagsmithCache if enabled, otherwise null.