universum.studios.android.officium.account

Class SingleUserAccountManager<A extends UserAccount>

java.lang.Object

universum.studios.android.officium.account.UserAccountManager<A>

universum.studios.android.officium.account.SingleUserAccountManager<A>

public class SingleUserAccountManager<A extends UserAccount>
extends UserAccountManager<A>

A UserAccountManager implementation that can be used for Android applications that allow only one account to be created for a user.

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from class universum.studios.android.officium.account.UserAccountManager

UserAccountManager.AccountWatcher<A extends UserAccount>

Field Summary

Fields inherited from class universum.studios.android.officium.account.UserAccountManager

ERROR_CREATE_ACCOUNT, ERROR_DELETE_ACCOUNT, mAccountType, mContext, mManager, PERMISSION_AUTHENTICATE_ACCOUNTS, PERMISSION_GET_ACCOUNTS, PERMISSION_MANAGE_ACCOUNTS

Constructor Summary

Constructors

Constructor and Description
SingleUserAccountManager(Context context, String accountType) Creates a new instance of SingleUserAccountManager for the specified accountType.

Method Summary

Modifier and Type	Method and Description
protected Account	acquireAccount() Called to acquire current single account.
boolean	clearAccountPassword() Clears the password for the current single account (if created).
Account	getAccount() Returns the current account if it is created.
String	getAccountData(String key) Returns the single data for the current single account (if created) stored under the specified key.
Bundle	getAccountDataBundle(String... keys) Returns the bundle with data for the current single account (if created).
String	getAccountPassword() Returns the password for the current single account (if created).
boolean	invalidateAccountAuthToken(String authToken) Invalidates the specified authToken for the current single account (if created).
boolean	isAccountAuthenticated(String authTokenType) Checks whether the current single account (if created) is authenticated or not.
boolean	isAccountCreated() Checks whether there is account created or not.
String	peekAccountAuthToken(String authTokenType) Returns the authentication token for the current single account (if created) stored for the specified authTokenType.
boolean	setAccountAuthToken(String authTokenType, String authToken) Sets an authentication token for the current single account (if created) with the specified authTokenType.
boolean	setAccountData(String key, String value) Sets a single data value for the current single account (if created) with the specified key.
boolean	setAccountDataBundle(Bundle dataBundle) Sets a bundle with data for the current single account (if created).
boolean	setAccountPassword(String password) Sets a password for the current single account (if created).

Methods inherited from class universum.studios.android.officium.account.UserAccountManager

clearAccountPassword, createAccount, createAccountAsync, deleteAccount, deleteAccountAsync, findAccountForUser, getAccountData, getAccountDataBundle, getAccountPassword, invalidateAccountAuthToken, isAccountAuthenticated, onCreateAccount, onDeleteAccount, peekAccountAuthToken, registerWatcher, setAccountAuthToken, setAccountData, setAccountDataBundle, setAccountPassword, unregisterWatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleUserAccountManager

public SingleUserAccountManager(@NonNull
                                Context context,
                                @NonNull
                                String accountType)

Creates a new instance of SingleUserAccountManager for the specified accountType.

Parameters:

context - Context used to access AccountManager.

accountType - The desired account type that will be managed by the new user account manager.

Method Detail

isAccountCreated

public boolean isAccountCreated()

Checks whether there is account created or not.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS permission.

Returns:

True if there is account created at this time, false otherwise.

See Also:

getAccount()

getAccount

@Nullable
public Account getAccount()

Returns the current account if it is created.

Note, that default implementation of this method assumes that there can be only one account created for this Android application. If there are multiple accounts created this method will pick the first one.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS permission.

Returns:

Current account or null if there is no account created yet.

See Also:

isAccountCreated()

setAccountAuthToken

public boolean setAccountAuthToken(@NonNull
                                   String authTokenType,
                                   @Nullable
                                   String authToken)

Sets an authentication token for the current single account (if created) with the specified authTokenType.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

authTokenType - Type of the authentication token to be stored used as key.

authToken - The desired authentication token to be stored.

Returns:

True if authentication token for the account has been updated, false if there is no account created at this time for which to update its token.

See Also:

peekAccountAuthToken(String), isAccountAuthenticated(String), UserAccountManager.setAccountAuthToken(Account, String, String)

isAccountAuthenticated

public boolean isAccountAuthenticated(@NonNull
                                      String authTokenType)

Checks whether the current single account (if created) is authenticated or not.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

authTokenType - Type of the authentication token used to resolve whether the account is authenticated or not.

Returns:

True if there is stored valid authentication token for the account with the specified token type, false if there is no account created at this time or there has not been stored token with the specified token type yet.

See Also:

setAccountAuthToken(String, String), UserAccountManager.isAccountAuthenticated(Account, String)

peekAccountAuthToken

@Nullable
public String peekAccountAuthToken(@NonNull
                                              String authTokenType)

Returns the authentication token for the current single account (if created) stored for the specified authTokenType.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

authTokenType - Type of the requested authentication token to peek for the account.

Returns:

Authentication token or null if there is no account created at this time or there has not been stored token for the requested type yet or the token has been invalidated.

See Also:

setAccountAuthToken(String, String), invalidateAccountAuthToken(String), UserAccountManager.peekAccountAuthToken(Account, String)

invalidateAccountAuthToken

public boolean invalidateAccountAuthToken(@NonNull
                                          String authToken)

Invalidates the specified authToken for the current single account (if created).

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_MANAGE_ACCOUNTS permissions.

Parameters:

authToken - The token that should be invalidated for the account.

Returns:

True if authentication token for the account has been invalidated, false if there is not account created at this time for which to invalidate its token.

See Also:

peekAccountAuthToken(String), UserAccountManager.invalidateAccountAuthToken(Account, String)

setAccountPassword

public boolean setAccountPassword(@Nullable
                                  String password)

Sets a password for the current single account (if created).

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

password - The desired password to be stored for the account. May be null to clear the current one.

Returns:

True if password for the account has been updated, false if there is no account created at this time for which to update its password.

See Also:

getAccountPassword(), clearAccountPassword(), UserAccountManager.setAccountPassword(Account, String)

getAccountPassword

@Nullable
public String getAccountPassword()

Returns the password for the current single account (if created).

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Returns:

Requested password or null if there is no account created at this time or there has not been stored any password for the account yet.

See Also:

setAccountPassword(String), clearAccountPassword(), UserAccountManager.getAccountPassword(Account)

clearAccountPassword

public boolean clearAccountPassword()

Clears the password for the current single account (if created).

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Returns:

True if password for the account has been cleared, false if there is no account created at this time for which to clear its password.

See Also:

setAccountPassword(String), getAccountPassword(), UserAccountManager.clearAccountPassword(Account)

setAccountData

public boolean setAccountData(@NonNull
                              String key,
                              @Nullable
                              String value)

Sets a single data value for the current single account (if created) with the specified key.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

key - The key under which will be the desired value stored for the account.

value - The desired data value to be stored.

Returns:

True if data for the account has been updated, false if there is no account created at this time for which to update its data.

See Also:

getAccountData(String), setAccountDataBundle(Bundle), UserAccountManager.setAccountData(Account, String, String)

getAccountData

@Nullable
public String getAccountData(@NonNull
                                        String key)

Returns the single data for the current single account (if created) stored under the specified key.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

key - The key for which to obtain the requested account data.

Returns:

Requested account data or null if there is no account created at this time or there are no data stored for the requested key.

See Also:

setAccountData(String, String), UserAccountManager.getAccountData(Account, String)

setAccountDataBundle

public boolean setAccountDataBundle(@NonNull
                                    Bundle dataBundle)

Sets a bundle with data for the current single account (if created).

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

dataBundle - Bundle with the desired data for the account.

Returns:

True if data bundle for the account has been updated, false if there is no account created at this time for which to update its data bundle.

See Also:

getAccountDataBundle(String...), UserAccountManager.setAccountDataBundle(Account, Bundle)

getAccountDataBundle

@Nullable
public Bundle getAccountDataBundle(@NonNull
                                              String... keys)

Returns the bundle with data for the current single account (if created).

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS along with UserAccountManager.PERMISSION_AUTHENTICATE_ACCOUNTS permissions.

Parameters:

keys - Set of keys for which to obtain the desired data.

Returns:

Bundle with account data for the requested keys or null if there is no account created at this time.

See Also:

setAccountDataBundle(Bundle), setAccountData(String, String), UserAccountManager.getAccountDataBundle(Account, String...)

acquireAccount

@Nullable
protected Account acquireAccount()

Called to acquire current single account.

Note, that default implementation of this method assumes that there can be only one account created for this Android application. If there are multiple accounts created this method will pick the first one.

This method requires the caller to hold UserAccountManager.PERMISSION_GET_ACCOUNTS permission.

Returns:

Valid account if there is some created for the account type specified for this manager, null if there is no account created yet.

See Also:

AccountManager.getAccountsByType(String)