foundation/com.sap.cloud.mobile.foundation.common

Package-level declarations

Types

open class About

A utility class to retrieve information about the SAP BTP SDK for Android, operating system, brand, model, and manufacturer.

AttestationTokenInvalidException

object ~~AttestationTokenInvalidException~~ : SDKExceptions

AttestationTokenMissingException

object ~~AttestationTokenMissingException~~ : SDKExceptions

BlockedByAdminException

class BlockedByAdminException(msg: String) : SDKExceptions

Represents the exception encountered when calling an API because the admin locks the network traffic or the registration of the user.

BlockedByNetworkPolicy

class BlockedByNetworkPolicy(msg: String) : SDKExceptions

ClientProvider

object ClientProvider

Facilitates keeping a global reference to a Networking Client that has been initialized with all the necessary Authentication and other interceptors. Generally the application developer will set the initialized okHttpClient once and get it from any where a okHttpClient is needed for the server communication. The set must be called at least once.

CpmsParameters

open class ~~CpmsParameters~~

DiscoveryService

class DiscoveryService(context: Context)

Represents the service to retrieve AppConfig from discovery service, it will try to call API without application version information, if failed, then try with version.

DiscoveryServiceProvider

open class DiscoveryServiceProvider

Facilitates keeping a global reference to discovery service host.

EmptyLogUploadException

object EmptyLogUploadException : SDKExceptions

EmptyUsageUploadException

object EmptyUsageUploadException : SDKExceptions

EncryptionError

class EncryptionError : Exception

Signals that an error occurred during encryption.

EncryptionInputStream

open class EncryptionInputStream : FilterInputStream

This class provides a wrapper for an InputStream that encrypts or decrypts the bytes as they are read.

EncryptionOutputStream

open class EncryptionOutputStream : FilterOutputStream

This class provides a wrapper for an OutputStream that encrypts or decrypts the bytes as they are read.

EncryptionState

enum EncryptionState

Describes different encryption states associated with the encryption key generation mechanisms.

EncryptionUtil

open class EncryptionUtil

Provides a protected storage for the users to generate and access their encryption key associated with an alias.

RawEncryption

open class RawEncryption

This class provides methods to encrypt and decrypt byte streams and byte arrays.

SDKExceptions

abstract class SDKExceptions(val message: String, val code: ServiceErrorCode = ServiceErrorCode.UNKNOWN) : Exception

Represents the exception used for all services.

SettingsParameters

open class SettingsParameters

This Class holds the basic settings parameters There are ApplicationId, deviceID, applicationVersion,backendURL, and version of the server

SettingsProvider

open class SettingsProvider

Facilitates keeping a global reference to application SettingsParameters, including ApplicationId, deviceID, applicationVersion,backendURL, and version of the server.

ThemeDownloadEmptyResponseBodyException

class ThemeDownloadEmptyResponseBodyException(msg: String) : SDKExceptions

ThemeDownloadUnzipFailedException

class ThemeDownloadUnzipFailedException(msg: String) : SDKExceptions

ThemeIsNotAvailableException

class ThemeIsNotAvailableException(msg: String) : SDKExceptions

ThemeNotModifiedException

class ThemeNotModifiedException(msg: String) : SDKExceptions

UserSessionInvalidException

class UserSessionInvalidException(msg: String) : SDKExceptions

WipedByAdminException

class WipedByAdminException(msg: String) : SDKExceptions

Functions

addUniqueInterceptor

@JvmOverloads

fun OkHttpClient.addUniqueInterceptor(interceptor: Interceptor, save: Boolean = true): OkHttpClient

Creates a new instance of OkHttpClient after adding the given interceptor, and saves it into ClientProvider if save is true.

addUniqueNetworkInterceptor

@JvmOverloads

fun OkHttpClient.addUniqueNetworkInterceptor(interceptor: Interceptor, save: Boolean = true): OkHttpClient

Creates a new instance of OkHttpClient after adding the given network interceptor, and saves it into ClientProvider if save is true.

isAttestationFailure

fun Exception.~~isAttestationFailure~~(): Boolean

isCausedBy

inline fun <T : SDKExceptions> Exception.isCausedBy(): Boolean

Checks whether the current 'Exception' is caused by Android Attestation. This is usually being used to check the exception thrown from interceptors to see the real cause.

isUnauthorized

fun Exception.isUnauthorized(): Boolean

Checks whether the current 'Exception' is caused by OAuth token expiration. This may usually be used in widget request calls when the widget wants to know the exact reason the request failure thus show meaningful messages on the UI.

newSilentCall

fun OkHttpClient.newSilentCall(request: Request): Call

Creates a 'silent' call when refresh token expires or SAML session expires, automatic re-authentication process will not be started.

removeDuplicateInterceptors

fun OkHttpClient.removeDuplicateInterceptors(save: Boolean = true): OkHttpClient

Removes duplicate interceptors and network interceptors and save the result back to ClientProvider if save is true.

removeInterceptor

@JvmOverloads

fun OkHttpClient.removeInterceptor(interceptor: Interceptor, save: Boolean = true): OkHttpClient

Removes the interceptor identified by the type of the given interceptor from the current OkHttpClient, and save the result back to ClientProvider if save is true.

removeInterceptorByType

@JvmOverloads

fun <T : KClass<out Interceptor>> OkHttpClient.removeInterceptorByType(interceptorClazz: T, save: Boolean = true): OkHttpClient

Removes the interceptor of the given type interceptorClazz, and save it back to ClientProvider if save is true.

silent

fun OkHttpClient.silent(): OkHttpClient

Clones the 'OkHttpClient' into a silent mode, this is only applicable for OAuth2 and SAML, and mostly be used for OData calls.

Properties

ALLOW_OPEN_URL

const val ALLOW_OPEN_URL: String