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 javax.net.ssl.SSLSocketFactory	sslSocketFactory The SSl socket factory.

Fields inherited from class com.amplitude.api.AmplitudeClient

apiKey, callFactory, context, dbHelper, DEVICE_ID_KEY, deviceId, deviceInfo, END_SESSION_EVENT, 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
protected static java.lang.String	getCertificate(AmplitudeServerZone serverZone)
static PinnedAmplitudeClient	getInstance() Gets the default instance.
static PinnedAmplitudeClient	getInstance(java.lang.String instance) Gets the specified instance.
protected static PinnedAmplitudeClient.SSLContextBuilder	getPinnedCertificateChain(AmplitudeServerZone serverZone) Pinned certificate chain for api.amplitude.com.
protected javax.net.ssl.SSLSocketFactory	getPinnedCertSslSocketFactory(AmplitudeServerZone serverZone) 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.
AmplitudeClient	initialize(android.content.Context context, java.lang.String apiKey, java.lang.String userId, Provider<OkHttpClient> clientProvider)
AmplitudeClient	initializeInternal(android.content.Context context, java.lang.String apiKey, java.lang.String userId, Provider<OkHttpClient> clientProvider)
AmplitudeClient	setServerZone(AmplitudeServerZone serverZone) Set Amplitude Server Zone, switch to zone related configuration, including dynamic configuration and server url.

Methods inherited from class com.amplitude.api.AmplitudeClient

addEventMiddleware, bytesToHexString, clearUserProperties, contextAndApiKeySet, disableCoppaControl, disableDiagnosticLogging, disableLocationListening, enableCoppaControl, enableDiagnosticLogging, enableForegroundTracking, enableLocationListening, enableLogging, enableNewDeviceIdPerInstall, getCurrentTimeMillis, getDeviceId, getServerZone, getSessionId, getUserId, groupIdentify, groupIdentify, groupIdentify, groupIdentify, identify, identify, identify, initialize, initialize, initialize, initializeDeviceInfo, initializeInternal, isOptedOut, logEvent, logEvent, logEvent, logEvent, logEvent, logEvent, logEvent, logEvent, logEvent, logEvent, logEventAsync, logEventAsync, logEventSync, logEventSync, logEventSync, logEventSync, logEventSync, logEventSync, logRevenue, logRevenue, logRevenue, logRevenue, logRevenueV2, logRevenueV2, makeEventUploadPostRequest, mergeEventsAndIdentifys, regenerateDeviceId, replaceWithJSONNull, runOnLogThread, saveEvent, saveEvent, setBearerToken, setDeviceId, setDeviceIdCallback, setDiagnosticEventMaxCount, setEventMaxCount, setEventUploadMaxBatchSize, setEventUploadPeriodMillis, setEventUploadThreshold, setFlushEventsOnClose, setGroup, setGroup, setIdentifyBatchIntervalMillis, setIngestionMetadata, setLibraryName, setLibraryVersion, setLogCallback, setLogLevel, setMinTimeBetweenSessionsMillis, setOffline, setOptOut, setPlan, setServerUrl, setServerZone, setSessionTimeoutMillis, setTrackingOptions, setUseDynamicConfig, setUserId, setUserId, setUserProperties, setUserProperties, setUserProperties, showEventExplorer, startNewSessionIfNeeded, trackSessionEvents, truncate, truncate, truncate, updateServer, updateServer, uploadEvents, useAdvertisingIdForDeviceId, useAppSetIdForDeviceId, validateLogEvent

Methods inherited from class java.lang.Object

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

Field Detail

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

getCertificate

protected static java.lang.String getCertificate(AmplitudeServerZone serverZone)

getPinnedCertificateChain

protected static PinnedAmplitudeClient.SSLContextBuilder getPinnedCertificateChain(AmplitudeServerZone serverZone)

Pinned certificate chain for api.amplitude.com.

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

initializeInternal

public AmplitudeClient initializeInternal(android.content.Context context,
                                          java.lang.String apiKey,
                                          java.lang.String userId,
                                          Provider<OkHttpClient> clientProvider)

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

initialize

public AmplitudeClient initialize(android.content.Context context,
                                  java.lang.String apiKey,
                                  java.lang.String userId,
                                  Provider<OkHttpClient> clientProvider)

getPinnedCertSslSocketFactory

protected javax.net.ssl.SSLSocketFactory getPinnedCertSslSocketFactory(AmplitudeServerZone serverZone)

Gets pinned cert ssl socket factory.

Parameters:

serverZone - the current server zone

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

setServerZone

public AmplitudeClient setServerZone(AmplitudeServerZone serverZone)

Description copied from class: AmplitudeClient

Set Amplitude Server Zone, switch to zone related configuration, including dynamic configuration and server url. To send data to Amplitude's EU servers, you need to configure the serverZone to EU like client.setServerZone(AmplitudeServerZone.EU);

Overrides:

setServerZone in class AmplitudeClient

Parameters:

serverZone - AmplitudeServerZone, US or EU, default is US

Returns:

the AmplitudeClient