io.rakam.api

Class PinnedRakamClient

java.lang.Object

io.rakam.api.RakamClient

io.rakam.api.PinnedRakamClient

public class PinnedRakamClient
extends RakamClient

PinnedRakamClient

This is a version of the RakamClient that supports SSL pinning for encrypted requests. Please contact Rakam Support before you ship any products with SSL pinning enabled so that we are aware and can provide documentation and implementation help.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PinnedRakamClient.SSLContextBuilder SSl context builder, used to generate the SSL context.

Nested classes/interfaces inherited from class io.rakam.api.RakamClient

RakamClient.CleanerFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initializedSSLSocketFactory The Initialized ssl socket factory.
protected static PinnedRakamClient	instance The default instance.
protected static PinnedRakamClient.SSLContextBuilder	SSL_CONTEXT_API_RAKAM_IO Pinned certificate chain for api.rakam.io.
protected SSLSocketFactory	sslSocketFactory The SSl socket factory.
static String	TAG The class identifier tag used in logging.

Fields inherited from class io.rakam.api.RakamClient

apiKey, context, dbHelper, DEVICE_ID_KEY, deviceId, END_SESSION_EVENT, httpClient, LAST_EVENT_ID_KEY, LAST_EVENT_TIME_KEY, LAST_IDENTIFY_ID_KEY, OPT_OUT_KEY, PREVIOUS_SESSION_ID_KEY, START_SESSION_EVENT, SUPER_PROPERTIES_KEY, USER_ID_KEY, userId

Constructor Summary

Constructors

Constructor and Description
PinnedRakamClient() Instantiates a new Pinned rakam client.

Method Summary

Modifier and Type	Method and Description
static PinnedRakamClient	getInstance() Gets the default instance.
protected SSLSocketFactory	getPinnedCertSslSocketFactory() Gets pinned cert ssl socket factory.
protected SSLSocketFactory	getPinnedCertSslSocketFactory(PinnedRakamClient.SSLContextBuilder context) Gets pinned cert ssl socket factory.
RakamClient	initialize(android.content.Context context, String apiKey, String userId) Initialize the Rakam SDK with the Android application context, your Rakam App API key, and a user ID for the current user.
protected void	setPinnedCertSslSocketFactory(SSLSocketFactory sslSocketFactory) Sets pinned cert ssl certicate

Methods inherited from class io.rakam.api.RakamClient

bytesToHexString, clearSuperProperties, clearUserProperties, contextAndApiKeySet, disableLocationListening, enableForegroundTracking, enableLocationListening, enableLogging, getCurrentTimeMillis, getDeviceId, getSessionId, getSuperProperties, getUserId, identify, initialize, isOptedOut, logEvent, logEvent, logEvent, logEvent, logEventAsync, logEventSync, logEventSync, logEventSync, logRevenue, makeEventUploadPostRequest, recordAction, recordIdentify, replaceWithJSONNull, setApiUrl, setDeviceId, setEventMaxCount, setEventUploadMaxBatchSize, setEventUploadPeriodMillis, setEventUploadThreshold, setLogLevel, setMinTimeBetweenSessionsMillis, setOffline, setOptOut, setSessionTimeoutMillis, setSuperProperties, setUserId, setUserId, setUserId, setUserProperties, syncEventsWithServer, syncEventsWithServer, trackSessionEvents, truncate, truncate, truncate, uploadEvents, useAdvertisingIdForDeviceId, validateLogEvent

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final String TAG

The class identifier tag used in logging. TAG = "PinnedRakamClient";

See Also:

Constant Field Values

SSL_CONTEXT_API_RAKAM_IO

protected static final PinnedRakamClient.SSLContextBuilder SSL_CONTEXT_API_RAKAM_IO

Pinned certificate chain for api.rakam.io.

instance

protected static PinnedRakamClient instance

The default instance.

sslSocketFactory

protected SSLSocketFactory sslSocketFactory

The SSl socket factory.

initializedSSLSocketFactory

protected boolean initializedSSLSocketFactory

The Initialized ssl socket factory.

Constructor Detail

PinnedRakamClient

public PinnedRakamClient()

Instantiates a new Pinned rakam client.

Method Detail

getInstance

public static PinnedRakamClient getInstance()

Gets the default instance. Call SDK method on the default instance.

Returns:

the default instance

initialize

public RakamClient initialize(android.content.Context context,
                              String apiKey,
                              String userId)

Description copied from class: RakamClient

Initialize the Rakam SDK with the Android application context, your Rakam App API key, and a user ID for the current user. Note: initialization is required before you log events and modify user properties.

Overrides:

initialize in class RakamClient

Parameters:

context - the Android application context

apiKey - your Rakam App API key

userId - the user id to set

Returns:

the RakamClient

getPinnedCertSslSocketFactory

protected SSLSocketFactory getPinnedCertSslSocketFactory()

Gets pinned cert ssl socket factory.

Returns:

the pinned cert ssl socket factory

setPinnedCertSslSocketFactory

protected void setPinnedCertSslSocketFactory(SSLSocketFactory sslSocketFactory)

Sets pinned cert ssl certicate

getPinnedCertSslSocketFactory

protected SSLSocketFactory getPinnedCertSslSocketFactory(PinnedRakamClient.SSLContextBuilder context)

Gets pinned cert ssl socket factory.

Parameters:

context - the context

Returns:

the pinned cert ssl socket factory