Updating UI oauth module with suppressed warnings for verified, but unresolved variables and functions

components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/modules/oauth/token-handler-utils.js

@@ -31,17 +31,17 @@ var utils = function () {
     var publicMethods = {};
     var privateMethods = {};
 
-    publicMethods.encode = function (payload) {
+    publicMethods["encode"] = function (payload) {
         //noinspection JSUnresolvedFunction
         return String(Base64.encodeBase64(String(payload).getBytes()));
     };
 
-    publicMethods.decode = function (payload) {
+    publicMethods["decode"] = function (payload) {
         //noinspection JSUnresolvedFunction
         return String(Base64.decodeBase64(String(payload).getBytes()));
     };
 
-    publicMethods.getDynamicClientAppCredentials = function () {
+    publicMethods["getDynamicClientAppCredentials"] = function () {
         // setting up dynamic client application properties
         var dcAppProperties = {
             "applicationType": deviceMgtProps["oauthProvider"]["appRegistration"]["appType"],
@@ -80,7 +80,79 @@ var utils = function () {
         return dynamicClientAppCredentials;
     };
 
-    publicMethods.getTokenPairByPasswordGrantType = function (username, password, encodedClientAppCredentials, scopes) {
+    publicMethods["getTenantBasedClientAppCredentials"] = function (username, jwtToken) {
+        if (!username || !jwtToken) {
+            log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving tenant " +
+                "based client app credentials. No username or jwt token is found " +
+                "as input - getTenantBasedClientAppCredentials(x, y)");
+            return null;
+        } else {
+            //noinspection JSUnresolvedFunction, JSUnresolvedVariable
+            var tenantDomain = carbon.server.tenantDomain({username: username});
+            if (!tenantDomain) {
+                log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving tenant " +
+                    "based client application credentials. Unable to obtain a valid tenant domain for provided " +
+                    "username - getTenantBasedClientAppCredentials(x, y)");
+                return null;
+            } else {
+                var cachedTenantBasedClientAppCredentials = privateMethods.
+                    getCachedTenantBasedClientAppCredentials(tenantDomain);
+                if (cachedTenantBasedClientAppCredentials) {
+                    return cachedTenantBasedClientAppCredentials;
+                } else {
+                    // register a tenant based client app at API Manager
+                    var applicationName = "webapp_" + tenantDomain;
+                    var requestURL = deviceMgtProps["oauthProvider"]["appRegistration"]
+                        ["apiManagerClientAppRegistrationServiceURL"] +
+                        "?tenantDomain=" + tenantDomain + "&applicationName=" + applicationName;
+
+                    var xhr = new XMLHttpRequest();
+                    xhr.open("POST", requestURL, false);
+                    xhr.setRequestHeader("Content-Type", "application/json");
+                    xhr.setRequestHeader("Authorization", "Bearer " + jwtToken);
+                    xhr.send();
+
+                    if (xhr["status"] == 201 && xhr["responseText"]) {
+                        var responsePayload = parse(xhr["responseText"]);
+                        var tenantBasedClientAppCredentials = {};
+                        tenantBasedClientAppCredentials["clientId"] = responsePayload["client_id"];
+                        tenantBasedClientAppCredentials["clientSecret"] = responsePayload["client_secret"];
+                        privateMethods.
+                            setCachedTenantBasedClientAppCredentials(tenantDomain, tenantBasedClientAppCredentials);
+                        return tenantBasedClientAppCredentials;
+                    } else {
+                        log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving tenant " +
+                            "based client application credentials from API " +
+                            "Manager - getTenantBasedClientAppCredentials(x, y)");
+                        return null;
+                    }
+                }
+            }
+        }
+    };
+
+    privateMethods["setCachedTenantBasedClientAppCredentials"] = function (tenantDomain, clientAppCredentials) {
+        var cachedTenantBasedClientAppCredentialsMap = application.get(constants["CACHED_CREDENTIALS"]);
+        if (!cachedTenantBasedClientAppCredentialsMap) {
+            cachedTenantBasedClientAppCredentialsMap = {};
+            cachedTenantBasedClientAppCredentialsMap[tenantDomain] = clientAppCredentials;
+            application.put(constants["CACHED_CREDENTIALS"], cachedTenantBasedClientAppCredentialsMap);
+        } else if (!cachedTenantBasedClientAppCredentialsMap[tenantDomain]) {
+            cachedTenantBasedClientAppCredentialsMap[tenantDomain] = clientAppCredentials;
+        }
+    };
+
+    privateMethods["getCachedTenantBasedClientAppCredentials"] = function (tenantDomain) {
+        var cachedTenantBasedClientAppCredentialsMap = application.get(constants["CACHED_CREDENTIALS"]);
+        if (!cachedTenantBasedClientAppCredentialsMap ||
+            !cachedTenantBasedClientAppCredentialsMap[tenantDomain]) {
+            return null;
+        } else {
+            return cachedTenantBasedClientAppCredentialsMap[tenantDomain];
+        }
+    };
+
+    publicMethods["getTokenPairByPasswordGrantType"] = function (username, password, encodedClientAppCredentials, scopes) {
         if (!username || !password || !encodedClientAppCredentials || !scopes) {
             log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving access token by password " +
                 "grant type. No username, password, encoded client app credentials or scopes are " +
@@ -112,7 +184,7 @@ var utils = function () {
         }
     };
 
-    publicMethods.getTokenPairBySAMLGrantType = function (assertion, encodedClientAppCredentials, scopes) {
+    publicMethods["getTokenPairBySAMLGrantType"] = function (assertion, encodedClientAppCredentials, scopes) {
         if (!assertion || !encodedClientAppCredentials || !scopes) {
             log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving access token by saml " +
                 "grant type. No assertion, encoded client app credentials or scopes are " +
@@ -165,7 +237,7 @@ var utils = function () {
         }
     };
 
-    publicMethods.getNewTokenPairByRefreshToken = function (refreshToken, encodedClientAppCredentials, scopes) {
+    publicMethods["getNewTokenPairByRefreshToken"] = function (refreshToken, encodedClientAppCredentials, scopes) {
         if (!refreshToken || !encodedClientAppCredentials) {
             log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving new access token " +
                 "by current refresh token. No refresh token or encoded client app credentials are " +
@@ -198,7 +270,7 @@ var utils = function () {
         }
     };
 
-    publicMethods.getAccessTokenByJWTGrantType =  function (clientAppCredentials) {
+    publicMethods["getAccessTokenByJWTGrantType"] =  function (clientAppCredentials) {
         if (!clientAppCredentials) {
             log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving new access token " +
                 "by current refresh token. No client app credentials are found " +
@@ -217,77 +289,5 @@ var utils = function () {
         }
     };
 
-    publicMethods.getTenantBasedClientAppCredentials = function (username, jwtToken) {
-        if (!username || !jwtToken) {
-            log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving tenant " +
-                "based client app credentials. No username or jwt token is found " +
-                    "as input - getTenantBasedClientAppCredentials(x, y)");
-            return null;
-        } else {
-            //noinspection JSUnresolvedFunction, JSUnresolvedVariable
-            var tenantDomain = carbon.server.tenantDomain({username: username});
-            if (!tenantDomain) {
-                log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving tenant " +
-                    "based client application credentials. Unable to obtain a valid tenant domain for provided " +
-                        "username - getTenantBasedClientAppCredentials(x, y)");
-                return null;
-            } else {
-                var cachedTenantBasedClientAppCredentials = privateMethods.
-                    getCachedTenantBasedClientAppCredentials(tenantDomain);
-                if (cachedTenantBasedClientAppCredentials) {
-                    return cachedTenantBasedClientAppCredentials;
-                } else {
-                    // register a tenant based client app at API Manager
-                    var applicationName = "webapp_" + tenantDomain;
-                    var requestURL = deviceMgtProps["oauthProvider"]["appRegistration"]
-                        ["apiManagerClientAppRegistrationServiceURL"] +
-                            "?tenantDomain=" + tenantDomain + "&applicationName=" + applicationName;
-
-                    var xhr = new XMLHttpRequest();
-                    xhr.open("POST", requestURL, false);
-                    xhr.setRequestHeader("Content-Type", "application/json");
-                    xhr.setRequestHeader("Authorization", "Bearer " + jwtToken);
-                    xhr.send();
-
-                    if (xhr["status"] == 201 && xhr["responseText"]) {
-                        var responsePayload = parse(xhr["responseText"]);
-                        var tenantBasedClientAppCredentials = {};
-                        tenantBasedClientAppCredentials["clientId"] = responsePayload["client_id"];
-                        tenantBasedClientAppCredentials["clientSecret"] = responsePayload["client_secret"];
-                        privateMethods.
-                            setCachedTenantBasedClientAppCredentials(tenantDomain, tenantBasedClientAppCredentials);
-                        return tenantBasedClientAppCredentials;
-                    } else {
-                        log.error("{/app/modules/oauth/token-handler-utils.js} Error in retrieving tenant " +
-                            "based client application credentials from API " +
-                                "Manager - getTenantBasedClientAppCredentials(x, y)");
-                        return null;
-                    }
-                }
-            }
-        }
-    };
-
-    privateMethods.setCachedTenantBasedClientAppCredentials = function (tenantDomain, clientAppCredentials) {
-        var cachedTenantBasedClientAppCredentialsMap = application.get(constants["CACHED_CREDENTIALS"]);
-        if (!cachedTenantBasedClientAppCredentialsMap) {
-            cachedTenantBasedClientAppCredentialsMap = {};
-            cachedTenantBasedClientAppCredentialsMap[tenantDomain] = clientAppCredentials;
-            application.put(constants["CACHED_CREDENTIALS"], cachedTenantBasedClientAppCredentialsMap);
-        } else if (!cachedTenantBasedClientAppCredentialsMap[tenantDomain]) {
-            cachedTenantBasedClientAppCredentialsMap[tenantDomain] = clientAppCredentials;
-        }
-    };
-
-    privateMethods.getCachedTenantBasedClientAppCredentials = function (tenantDomain) {
-        var cachedTenantBasedClientAppCredentialsMap = application.get(constants["CACHED_CREDENTIALS"]);
-        if (!cachedTenantBasedClientAppCredentialsMap ||
-            !cachedTenantBasedClientAppCredentialsMap[tenantDomain]) {
-            return null;
-        } else {
-            return cachedTenantBasedClientAppCredentialsMap[tenantDomain];
-        }
-    };
-
     return publicMethods;
 }();

components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/modules/oauth/token-handlers.js

@@ -32,7 +32,7 @@ var handlers = function () {
     var publicMethods = {};
     var privateMethods = {};
 
-    publicMethods.setupTokenPairByPasswordGrantType = function (username, password) {
+    publicMethods["setupTokenPairByPasswordGrantType"] = function (username, password) {
         if (!username || !password) {
             throw new Error("{/app/modules/oauth/token-handlers.js} Could not set up access token pair by " +
                 "password grant type. Either username of logged in user, password or both are missing " +
@@ -67,7 +67,7 @@ var handlers = function () {
         }
     };
 
-    publicMethods.setupTokenPairBySamlGrantType = function (username, samlToken) {
+    publicMethods["setupTokenPairBySamlGrantType"] = function (username, samlToken) {
         if (!username || !samlToken) {
             throw new Error("{/app/modules/oauth/token-handlers.js} Could not set up access token pair by " +
                 "saml grant type. Either username of logged in user, samlToken or both are missing " +
@@ -96,7 +96,7 @@ var handlers = function () {
         }
     };
 
-    publicMethods.refreshTokenPair = function () {
+    publicMethods["refreshTokenPair"] = function () {
         var currentTokenPair = parse(session.get(constants["TOKEN_PAIR"]));
         // currentTokenPair includes current access token as well as current refresh token
         var encodedClientAppCredentials = session.get(constants["ENCODED_TENANT_BASED_CLIENT_APP_CREDENTIALS"]);
@@ -116,7 +116,7 @@ var handlers = function () {
         }
     };
 
-    privateMethods.setUpEncodedTenantBasedClientAppCredentials = function (username) {
+    privateMethods["setUpEncodedTenantBasedClientAppCredentials"] = function (username) {
         if (!username) {
             throw new Error("{/app/modules/oauth/token-handlers.js} Could not set up encoded tenant based " +
                 "client credentials to session context. No username of logged in user is found as " +

components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/modules/oauth/token-protected-service-invokers.js

@@ -67,7 +67,7 @@ var invokers = function () {
      * @param responseCallback a function to be called with response retrieved.
      * @param count a counter which hold the number of recursive execution
      */
-    privateMethods.execute = function (httpMethod, requestPayload, endpoint, responseCallback, count) {
+    privateMethods["execute"] = function (httpMethod, requestPayload, endpoint, responseCallback, count) {
         var xmlHttpRequest = new XMLHttpRequest();
 
         xmlHttpRequest.open(httpMethod, endpoint);
@@ -81,8 +81,8 @@ var invokers = function () {
                     response.sendRedirect(devicemgtProps["appContext"] + "login");
                 });
             } else {
-                xmlHttpRequest.
+                xmlHttpRequest.setRequestHeader(constants["AUTHORIZATION_HEADER"],
-                    setRequestHeader(constants["AUTHORIZATION_HEADER"], constants["BEARER_PREFIX"] + accessToken);
+                    constants["BEARER_PREFIX"] + accessToken);
             }
         }
 
@@ -99,7 +99,6 @@ var invokers = function () {
         log.info("Request payload if any : " + stringify(requestPayload));
         log.info("Response status : " + xmlHttpRequest.status);
         log.info("Response payload if any : " + xmlHttpRequest.responseText);
-        //log.info("Response headers : " + xmlHttpRequest.getAllResponseHeaders());
 
         if (xmlHttpRequest.status == 401 && (xmlHttpRequest.responseText == TOKEN_EXPIRED ||
             xmlHttpRequest.responseText == TOKEN_INVALID ) && count < 5) {
@@ -117,7 +116,7 @@ var invokers = function () {
      * @param endpoint Backend REST API url.
      * @param responseCallback a function to be called with response retrieved.
      */
-    privateMethods.initiateXMLHTTPRequest = function (httpMethod, requestPayload, endpoint, responseCallback) {
+    privateMethods["initiateXMLHTTPRequest"] = function (httpMethod, requestPayload, endpoint, responseCallback) {
         return privateMethods.execute(httpMethod, requestPayload, endpoint, responseCallback, 0);
     };
 
@@ -126,7 +125,7 @@ var invokers = function () {
      * @param endpoint Backend REST API url.
      * @param responseCallback a function to be called with response retrieved.
      */
-    publicXMLHTTPInvokers.get = function (endpoint, responseCallback) {
+    publicXMLHTTPInvokers["get"] = function (endpoint, responseCallback) {
         var requestPayload = null;
         return privateMethods.initiateXMLHTTPRequest(constants["HTTP_GET"], requestPayload, endpoint, responseCallback);
     };
@@ -137,7 +136,7 @@ var invokers = function () {
      * @param requestPayload payload/data if exists which is needed to be send.
      * @param responseCallback a function to be called with response retrieved.
      */
-    publicXMLHTTPInvokers.post = function (endpoint, requestPayload, responseCallback) {
+    publicXMLHTTPInvokers["post"] = function (endpoint, requestPayload, responseCallback) {
         return privateMethods.initiateXMLHTTPRequest(constants["HTTP_POST"], requestPayload, endpoint, responseCallback);
     };
 
@@ -147,7 +146,7 @@ var invokers = function () {
      * @param requestPayload payload/data if exists which is needed to be send.
      * @param responseCallback a function to be called with response retrieved.
      */
-    publicXMLHTTPInvokers.put = function (endpoint, requestPayload, responseCallback) {
+    publicXMLHTTPInvokers["put"] = function (endpoint, requestPayload, responseCallback) {
         return privateMethods.initiateXMLHTTPRequest(constants["HTTP_PUT"], requestPayload, endpoint, responseCallback);
     };
 
@@ -156,7 +155,7 @@ var invokers = function () {
      * @param endpoint Backend REST API url.
      * @param responseCallback a function to be called with response retrieved.
      */
-    publicXMLHTTPInvokers.delete = function (endpoint, responseCallback) {
+    publicXMLHTTPInvokers["delete"] = function (endpoint, responseCallback) {
         var requestPayload = null;
         return privateMethods.initiateXMLHTTPRequest(constants["HTTP_DELETE"], requestPayload, endpoint, responseCallback);
     };
@@ -176,8 +175,10 @@ var invokers = function () {
      * @param errorCallback a function to be called if en error is reserved.
      * @param soapVersion soapVersion which need to used.
      */
-    privateMethods.initiateWSRequest = function (action, endpoint, successCallback, errorCallback, soapVersion, payload) {
+    privateMethods["initiateWSRequest"] = function (action, endpoint, successCallback,
+                                                    errorCallback, soapVersion, payload) {
         var ws = require("ws");
+        //noinspection JSUnresolvedFunction
         var wsRequest = new ws.WSRequest();
         var options = [];
         if (devicemgtProps["isOAuthEnabled"]) {
@@ -222,8 +223,10 @@ var invokers = function () {
      * @param errorCallback a function to be called if en error is reserved.
      * @param soapVersion soapVersion which need to used.
      */
-    publicWSInvokers.soapRequest = function (action, requestPayload, endpoint, successCallback, errorCallback, soapVersion) {
+    publicWSInvokers["soapRequest"] = function (action, requestPayload, endpoint,
-        return privateMethods.initiateWSRequest(action, endpoint, successCallback, errorCallback, soapVersion, requestPayload);
+                                                successCallback, errorCallback, soapVersion) {
+        return privateMethods.initiateWSRequest(action, endpoint, successCallback,
+                                                errorCallback, soapVersion, requestPayload);
     };
 
     /**
@@ -240,37 +243,46 @@ var invokers = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    privateMethods.initiateHTTPClientRequest = function (method, url, successCallback, errorCallback, payload) {
+    privateMethods["initiateHTTPClientRequest"] = function (method, url, successCallback, errorCallback, payload) {
+        //noinspection JSUnresolvedVariable
         var HttpClient = Packages.org.apache.commons.httpclient.HttpClient;
         var httpMethodObject;
         switch (method) {
             case constants["HTTP_GET"]:
+                //noinspection JSUnresolvedVariable
                 var GetMethod = Packages.org.apache.commons.httpclient.methods.GetMethod;
                 httpMethodObject = new GetMethod(url);
                 break;
             case constants["HTTP_POST"]:
+                //noinspection JSUnresolvedVariable
                 var PostMethod = Packages.org.apache.commons.httpclient.methods.PostMethod;
                 httpMethodObject = new PostMethod(url);
                 break;
             case constants["HTTP_PUT"]:
+                //noinspection JSUnresolvedVariable
                 var PutMethod = Packages.org.apache.commons.httpclient.methods.PutMethod;
                 httpMethodObject = new PutMethod(url);
                 break;
             case constants["HTTP_DELETE"]:
+                //noinspection JSUnresolvedVariable
                 var DeleteMethod = Packages.org.apache.commons.httpclient.methods.DeleteMethod;
                 httpMethodObject = new DeleteMethod(url);
                 break;
             default:
+                //noinspection JSUnresolvedFunction
                 throw new IllegalArgumentException("Invalid HTTP request method: " + method);
         }
+        //noinspection JSUnresolvedVariable
         var Header = Packages.org.apache.commons.httpclient.Header;
         var header = new Header();
         header.setName(constants["CONTENT_TYPE_IDENTIFIER"]);
         header.setValue(constants["APPLICATION_JSON"]);
+        //noinspection JSUnresolvedFunction
         httpMethodObject.addRequestHeader(header);
         header = new Header();
         header.setName(constants["ACCEPT_IDENTIFIER"]);
         header.setValue(constants["APPLICATION_JSON"]);
+        //noinspection JSUnresolvedFunction
         httpMethodObject.addRequestHeader(header);
 
         if (devicemgtProps["isOAuthEnabled"]) {
@@ -279,25 +291,33 @@ var invokers = function () {
                 header = new Header();
                 header.setName(constants["AUTHORIZATION_HEADER"]);
                 header.setValue(constants["BEARER_PREFIX"] + accessToken);
+                //noinspection JSUnresolvedFunction
                 httpMethodObject.addRequestHeader(header);
             } else {
                 response.sendRedirect(devicemgtProps["appContext"] + "login");
             }
         }
+        //noinspection JSUnresolvedFunction
         var stringRequestEntity = new StringRequestEntity(stringify(payload));
+        //noinspection JSUnresolvedFunction
         httpMethodObject.setRequestEntity(stringRequestEntity);
         var client = new HttpClient();
         try {
+            //noinspection JSUnresolvedFunction
             client.executeMethod(httpMethodObject);
+            //noinspection JSUnresolvedFunction
             var status = httpMethodObject.getStatusCode();
             if (status == 200) {
+                //noinspection JSUnresolvedFunction
                 return successCallback(httpMethodObject.getResponseBody());
             } else {
+                //noinspection JSUnresolvedFunction
                 return errorCallback(httpMethodObject.getResponseBody());
             }
         } catch (e) {
             return errorCallback(response);
         } finally {
+            //noinspection JSUnresolvedFunction
             method.releaseConnection();
         }
     };
@@ -308,7 +328,7 @@ var invokers = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.get = function (url, successCallback, errorCallback) {
+    publicHTTPClientInvokers["get"] = function (url, successCallback, errorCallback) {
         var requestPayload = null;
         return privateMethods.
             initiateHTTPClientRequest(constants["HTTP_GET"], url, successCallback, errorCallback, requestPayload);
@@ -321,7 +341,7 @@ var invokers = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.post = function (url, payload, successCallback, errorCallback) {
+    publicHTTPClientInvokers["post"] = function (url, payload, successCallback, errorCallback) {
         return privateMethods.
             initiateHTTPClientRequest(constants["HTTP_POST"], url, successCallback, errorCallback, payload);
     };
@@ -333,7 +353,7 @@ var invokers = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.put = function (url, payload, successCallback, errorCallback) {
+    publicHTTPClientInvokers["put"] = function (url, payload, successCallback, errorCallback) {
         return privateMethods.
             initiateHTTPClientRequest(constants["HTTP_PUT"], url, successCallback, errorCallback, payload);
     };
@@ -344,7 +364,7 @@ var invokers = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.delete = function (url, successCallback, errorCallback) {
+    publicHTTPClientInvokers["delete"] = function (url, successCallback, errorCallback) {
         var requestPayload = null;
         return privateMethods.
             initiateHTTPClientRequest(constants["HTTP_DELETE"], url, successCallback, errorCallback, requestPayload);