com.heroiclabs.satori

Class DefaultClient

java.lang.Object

com.heroiclabs.satori.DefaultClient

All Implemented Interfaces:

Client

public class DefaultClient
extends java.lang.Object
implements Client

Constructor Summary

Constructors

Constructor and Description
DefaultClient(@NonNull java.lang.String apiKey, @NonNull java.lang.String host, int port, boolean ssl) A client to interact with the Satori server.
DefaultClient(@NonNull java.lang.String apiKey, @NonNull java.lang.String host, int port, boolean ssl, int deadlineAfterMs, long keepAliveTimeMs, long keepAliveTimeoutMs, boolean trace) A client to interact with the Satori Satori.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Session>	authenticate(@NonNull java.lang.String id, java.util.Map<java.lang.String,java.lang.String> defaultProperties, java.util.Map<java.lang.String,java.lang.String> customProperties) Authenticate against the server.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	authenticateLogout(@NonNull Session session) Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteIdentity(@NonNull Session session) Delete the caller's identity and associated data.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteMessage(@NonNull Session session, @NonNull java.lang.String messageId) The request to delete a scheduled message.
void	disconnect() Disconnects the client.
void	disconnect(long timeout, @NonNull java.util.concurrent.TimeUnit unit) Disconnects the client.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	event(@NonNull Session session, @NonNull Event event) Send an event for this session.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	events(@NonNull Session session, @NonNull java.util.List<Event> events) Send a batch of events for this session.
com.google.common.util.concurrent.ListenableFuture<ExperimentList>	getAllExperiments(@NonNull Session session) Get all experiments data.
int	getDefaultExpiryTimeMinutes()
com.google.common.util.concurrent.ListenableFuture<ExperimentList>	getExperiments(@NonNull Session session, java.lang.String... names) Get specific experiments data.
com.google.common.util.concurrent.ListenableFuture<Flag>	getFlag(@NonNull Session session, @NonNull java.lang.String name) Get a single flag for this identity.
com.google.common.util.concurrent.ListenableFuture<Flag>	getFlag(@NonNull Session session, @NonNull java.lang.String name, @NonNull java.lang.String defaultValue) Get a single flag for this identity.
com.google.common.util.concurrent.ListenableFuture<Flag>	getFlagDefault(@NonNull java.lang.String name) Get a single default flag for this identity.
com.google.common.util.concurrent.ListenableFuture<Flag>	getFlagDefault(@NonNull java.lang.String name, @NonNull java.lang.String defaultValue) Get a single default flag for this identity.
com.google.common.util.concurrent.ListenableFuture<FlagList>	getFlags(@NonNull Session session, java.lang.String... names) Get flags for this identity.
com.google.common.util.concurrent.ListenableFuture<FlagList>	getFlagsDefault(java.lang.String... names) List all available default flags.
com.google.common.util.concurrent.ListenableFuture<LiveEventList>	getLiveEvents(@NonNull Session session, java.lang.String... names) Get live events.
com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse>	getMessageList(@NonNull Session session) Get the list of messages for the identity.
com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse>	getMessageList(@NonNull Session session, int limit) Get the list of messages for the identity.
com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse>	getMessageList(@NonNull Session session, int limit, boolean forward) Get the list of messages for the identity.
com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse>	getMessageList(@NonNull Session session, int limit, boolean forward, @NonNull java.lang.String cursor) Get the list of messages for the identity.
com.google.common.util.concurrent.ListenableFuture<Session>	identify(@NonNull Session session, @NonNull java.lang.String id, @NonNull java.util.Map<java.lang.String,java.lang.String> defaultProperties, @NonNull java.util.Map<java.lang.String,java.lang.String> customProperties) Identify a session with a new ID.
boolean	isAutoRefreshSession()
com.google.common.util.concurrent.ListenableFuture<Properties>	listProperties(@NonNull Session session) List properties associated with this identity.
com.google.common.util.concurrent.ListenableFuture<Session>	sessionRefresh(Session session) Refresh a user's session using a refresh token retrieved from a previous authentication request.
void	setAutoRefreshSession(boolean autoRefreshSession)
void	setDefaultExpiryTimeMinutes(int defaultExpiryTimeMinutes)
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	updateMessage(@NonNull Session session, @NonNull java.lang.String id, long readTime) The request to update the status of a message.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	updateMessage(@NonNull Session session, @NonNull java.lang.String id, long readTime, long consumeTime) The request to update the status of a message.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	updateProperties(@NonNull Session session, @NonNull java.util.Map<java.lang.String,java.lang.String> defaultProperties, @NonNull java.util.Map<java.lang.String,java.lang.String> customProperties) Update or create properties for an identity.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	updateProperties(@NonNull Session session, @NonNull java.util.Map<java.lang.String,java.lang.String> defaultProperties, @NonNull java.util.Map<java.lang.String,java.lang.String> customProperties, boolean recompute) Update or create properties for an identity.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClient

public DefaultClient(@NonNull
                     @NonNull java.lang.String apiKey,
                     @NonNull
                     @NonNull java.lang.String host,
                     int port,
                     boolean ssl)

A client to interact with the Satori server.

Parameters:

apiKey - The key used to authenticate with the server without a session.

host - The host address of the server. Defaults to "127.0.0.1".

port - The port number of the server. Defaults to 7349.

ssl - Set connection strings to use the secure mode with the server. Defaults to false. The server must be configured to make use of this option. With HTTP, GRPC, and WebSockets the server must be configured with an SSL certificate or use a load balancer which performs SSL termination. For rUDP you must configure the server to expose it's IP address so it can be bundled within session tokens. See the server documentation for more information.

DefaultClient

public DefaultClient(@NonNull
                     @NonNull java.lang.String apiKey,
                     @NonNull
                     @NonNull java.lang.String host,
                     int port,
                     boolean ssl,
                     int deadlineAfterMs,
                     long keepAliveTimeMs,
                     long keepAliveTimeoutMs,
                     boolean trace)

A client to interact with the Satori Satori.

Parameters:

apiKey - The key used to authenticate with the server without a session.

host - The host address of the server.

port - The port number of the server. Defaults to 7349.

ssl - Set connection strings to use the secure mode with the server. Defaults to false. The server must be configured to make use of this option. With HTTP, GRPC, and WebSockets the server must be configured with an SSL certificate or use a load balancer which performs SSL termination. For rUDP you must configure the server to expose it's IP address so it can be bundled within session tokens. See the server documentation for more information.

deadlineAfterMs - Timeout for the gRPC messages.

keepAliveTimeMs - Sets the time without read activity before sending a keepalive ping. An unreasonably small value might be increased, and Long.MAX_VALUE nano seconds or an unreasonably large value will disable keepalive. Defaults to infinite.

keepAliveTimeoutMs - Sets the time waiting for read activity after sending a keepalive ping. If the time expires without any read activity on the connection, the connection is considered dead. An unreasonably small value might be increased. Defaults to 20 seconds.

trace - Trace all actions performed by the client. Defaults to false.

Method Detail

authenticate

public com.google.common.util.concurrent.ListenableFuture<Session> authenticate(@NonNull
                                                                                @NonNull java.lang.String id,
                                                                                java.util.Map<java.lang.String,java.lang.String> defaultProperties,
                                                                                java.util.Map<java.lang.String,java.lang.String> customProperties)

Description copied from interface: Client

Authenticate against the server.

Specified by:

authenticate in interface Client

Parameters:

id - An optional user id.

defaultProperties - Optional default properties to update with this call. If not set, properties are left as they are on the server.

customProperties - Optional custom properties to update with this call. If not set, properties are left as they are on the server.

Returns:

A future which resolves to a user session.

authenticateLogout

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> authenticateLogout(@NonNull
                                                                                                        @NonNull Session session)

Description copied from interface: Client

Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.

Specified by:

authenticateLogout in interface Client

Parameters:

session - The session of the user.

Returns:

A future object which represents the asynchronous operation.

deleteIdentity

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteIdentity(@NonNull
                                                                                                    @NonNull Session session)

Description copied from interface: Client

Delete the caller's identity and associated data.

Specified by:

deleteIdentity in interface Client

Parameters:

session - The session of the user.

Returns:

A future object.

deleteMessage

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteMessage(@NonNull
                                                                                                   @NonNull Session session,
                                                                                                   @NonNull
                                                                                                   @NonNull java.lang.String messageId)

Description copied from interface: Client

The request to delete a scheduled message.

Specified by:

deleteMessage in interface Client

Parameters:

session - The session of the user.

messageId - The ID of the message to delete.

Returns:

A future object.

disconnect

public void disconnect()

Description copied from interface: Client

Disconnects the client. This function kills all outgoing exchanges immediately without waiting.

Specified by:

disconnect in interface Client

disconnect

public void disconnect(long timeout,
                       @NonNull
                       @NonNull java.util.concurrent.TimeUnit unit)
                throws java.lang.InterruptedException

Description copied from interface: Client

Disconnects the client. This function kills all outgoing exchanges and waits until the channel is shutdown.

Specified by:

disconnect in interface Client

Throws:

java.lang.InterruptedException

event

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> event(@NonNull
                                                                                           @NonNull Session session,
                                                                                           @NonNull
                                                                                           @NonNull Event event)

Description copied from interface: Client

Send an event for this session.

Specified by:

event in interface Client

Parameters:

session - The session of the user.

event - The event to send.

Returns:

A future object.

events

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> events(@NonNull
                                                                                            @NonNull Session session,
                                                                                            @NonNull
                                                                                            @NonNull java.util.List<Event> events)

Description copied from interface: Client

Send a batch of events for this session.

Specified by:

events in interface Client

Parameters:

session - The session of the user.

events - The batch of events which will be sent.

Returns:

A future object.

getAllExperiments

public com.google.common.util.concurrent.ListenableFuture<ExperimentList> getAllExperiments(@NonNull
                                                                                            @NonNull Session session)

Description copied from interface: Client

Get all experiments data.

Specified by:

getAllExperiments in interface Client

Parameters:

session - The session of the user.

Returns:

A future which resolves to all experiments that this identity is involved with.

getExperiments

public com.google.common.util.concurrent.ListenableFuture<ExperimentList> getExperiments(@NonNull
                                                                                         @NonNull Session session,
                                                                                         @NonNull
                                                                                         java.lang.String... names)

Description copied from interface: Client

Get specific experiments data.

Specified by:

getExperiments in interface Client

Parameters:

session - The session of the user.

names - Experiment names.

Returns:

A future which resolves to all experiments that this identity is involved with.

getFlag

public com.google.common.util.concurrent.ListenableFuture<Flag> getFlag(@NonNull
                                                                        @NonNull Session session,
                                                                        @NonNull
                                                                        @NonNull java.lang.String name)

Description copied from interface: Client

Get a single flag for this identity.

Specified by:

getFlag in interface Client

Parameters:

session - The session of the user.

name - The name of the flag.

Returns:

A future which resolves to a single feature flag.

getFlag

public com.google.common.util.concurrent.ListenableFuture<Flag> getFlag(@NonNull
                                                                        @NonNull Session session,
                                                                        @NonNull
                                                                        @NonNull java.lang.String name,
                                                                        @NonNull
                                                                        @NonNull java.lang.String defaultValue)

Description copied from interface: Client

Get a single flag for this identity.

Specified by:

getFlag in interface Client

Parameters:

session - The session of the user.

name - The name of the flag.

defaultValue - The default value if the server is unreachable or the flag does not exist.

Returns:

A future which resolves to a single feature flag.

getFlags

public com.google.common.util.concurrent.ListenableFuture<FlagList> getFlags(@NonNull
                                                                             @NonNull Session session,
                                                                             java.lang.String... names)

Description copied from interface: Client

Get flags for this identity.

Specified by:

getFlags in interface Client

Parameters:

session - The session of the user.

names - The names of the flags.

Returns:

A future which resolves to a list of feature flags.

getFlagDefault

public com.google.common.util.concurrent.ListenableFuture<Flag> getFlagDefault(@NonNull
                                                                               @NonNull java.lang.String name)

Description copied from interface: Client

Get a single default flag for this identity.

Specified by:

getFlagDefault in interface Client

Parameters:

name - The name of the flag.

Returns:

A ListenableFuture which resolves to a single default feature flag.

getFlagDefault

public com.google.common.util.concurrent.ListenableFuture<Flag> getFlagDefault(@NonNull
                                                                               @NonNull java.lang.String name,
                                                                               @NonNull
                                                                               @NonNull java.lang.String defaultValue)

Description copied from interface: Client

Get a single default flag for this identity. Unlike Client.getFlagDefault(String) this method will return the default value specified and will not raise an exception if the network is unreachable.

Specified by:

getFlagDefault in interface Client

Parameters:

name - The name of the flag.

defaultValue - The default value if the server is unreachable or the flag does not exist.

Returns:

A ListenableFuture which resolves to a single default feature flag.

getFlagsDefault

public com.google.common.util.concurrent.ListenableFuture<FlagList> getFlagsDefault(java.lang.String... names)

Description copied from interface: Client

List all available default flags.

Specified by:

getFlagsDefault in interface Client

Parameters:

names - Flag names, if empty all flags are returned.

Returns:

A ListenableFuture which resolves to all available default flags.

getLiveEvents

public com.google.common.util.concurrent.ListenableFuture<LiveEventList> getLiveEvents(@NonNull
                                                                                       @NonNull Session session,
                                                                                       java.lang.String... names)

Description copied from interface: Client

Get live events.

Specified by:

getLiveEvents in interface Client

Parameters:

session - The session of the user.

names - The live events to get. Returns all live events if none are supplied.

Returns:

A future which resolves to a list of live events.

getMessageList

public com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse> getMessageList(@NonNull
                                                                                                 @NonNull Session session)

Description copied from interface: Client

Get the list of messages for the identity.

Specified by:

getMessageList in interface Client

Parameters:

session - The session of the user.

Returns:

A future which resolves to all messages.

getMessageList

public com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse> getMessageList(@NonNull
                                                                                                 @NonNull Session session,
                                                                                                 int limit)

Description copied from interface: Client

Get the list of messages for the identity.

Specified by:

getMessageList in interface Client

Parameters:

session - The session of the user.

limit - Max number of messages to return. Between 1 and 100.

Returns:

A future which resolves to all messages.

getMessageList

public com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse> getMessageList(@NonNull
                                                                                                 @NonNull Session session,
                                                                                                 int limit,
                                                                                                 boolean forward)

Description copied from interface: Client

Get the list of messages for the identity.

Specified by:

getMessageList in interface Client

Parameters:

session - The session of the user.

limit - Max number of messages to return. Between 1 and 100.

forward - True if listing should be older messages to newer, false if reverse.

Returns:

A future which resolves to all messages.

getMessageList

public com.google.common.util.concurrent.ListenableFuture<GetMessageListResponse> getMessageList(@NonNull
                                                                                                 @NonNull Session session,
                                                                                                 int limit,
                                                                                                 boolean forward,
                                                                                                 @NonNull
                                                                                                 @NonNull java.lang.String cursor)

Description copied from interface: Client

Get the list of messages for the identity.

Specified by:

getMessageList in interface Client

Parameters:

session - The session of the user.

limit - Max number of messages to return. Between 1 and 100.

forward - True if listing should be older messages to newer, false if reverse.

cursor - A pagination cursor.

Returns:

A future which resolves to all messages.

listProperties

public com.google.common.util.concurrent.ListenableFuture<Properties> listProperties(@NonNull
                                                                                     @NonNull Session session)

Description copied from interface: Client

List properties associated with this identity.

Specified by:

listProperties in interface Client

Parameters:

session - The session of the user.

Returns:

A ListenableFuture which resolves to a list of live events.

identify

public com.google.common.util.concurrent.ListenableFuture<Session> identify(@NonNull
                                                                            @NonNull Session session,
                                                                            @NonNull
                                                                            @NonNull java.lang.String id,
                                                                            @NonNull
                                                                            @NonNull java.util.Map<java.lang.String,java.lang.String> defaultProperties,
                                                                            @NonNull
                                                                            @NonNull java.util.Map<java.lang.String,java.lang.String> customProperties)

Description copied from interface: Client

Identify a session with a new ID.

Specified by:

identify in interface Client

Parameters:

session - The session of the user.

id - Identity ID to enrich the current session and return a new session. The old session will no longer be usable. Must be between eight and 128 characters (inclusive). Must be an alphanumeric string with only underscores and hyphens allowed.

defaultProperties - The default properties.

customProperties - The custom event properties.

Returns:

A ListenableFuture which resolves to the new session for the user.

sessionRefresh

public com.google.common.util.concurrent.ListenableFuture<Session> sessionRefresh(Session session)

Description copied from interface: Client

Refresh a user's session using a refresh token retrieved from a previous authentication request.

Specified by:

sessionRefresh in interface Client

Parameters:

session - The session of the user.

Returns:

A future which resolves to a user session.

updateMessage

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateMessage(@NonNull
                                                                                                   @NonNull Session session,
                                                                                                   @NonNull
                                                                                                   @NonNull java.lang.String id,
                                                                                                   long readTime)

Description copied from interface: Client

The request to update the status of a message.

Specified by:

updateMessage in interface Client

Parameters:

session - The session of the user.

id - The identifier of the message.

readTime - The time the message was read at the client.

Returns:

A future.

updateMessage

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateMessage(@NonNull
                                                                                                   @NonNull Session session,
                                                                                                   @NonNull
                                                                                                   @NonNull java.lang.String id,
                                                                                                   long readTime,
                                                                                                   long consumeTime)

Description copied from interface: Client

The request to update the status of a message.

Specified by:

updateMessage in interface Client

Parameters:

session - The session of the user.

id - The identifier of the message.

readTime - The time the message was read at the client.

consumeTime - The time the message was consumed by the identity.

Returns:

A future.

updateProperties

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateProperties(@NonNull
                                                                                                      @NonNull Session session,
                                                                                                      @NonNull
                                                                                                      @NonNull java.util.Map<java.lang.String,java.lang.String> defaultProperties,
                                                                                                      @NonNull
                                                                                                      @NonNull java.util.Map<java.lang.String,java.lang.String> customProperties)

Description copied from interface: Client

Update or create properties for an identity.

Specified by:

updateProperties in interface Client

Parameters:

session - The session of the user.

defaultProperties - The properties to update or create.

customProperties - The properties to update or create.

Returns:

A future object.

updateProperties

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> updateProperties(@NonNull
                                                                                                      @NonNull Session session,
                                                                                                      @NonNull
                                                                                                      @NonNull java.util.Map<java.lang.String,java.lang.String> defaultProperties,
                                                                                                      @NonNull
                                                                                                      @NonNull java.util.Map<java.lang.String,java.lang.String> customProperties,
                                                                                                      boolean recompute)

Description copied from interface: Client

Update or create properties for an identity.

Specified by:

updateProperties in interface Client

Parameters:

session - The session of the user.

defaultProperties - The properties to update or create.

customProperties - The properties to update or create.

recompute - Informs the server to recompute the audience membership of the identity.

Returns:

A future object.

isAutoRefreshSession

public boolean isAutoRefreshSession()

setAutoRefreshSession

public void setAutoRefreshSession(boolean autoRefreshSession)

getDefaultExpiryTimeMinutes

public int getDefaultExpiryTimeMinutes()

setDefaultExpiryTimeMinutes

public void setDefaultExpiryTimeMinutes(int defaultExpiryTimeMinutes)