||A utility class to retrieve version information for the SAP Cloud Platform SDK, and OS, and
brand, model, and manufacturer information.
||This interceptor is responsible to set required headers for communication with services exposed
||This class keeps track of the application's current activity.
||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 (
and provides simplified utility methods and encrypted usage store.
||A helper class that embeds usage event information and provides chained setter methods to set
values with Cloud Platform Mobile Service specific keys.
||This class is used for uploading client usage information to SAP Cloud Platform Mobile Services.
||Listener for the
AppUsageUploader to dispatch usage upload events-- progress
and completion status.
||An application can control whether UI is shown by implementing this interface.
||This class provides a place to set and call the
AuthenticationUiCallback that decides
whether to allow UI to be shown to authenticate the user.
||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.
||Abstract class for
||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
- During cache initialization, the cache implementation should have method(s) to let the user
specify the maximum total cost, and a
CacheCostFactor instance that
||A read-only helper class used as the return value of
||This class helps recover from certificate failures caused by waiting for a client certificate to
||Interface definition for a class that will be called when a certificate challenge is received.
||The certificate request includes information to help choose the client certificate.
||Facilitates keeping a global reference to a Networking Client that has been initialized
with all the necessary Authentication and other interceptors.
||The ClientResources class that implements APIs to download client resources or retrieve information
about resources from mobile services.
||Interface definition for callback handler for operation.
||Client to auto download clientresource from server
CompositeCache is a multi-level cache container that implements the Cache
||The main entry point, responsible for configuration retrieval, provider processing, retries,
input and error callbacks.
||Callbacks for the providers.
||An Exception thrown by a
when there is an error persisting the given configuration data.
||Output handler contract.
||Configuration provider contract.
||Represents an error generated by a configuration provider.
||This interceptor adds a X-SAP-CorrelationID header to each request.
This class is deprecated.
As of release 2.2, use
SettingsProvider to hold global reference for
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
and get it from any where a o
SettingsParameters is needed for the server
init(SettingsParameters) must be called once and only once.
||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).
||This interceptor is responsible for setting the X-CSRF-Token header for communication with
services exposed by SAPcpms.
||This class holds all the information of a SAML configuration.
||Used to build a
||Enables SAML authentication with OkHttp by implementing a
||This interface is used by the
SamlInterceptor to authenticate when it detects a SAML
||This class uses
WebView to implement
||This service is responsible for handling the FCM remote notifications.
||Represents the application state.
||Executing a SQL query returns a
||Secure Database Store provides transparent 256-bit AES encryption of data stored in a
||The SecureKeyValueStore is used to persist key-value pairs using an encrypted backing store.
PreferenceDataStore implementation encrypts contents using
256-bit AES encryption, and is provided to the
Preference framework via
|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.
||to check if the onboarding is success and send the notification to the registered services
||SAP cloud mobile Settings class provides an API interface to get the application connection
settings from the server and also to update these settings.
||Interface for callback in the async operation
||This inner public class define common settings key paths.
||Enumeration to specify what is the settings target level to be used
APPLICATION: This is an application level property list.
||auto download setting from server when app from background to foreground
||This Class holds the basic settings parameters
There are ApplicationId, deviceID, applicationVersion,backendURL, and version of the server
||Enumeration to use different push services
ANDROID is to choose all google push services
BAIDU is to choose BAIDU push service
||Facilitates keeping a global reference to application SettingsParameters, including
ApplicationId, deviceID, applicationVersion,backendURL, and version of the server.
||This class is meant to be used with the
||An implementation of the
CertificateProvider that provides certificates available in the
||An interface used for persisting the aliases the user has selected from the
||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.
||Collect, store and upload client usage events in a flexible way and send it to an analytics
||This class embeds name/value pair properties in a
HashMap and is part of a
|UsageRecord<T extends Enum<T>>
||A Usage Record represents a single unit of usage information reported by a
it contains a Date,
UsageInfo, and a user defined event implemented as an
||Each Usage Reporter is assigned a Target ID, and reports usage by persisting the
UsageRecords into the
||Represents the facade to initialize the usage feature.
||This is the interface that defines the behavior of a usage snapshot object.
||Provides interface for the store object to persist the
UsageRecord reported by all
||This class represent Information about user.
||User Input contains a list of each provider and the providers ProviderInput
As each provider requires input, the loader will pass its
||Loads information about the current user from SAP Cloud Platform mobile services.
||Interface for callback in the async operation
||service to auto download the user role
||interface to get the user info