Class Index



About A utility class to retrieve version information for the SAP Cloud Platform SDK, and OS, and brand, model, and manufacturer information. 
AppHeadersInterceptor This interceptor is responsible to set required headers for communication with services exposed by SAPcpms. 
AppLifecycleCallbackHandler This class keeps track of the application's current activity. 
AppUsage The SAP Cloud Platform Mobile Services server supports a specific format of Usage data and event types, its client Usage implementation AppUsage follows the Usage Framework API (Usage) and provides simplified utility methods and encrypted usage store. 
AppUsageInfo A helper class that embeds usage event information and provides chained setter methods to set values with Cloud Platform Mobile Service specific keys. 
AppUsageUploader This class is used for uploading client usage information to SAP Cloud Platform Mobile Services. 
AppUsageUploader.UploadListener Listener for the AppUsageUploader to dispatch usage upload events-- progress and completion status. 
AuthenticationUiCallback An application can control whether UI is shown by implementing this interface. 
AuthenticationUiCallbackManager This class provides a place to set and call the AuthenticationUiCallback that decides whether to allow UI to be shown to authenticate the user. 


BackingStoreException Signals that an error occurred during SecureDatabaseResultSet or SecureDatabaseStore operations. 
BasicAuthCredentialStore This interface is used by BasicAuthDialogAuthenticator to store Basic Auth credentials to reuse on future challenges. 
BasicAuthDialogAuthenticator This class is an implementation of Authenticator (see that gets credentials from the user via a dialog. 
BasicAuthInMemoryStore This class implements BasicAuthCredentialStore by simply keeping a hashmap in memory (there is no persistence across app restarts). 
BasicAuthPersistentStore This class implements BasicAuthCredentialStore by persisting credentials in SecureKeyValueStore  
BlockedUserInterceptor This Interceptor is responsible for informing the application that the user has been blocked from communicating with the server. 
BlockedUserInterceptor.BlockedUserCallback Callback interface used to handle a user blocked event. 
BlockedUserInterceptor.BlockType Specifies the type of user block that occurred. 
BrowserDetails Contains details about a browser. 
BrowserWhitelist A whitelist of browsers. 


Cache<K, V> In general, a cache is a key/value store that has a maximum storage capacity and exposes methods to support CRUD operations to provide temporary storage which maintains a single copy of items that are expensive to create or load, for example via remote network calls. 
CacheBase<K, V> Abstract class for Cache implementations. 
CacheCostFactor<K> In parallel to the Cache Replacement Policy, the optional Cost Factor feature described here provides the eviction mechanism for a Cache implementation to remove one or more existing cache entries so that a new item can be added (via put(Object, Object, double)) when the aggregated cost exceeds the maximum total cost:

  1. During cache initialization, the cache implementation should have method(s) to let the user specify the maximum total cost, and a CacheCostFactor instance that implements onExceedMaxCost(List)
CacheEntry<K, V> A read-only helper class used as the return value of getEntry(Object)
CertificateFailureInterceptor This class helps recover from certificate failures caused by waiting for a client certificate to be provided. 
CertificateProvider Interface definition for a class that will be called when a certificate challenge is received. 
CertificateRequest The certificate request includes information to help choose the client certificate. 
ClientProvider Facilitates keeping a global reference to a Networking Client that has been initialized with all the necessary Authentication and other interceptors. 
ClientResources The ClientResources class that implements APIs to download client resources or retrieve information about resources from mobile services. 
ClientResources.CallbackListener<T> Interface definition for callback handler for operation. 
ClientResourceService Client to auto download clientresource from server  
CompositeCache<K, V>


is a multi-level cache container that implements the Cache interface. 
ConfigurationLoader The main entry point, responsible for configuration retrieval, provider processing, retries, input and error callbacks. 
ConfigurationLoaderCallback Callbacks for the providers. 
ConfigurationPersistenceException An Exception thrown by a ConfigurationPersiter when there is an error persisting the given configuration data. 
ConfigurationPersister Output handler contract. 
ConfigurationProvider Configuration provider contract. 
ConfigurationProviderError Represents an error generated by a configuration provider. 
CorrelationInterceptor This interceptor adds a X-SAP-CorrelationID header to each request. 
CpmsParameters This class is deprecated. As of release 2.2, use SettingsProvider to hold global reference for SettingsParameters Facilitates keeping a global reference to a SettingsParameters that has been initialized with all the settings-- HCPMS server URL, application ID, application version, and device ID.

Generally, the application developer will initialize the SettingsParameters once and get it from any where a oSettingsParameters is needed for the server communication.

The init(SettingsParameters) must be called once and only once.  

CreateDatabaseCallback This interface is used to provide callback methods to create or update database objects when instantiating Secure Database Store via SecureDatabaseStore(Context, String, int, CreateDatabaseCallback)
CsrfTokenInterceptor This interceptor is responsible for setting the X-CSRF-Token header for communication with services exposed by SAPcpms. 


DefaultManagedConfigToJsonConverter Provides the default method for converting managed configuration data to Json. 
DefaultPersistenceMethod Default Persistence Method. 
DiscoveryServiceConfigurationProvider One of the default ConfigurationProviders, it obtains configuration data from the Discovery Service. 


EncryptionError Signals that an error occurred during encryption. 
EncryptionInputStream This class provides a wrapper for an InputStream that encrypts or decrypts the bytes as they are read. 
EncryptionOutputStream This class provides a wrapper for an OutputStream that encrypts or decrypts the bytes as they are read. 
EncryptionState Describes different encryption states associated with the encryption key generation mechanisms. 
EncryptionUtil Provides a protected storage for the users to generate and access their encryption key associated with an alias. 


FileClosedException Signals that an operation is attempted when the associated SecureDatabaseResultSet, SecureDatabaseStore, or SecureKeyValueStore has been closed. 
FileConfigurationProvider One of the default ConfigurationProviders, it obtains JSON configuration data from the application's resource file. 
FileMissingException Signals that underlying persistence store file does not exist. 


HttpException Exception for an HTTP response that is unexpected. 


JsonConfigurationProvider One of the default ConfigurationProviders, it obtains configuration data from JSON data supplied as user input. 


LastConnectionTimeInterceptor This Interceptor is responsible for informing the application that a successful connetion with the server has occurred so that the last connection time can be updated. 
LastConnectionTimeInterceptor.LastConnectionTimeCallback Callback interface used to handle an update last connection time event. 
LockWipePolicy The class responsible for defining and applying the lock and wipe policies. 
LockWipePolicy.LockCallback Callback interface used to handle a lock event. 
LockWipePolicy.WipeCallback Callback interface used to handle a wipe event. 
Logging The SAP Cloud Platform SDK for Android uses Simple Logging Facade for Java (SLF4J) for it's logging API. 
Logging.ConfigurationBuilder Builder class to build configuration for
Logging.UploadListener Listener used to dispatch log upload events. 
Logging.UploadType Upload types, where:

means, upload the current contents of the log. 
LogService Log service is responsible for initializing logging facility. 


ManagedConfigToJsonConverter Defines the contract for converting managed configuration data to Json. 
ManagedConfigurationProvider One of the default ConfigurationProviders, it obtains configuration data from the Enterprise Mobility Management ( EMM ) settings. 
MemoryCache<K, V> MemoryCache is a fixed size in-memory cache that uses weak reference keys to store a set of values with the following features and options:
  1. LRU (Least Recently Used) Cache Replacement Policy: Each time a value is accessed, it is moved to the end of a queue in descending LRU order. 
MobileService abstract class that each service need implements it  
MobileServices Represents the facade to initialize mobile services. 


OAuth2BrowserProcessor Handles authentication with OAuth2. 
OAuth2Configuration This class holds all the information of an OAuth configuration. 
OAuth2Configuration.Builder Used to build a OAuth2Configuration object. 
OAuth2Exception Indicates a OAuth2 error response during the authorization. 
OAuth2Interceptor This class implements a Interceptor which enables OAuth authentication. 
OAuth2Processor This class is used by OAuth2Interceptor to authenticate when it detects an OAuth challenge. 
OAuth2RedirectActivity Used to signal the end of OAuth2 authorization. 
OAuth2Token This class keeps all relevant OAuth token information. 
OAuth2TokenPersistentStore This class implements OAuth2TokenStore by persisting credentials in SecureKeyValueStore  
OAuth2TokenStore This class takes care of storing (and potentially persisting) the OAuth token. 
OAuth2WebViewProcessor This class is used by OAuth2Interceptor to authenticate when it detects an OAuth challenge. 
OpenFailureException Signals that an error occurred when opening the Secure Database. 
OtpConfiguration This class holds all the information for OTP (one time passcode) configuration. 
OtpConfiguration.Builder This class is used to build a OtpConfiguration object. 
OtpInterceptor This class implements a Interceptor which enables OTP authentication. 
OtpProcessor This interface is used by the OtpInterceptor to authenticate when it detects an OTP challenge. 
OtpResponseActivity This class receives the intent from SAP Authenticator with the one time passcode data (in the form of a Uri). 
OtpWebViewProcessor This class uses WebView to implement OtpProcessor


PermissionNotGrantedException This class gives information about errors the SDK can't handle. 
Progress This class provides methods that allow the handling of progress events. 
ProgressListener This interface is used with Progress
ProviderConfiguration Providers all extend from this class and use it to provide. 
ProviderIdentifier Contains the provider identifiers for the default providers used in the ConfigurationLoader
ProviderInputs Property map containing key value pairs which represent the user input fields and the user response data that will be supplied to the associated provider. 
PushCallbackListener callBack to receive the message sent from push  
PushNotificationActionReceiver Receiver to handle cancel notification  
PushNotificationBroadcastReceiver This class is registered by the application to receive FCM notifications. 
PushRemoteMessage notification model  
PushService push service which can register/remove push token and change the notification status  
PushService.NotificationStatus notification status  


RawEncryption This class provides methods to encrypt and decrypt byte streams and byte arrays. 
RemoteNotificationClient Provides an API interface for updating and managing notification related parameter with the mobile cloud platform. 
RemoteNotificationClient.CallbackListener Interface for callback in the async operation. 
RemoteNotificationConfig This class contains all the constant values that we use for handling remote notifications  
RemoteNotificationParameters RemoteNotificationParameters class provides an API for managing the Notification configuration parameters. 
RemoteNotificationParameters.Builder Used to build a RemoteNotificationParameters object. 
RemoteNotificationParameters.Capability This class keeps the capability value. 
RemoteNotificationParameters.LastKnownLocation This class object is used to keep the longitude/latitude values  
ResourceBundle Class that represents a resource. 


SamlConfiguration This class holds all the information of a SAML configuration. 
SamlConfiguration.Builder Used to build a SamlConfiguration object. 
SamlInterceptor Enables SAML authentication with OkHttp by implementing a Interceptor
SamlProcessor This interface is used by the SamlInterceptor to authenticate when it detects a SAML challenge. 
SamlWebViewProcessor This class uses WebView to implement SamlProcessor
SAPFirebaseMessagingService This service is responsible for handling the FCM remote notifications. 
SDKApplicationState Represents the application state. 
SecureDatabaseResultSet Executing a SQL query returns a SecureDatabaseResultSet object. 
SecureDatabaseStore Secure Database Store provides transparent 256-bit AES encryption of data stored in a SQLite database. 
SecureKeyValueStore The SecureKeyValueStore is used to persist key-value pairs using an encrypted backing store. 
SecurePreferenceDataStore A PreferenceDataStore implementation encrypts contents using 256-bit AES encryption, and is provided to the Preference framework via setPreferenceDataStore(PreferenceDataStore)
SecureStoreCache<V extends Serializable> A SecureStoreCache is a fixed size LRU (Least Recently Used) cache that contains key-value pairs persisted in an encrypted database. 
SessionCreatedCheckinterceptor to check if the onboarding is success and send the notification to the registered services  
Settings SAP cloud mobile Settings class provides an API interface to get the application connection settings from the server and also to update these settings. 
Settings.CallbackListener Interface for callback in the async operation  
Settings.KeyPath This inner public class define common settings key paths. 
Settings.SettingTarget Enumeration to specify what is the settings target level to be used
  • APPLICATION: This is an application level property list. 

  • SettingService auto download setting from server when app from background to foreground  
    SettingsParameters This Class holds the basic settings parameters There are ApplicationId, deviceID, applicationVersion,backendURL, and version of the server  
    SettingsParameters.PushService Enumeration to use different push services ANDROID is to choose all google push services BAIDU is to choose BAIDU push service  
    SettingsProvider Facilitates keeping a global reference to application SettingsParameters, including ApplicationId, deviceID, applicationVersion,backendURL, and version of the server. 
    SslClientAuth This class is meant to be used with the OkHttpClient
    SystemCertificateProvider An implementation of the CertificateProvider that provides certificates available in the KeyChain
    SystemCertificateProvider.AliasStore An interface used for persisting the aliases the user has selected from the KeyChain


    TransactionFailureException Signals that an error occurred during database transaction related operations. 
    TypeConversionException Signals that an error occurred when converting data types during operations of SecureKeyValueStore, SecureDatabaseStore, or SecureDatabaseResultSet


    Usage This class serves as the entry point to a set of framework APIs that allow you to extend and implement your own usage reporting based on your own server, to collect, store, and upload client usage events in a flexible way. 
    UsageBroker Collect, store and upload client usage events in a flexible way and send it to an analytics server. 
    UsageInfo This class embeds name/value pair properties in a HashMap and is part of a UsageRecord
    UsageRecord<T extends Enum<T>> A Usage Record represents a single unit of usage information reported by a UsageReporter, it contains a Date, UsageInfo, and a user defined event implemented as an Enum instance. 
    UsageReporter Each Usage Reporter is assigned a Target ID, and reports usage by persisting the UsageRecords into the UsageStore
    UsageService Represents the facade to initialize the usage feature. 
    UsageSnapshot This is the interface that defines the behavior of a usage snapshot object. 
    UsageStore Provides interface for the store object to persist the UsageRecord reported by all UsageReporters. 
    UserInfo This class represent Information about user. 
    UserInputs User Input contains a list of each provider and the providers ProviderInput As each provider requires input, the loader will pass its ProviderInput data. 
    UserRoles Loads information about the current user from SAP Cloud Platform mobile services. 
    UserRoles.CallbackListener Interface for callback in the async operation  
    UserRoleService service to auto download the user role  
    UserRoleService.UserInfoChangeListenner interface to get the user info  


    WebkitCookieJar This class implements CookieJar by storing/getting all cookies with CookieManager