Enable multi user logged in to multiple back ends in multiple tabs (#183)

* Back gui sends back-end-name as prameter to bridge
* Enable multi user logged in to multiple back ends in multiple tabs
* A user may browse EI front end gui same or different back end without
  interference from other tab.
* A user logging in and or out from a back end will be logged in or out on
  all tabs for specified back end.
* Selected back end is defined for current tab.
* a new parameter has been enabled in bridge "backendname" that selects a
  back end instance based on its name in the back end instance list.

Author: Anders Breid

pom.xml

@@ -232,6 +232,7 @@
                         </goals>
                         <configuration>
                             <sources>
+                                <source>src/test/resources</source>
                                 <source>src/functionaltest/java</source>
                                 <source>src/functionaltest/resources</source>
                                 <source>src/integrationtest/java</source>

src/functionaltest/java/com/ericsson/ei/frontend/TestRulesFunctionality.java

@@ -52,7 +52,7 @@ public void testJourneyToFindAggregatedObjectButton() throws Exception {
         int portServer = mockServer.getLocalPort();
         backEndInstancesUtils.setDefaultBackEndInstanceToNull();
         backEndInstancesUtils.setDefaultBackEndInstance("new_instance_default", "localhost", portServer, "", true);
-        JavascriptExecutor js = (JavascriptExecutor) driver;
+        JavascriptExecutor js = driver;
 
         // Open indexpage and verify that it is opened
         IndexPage indexPageObject = new IndexPage(null, driver, baseUrl);
@@ -137,7 +137,6 @@ public static void setUpMocks() throws IOException {
     @AfterClass
     public static void tearDownMocks() throws IOException {
         mockClient.stop();
-        mockServer.stop();
     }
 
 }

src/main/java/com/ericsson/ei/frontend/utils/BackEndInformationControllerUtils.java

@@ -17,7 +17,6 @@
 package com.ericsson.ei.frontend.utils;
 
 import java.net.URI;
-import java.util.NoSuchElementException;
 import java.util.stream.Collectors;
 
 import javax.servlet.http.HttpServletRequest;
@@ -32,7 +31,6 @@
 import org.springframework.stereotype.Component;
 
 import com.google.gson.JsonArray;
-import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
 
@@ -54,13 +52,7 @@ public class BackEndInformationControllerUtils {
      */
     public ResponseEntity<String> handleRequestForInstances(HttpServletRequest request) {
         try {
-            String activeInstance = null;
-            if (request.getSession().getAttribute("backEndInstanceName") != null) {
-                activeInstance = request.getSession().getAttribute("backEndInstanceName").toString();
-            }
-
             JsonArray allAvailableInstances = backEndInstancesUtils.getBackEndsAsJsonArray();
-            allAvailableInstances = setActiveInstance(allAvailableInstances, activeInstance);
 
             return new ResponseEntity<>(
                     allAvailableInstances.toString(),
@@ -206,21 +198,4 @@ private HttpHeaders getHeaders() {
         return httpHeaders;
     }
 
-    private JsonArray setActiveInstance(JsonArray allAvailableInstances, String activeInstance) {
-        if (allAvailableInstances.size() == 0) {
-            throw new NoSuchElementException ("No Available instances, back end instance list is empty!");
-        }
-        for (JsonElement element : allAvailableInstances) {
-            if (activeInstance == null && element.getAsJsonObject().get("defaultBackend").getAsBoolean()) {
-                element.getAsJsonObject().addProperty("active", true);
-            } else if (activeInstance != null
-                    && element.getAsJsonObject().get("name").getAsString().equals(activeInstance)) {
-                element.getAsJsonObject().addProperty("active", true);
-            } else {
-                element.getAsJsonObject().addProperty("active", false);
-            }
-        }
-        return allAvailableInstances;
-    }
-
 }

src/main/java/com/ericsson/ei/frontend/utils/EIRequestsControllerUtils.java

@@ -17,11 +17,12 @@
 package com.ericsson.ei.frontend.utils;
 
 import java.io.IOException;
+import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.net.URLDecoder;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 
 import javax.servlet.http.HttpServletRequest;
@@ -44,16 +45,16 @@ public class EIRequestsControllerUtils {
 
     private static final Logger LOG = LoggerFactory.getLogger(EIRequestsControllerUtils.class);
 
-    private static final List<String> REQUESTS_WITH_QUERY_PARAM = new ArrayList<>(Arrays.asList("/queryAggregatedObject", "/queryMissedNotifications", "/query"));
-    private static final String BACKEND_KEY_NAME = "backendurl";
+    private static final String BACKEND_URL_KEY_NAME = "backendurl";
+    private static final String BACKEND_NAME_KEY_NAME = "backendname";
 
     @Autowired
     private BackEndInstancesUtils backEndInstancesUtils;
 
     /**
-     * Processes an HttpServletRequest and extract the URL parameters from it and reformats
-     * the requests and removes EI Front End specific parameters if any and builds a new URL
-     * to be used to call the requested, selected or default EI back end.
+     * Processes an HttpServletRequest and extract the URL parameters from it and reformats the requests and removes EI
+     * Front End specific parameters if any and builds a new URL to be used to call the requested, selected or default
+     * EI back end.
      *
      * @param request
      * @return String
@@ -62,38 +63,42 @@ public class EIRequestsControllerUtils {
     public String getEIRequestURL(HttpServletRequest request) {
         String eiBackendAddressSuffix = request.getServletPath();
         String requestQuery = request.getQueryString();
-        String requestUrl = null;
 
-        if (requestQuery != null && requestQuery.contains(BACKEND_KEY_NAME)) {
-            // Selecting back end from user input as parameter.
-            List<NameValuePair> params = getParameters(requestQuery);
-            requestUrl = extractUrlFromParameters(params);
-            requestQuery = removeBackendDataFromQueryString(params);
-            LOG.debug(BACKEND_KEY_NAME + " key detected, forwarding request to url '" + requestUrl + "'.");
-        } else {
-            BackEndInformation backEndInformation = getEIBackendInformation(request);
-            requestUrl = backEndInformation.getUrlAsString();
-        }
+        String requestUrl = getBackEndUrl(requestQuery);
+        requestQuery = removeBackendDataFromQueryString(requestQuery);
 
-        if(REQUESTS_WITH_QUERY_PARAM.contains(eiBackendAddressSuffix)) {
-            String query = (requestQuery != null && !requestQuery.isEmpty()) ? "?" + requestQuery : "";
+        if (!requestQuery.isEmpty()) {
+            String query = "?" + requestQuery;
             requestUrl = requestUrl + eiBackendAddressSuffix + query;
         } else {
             requestUrl = requestUrl + eiBackendAddressSuffix;
         }
+
         LOG.debug("Got HTTP Request with method " + request.getMethod() + "\nUrlSuffix: " + eiBackendAddressSuffix
                 + "\nForwarding Request to EI Backend with url: " + requestUrl);
+
         return requestUrl;
     }
 
-    private BackEndInformation getEIBackendInformation(HttpServletRequest request) {
-        String backEndInstanceName = null;
+    private String getBackEndUrl(String requestQuery) {
+        String requestUrl = null;
 
-        if (request.getSession().getAttribute("backEndInstanceName") != null) {
-            backEndInstanceName = request.getSession().getAttribute("backEndInstanceName").toString();
+        if (requestQuery != null) {
+            List<NameValuePair> params = getParameters(requestQuery);
+            if (requestQuery.contains(BACKEND_URL_KEY_NAME)) {
+                requestUrl = extractUrlFromParameters(params);
+            } else {
+                String backEndName = extractBackEndNameFromParameters(params);
+                BackEndInformation backEndInformation = backEndInstancesUtils.getBackEndInformationByName(backEndName);
+                requestUrl = backEndInformation.getUrlAsString();
+            }
+        } else {
+            BackEndInformation backEndInformation = backEndInstancesUtils.getBackEndInformationByName(null);
+            requestUrl = backEndInformation.getUrlAsString();
         }
 
-        return backEndInstancesUtils.getBackEndInformationByName(backEndInstanceName);
+        LOG.debug("Forwarding request to url '" + requestUrl + "'.");
+        return requestUrl;
     }
 
     private List<NameValuePair> getParameters(String requestQuery) {
@@ -104,31 +109,58 @@ private List<NameValuePair> getParameters(String requestQuery) {
         } catch (URISyntaxException e) {
             LOG.error("Error while encoding URL parameters: " + e);
         }
+
         return params;
     }
 
     private String extractUrlFromParameters(List<NameValuePair> params) {
         String urlFromParams = null;
+
         for (NameValuePair param : params) {
-            if (param.getName().equals(BACKEND_KEY_NAME)) {
-                urlFromParams = param.getValue();
+            if (param.getName()
+                     .equals(BACKEND_URL_KEY_NAME)) {
+                try {
+                    urlFromParams = URLDecoder.decode(param.getValue(), "UTF-8");
+                } catch (UnsupportedEncodingException e) {
+                    LOG.error("Failed to decode back-end url");
+                }
             }
         }
+
         return urlFromParams;
     }
 
-    private String removeBackendDataFromQueryString(List<NameValuePair> params) {
+    private String extractBackEndNameFromParameters(List<NameValuePair> params) {
+        String backendName = null;
+
+        for (NameValuePair param : params) {
+            if (param.getName()
+                     .equals(BACKEND_NAME_KEY_NAME)) {
+                try {
+                    backendName = URLDecoder.decode(param.getValue(), "UTF-8");
+                } catch (UnsupportedEncodingException e) {
+                    LOG.error("Failed to decode back-end name");
+                }
+            }
+        }
+
+        return backendName;
+    }
+
+    private String removeBackendDataFromQueryString(String requestQuery) {
+        List<NameValuePair> params = getParameters(requestQuery);
         List<NameValuePair> processedParams = new ArrayList<>();
         for (NameValuePair param : params) {
             String name = param.getName(), value = param.getValue();
-            if (name.equals(BACKEND_KEY_NAME)) {
+            if (name == null || value == null || name.equals(BACKEND_URL_KEY_NAME) || name.equals(BACKEND_NAME_KEY_NAME)) {
                 continue;
             }
             processedParams.add(new BasicNameValuePair(name, value));
         }
 
-        if (processedParams.size() == 0)
-            return null;
+        if (processedParams.size() == 0) {
+            return "";
+        }
 
         return URLEncodedUtils.format(processedParams, "UTF8");
     }