com.pega.mobile.accountmanager

Class AccountManager

java.lang.Object

com.pega.mobile.accountmanager.AccountManager

All Implemented Interfaces:

Plugin

public class AccountManager
extends Object
implements Plugin

Account manager, like the name suggests, manages internal accounts in Hybrid Client. Each account has a number of properties partitioned into two scopes: public and secured. Secured data can be only accessed when the account is opened. With the use of secured data Account managed can serve as a source of credentials to other services (wallet functionality). This is not supposed to be the global and only authentication manager. Authentication to other services like ProfileService will in most cases be performed before opening AccountManager4AMP (although it is possible to treat Account manager as main authentication service and keep profile service credentials in it).

Note: There can be only one account open at any given time and it is shared between all running managed applications (in this container).

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_NAME
static String	ON_CLOSE_CALLBACK
static String	ON_OPEN_CALLBACK

Constructor Summary

Constructors

Constructor and Description
AccountManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	accountList(Object data, JavascriptCallback callback) Retrieves the map of all accounts with their public user data, see #AccountList.
void	addAccount(Object data, JavascriptCallback callback) Adds a new account.
void	appendJavascript(JavascriptAppender loader) Must load the javascript implementation of plugin.
void	changePassword(Object data, JavascriptCallback callback) Changes account password.
void	closeAccount(Object data, JavascriptCallback callback) Closes a currently open account.
String	getName() Must return the name of plugin
void	getPrivateAccountData(Object data, JavascriptCallback callback) Returns a list of all private data stored for currently open account.
void	init(PluginInitializationContext context) Can be implemented by the plugin to have access to plugins registry, application description or to fire js events
void	onDestroy() Called when WebApplication is stopped or destroyed and this plugin is no longer used.
void	onEvent(AccountManagerEvent.OnClose event)
void	onEvent(AccountManagerEvent.OnOpen event) EventBus handlers
void	onPageLoaded() Called when WebApplication has finished loading and JavaScript has been injected into HybridWebView
void	onReload() Called when url has changed or has been reloaded
void	openAccount(Object data, JavascriptCallback callback) Opens/authenticates the account and gives access to private (encrypted) data.
void	removeAccount(Object data, JavascriptCallback callback) Removes account.
void	removeField(Object data, JavascriptCallback callback) Removes a key with corresponding value from given scope.
void	setField(Object data, JavascriptCallback callback) Sets the value for a key in selected custom account data scope (public, private).

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_NAME

public static String EVENT_NAME

ON_OPEN_CALLBACK

public static String ON_OPEN_CALLBACK

ON_CLOSE_CALLBACK

public static String ON_CLOSE_CALLBACK

Constructor Detail

AccountManager

public AccountManager()

Method Detail

getName

public String getName()

Description copied from interface: Plugin

Must return the name of plugin

Specified by:

getName in interface Plugin

Returns:

Plugin name

onPageLoaded

public void onPageLoaded()

Description copied from interface: Plugin

Called when WebApplication has finished loading and JavaScript has been injected into HybridWebView

Specified by:

onPageLoaded in interface Plugin

onReload

public void onReload()

Description copied from interface: Plugin

Called when url has changed or has been reloaded

Specified by:

onReload in interface Plugin

onDestroy

public void onDestroy()

Description copied from interface: Plugin

Called when WebApplication is stopped or destroyed and this plugin is no longer used.

Specified by:

onDestroy in interface Plugin

init

public void init(PluginInitializationContext context)

Description copied from interface: Plugin

Can be implemented by the plugin to have access to plugins registry, application description or to fire js events

Specified by:

init in interface Plugin

Parameters:

context - Plugin context object

appendJavascript

public void appendJavascript(JavascriptAppender loader)

Description copied from interface: Plugin

Must load the javascript implementation of plugin.

Specified by:

appendJavascript in interface Plugin

Parameters:

loader - AssetLoader object

accountList

public void accountList(Object data,
               JavascriptCallback callback)

Retrieves the map of all accounts with their public user data, see #AccountList.

Parameters:

data - the payload map

callback - the callback

addAccount

public void addAccount(Object data,
              JavascriptCallback callback)

Adds a new account.

Parameters:

data - the payload map with fields: identifier - the identifier name

callback - the callback

removeAccount

public void removeAccount(Object data,
                 JavascriptCallback callback)

Removes account.

Parameters:

data - the payload map with fields: identifier - the identifier name,

callback - the callback

changePassword

public void changePassword(Object data,
                  JavascriptCallback callback)

Changes account password.

Parameters:

data - the payload map with fields: identifier - the identifier name, oldPassword - the identifier current password newPassword - the identifier new password to be set

callback - the callback

openAccount

public void openAccount(Object data,
               JavascriptCallback callback)

Opens/authenticates the account and gives access to private (encrypted) data.

Parameters:

data - the payload map with fields: identifier - the identifier name, password - the identifier password

callback - the callback

closeAccount

public void closeAccount(Object data,
                JavascriptCallback callback)

Closes a currently open account. Native services can respond to this action an e.g. by closing their storage. NOTE: does NOT throw any error if there is no account currently open.

Parameters:

data - the payload map

callback - the callback

getPrivateAccountData

public void getPrivateAccountData(Object data,
                         JavascriptCallback callback)

Returns a list of all private data stored for currently open account.

Parameters:

data - the map

callback - the callback

setField

public void setField(Object data,
            JavascriptCallback callback)

Sets the value for a key in selected custom account data scope (public, private). If the key does not exist, it is created. If it exists, its value is overwritten.

Parameters:

data - the payload map with fields: key - the field key, value - the field value, scope - the data scope (public/private)

callback - the callback

removeField

public void removeField(Object data,
               JavascriptCallback callback)

Removes a key with corresponding value from given scope.

Parameters:

data - the payload map with fields: key - the field key, scope - the data scope (public/private)

callback - the callback

onEvent

public void onEvent(AccountManagerEvent.OnOpen event)

EventBus handlers

onEvent

public void onEvent(AccountManagerEvent.OnClose event)