SalesforceSDK/com.salesforce.androidsdk.config/LoginServerManager

LoginServerManager

open class LoginServerManager

Class to manage login hosts (default and user entered).

Author

bhariharan

Constructors

Link copied to clipboard
constructor(ctx: Context)
Constructs a new login server manager.
@VisibleForTesting
constructor(ctx: Context, runtimeConfig: RuntimeConfig, serversXmlResourceId: Int)
Constructs a new login server manager.

Types

Link copied to clipboard
open class LoginServer
Class to encapsulate a login server name, URL, index and type (custom or not).

Properties

Link copied to clipboard
@VisibleForTesting
val IS_CUSTOM: String = "is_custom_%d"
Link copied to clipboard
@VisibleForTesting
val NUMBER_OF_ENTRIES: String = "number_of_entries"
Link copied to clipboard
val PRODUCTION_LOGIN_URL: String = "https://login.salesforce.com"
Link copied to clipboard
@VisibleForTesting
val RUNTIME_PREFS_FILE: String = "runtime_prefs_file"
Shared preferences when non-custom login servers are provided by runtime config Mobile Device Management (MDM)
Link copied to clipboard
val SANDBOX_LOGIN_URL: String = "https://test.salesforce.com"
Link copied to clipboard
Link copied to clipboard
@VisibleForTesting
val SERVER_NAME: String = "server_name_%d"
Link copied to clipboard
@VisibleForTesting
val SERVER_SELECTION_FILE: String = "server_selection_file"
Shared preferences for the selected login server
Link copied to clipboard
@VisibleForTesting
val SERVER_URL: String = "server_url_%d"
Link copied to clipboard
@VisibleForTesting
val SERVER_URL_FILE: String = "server_url_file"
Shared preferences when non-custom login servers are provided by resources servers.
Link copied to clipboard
val WELCOME_LOGIN_URL: String = "https://welcome.salesforce.com/discovery"

Functions

Link copied to clipboard
open fun addCustomLoginServer(@NonNull name: String, @NonNull url: String)
Adds a custom login server.
Link copied to clipboard
open fun getLoginServerFromURL(url: String): LoginServerManager.LoginServer
Returns a LoginServer instance from URL.
Link copied to clipboard
open fun getLoginServers(): List<LoginServerManager.LoginServer>
Returns the list of login servers.
Link copied to clipboard
open fun getLoginServersFromPreferences(): List<LoginServerManager.LoginServer>
Returns the list of login servers from resources (servers.xml) and the user's custom servers.
@VisibleForTesting
@NonNull
open fun getLoginServersFromPreferences(prefs: SharedPreferences): List<LoginServerManager.LoginServer>
Returns the list of all saved servers, including custom servers.
Link copied to clipboard
open fun getLoginServersFromRuntimeConfig(): List<LoginServerManager.LoginServer>
Resets the list of Mobile Device Management (MDM) login servers from the runtime configuration.
Link copied to clipboard
open fun getSelectedLoginServer(): LoginServerManager.LoginServer
Returns the selected login server.
Link copied to clipboard
open fun isMyDomainServer(@NonNull serverUrl: String): Boolean
Returns true when serverUrl is a My Domain server: host ends with .my.salesforce.com or contains .my.
Link copied to clipboard
open fun isPoolServer(@NonNull serverUrl: String): Boolean
Returns true when serverUrl is one of the three Salesforce pool (non-my-domain) servers.
Link copied to clipboard
open fun isProductionLoginServer(@NonNull serverUrl: String): Boolean
Returns true when serverUrl is the production login pool: https://login.salesforce.com or internal variants like https://login.test1.pc-rnd.salesforce.com.
Link copied to clipboard
open fun removeServer(server: LoginServerManager.LoginServer)
Removes a custom login server from the list.
@VisibleForTesting
open fun removeServer(server: LoginServerManager.LoginServer, sharedPreferences: SharedPreferences, allowNonCustomRemoval: Boolean)
Removes a login server from the list.
Link copied to clipboard
open fun reorderCustomLoginServer(originalIndex: Int, updatedIndex: Int)
Reorders a custom login server in the list of login servers.
Link copied to clipboard
open fun replaceCustomLoginServer(originalCustomLoginServer: LoginServerManager.LoginServer, updatedCustomLoginServer: LoginServerManager.LoginServer)
Replaces one custom login server with another.
Link copied to clipboard
open fun reset()
Clears all saved custom servers.
Link copied to clipboard
open fun setSelectedLoginServer(server: LoginServerManager.LoginServer)
Sets the currently selected login server to display.
Link copied to clipboard
open fun useSandbox()
Selects Sandbox as login server (used in tests).