com.amplitude.api

Class PinnedAmplitudeClient

java.lang.Object

com.amplitude.api.AmplitudeClient

com.amplitude.api.PinnedAmplitudeClient

public class PinnedAmplitudeClient
extends AmplitudeClient

PinnedAmplitudeClient

This is a version of the AmplitudeClient that supports SSL pinning for encrypted requests. Please contact Amplitude 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	PinnedAmplitudeClient.SSLContextBuilder SSl context builder, used to generate the SSL context.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initializedSSLSocketFactory The Initialized ssl socket factory.
protected static PinnedAmplitudeClient.SSLContextBuilder	SSL_CONTEXT_API_AMPLITUDE_COM Pinned certificate chain for api.amplitude.com.
protected javax.net.ssl.SSLSocketFactory	sslSocketFactory The SSl socket factory.

Fields inherited from class com.amplitude.api.AmplitudeClient

apiKey, context, dbHelper, DEVICE_ID_KEY, deviceId, END_SESSION_EVENT, httpClient, initialized, instanceName, LAST_EVENT_ID_KEY, LAST_EVENT_TIME_KEY, LAST_IDENTIFY_ID_KEY, OPT_OUT_KEY, platform, PREVIOUS_SESSION_ID_KEY, SEQUENCE_NUMBER_KEY, START_SESSION_EVENT, USER_ID_KEY, userId

Constructor Summary

Constructors

Constructor and Description
PinnedAmplitudeClient(java.lang.String instance) Instantiates a new Pinned amplitude client.

Method Summary

Modifier and Type	Method and Description
static PinnedAmplitudeClient	getInstance() Gets the default instance.
static PinnedAmplitudeClient	getInstance(java.lang.String instance) Gets the specified instance.
protected javax.net.ssl.SSLSocketFactory	getPinnedCertSslSocketFactory() Gets pinned cert ssl socket factory.
protected javax.net.ssl.SSLSocketFactory	getPinnedCertSslSocketFactory(PinnedAmplitudeClient.SSLContextBuilder context) Gets pinned cert ssl socket factory.
AmplitudeClient	initialize(android.content.Context context, java.lang.String apiKey, java.lang.String userId) Initialize the Amplitude SDK with the Android application context, your Amplitude App API key, and a user ID for the current user.

Methods inherited from class com.amplitude.api.AmplitudeClient

bytesToHexString, clearUserProperties, contextAndApiKeySet, disableCoppaControl, disableDiagnosticLogging, disableLocationListening, enableCoppaControl, enableDiagnosticLogging, enableForegroundTracking, enableLocationListening, enableLogging, enableNewDeviceIdPerInstall, getCurrentTimeMillis, getDeviceId, getSessionId, getUserId, groupIdentify, groupIdentify, identify, identify, initialize, initialize, isOptedOut, logEvent, logEvent, logEvent, logEvent, logEvent, logEvent, logEvent, logEventAsync, logEventSync, logEventSync, logEventSync, logEventSync, logEventSync, logEventSync, logRevenue, logRevenue, logRevenue, logRevenueV2, makeEventUploadPostRequest, mergeEventsAndIdentifys, regenerateDeviceId, replaceWithJSONNull, runOnLogThread, saveEvent, setBearerToken, setDeviceId, setDiagnosticEventMaxCount, setEventMaxCount, setEventUploadMaxBatchSize, setEventUploadPeriodMillis, setEventUploadThreshold, setFlushEventsOnClose, setGroup, setLogLevel, setMinTimeBetweenSessionsMillis, setOffline, setOptOut, setServerUrl, setSessionTimeoutMillis, setTrackingOptions, setUserId, setUserId, setUserProperties, setUserProperties, startNewSessionIfNeeded, trackSessionEvents, truncate, truncate, truncate, updateServer, updateServer, uploadEvents, useAdvertisingIdForDeviceId, validateLogEvent

Methods inherited from class java.lang.Object

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

Field Detail

SSL_CONTEXT_API_AMPLITUDE_COM

protected static final PinnedAmplitudeClient.SSLContextBuilder SSL_CONTEXT_API_AMPLITUDE_COM

Pinned certificate chain for api.amplitude.com.

sslSocketFactory

protected javax.net.ssl.SSLSocketFactory sslSocketFactory

The SSl socket factory.

initializedSSLSocketFactory

protected boolean initializedSSLSocketFactory

The Initialized ssl socket factory.

Constructor Detail

PinnedAmplitudeClient

public PinnedAmplitudeClient(java.lang.String instance)

Instantiates a new Pinned amplitude client.

Method Detail

getInstance

public static PinnedAmplitudeClient getInstance()

Gets the default instance.

Returns:

the default instance

getInstance

public static PinnedAmplitudeClient getInstance(java.lang.String instance)

Gets the specified instance. If instance is null or empty string, fetches the default instance instead.

Parameters:

instance - name to get "ex app 1"

Returns:

the specified instance

initialize

public AmplitudeClient initialize(android.content.Context context,
                                  java.lang.String apiKey,
                                  java.lang.String userId)

Description copied from class: AmplitudeClient

Initialize the Amplitude SDK with the Android application context, your Amplitude 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 AmplitudeClient

Parameters:

context - the Android application context

apiKey - your Amplitude App API key

userId - the user id to set

Returns:

the AmplitudeClient

getPinnedCertSslSocketFactory

protected javax.net.ssl.SSLSocketFactory getPinnedCertSslSocketFactory()

Gets pinned cert ssl socket factory.

Returns:

the pinned cert ssl socket factory

getPinnedCertSslSocketFactory

protected javax.net.ssl.SSLSocketFactory getPinnedCertSslSocketFactory(PinnedAmplitudeClient.SSLContextBuilder context)

Gets pinned cert ssl socket factory.

Parameters:

context - the context

Returns:

the pinned cert ssl socket factory