foundation/com.sap.cloud.mobile.foundation.authentication

Package-level declarations

Types

class AppLifecycleCallbackHandler : Application.ActivityLifecycleCallbacks

This class keeps track of the application's current activity. It is important to register this callback, otherwise the authentication interceptors will not be able to handle challenges properly! The recommended way to register this callback is by overriding android.app.Application and calling registerActivityLifecycleCallbacks from onCreate.

AuthenticationUiCallback

interface AuthenticationUiCallback

An application can control whether UI is shown by implementing this interface.

AuthenticationUiCallbackManager

open class 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.

BasicAuthActivity

open class BasicAuthActivity : Activity

BasicAuthCredentialStore

interface BasicAuthCredentialStore

This interface is used by BasicAuthDialogAuthenticator to store Basic Auth credentials to reuse on future challenges.

BasicAuthDialogAuthenticator

open class BasicAuthDialogAuthenticator : Authenticator

This class is an implementation of Authenticator (see https://square.github.io/okhttp/3.x/okhttp/okhttp3/Authenticator.html) that gets credentials from the user via a dialog.

BasicAuthInMemoryStore

open class BasicAuthInMemoryStore : BasicAuthCredentialStore

This class implements BasicAuthCredentialStore by simply keeping a hashmap in memory (there is no persistence across app restarts).

BasicAuthPersistentStore

open class BasicAuthPersistentStore : BasicAuthCredentialStore

This class implements BasicAuthCredentialStore by persisting credentials in com.sap.cloud.mobile.foundation.securestore.SecureKeyValueStore

BrowserDetails

open class BrowserDetails : Serializable

Contains details about a browser.

BrowserWhitelist

open class BrowserWhitelist : Serializable

A whitelist of browsers.

CertificateFailureInterceptor

open class CertificateFailureInterceptor : Interceptor

This class helps recover from certificate failures caused by waiting for a client certificate to be provided.

CertificateProvider

interface CertificateProvider

Interface definition for a class that will be called when a certificate challenge is received.

CertificateRequest

open class CertificateRequest

The certificate request includes information to help choose the client certificate.

ChooseCertificateProvider

class ChooseCertificateProvider @JvmOverloads constructor(aliasStore: ChooseCertificateProvider.AliasStore? = null) : CertificateProvider

An implementation of the {@link CertificateProvider} that present the dialog to choose the certificate from device. The User selection can be saved in {@link AliasStore} if provided and the dialog will not show again. {@link AliasStore} only work when application is alive

IBackPress

interface IBackPress

NestedWebView

open class NestedWebView : WebView, NestedScrollingChild

Immersive style WebView

OAuth2AuthorizationActivity

class OAuth2AuthorizationActivity : Activity

OAuth2BrowserProcessor

open class OAuth2BrowserProcessor : OAuth2Processor

Handles authentication with OAuth2.

OAuth2ClientCredentialGrantProcessor

open class OAuth2ClientCredentialGrantProcessor : OAuth2Processor

OAuth2Configuration

open class ~~OAuth2Configuration~~ : Serializable

OAuth2Exception

open class OAuth2Exception : IOException

Indicates a OAuth2 error response during the authorization.

OAuth2Interceptor

class OAuth2Interceptor @JvmOverloads constructor(var oauth2Processor: OAuth2Processor, var tokenStore: OAuth2TokenStore = OAuth2TokenInMemoryStore()) : Interceptor

This class implements a okhttp3.Interceptor which enables OAuth authentication.

OAuth2PasswordProcessor

class OAuth2PasswordProcessor(oAuthConfig: OAuthConfig, oAuthClient: OAuthClientPassword?, okHttpClient: OkHttpClient?) : OAuth2Processor

Handles authentication with OAuth2 One-time Passcode. In the type of OAuthClientPassword as designated OAuth2 client, it can authenticate with server programmatically without launching webview or browser.

OAuth2Processor

abstract class OAuth2Processor

This class is used by OAuth2Interceptor to authenticate when it detects an OAuth challenge.

OAuth2RedirectActivity

class OAuth2RedirectActivity : Activity

Used to signal the end of OAuth2 authorization. An application doesn't need to use this class directly, but this class needs to have a correct tag in AndroidManifest.xml. By default this activity is in the AndroidManifest.xml with a scheme that is the app ID. The scheme must match the scheme of the redirect URL that is part of the OAuth security settings for the application on the server. If a non-default scheme is required, add a tag like this to AndroidManifest.xml inside the application tag:

OAuth2Token

@Serializable

class OAuth2Token : Serializable

This class keeps all relevant OAuth token information.

OAuth2TokenInMemoryStore

open class OAuth2TokenInMemoryStore : OAuth2TokenStore

OAuth2TokenPersistentStore

open class OAuth2TokenPersistentStore : OAuth2TokenStore

This class implements OAuth2TokenStore by persisting credentials in com.sap.cloud.mobile.foundation.securestore.SecureKeyValueStore

OAuth2TokenStore

interface OAuth2TokenStore

This class takes care of storing (and potentially persisting) the OAuth token.

OAuth2WebOption

enum OAuth2WebOption : Enum<OAuth2WebOption>

Represents the OAuth2 authentication option to use with either WebView, CCT or Browser

OAuth2WebViewProcessor

open class OAuth2WebViewProcessor : OAuth2Processor

This class is used by OAuth2Interceptor to authenticate when it detects an OAuth challenge.

OtpConfiguration

open class OtpConfiguration

This class holds all the information for OTP (one time passcode) configuration.

OtpInterceptor

open class OtpInterceptor : Interceptor

This class implements a okhttp3.Interceptor which enables OTP authentication.

OtpProcessor

interface OtpProcessor

This interface is used by the OtpInterceptor to authenticate when it detects an OTP challenge.

OtpResponseActivity

open class OtpResponseActivity : Activity

This class receives the intent from SAP Authenticator with the one time passcode data (in the form of a Uri).

OtpWebViewProcessor

open class OtpWebViewProcessor : OtpProcessor, OtpResultListener

This class uses android.webkit.WebView to implement OtpProcessor.

SamlConfiguration

open class SamlConfiguration

This class holds all the information of a SAML configuration.

SamlInterceptor

class SamlInterceptor : Interceptor

Enables SAML authentication with OkHttp by implementing a okhttp3.Interceptor. This class detects SAML challenges, but uses a SamlProcessor to authenticate when a challenge is detected. If a SamlProcessor is not specified, SamlWebViewProcessor is used by default.

SamlProcessor

interface SamlProcessor

This interface is used by the SamlInterceptor to authenticate when it detects a SAML challenge.

SamlWebViewProcessor

open class SamlWebViewProcessor : SamlProcessor

This class uses android.webkit.WebView to implement SamlProcessor.

SslClientAuth

open class SslClientAuth

This class is meant to be used with the okhttp3.OkHttpClient.

SystemCertificateProvider

class SystemCertificateProvider(aliasStore: SystemCertificateProvider.AliasStore? = null) : CertificateProvider

An implementation of the CertificateProvider that provides certificates available in the android.security.KeyChain.

WebViewActivity

open class WebViewActivity : AppCompatActivity