com.pubnub.internal.v2.PNConfigurationImpl.kt Maven / Gradle / Ivy

Go to download
package com.pubnub.internal.v2

import com.pubnub.api.UserId
import com.pubnub.api.crypto.CryptoModule
import com.pubnub.api.enums.PNHeartbeatNotificationOptions
import com.pubnub.api.enums.PNLogVerbosity
import com.pubnub.api.retry.RetryConfiguration
import com.pubnub.api.retry.RetryableEndpointGroup
import com.pubnub.api.v2.PNConfiguration
import com.pubnub.api.v2.PNConfigurationOverride
import okhttp3.Authenticator
import okhttp3.CertificatePinner
import okhttp3.ConnectionSpec
import okhttp3.logging.HttpLoggingInterceptor
import org.slf4j.LoggerFactory
import java.net.Proxy
import java.net.ProxySelector
import javax.net.ssl.HostnameVerifier
import javax.net.ssl.SSLSocketFactory
import javax.net.ssl.X509ExtendedTrustManager

class PNConfigurationImpl(
    override val userId: UserId,
    override val subscribeKey: String = "",
    override val publishKey: String = "",
    override val secretKey: String = "",
    override val authKey: String = "",
    override val cryptoModule: CryptoModule? = null,
    override val origin: String = "",
    override val secure: Boolean = true,
    override val logVerbosity: PNLogVerbosity = PNLogVerbosity.NONE,
    override val heartbeatNotificationOptions: PNHeartbeatNotificationOptions = PNHeartbeatNotificationOptions.FAILURES,
    override val presenceTimeout: Int = PRESENCE_TIMEOUT,
    override val heartbeatInterval: Int = 0,
    override val subscribeTimeout: Int = SUBSCRIBE_TIMEOUT,
    override val connectTimeout: Int = CONNECT_TIMEOUT,
    override val nonSubscribeReadTimeout: Int = NON_SUBSCRIBE_REQUEST_TIMEOUT,
    override val cacheBusting: Boolean = false,
    override val suppressLeaveEvents: Boolean = false,
    override val maintainPresenceState: Boolean = true,
    override val filterExpression: String = "",
    override val includeInstanceIdentifier: Boolean = false,
    override val includeRequestIdentifier: Boolean = true,
    override val maximumConnections: Int? = null,
    override val googleAppEngineNetworking: Boolean = false,
    override val proxy: Proxy? = null,
    override val proxySelector: ProxySelector? = null,
    override val proxyAuthenticator: Authenticator? = null,
    override val certificatePinner: CertificatePinner? = null,
    override val httpLoggingInterceptor: HttpLoggingInterceptor? = null,
    override val sslSocketFactory: SSLSocketFactory? = null,
    override val x509ExtendedTrustManager: X509ExtendedTrustManager? = null,
    override val connectionSpec: ConnectionSpec? = null,
    override val hostnameVerifier: HostnameVerifier? = null,
    override val fileMessagePublishRetryLimit: Int = 5,
    override val dedupOnSubscribe: Boolean = false,
    override val maximumMessagesCacheSize: Int = DEFAULT_DEDUPE_SIZE,
    override val pnsdkSuffixes: Map = emptyMap(),
    override val retryConfiguration: RetryConfiguration = RetryConfiguration.Exponential(
        excludedOperations = listOf(
            RetryableEndpointGroup.PUBLISH,
            RetryableEndpointGroup.PRESENCE,
            RetryableEndpointGroup.FILE_PERSISTENCE,
            RetryableEndpointGroup.MESSAGE_PERSISTENCE,
            RetryableEndpointGroup.CHANNEL_GROUP,
            RetryableEndpointGroup.PUSH_NOTIFICATION,
            RetryableEndpointGroup.APP_CONTEXT,
            RetryableEndpointGroup.MESSAGE_REACTION,
            RetryableEndpointGroup.ACCESS_MANAGER,
        )
    ),
    override val managePresenceListManually: Boolean = false,
) : PNConfiguration, PNConfigurationOverride {
    companion object {
        const val DEFAULT_DEDUPE_SIZE = 100
        const val PRESENCE_TIMEOUT = 300
        const val MINIMUM_PRESENCE_TIMEOUT = 20
        const val NON_SUBSCRIBE_REQUEST_TIMEOUT = 10
        const val SUBSCRIBE_TIMEOUT = 310
        const val CONNECT_TIMEOUT = 5
    }

    class Builder(defaultConfiguration: PNConfiguration) :
        PNConfiguration.Builder,
        PNConfigurationOverride.Builder {
        constructor(userId: UserId, subscribeKey: String) : this(PNConfigurationImpl(userId, subscribeKey))

        private val log = LoggerFactory.getLogger(this::class.simpleName)

        override var userId: UserId = defaultConfiguration.userId

        override var subscribeKey: String = defaultConfiguration.subscribeKey

        override var publishKey: String = defaultConfiguration.publishKey

        override var secretKey: String = defaultConfiguration.secretKey

        override var authKey: String = defaultConfiguration.authKey

        override var cryptoModule: CryptoModule? = defaultConfiguration.cryptoModule

        override var origin: String = defaultConfiguration.origin

        override var secure: Boolean = defaultConfiguration.secure

        override var logVerbosity: PNLogVerbosity = defaultConfiguration.logVerbosity

        override var heartbeatNotificationOptions: PNHeartbeatNotificationOptions = defaultConfiguration.heartbeatNotificationOptions

        override var presenceTimeout: Int = defaultConfiguration.presenceTimeout
            set(value) {
                field =
                    if (value < MINIMUM_PRESENCE_TIMEOUT) {
                        log.warn("Presence timeout is too low. Defaulting to: $MINIMUM_PRESENCE_TIMEOUT")
                        MINIMUM_PRESENCE_TIMEOUT
                    } else {
                        value
                    }
                heartbeatInterval = (presenceTimeout / 2) - 1
            }

        override var heartbeatInterval: Int = defaultConfiguration.heartbeatInterval

        override var subscribeTimeout: Int = defaultConfiguration.subscribeTimeout

        override var connectTimeout: Int = defaultConfiguration.connectTimeout

        @Deprecated(
            "This setting relates to *read* timeout and was renamed to `nonSubscribeReadTimeout`",
            replaceWith = ReplaceWith("nonSubscribeReadTimeout")
        )
        override var nonSubscribeRequestTimeout: Int
            get() = nonSubscribeReadTimeout
            set(value) {
                nonSubscribeReadTimeout = value
            }

        override var nonSubscribeReadTimeout: Int = defaultConfiguration.nonSubscribeReadTimeout

        override var cacheBusting: Boolean = defaultConfiguration.cacheBusting

        override var suppressLeaveEvents: Boolean = defaultConfiguration.suppressLeaveEvents

        override var maintainPresenceState: Boolean = defaultConfiguration.maintainPresenceState

        override var filterExpression: String = defaultConfiguration.filterExpression

        override var includeInstanceIdentifier: Boolean = defaultConfiguration.includeInstanceIdentifier

        override var includeRequestIdentifier: Boolean = defaultConfiguration.includeRequestIdentifier

        override var maximumConnections: Int? = defaultConfiguration.maximumConnections

        override var googleAppEngineNetworking: Boolean = defaultConfiguration.googleAppEngineNetworking

        override var proxy: Proxy? = defaultConfiguration.proxy

        override var proxySelector: ProxySelector? = defaultConfiguration.proxySelector

        override var proxyAuthenticator: Authenticator? = defaultConfiguration.proxyAuthenticator

        override var certificatePinner: CertificatePinner? = defaultConfiguration.certificatePinner

        override var httpLoggingInterceptor: HttpLoggingInterceptor? = defaultConfiguration.httpLoggingInterceptor

        override var sslSocketFactory: SSLSocketFactory? = defaultConfiguration.sslSocketFactory

        override var x509ExtendedTrustManager: X509ExtendedTrustManager? = defaultConfiguration.x509ExtendedTrustManager

        override var connectionSpec: ConnectionSpec? = defaultConfiguration.connectionSpec

        override var hostnameVerifier: HostnameVerifier? = defaultConfiguration.hostnameVerifier

        override var fileMessagePublishRetryLimit: Int = defaultConfiguration.fileMessagePublishRetryLimit
        override var dedupOnSubscribe: Boolean = defaultConfiguration.dedupOnSubscribe
        override var maximumMessagesCacheSize: Int = defaultConfiguration.maximumMessagesCacheSize
        override var pnsdkSuffixes: Map = defaultConfiguration.pnsdkSuffixes

        override var retryConfiguration: RetryConfiguration = defaultConfiguration.retryConfiguration

        override var managePresenceListManually: Boolean = defaultConfiguration.managePresenceListManually

        override fun build(): PNConfiguration {
            return PNConfigurationImpl(
                userId = userId,
                subscribeKey = subscribeKey,
                publishKey = publishKey,
                secretKey = secretKey,
                authKey = authKey,
                cryptoModule = cryptoModule,
                origin = origin,
                secure = secure,
                logVerbosity = logVerbosity,
                heartbeatNotificationOptions = heartbeatNotificationOptions,
                presenceTimeout = presenceTimeout,
                heartbeatInterval = heartbeatInterval,
                subscribeTimeout = subscribeTimeout,
                connectTimeout = connectTimeout,
                nonSubscribeReadTimeout = nonSubscribeReadTimeout,
                cacheBusting = cacheBusting,
                suppressLeaveEvents = suppressLeaveEvents,
                maintainPresenceState = maintainPresenceState,
                filterExpression = filterExpression,
                includeInstanceIdentifier = includeInstanceIdentifier,
                includeRequestIdentifier = includeRequestIdentifier,
                maximumConnections = maximumConnections,
                googleAppEngineNetworking = googleAppEngineNetworking,
                proxy = proxy,
                proxySelector = proxySelector,
                proxyAuthenticator = proxyAuthenticator,
                certificatePinner = certificatePinner,
                httpLoggingInterceptor = httpLoggingInterceptor,
                sslSocketFactory = sslSocketFactory,
                x509ExtendedTrustManager = x509ExtendedTrustManager,
                connectionSpec = connectionSpec,
                hostnameVerifier = hostnameVerifier,
                fileMessagePublishRetryLimit = fileMessagePublishRetryLimit,
                dedupOnSubscribe = dedupOnSubscribe,
                maximumMessagesCacheSize = maximumMessagesCacheSize,
                pnsdkSuffixes = pnsdkSuffixes,
                retryConfiguration = retryConfiguration,
                managePresenceListManually = managePresenceListManually,
            )
        }
    }
}