com.salesforce.androidsdk.accounts

Class UserAccountManager

java.lang.Object

com.salesforce.androidsdk.accounts.UserAccountManager

public class UserAccountManager
extends java.lang.Object

This class acts as a manager that provides methods to access user accounts that are currently logged in, and can be used to add new user accounts.

Author:

bhariharan

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_USER_SWITCH_TYPE Represents how the current user has been switched to, as found in an intent sent to a android.content.BroadcastReceiver filtering USER_SWITCH_INTENT_ACTION.
static java.lang.String	USER_SWITCH_INTENT_ACTION
static int	USER_SWITCH_TYPE_DEFAULT A switch has occurred between two authenticated users.
static int	USER_SWITCH_TYPE_FIRST_LOGIN The first user has logged in and is being switched to.
static int	USER_SWITCH_TYPE_LOGIN An additional user has logged in and is being switched to.
static int	USER_SWITCH_TYPE_LOGOUT A user has a logged out and another authenticated user is being switched to.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserAccountManager() Protected constructor.

Method Summary

Modifier and Type	Method and Description
Account	buildAccount(UserAccount userAccount) Builds an Account object from the user account passed in.
UserAccount	buildUserAccount(Account account) Builds a UserAccount object from the saved account.
void	clearCachedCurrentUser() Get rid of cached current user account
Bundle	createAccount(UserAccount userAccount) Create AccountManager Account from the given UserAccount
boolean	doesUserAccountExist(UserAccount account) Returns whether the specified user account exists or not.
java.util.List<UserAccount>	getAuthenticatedUsers() Returns a list of authenticated users.
UserAccount	getCachedCurrentUser() Returns a cached value of the current user.
Account	getCurrentAccount() Returns the current user logged in.
UserAccount	getCurrentUser() Returns the current user logged in.
static UserAccountManager	getInstance() Returns a singleton instance of this class.
java.lang.String	getStoredOrgId() Returns the stored org ID.
java.lang.String	getStoredUserId() Returns the stored user ID.
UserAccount	getUserFromOrgAndUserId(java.lang.String orgId, java.lang.String userId) Retrieves a stored user account from org ID and user ID.
void	refreshToken(UserAccount userAccount) Attempts to refresh the access token for this user by making an API call to the "/token" endpoint.
void	sendUserSwitchIntent(int userSwitchType, Bundle extras) Broadcasts an intent that a user switch has occurred.
void	signoutCurrentUser(Activity frontActivity) Logs the current user out.
void	signoutCurrentUser(Activity frontActivity, boolean showLoginPage) Logs the current user out.
void	signoutCurrentUser(Activity frontActivity, boolean showLoginPage, OAuth2.LogoutReason reason) Logs the current user out.
void	signoutUser(UserAccount userAccount, Activity frontActivity) Logs the specified user out.
void	signoutUser(UserAccount userAccount, Activity frontActivity, boolean showLoginPage) Logs the specified user out.
void	signoutUser(UserAccount userAccount, Activity frontActivity, boolean showLoginPage, OAuth2.LogoutReason reason) Logs the specified user out.
void	storeCurrentUserInfo(java.lang.String userId, java.lang.String orgId) Stores the current active user's user ID and org ID in a shared preference file.
void	switchToNewUser() Kicks off the login flow to switch to a new user.
void	switchToNewUser(java.lang.String jwt, java.lang.String url) Kicks off the login flow to switch to a new user with jwt.
void	switchToUser(UserAccount user) Switches to the specified user account.
void	switchToUser(UserAccount user, int userSwitchType, Bundle extras) Switches to the specified user account.
Bundle	updateAccount(Account account, UserAccount userAccount) Update AccountManager Account for the given UserAccount

Methods inherited from class java.lang.Object

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

Field Detail

USER_SWITCH_INTENT_ACTION

public static final java.lang.String USER_SWITCH_INTENT_ACTION

See Also:

Constant Field Values

EXTRA_USER_SWITCH_TYPE

public static final java.lang.String EXTRA_USER_SWITCH_TYPE

Represents how the current user has been switched to, as found in an intent sent to a android.content.BroadcastReceiver filtering USER_SWITCH_INTENT_ACTION. User switching including logging in, logging out and switching between authenticated users. For backwards compatibility, the case where the last user has logged out is not included, as this currently does not send a broadcast.

See Also:

Constant Field Values

USER_SWITCH_TYPE_DEFAULT

public static final int USER_SWITCH_TYPE_DEFAULT

A switch has occurred between two authenticated users.

Use this constant with EXTRA_USER_SWITCH_TYPE.

See Also:

Constant Field Values

USER_SWITCH_TYPE_FIRST_LOGIN

public static final int USER_SWITCH_TYPE_FIRST_LOGIN

The first user has logged in and is being switched to. There were no users authenticated before this switch.

Use this constant with EXTRA_USER_SWITCH_TYPE.

See Also:

Constant Field Values

USER_SWITCH_TYPE_LOGIN

public static final int USER_SWITCH_TYPE_LOGIN

An additional user has logged in and is being switched to. There was at least one user authenticated before this switch.

Use this constant with EXTRA_USER_SWITCH_TYPE.

See Also:

Constant Field Values

USER_SWITCH_TYPE_LOGOUT

public static final int USER_SWITCH_TYPE_LOGOUT

A user has a logged out and another authenticated user is being switched to.

Use this constant with EXTRA_USER_SWITCH_TYPE.

See Also:

Constant Field Values

Constructor Detail

UserAccountManager

protected UserAccountManager()

Protected constructor.

Method Detail

getInstance

public static UserAccountManager getInstance()

Returns a singleton instance of this class.

Returns:

Instance of this class.

storeCurrentUserInfo

public void storeCurrentUserInfo(java.lang.String userId,
                                 java.lang.String orgId)

Stores the current active user's user ID and org ID in a shared preference file.

Parameters:

userId - User ID.

orgId - Org ID.

getStoredUserId

public java.lang.String getStoredUserId()

Returns the stored user ID.

Returns:

User ID.

getStoredOrgId

public java.lang.String getStoredOrgId()

Returns the stored org ID.

Returns:

Org ID.

getCurrentUser

public UserAccount getCurrentUser()

Returns the current user logged in.

Returns:

Current user that's logged in.

getCachedCurrentUser

public UserAccount getCachedCurrentUser()

Returns a cached value of the current user. NB: The oauth tokens might be outdated Should be used by methods that only care about the current user's identity (org id, user id etc) Is faster than getCurrentUser()

Returns:

Current user that's logged in (with potentially outdated oauth tokens)

clearCachedCurrentUser

public void clearCachedCurrentUser()

Get rid of cached current user account

getCurrentAccount

public Account getCurrentAccount()

Returns the current user logged in.

Returns:

Current user that's logged in.

getAuthenticatedUsers

public java.util.List<UserAccount> getAuthenticatedUsers()

Returns a list of authenticated users.

Returns:

List of authenticated users.

doesUserAccountExist

public boolean doesUserAccountExist(UserAccount account)

Returns whether the specified user account exists or not.

Parameters:

account - User account.

Returns:

True - if it exists, False - otherwise.

switchToUser

public void switchToUser(UserAccount user)

Switches to the specified user account. If the specified user account is invalid/doesn't exist, this method kicks off the login flow for a new user. When the user account switch is complete, it is imperative for the app to update its cached references to RestClient, to avoid holding on to a RestClient from the previous user.

Parameters:

user - User account to switch to.

switchToUser

public void switchToUser(UserAccount user,
                         int userSwitchType,
                         Bundle extras)

Switches to the specified user account.

Parameters:

user - the user account to switch to

userSwitchType - a USER_SWITCH_TYPE constant

extras - a optional Bundle of extras to pass additional information during user switch

See Also:

switchToUser(UserAccount)

switchToNewUser

public void switchToNewUser()

Kicks off the login flow to switch to a new user. Once the login flow is complete, the context will automatically become the new user's context and a call to peekRestClient() or getRestClient() in ClientManager will return a RestClient instance for the new user.

switchToNewUser

public void switchToNewUser(java.lang.String jwt,
                            java.lang.String url)

Kicks off the login flow to switch to a new user with jwt. Once the login flow is complete, the context will automatically become the new user's context and a call to peekRestClient() or getRestClient() in ClientManager will return a RestClient instance for the new user.

Parameters:

jwt - JWT.

url - Instance/My domain URL.

signoutCurrentUser

public void signoutCurrentUser(Activity frontActivity)

Logs the current user out.

Parameters:

frontActivity - Front activity.

signoutCurrentUser

public void signoutCurrentUser(Activity frontActivity,
                               boolean showLoginPage)

Logs the current user out.

Parameters:

frontActivity - Front activity.

showLoginPage - True - if the login page should be shown, False - otherwise.

signoutCurrentUser

public void signoutCurrentUser(Activity frontActivity,
                               boolean showLoginPage,
                               OAuth2.LogoutReason reason)

Logs the current user out.

Parameters:

frontActivity - Front activity.

showLoginPage - True - if the login page should be shown, False - otherwise.

reason - The reason for the logout.

signoutUser

public void signoutUser(UserAccount userAccount,
                        Activity frontActivity)

Logs the specified user out. If the user specified is not the current user, push notification un-registration will not take place.

Parameters:

userAccount - User account.

frontActivity - Front activity.

signoutUser

public void signoutUser(UserAccount userAccount,
                        Activity frontActivity,
                        boolean showLoginPage)

Logs the specified user out. If the user specified is not the current user, push notification un-registration will not take place.

Parameters:

userAccount - User account.

frontActivity - Front activity.

showLoginPage - True - if the login page should be shown, False - otherwise.

signoutUser

public void signoutUser(UserAccount userAccount,
                        Activity frontActivity,
                        boolean showLoginPage,
                        OAuth2.LogoutReason reason)

Logs the specified user out. If the user specified is not the current user, push notification un-registration will not take place.

Parameters:

userAccount - User account.

frontActivity - Front activity.

showLoginPage - True - if the login page should be shown, False - otherwise.

reason - The reason for the logout.

createAccount

public Bundle createAccount(UserAccount userAccount)

Create AccountManager Account from the given UserAccount

Parameters:

userAccount - UserAccount object.

Returns:

auth bundle with encrypted values

updateAccount

public Bundle updateAccount(Account account,
                            UserAccount userAccount)

Update AccountManager Account for the given UserAccount

Parameters:

account - Account object to update.

userAccount - UserAccount object.

Returns:

auth bundle with encrypted values

buildUserAccount

public UserAccount buildUserAccount(Account account)

Builds a UserAccount object from the saved account.

Parameters:

account - Account object.

Returns:

UserAccount object.

buildAccount

public Account buildAccount(UserAccount userAccount)

Builds an Account object from the user account passed in.

Parameters:

userAccount - UserAccount object.

Returns:

Account object.

sendUserSwitchIntent

public final void sendUserSwitchIntent(int userSwitchType,
                                       Bundle extras)

Broadcasts an intent that a user switch has occurred.

Parameters:

userSwitchType - A USER_SWITCH_TYPE constant.

extras - An optional Bundle of extras to add to the broadcast intent.

getUserFromOrgAndUserId

public UserAccount getUserFromOrgAndUserId(java.lang.String orgId,
                                           java.lang.String userId)

Retrieves a stored user account from org ID and user ID.

Parameters:

orgId - Org ID.

userId - User ID.

Returns:

User account.

refreshToken

public void refreshToken(UserAccount userAccount)

Attempts to refresh the access token for this user by making an API call to the "/token" endpoint. If the call succeeds, the new token is persisted. If the call fails and the refresh token is no longer valid, the user is logged out. This should NOT be called from the main thread because it makes a network request.

Parameters:

userAccount - User account whose token should be refreshed. Use 'null' for current user.