com.salesforce.androidsdk.config

Class LoginServerManager

java.lang.Object

com.salesforce.androidsdk.config.LoginServerManager

public class LoginServerManager
extends java.lang.Object

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

Author:

bhariharan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoginServerManager.LoginServer Class to encapsulate a login server name, URL, index and type (custom or not).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IS_CUSTOM
static java.lang.String	NUMBER_OF_ENTRIES
static java.lang.String	PRODUCTION_LOGIN_URL
static java.lang.String	RUNTIME_PREFS_FILE Shared preferences when non-custom login servers are provided by runtime config Mobile Device Management (MDM)
static java.lang.String	SANDBOX_LOGIN_URL
<any>	selectedServer
static java.lang.String	SERVER_NAME
static java.lang.String	SERVER_SELECTION_FILE Shared preferences for the selected login server
static java.lang.String	SERVER_URL
static java.lang.String	SERVER_URL_FILE Shared preferences when non-custom login servers are provided by resources servers.xml
static java.lang.String	WELCOME_LOGIN_URL

Constructor Summary

Constructors

Constructor and Description
LoginServerManager(Context ctx) Constructs a new login server manager.
LoginServerManager(Context ctx, RuntimeConfig runtimeConfig, int serversXmlResourceId) Constructs a new login server manager.

Method Summary

Modifier and Type	Method and Description
void	addCustomLoginServer(java.lang.String name, java.lang.String url) Adds a custom login server.
LoginServerManager.LoginServer	getLoginServerFromURL(java.lang.String url) Returns a LoginServer instance from URL.
java.util.List<LoginServerManager.LoginServer>	getLoginServers() Returns the list of login servers.
java.util.List<LoginServerManager.LoginServer>	getLoginServersFromPreferences() Returns the list of login servers from resources (servers.xml) and the user's custom servers.
java.util.List<LoginServerManager.LoginServer>	getLoginServersFromPreferences(SharedPreferences prefs) Returns the list of all saved servers, including custom servers.
java.util.List<LoginServerManager.LoginServer>	getLoginServersFromRuntimeConfig() Resets the list of Mobile Device Management (MDM) login servers from the runtime configuration.
LoginServerManager.LoginServer	getSelectedLoginServer() Returns the selected login server.
void	removeServer(LoginServerManager.LoginServer server) Removes a custom login server from the list.
void	removeServer(LoginServerManager.LoginServer server, SharedPreferences sharedPreferences, boolean allowNonCustomRemoval) Removes a login server from the list.
void	reorderCustomLoginServer(int originalIndex, int updatedIndex) Reorders a custom login server in the list of login servers.
void	replaceCustomLoginServer(LoginServerManager.LoginServer originalCustomLoginServer, LoginServerManager.LoginServer updatedCustomLoginServer) Replaces one custom login server with another.
void	reset() Clears all saved custom servers.
void	setSelectedLoginServer(LoginServerManager.LoginServer server) Sets the currently selected login server to display.
void	useSandbox() Selects Sandbox as login server (used in tests).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

selectedServer

public <any> selectedServer

PRODUCTION_LOGIN_URL

public static final java.lang.String PRODUCTION_LOGIN_URL

See Also:

Constant Field Values

WELCOME_LOGIN_URL

public static final java.lang.String WELCOME_LOGIN_URL

See Also:

Constant Field Values

SANDBOX_LOGIN_URL

public static final java.lang.String SANDBOX_LOGIN_URL

See Also:

Constant Field Values

SERVER_URL_FILE

public static final java.lang.String SERVER_URL_FILE

Shared preferences when non-custom login servers are provided by resources servers.xml

See Also:

Constant Field Values

RUNTIME_PREFS_FILE

public static final java.lang.String RUNTIME_PREFS_FILE

Shared preferences when non-custom login servers are provided by runtime config Mobile Device Management (MDM)

See Also:

Constant Field Values

NUMBER_OF_ENTRIES

public static final java.lang.String NUMBER_OF_ENTRIES

See Also:

Constant Field Values

SERVER_NAME

public static final java.lang.String SERVER_NAME

See Also:

Constant Field Values

SERVER_URL

public static final java.lang.String SERVER_URL

See Also:

Constant Field Values

IS_CUSTOM

public static final java.lang.String IS_CUSTOM

See Also:

Constant Field Values

SERVER_SELECTION_FILE

public static final java.lang.String SERVER_SELECTION_FILE

Shared preferences for the selected login server

See Also:

Constant Field Values

Constructor Detail

LoginServerManager

public LoginServerManager(Context ctx)

Constructs a new login server manager.

Parameters:

ctx - The context

LoginServerManager

public LoginServerManager(Context ctx,
                          RuntimeConfig runtimeConfig,
                          int serversXmlResourceId)

Constructs a new login server manager.

Parameters:

ctx - The context

Method Detail

getLoginServerFromURL

public LoginServerManager.LoginServer getLoginServerFromURL(java.lang.String url)

Returns a LoginServer instance from URL.

Parameters:

url - Server URL.

Returns:

Matching LoginServer instance if found, or null.

getSelectedLoginServer

public LoginServerManager.LoginServer getSelectedLoginServer()

Returns the selected login server. This will set a default login server if needed and ensure the selected login server is available in the current list of login servers.

Returns:

The selected login server

setSelectedLoginServer

public void setSelectedLoginServer(LoginServerManager.LoginServer server)

Sets the currently selected login server to display.

Parameters:

server - LoginServer instance.

useSandbox

public void useSandbox()

Selects Sandbox as login server (used in tests).

addCustomLoginServer

public void addCustomLoginServer(java.lang.String name,
                                 java.lang.String url)

Adds a custom login server.

Parameters:

name - The login server name

url - The login server URL

reset

public void reset()

Clears all saved custom servers.

removeServer

public void removeServer(LoginServerManager.LoginServer server)

Removes a custom login server from the list.

Parameters:

server - The server to remove. If the server is not custom, this method does nothing

removeServer

public void removeServer(LoginServerManager.LoginServer server,
                         SharedPreferences sharedPreferences,
                         boolean allowNonCustomRemoval)

Removes a login server from the list.

Parameters:

server - The server to remove

sharedPreferences - The shared preferences to remove the server from

allowNonCustomRemoval - Boolean true allows the removal of non-custom login servers and false does not

getLoginServers

public java.util.List<LoginServerManager.LoginServer> getLoginServers()

Returns the list of login servers. Defaults to mobile device management (MDM) login servers from the runtime configuration, if available, or resources login servers from the servers.xml. MDM and resources login servers are not custom and cannot be removed by the user. A separate list of custom login servers is stored in a shared preferences for each of MDM and resources.

Returns:

The list of login servers

getLoginServersFromRuntimeConfig

public java.util.List<LoginServerManager.LoginServer> getLoginServersFromRuntimeConfig()

Resets the list of Mobile Device Management (MDM) login servers from the runtime configuration. This does not remove the user's custom login servers.

Returns:

The list of login servers from the runtime configuration, not including the user's custom login servers

getLoginServersFromPreferences

public java.util.List<LoginServerManager.LoginServer> getLoginServersFromPreferences()

Returns the list of login servers from resources (servers.xml) and the user's custom servers. Note this does not consider login servers the runtime config provides from Mobile Device Management (MDM). Consider using getLoginServers() instead if you need to consider MDM login servers.

Returns:

The list of login servers from resources (servers.xml) and the user's custom servers

reorderCustomLoginServer

public void reorderCustomLoginServer(int originalIndex,
                                     int updatedIndex)

Reorders a custom login server in the list of login servers.

Parameters:

originalIndex - The original index of the custom login server. If this is not the index of a custom login server, this method will do nothing

updatedIndex - The new index of the custom login server. This must be after the last non-custom login server and within the updatable bounds of the list. If it is not it will be automatically corrected

replaceCustomLoginServer

public void replaceCustomLoginServer(LoginServerManager.LoginServer originalCustomLoginServer,
                                     LoginServerManager.LoginServer updatedCustomLoginServer)

Replaces one custom login server with another.

Parameters:

originalCustomLoginServer - The original custom login server. If this is not a custom login server or doesn't match an existing login server this method will do nothing.

updatedCustomLoginServer - The updated custom login server. If this is not a custom login server this method will do nothing.

getLoginServersFromPreferences

public java.util.List<LoginServerManager.LoginServer> getLoginServersFromPreferences(SharedPreferences prefs)

Returns the list of all saved servers, including custom servers.

Parameters:

prefs - SharedPreferences file.

Returns:

List of all saved servers.