com.dpslink.flash.util

Class NotificationFramework

java.lang.Object

com.dpslink.flash.util.NotificationFramework

All Implemented Interfaces:

java.io.Serializable

public class NotificationFramework
extends java.lang.Object
implements java.io.Serializable

A utility class that handles interactions with the Notification Framework.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	API_ACTIVE The value of the "Notification.Framework.Active" key.
private static java.lang.String	API_DOMAIN The value of the "Notification.Framework.Domain" key.
private static boolean	API_LOGINBLOCK The value of the "Notification.Framework.LoginBlockSite" key.
private static java.lang.String	API_LOGINID The value of the "Notification.Framework.LogonId" key.
private static java.lang.String	API_LOGINPWD The value of the "Notification.Framework.LogonPwd" key.
private static int	API_LOGINRETRIES The value of the "Notification.Framework.LogonRetries" key.
private static java.lang.String	API_SERVERURL The value of the "Notification.Framework.URL" key.
private static java.lang.String	API_TOKEN The current notification framework login authorization token.
private static int	cvLoginRetries The current number of consecutive failed login retry attempts.
private static javax.net.ssl.TrustManager[]	cvTrustManager A trust manager that allows self-signed certificates to be accepted.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
NotificationFramework()

Method Summary

Modifier and Type	Method and Description
static int	callFramework(java.lang.String api, org.json.JSONObject data, java.lang.String errtext, java.util.ArrayList<java.lang.String> results) Performs a call to the notification framework for a given API.
static java.lang.String	getDomain() Returns the configured notification framework domain.
static java.lang.String	getServerURL() Returns the configured notification framework server URL.
static boolean	isActive() Answers if the notification framework is active.
static boolean	isLoggedIn() Answers if a successful login has occurred with the notification framework (i.e.
static boolean	isSiteBlocked() Answers if access to the site should be blocked due to an inability to login to the notification framework.
protected static void	logCallError(java.lang.Exception e, java.lang.String errmsg, int response) Logs an error to the MAIN log for notification call failures.
static boolean	login() Performs login with the notification framework and sets the API_TOKEN value to the token returned from the framework.
static void	resumeProcessing() Instructs this class to resume processing of notification requests.
protected static boolean	retryUnauthorized(java.lang.String api, java.lang.String token) Answers if a notification framework API call should be retried due to an unauthorized response from the framework (HTTP_UNAUTHORIZED).
protected static void	setDefaultSSLContext() Sets the default SSL context for URL SSL connections so that self-signed certificates will be accepted.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

API_ACTIVE

private static boolean API_ACTIVE

The value of the "Notification.Framework.Active" key. This is a flag indicating if the site is configured to use the notification framework.

API_DOMAIN

private static java.lang.String API_DOMAIN

The value of the "Notification.Framework.Domain" key. This value is used as the domain for all communication with the notification framework.

API_LOGINBLOCK

private static boolean API_LOGINBLOCK

The value of the "Notification.Framework.LoginBlockSite" key. This is a flag indicating if access to the site should be blocked if login to the notification framework fails.

API_LOGINID

private static java.lang.String API_LOGINID

The value of the "Notification.Framework.LogonId" key. This value is used as the login id when obtaining a login token.

API_LOGINPWD

private static java.lang.String API_LOGINPWD

The value of the "Notification.Framework.LogonPwd" key. This value is used as the login password when obtaining a login token.

API_LOGINRETRIES

private static int API_LOGINRETRIES

The value of the "Notification.Framework.LogonRetries" key. This value is used to determine how many consecutive failed login retry attempts are allowed before this interface quits trying.

API_TOKEN

private static java.lang.String API_TOKEN

The current notification framework login authorization token.

API_SERVERURL

private static java.lang.String API_SERVERURL

The value of the "Notification.Framework.URL" key. This value is used as the base URL for access to the notificaton framework APIs. Includes trailing URL separator character.

cvLoginRetries

private static int cvLoginRetries

The current number of consecutive failed login retry attempts.

cvTrustManager

private static javax.net.ssl.TrustManager[] cvTrustManager

A trust manager that allows self-signed certificates to be accepted.

Constructor Detail

NotificationFramework

public NotificationFramework()

Method Detail

isActive

public static final boolean isActive()

Answers if the notification framework is active.

Returns:

boolean - true if the framework is active, otherwise false.

isLoggedIn

public static final boolean isLoggedIn()

Answers if a successful login has occurred with the notification framework (i.e. has a bearer token been obtained from the notification framework).

Returns:

boolean - true if a successful login has occurred, otherwise false.

isSiteBlocked

public static final boolean isSiteBlocked()

Answers if access to the site should be blocked due to an inability to login to the notification framework.

Returns:

boolean - true if site access should be blocked, otherwise false.

getDomain

public static final java.lang.String getDomain()

Returns the configured notification framework domain.

Returns:

String - The configured domain.

getServerURL

public static final java.lang.String getServerURL()

Returns the configured notification framework server URL.

Returns:

String - The configured URL.

login

public static final boolean login()

Performs login with the notification framework and sets the API_TOKEN value to the token returned from the framework.

Returns:

boolean - true if the processing was successful, otherwise false.

callFramework

public static final int callFramework(java.lang.String api,
                                      org.json.JSONObject data,
                                      java.lang.String errtext,
                                      java.util.ArrayList<java.lang.String> results)

Performs a call to the notification framework for a given API.

Parameters:

api - (String) The name of the API to call.

data - (JSONObject) The data to be sent to the API.

errtext - (String) Any additional text to add to logged error messages.

results - (ArrayList) An empty array list of type String. Any result codes or other info returned by the API are placed here.

Returns:

int - 0=success, 1=retry, 2=failure

logCallError

protected static final void logCallError(java.lang.Exception e,
                                         java.lang.String errmsg,
                                         int response)

Logs an error to the MAIN log for notification call failures.

Parameters:

e - (Exception) An exception to log or null if there is no exception.

errmsg - (String) Any additional error message text to include in the logged error.

response - (int) The response code for the call.

resumeProcessing

public static final void resumeProcessing()

Instructs this class to resume processing of notification requests. The processing might have been suspended due to the failed login retry attempts exceeding the maximum attempts allowed. Resets the login retries counter to zero and then submits a background task that performs pertinent Flash startup processing related to the Notification Framework, which might not have been performed during Flash startup due to whatever caused this class to suspend its processing.

retryUnauthorized

protected static final boolean retryUnauthorized(java.lang.String api,
                                                 java.lang.String token)

Answers if a notification framework API call should be retried due to an unauthorized response from the framework (HTTP_UNAUTHORIZED).

Parameters:

api - (String) The api being called when the unauthorized response occurred.

token - (String) The authorization token that was used when the unauthorized response occurred.

Returns:

boolean - true if a retry should be attempted, otherwise false.

setDefaultSSLContext

protected static void setDefaultSSLContext()
                                    throws java.lang.Exception

Sets the default SSL context for URL SSL connections so that self-signed certificates will be accepted.

Throws:

java.lang.Exception - - if an error occurs while setting the context.