com.salesforce.androidsdk.rest

Class ClientManager

java.lang.Object

com.salesforce.androidsdk.rest.ClientManager

public class ClientManager
extends java.lang.Object

ClientManager is a factory class for RestClient which stores OAuth credentials in the AccountManager. If no account is found, it kicks off the login flow which creates a new account if successful.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientManager.AccMgrAuthTokenProvider AuthTokenProvider implementation that calls out to the AccountManager to get a new access token.
static class	ClientManager.AccountInfoNotFoundException Exception thrown when no account could be found (during a peekRestClient call)
static class	ClientManager.LoginOptions Class encapsulating login options.
static interface	ClientManager.RestClientCallback RestClientCallback interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_TOKEN_REFRESH_INTENT
static java.lang.String	ACCESS_TOKEN_REVOKE_INTENT
static java.lang.String	INSTANCE_URL_UPDATE_INTENT

Constructor Summary

Constructors

Constructor and Description
ClientManager(Context ctx, java.lang.String accountType, ClientManager.LoginOptions loginOptions, boolean revokedTokenShouldLogout) Construct a ClientManager using a custom account type.

Method Summary

Modifier and Type	Method and Description
Bundle	createNewAccount(java.lang.String accountName, java.lang.String username, java.lang.String refreshToken, java.lang.String authToken, java.lang.String instanceUrl, java.lang.String loginUrl, java.lang.String idUrl, java.lang.String clientId, java.lang.String orgId, java.lang.String userId, java.lang.String communityId, java.lang.String communityUrl, java.lang.String firstName, java.lang.String lastName, java.lang.String displayName, java.lang.String email, java.lang.String photoUrl, java.lang.String thumbnailUrl, java.util.Map<java.lang.String,java.lang.String> additionalOauthValues, java.lang.String lightningDomain, java.lang.String lightningSid, java.lang.String vfDomain, java.lang.String vfSid, java.lang.String contentDomain, java.lang.String contentSid, java.lang.String csrfToken, java.lang.Boolean nativeLogin, java.lang.String language, java.lang.String locale) Deprecated.
Bundle	createNewAccount(UserAccount userAccount) Creates a new account and returns the parameters as a Bundle.
Account	getAccount() Returns the user account that is currently active.
Account	getAccountByName(java.lang.String name)
AccountManager	getAccountManager()
Account[]	getAccounts()
java.lang.String	getAccountType() Should match the value in authenticator.xml.12
void	getRestClient(Activity activityContext, ClientManager.RestClientCallback restClientCallback) Method to create a RestClient asynchronously.
void	getUnauthenticatedRestClient(Activity activityContext, ClientManager.RestClientCallback restClientCallback) Method to created an unauthenticated RestClient asynchronously
void	invalidateToken(java.lang.String lastNewAuthToken) Invalidate current auth token.
RestClient	peekRestClient()
RestClient	peekRestClient(Account acc)
RestClient	peekRestClient(UserAccount user) Method to create RestClient synchronously.
RestClient	peekUnauthenticatedRestClient() Method to create an unauthenticated RestClient.
void	removeAccount(Account acc) Removes the user account from the account manager.
void	removeAccounts(Account[] accounts) Remove all of the accounts passed in.

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_TOKEN_REVOKE_INTENT

public static final java.lang.String ACCESS_TOKEN_REVOKE_INTENT

See Also:

Constant Field Values

ACCESS_TOKEN_REFRESH_INTENT

public static final java.lang.String ACCESS_TOKEN_REFRESH_INTENT

See Also:

Constant Field Values

INSTANCE_URL_UPDATE_INTENT

public static final java.lang.String INSTANCE_URL_UPDATE_INTENT

See Also:

Constant Field Values

Constructor Detail

ClientManager

public ClientManager(Context ctx,
                     java.lang.String accountType,
                     ClientManager.LoginOptions loginOptions,
                     boolean revokedTokenShouldLogout)

Construct a ClientManager using a custom account type.

Parameters:

ctx - Context.

accountType - Account type.

loginOptions - Login options.

revokedTokenShouldLogout - True - if the SDK should logout when the access token is revoked, False - otherwise.

Method Detail

getRestClient

public void getRestClient(Activity activityContext,
                          ClientManager.RestClientCallback restClientCallback)

Method to create a RestClient asynchronously. It is intended to be used by code on the UI thread. If no accounts are found, it will kick off the login flow which will create a new account if successful. After the account is created or if an account already existed, it creates a RestClient and returns it through restClientCallback. Note: The work is actually being done by the service registered to handle authentication for this application account type.

Parameters:

activityContext - current activity

restClientCallback - callback invoked once the RestClient is ready

See Also:

AuthenticatorService

getUnauthenticatedRestClient

public void getUnauthenticatedRestClient(Activity activityContext,
                                         ClientManager.RestClientCallback restClientCallback)

Method to created an unauthenticated RestClient asynchronously

Parameters:

activityContext -

restClientCallback -

peekUnauthenticatedRestClient

public RestClient peekUnauthenticatedRestClient()

Method to create an unauthenticated RestClient.

Returns:

peekRestClient

public RestClient peekRestClient()

peekRestClient

public RestClient peekRestClient(UserAccount user)

Method to create RestClient synchronously. It is intended to be used by code not on the UI thread (e.g. ContentProvider). If there is no account, it will throw an exception.

Returns:

peekRestClient

public RestClient peekRestClient(Account acc)

invalidateToken

public void invalidateToken(java.lang.String lastNewAuthToken)

Invalidate current auth token. The next call to getRestClient will do a refresh.

getAccount

public Account getAccount()

Returns the user account that is currently active.

Returns:

The current user account.

getAccountByName

public Account getAccountByName(java.lang.String name)

Parameters:

name - The name associated with the account.

Returns:

The account with the application account type and the given name.

getAccounts

public Account[] getAccounts()

Returns:

All of the accounts found for this application account type.

removeAccounts

public void removeAccounts(Account[] accounts)

Remove all of the accounts passed in.

Parameters:

accounts - The array of accounts to remove.

createNewAccount

public Bundle createNewAccount(UserAccount userAccount)

Creates a new account and returns the parameters as a Bundle.

createNewAccount

@Deprecated
public Bundle createNewAccount(java.lang.String accountName,
                                           java.lang.String username,
                                           java.lang.String refreshToken,
                                           java.lang.String authToken,
                                           java.lang.String instanceUrl,
                                           java.lang.String loginUrl,
                                           java.lang.String idUrl,
                                           java.lang.String clientId,
                                           java.lang.String orgId,
                                           java.lang.String userId,
                                           java.lang.String communityId,
                                           java.lang.String communityUrl,
                                           java.lang.String firstName,
                                           java.lang.String lastName,
                                           java.lang.String displayName,
                                           java.lang.String email,
                                           java.lang.String photoUrl,
                                           java.lang.String thumbnailUrl,
                                           java.util.Map<java.lang.String,java.lang.String> additionalOauthValues,
                                           java.lang.String lightningDomain,
                                           java.lang.String lightningSid,
                                           java.lang.String vfDomain,
                                           java.lang.String vfSid,
                                           java.lang.String contentDomain,
                                           java.lang.String contentSid,
                                           java.lang.String csrfToken,
                                           java.lang.Boolean nativeLogin,
                                           java.lang.String language,
                                           java.lang.String locale)

Deprecated.

Creates a new account and returns the parameters as a Bundle.

Parameters:

accountName - Account name

username - Username.

refreshToken - Refresh token.

authToken - Access token.

instanceUrl - Instance URL.

loginUrl - Login URL.

idUrl - Identity URL.

clientId - Client ID.

orgId - Org ID.

userId - User ID.

communityId - Community ID.

communityUrl - Community URL.

firstName - First name.

lastName - Last name.

displayName - Display name.

email - Email.

photoUrl - Photo URL.

thumbnailUrl - Thumbnail URL.

additionalOauthValues - Additional OAuth values.

Returns:

Account info.

getAccountType

public java.lang.String getAccountType()

Should match the value in authenticator.xml.12

Returns:

The account type for this application.

getAccountManager

public AccountManager getAccountManager()

Returns:

The AccountManager for the application.

removeAccount

public void removeAccount(Account acc)

Removes the user account from the account manager. This is safe to call from main thread.

Parameters:

acc - Account to be removed.