com.eloview.homesdk.accountManager

Class AccountManager

java.lang.Object

com.eloview.homesdk.consts.Consts

com.eloview.homesdk.accountManager.AccountManager

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

EloView, Info, Memory, Network, OTA, Package, Peripheral, System

public class AccountManager
extends Consts

AccountManager class provides the below operations.
1. Provide an Authentication Token from an EloServer based on the credentials provided by the user (emailId/password or clientId/secretKey)
2. Verify whether a given Authentication Token is valid or has expired. The authentication token can either be the token obtained from the
EloView server or it can be an offline JWT token provided to you by Elo Support team. (The offline token is generated using the package name of your
application and can only be used with the package it was generated for.)
3. All the APIs require an offline token to work and will not work with the online token. The only exception is OTA APIs. The OTA APIs require the online
token when applying the OTA from an EloView server. For applying OTA through a custom server URL or from a local file on the device, the offline token may be used.

For example, to get an Authentication Token
1. Using emailId and password, call getEloAccessToken.
2. Using clientId and secretKey, call getEloOAuthToken.

Upon successful authentication, these methods will return a token.

3. For the offline JWT token, please contact Elo support team.

The token retrieved from the server/support team is verified using the method verifyEloToken.

Unregister the broadcast receivers used by this AccountManager APIs, using the method unregisterAccountManagerListener in the onPause
and onDestroy methods of the activities in which you use these APIs to avoid leaks.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCESS_TOKEN_INVALID Obtaining an Elo access token was not successful.
static int	ACCESS_TOKEN_VALID An access token was requested and a valid token was received from the elo servers
static int	API_ACCESS_TOKEN_INVALID
static int	API_ACCESS_TOKEN_VALID
static AccountManager	instance
static int	IS_USER_LOGIN_OAUTH LOGOUT the user with oauth.
static boolean	isPolaris
static java.lang.String	KEY_SERVER_ELO_POLARIS_DEV
static java.lang.String	KEY_SERVER_PRODUCTION_POLARIS
static java.lang.String	KEY_SERVER_QA_POLARIS
static java.lang.String	KEY_SERVER_STAGING_POLARIS
static int	OAUTH_TOKEN_INVALID Obtaining an Elo OAuth token was not successful.
static int	OAUTH_TOKEN_VALID An oAuth token was requested and a valid token was received from the elo servers
static int	REQUEST_AUTH_LOGIN
static int	REQUEST_AUTH_LOGOUT
static int	SETUP_OAUTH_ERROR
static int	SETUP_OAUTH_SUCCESS LOGOUT the user with oauth.
static int	TOKEN_VERIFY_FAIL A token was provided to elo server for verification and the token could not be verified.
static int	TOKEN_VERIFY_SUCCESS A token was provided to elo server for verification and was successfully verified

Fields inherited from class com.eloview.homesdk.consts.Consts

ACTION_SET_EST_REQUEST, ELO_FOLDER, ELO_NETWORK_CONF_CSV_FILE, ELO_WIFI_CONFIG_FOLDER, GENERIC_ERROR, isFROM, OAUTH_PATH_TOKEN, OAUTH_PATH_VERIFY, REQUEST_TOKEN, STR_CUSTOM_ANIM_IMAGE_FILE, STR_CUSTOM_ANIM_VIDEO_FILE, STR_CUSTOM_BRAND_LOGO_FILE, STR_CUSTOM_BRAND_NAME_FILE, STR_CUSTOM_BRAND_POWERED_BY_LOGO_FILE, STR_CUSTOM_LOCALE_NAME_FILE, STR_CUSTOM_WALLPAPER, STR_ELO_PATH_FOR_CUSTOM_ANIMATION, STR_SDCARD_ELO_DIR_PATH, VERIFY_TOKEN

Constructor Summary

Constructors

Constructor and Description
AccountManager()

Method Summary

Modifier and Type	Method and Description
void	configureOAuthHostedUI(android.app.Activity activity, android.os.Handler handler) This method is used to initialize OAuth Hosted UI
void	destroyOAuth() Call destroyOAuth in onStop override method of activity
static android.net.Uri	getBaseUri()
static java.lang.String	getClientId()
void	getEloAccessToken(android.content.Context context, java.lang.String userEmail, java.lang.String password, android.os.Handler handler) This method is used to get an accessToken from the ELO Server.
void	getEloOAuthToken(android.content.Context context, java.lang.String clientID, java.lang.String secret, android.os.Handler handler) This method is used to ask EloView Portal for a new oAuth Token.
java.lang.String	getEnvironment(android.content.Context ctx)
static java.lang.String	getProperty()
boolean	isPolaris(android.content.Context context)
boolean	isPolarisLocked(android.content.Context context)
void	logoutOAuth() logoutOAuth to end current login session
void	onOAuthActivityResult(android.content.Context context, android.content.Intent intent, android.os.Handler handler) Caller activity need to return onActivity result data when requestCode -> AccountManager.REQUEST_AUTH_LOGIN and resultCode -> Activity.RESULT_OK
void	selectEnvironment(android.content.Context ctx, java.lang.String prop, boolean isSealed)
void	setDefaultEnvironment(android.content.Context ctx)
void	setProperty(java.lang.String property)
void	stopOAuth() Call stopOAuth in onStop override method of activity
void	unregisterAccountManagerListener(android.content.Context context) This method is used to unregister the broadcast receiver registered while using any of the AccountManager APIs. Please make sure to call this in the "onPause" and "onDestroy" methods in your activity Lifecycle if you made use of any of the AccountManager APIs.
void	verifyEloToken(android.content.Context context, java.lang.String accessToken, android.os.Handler handler) This function asks the Elo Server to verify the given token.

Methods inherited from class com.eloview.homesdk.consts.Consts

clone, getEloIntentWithFlag, getMigrate, isDevice7Inch, isDeviceM100

Methods inherited from class java.lang.Object

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

Field Detail

API_ACCESS_TOKEN_VALID

public static final int API_ACCESS_TOKEN_VALID

See Also:

Constant Field Values

API_ACCESS_TOKEN_INVALID

public static final int API_ACCESS_TOKEN_INVALID

See Also:

Constant Field Values

KEY_SERVER_ELO_POLARIS_DEV

public static final java.lang.String KEY_SERVER_ELO_POLARIS_DEV

See Also:

Constant Field Values

KEY_SERVER_STAGING_POLARIS

public static final java.lang.String KEY_SERVER_STAGING_POLARIS

See Also:

Constant Field Values

KEY_SERVER_QA_POLARIS

public static final java.lang.String KEY_SERVER_QA_POLARIS

See Also:

Constant Field Values

KEY_SERVER_PRODUCTION_POLARIS

public static final java.lang.String KEY_SERVER_PRODUCTION_POLARIS

See Also:

Constant Field Values

ACCESS_TOKEN_VALID

public static final int ACCESS_TOKEN_VALID

An access token was requested and a valid token was received from the elo servers

See Also:

Constant Field Values

TOKEN_VERIFY_SUCCESS

public static final int TOKEN_VERIFY_SUCCESS

A token was provided to elo server for verification and was successfully verified

See Also:

Constant Field Values

OAUTH_TOKEN_VALID

public static final int OAUTH_TOKEN_VALID

An oAuth token was requested and a valid token was received from the elo servers

See Also:

Constant Field Values

OAUTH_TOKEN_INVALID

public static final int OAUTH_TOKEN_INVALID

Obtaining an Elo OAuth token was not successful.

See Also:

Constant Field Values

TOKEN_VERIFY_FAIL

public static final int TOKEN_VERIFY_FAIL

A token was provided to elo server for verification and the token could not be verified. Causes for receiving this, could be invalid credentials, an expired/invalidated token, or not having a token.

See Also:

Constant Field Values

ACCESS_TOKEN_INVALID

public static final int ACCESS_TOKEN_INVALID

Obtaining an Elo access token was not successful.

See Also:

Constant Field Values

IS_USER_LOGIN_OAUTH

public static final int IS_USER_LOGIN_OAUTH

LOGOUT the user with oauth.

See Also:

Constant Field Values

SETUP_OAUTH_SUCCESS

public static final int SETUP_OAUTH_SUCCESS

LOGOUT the user with oauth.

See Also:

Constant Field Values

SETUP_OAUTH_ERROR

public static final int SETUP_OAUTH_ERROR

See Also:

Constant Field Values

REQUEST_AUTH_LOGIN

public static final int REQUEST_AUTH_LOGIN

See Also:

Constant Field Values

REQUEST_AUTH_LOGOUT

public static final int REQUEST_AUTH_LOGOUT

See Also:

Constant Field Values

instance

public static final AccountManager instance

isPolaris

public static boolean isPolaris

Constructor Detail

AccountManager

public AccountManager()

Method Detail

getProperty

public static java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

getClientId

public static java.lang.String getClientId()

getBaseUri

public static android.net.Uri getBaseUri()

getEloAccessToken

public void getEloAccessToken(android.content.Context context,
                              java.lang.String userEmail,
                              java.lang.String password,
                              android.os.Handler handler)

This method is used to get an accessToken from the ELO Server.

Parameters:

context - A context object of the calling Class (Activity/Service).

userEmail - Elo Account email address

password - Elo Account password

handler - A handler to receive one of the following callback messages:

ACCESS_TOKEN_VALID
Consts.GENERIC_ERROR
ACCESS_TOKEN_INVALID

configureOAuthHostedUI

public void configureOAuthHostedUI(android.app.Activity activity,
                                   android.os.Handler handler)

This method is used to initialize OAuth Hosted UI

Parameters:

activity - An activity instance of the calling Class (Activity/Service).

handler - A handler to receive one of the following callback messages:

SETUP_OAUTH_SUCCESS
SETUP_OAUTH_ERROR

stopOAuth

public void stopOAuth()

Call stopOAuth in onStop override method of activity

destroyOAuth

public void destroyOAuth()

Call destroyOAuth in onStop override method of activity

logoutOAuth

public void logoutOAuth()

logoutOAuth to end current login session

verifyEloToken

public void verifyEloToken(android.content.Context context,
                           java.lang.String accessToken,
                           android.os.Handler handler)

This function asks the Elo Server to verify the given token. Upon successful verification, the handler will receive a message of type TOKEN_VERIFY_SUCCESS. Upon failure TOKEN_VERIFY_FAIL will be received.

Parameters:

context - A context object of the calling Class (Activity/Service).

accessToken - access/oAuth token received from elo server

handler - A handler to receive one of the following callback messages:

TOKEN_VERIFY_FAIL
TOKEN_VERIFY_SUCCESS

getEloOAuthToken

public void getEloOAuthToken(android.content.Context context,
                             java.lang.String clientID,
                             java.lang.String secret,
                             android.os.Handler handler)

This method is used to ask EloView Portal for a new oAuth Token. Upon successful authentication, a token will be sent to the device. This token is valid for use 24hrs after it is issued. When the token expires, further attempts to verify the token and call APIs will get the TOKEN_VERIFY_FAIL response. The same is true if a token was never procured/received. If successful, the handler will receive a message of type OAUTH_TOKEN_VALID with a JWT Token as the response. Below is an example of a successful response:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJQTSJ9.eyJ1ZW1haWwiOiJwcmF0YXBlbG8rUHJvZEBnbWFpbC5jb20iLCJvdGl0bGUiOiJwcmF0YXBlbG8rUHJvZEBnbWFpbC5jb20iLCJjYXAiOnsiY3JjIjoiSDIvb2RnIiwicGVybSI6ImZmZmZmZmYwMCJ9LCJpYXQiOjE1MjUxMTc4NDgsIm5iZiI6MTUyNTExNzg0OCwiZXhwIjoxNTI1MjA0MjQ4LCJpc3MiOiIxNTAyIiwic3ViIjoiZWVhNDRkY2JkMjU5YzQyOWY4NTA3YWZhNTQyY2Q3M2YiLCJqdGkiOiJ2ZE14N1ppUGVnWT0ifQ.b2e-F1mVh0ummkBJk3m8pT2qSCceRxuS_A9GAKtYBeo"

In case of an authentication failure due to bad clientID/secretID, the Handler will receive a message of type OAUTH_TOKEN_INVALID.

Parameters:

context - A context object of the calling Class (Activity/Service).

clientID - A clientID generated from the eloView portal at manage.eloview.com

secret - A secret generated from the eloView portal at manage.eloview.com

handler - A handler to receive one of the following callback messages:

OAUTH_TOKEN_INVALID
OAUTH_TOKEN_VALID

unregisterAccountManagerListener

public void unregisterAccountManagerListener(android.content.Context context)

This method is used to unregister the broadcast receiver registered while using any of the AccountManager APIs.
Please make sure to call this in the "onPause" and "onDestroy" methods in your activity Lifecycle if you made use of any of the AccountManager APIs. This ensures the receiver is not leaked.

Parameters:

context - Context in which the system APIs were used

setDefaultEnvironment

public void setDefaultEnvironment(android.content.Context ctx)

selectEnvironment

public void selectEnvironment(android.content.Context ctx,
                              java.lang.String prop,
                              boolean isSealed)

isPolarisLocked

public boolean isPolarisLocked(android.content.Context context)

getEnvironment

public java.lang.String getEnvironment(android.content.Context ctx)

isPolaris

public boolean isPolaris(android.content.Context context)

onOAuthActivityResult

public void onOAuthActivityResult(android.content.Context context,
                                  android.content.Intent intent,
                                  android.os.Handler handler)

Caller activity need to return onActivity result data when requestCode -> AccountManager.REQUEST_AUTH_LOGIN and resultCode -> Activity.RESULT_OK

Parameters:

context - A context object of the calling Class (Activity/Service).

intent - Intent

handler - A handler to receive one of the following callback messages:

Consts.GENERIC_ERROR
ACCESS_TOKEN_VALID
ACCESS_TOKEN_INVALID