UrlKey to be used as cachekey instead of toString

Author: janakmulani

core/src/main/java/net/sourceforge/jnlp/util/UrlKey.java

@@ -0,0 +1,62 @@
+package net.sourceforge.jnlp.util;
+
+import net.adoptopenjdk.icedteaweb.StringUtils;
+
+import java.net.URL;
+import java.util.Locale;
+import java.util.Objects;
+
+public class UrlKey {
+ private String protocol;
+ private String host;
+ private String file;
+ private int port;
+ private String ref;
+
+    public UrlKey(final URL url) {
+        this.protocol = url.getProtocol() != null ? url.getProtocol().toLowerCase(Locale.ENGLISH) : null;
+        this.host = url.getHost();
+        this.port = url.getPort();
+        this.file = url.getFile();
+        this.ref = url.getRef();
+    }
+
+    @Override
+    public boolean equals(final Object obj) {
+        if (!(obj instanceof UrlKey)) {
+            return false;
+        }
+        UrlKey other = ((UrlKey) obj);
+        return  Objects.equals(protocol, other.protocol) &&
+                Objects.equals(host, other.host) &&
+                samePort(port, other.port) &&
+                Objects.equals(file, other.file) &&
+                Objects.equals(ref, other.ref);
+    }
+
+    private boolean samePort(int port, int other) {
+        if (port == other) {
+            return true;
+        }
+        final int defaultPort = getDefaultPort();
+        return  (port == defaultPort || port == -1) && (other == defaultPort || other == -1);
+    }
+
+    private int getDefaultPort() {
+        if ("https".equalsIgnoreCase(protocol)) {
+            return 443;
+        }
+        if ("http".equalsIgnoreCase(protocol)) {
+            return 80;
+        }
+        if ("ftp".equalsIgnoreCase(protocol)) {
+            return 21;
+        }
+        return -1;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(protocol, host, file, ref);
+    }
+}

core/src/test/java/net/sourceforge/jnlp/util/UrlKeyTest.java

@@ -0,0 +1,94 @@
+package net.sourceforge.jnlp.util;
+
+import junit.framework.TestCase;
+
+import java.net.URL;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+
+public class UrlKeyTest extends TestCase {
+
+    public void testEqualsHttp() throws Exception {
+        URL url1 = new URL("http://www.example.com:80/index.html?a=b#3");
+        List<URL> urlList = Arrays.asList(
+                new URL("http://www.example.com/index.html?a=b#3"),
+                new URL("Http://www.example.com/index.html?a=b#3"),
+                new URL("http://www.example.com:80/index.html?a=b#3"));
+
+        for (final URL url : urlList) {
+            UrlKey key1 = new UrlKey(url1);
+            UrlKey key2 = new UrlKey(url);
+
+            assertEquals(key1.hashCode(), key2.hashCode());
+            assertEquals(key1, key2);
+            assertEquals(key2, key1);
+        }
+    }
+
+    public void testNotEqualsHttp() throws Exception {
+        URL url1 = new URL("http://www.example.com:80/index.html?a=b#3");
+        List<URL> urlList = Arrays.asList(
+                new URL("http://www.Example.com:80/index.html?a=b#3"),
+                new URL("http://www.example.com:80/index2.html?a=b#3"),
+                new URL("http://www.example.com:80/index.html#3"),
+                new URL("https://www.example.com:80/index.html?a=b#3"),
+                new URL("http://www.example.com:80/index.html?a=c#3"),
+                new URL("http://www.example.com:80/index.html?a=b#4"),
+                new URL("http://www.example.com:80/index.html?a=b"),
+                new URL("http://www.example.com:80/#3"),
+                new URL("http://:80/index.html?a=b#3")
+        );
+
+        for (final URL url : urlList) {
+            UrlKey key1 = new UrlKey(url1);
+            UrlKey key2 = new UrlKey(url);
+
+            assertNotEquals(key1.hashCode(), key2.hashCode());
+            assertNotEquals(key1, key2);
+            assertNotEquals(key2, key1);
+        }
+    }
+
+    public void testNotEqualsDifferentPorts() throws Exception {
+        URL url1 = new URL("http://www.example.com:80/index.html?a=b#3");
+        URL url = new URL("http://www.example.com:81/index.html?a=b#3");
+
+        UrlKey key1 = new UrlKey(url1);
+        UrlKey key2 = new UrlKey(url);
+
+        assertEquals(key1.hashCode(), key2.hashCode());
+        assertNotEquals(key1, key2);
+        assertNotEquals(key2, key1);
+    }
+
+    private void assertNotEquals(Object o1, Object o2) {
+        assertFalse(Objects.equals(o1, o2));
+    }
+
+    public void testEqualsHttps() throws Exception {
+        URL url1 = new URL("https://www.example.com:443/index.html");
+        URL url2 = new URL("https://www.example.com/index.html");
+
+        UrlKey key1 = new UrlKey(url1);
+        UrlKey key2 = new UrlKey(url2);
+
+        assertEquals(key1.hashCode(), key2.hashCode());
+        assertEquals(key1, key2);
+        assertEquals(key2, key1);
+    }
+
+    public void testEqualsFtp() throws Exception {
+        URL url1 = new URL("ftp://www.example.com:21/index.html");
+        URL url2 = new URL("ftp://www.example.com/index.html");
+
+        UrlKey key1 = new UrlKey(url1);
+        UrlKey key2 = new UrlKey(url2);
+
+        assertEquals(key1.hashCode(), key2.hashCode());
+        assertEquals(key1, key2);
+        assertEquals(key2, key1);
+    }
+
+}
+