Revert #52 (egress functionality) (#63)

Author: cowtowncoder

README.md

@@ -73,18 +73,6 @@ UUID uuid = gen.generate();
 UUID anotherUuid = gen.generate();
 ```
 
-If your machine has a standard IP networking setup, the `Generators.egressTimeBasedGenerator` (added in JUG 4.1) 
-factory method will try to determine which network interface corresponds to the default route for 
-all outgoing network traffic, and use that for creating a time based generator.
-This is likely a good choice for common usage scenarios if you want a version 1 UUID generator, but unfortunately
-is known not to work reliably on some platforms (MacOS seems to have some issues).
-
-```java
-TimeBasedGenerator gen = Generators.egressTimeBasedGenerator();
-UUID uuid = gen.generate();
-UUID anotherUuid = gen.generate();
-```
-
 Generators are fully thread-safe, so a single instance may be shared among multiple threads.
 
 Javadocs for further information can be found from [Project Wiki](../../wiki).

release-notes/CREDITS

@@ -120,7 +120,3 @@ Hal Hildebrand (Hellblazer@github)
   [4.1.0]
   * Contributed #46: Add support for Proposed type v7 (epoch-based time uuid)
   [4.1.0]
-
-Paul Galbraith (pgalbraith@github)
-  * Contributed #52: Add `Generators.egressTimeBasedGenerator()` method that constructs
-    `TimedBasedGenerator` with a sensible choice of interface

release-notes/VERSION

@@ -10,10 +10,7 @@ Releases
  (contributed by Hal H)
 #46: Add support for Proposed type v7 (epoch-based time uuid)
  (contributed by Hal H)
-#52: Add `Generators.egressTimeBasedGenerator()` method that constructs `TimedBasedGenerator`
-  with a sensible choice of interface
- (contributed by Paul G)
- #55: Add `Main-Class` manifest to make jar invoke `Jug` class
+#55: Add `Main-Class` manifest to make jar invoke `Jug` class
 - Fix a minor issue with argument validation for `Jug` tool class
 - Update junit dependency (via oss-parent:41)
 - Update slf4j-api to 1.7.36

src/main/java/com/fasterxml/uuid/EthernetAddress.java

@@ -275,9 +275,9 @@ public static EthernetAddress fromInterface()
             while (en.hasMoreElements()) {
                 NetworkInterface nint = en.nextElement();
                 if (!nint.isLoopback()) {
-                    EthernetAddress addr = fromInterface(nint);
-                    if (addr != null) {
-                        return addr;
+                    byte[] data = nint.getHardwareAddress();
+                    if ((data != null) && (data.length == 6)) {
+                        return new EthernetAddress(data);
                     }
                 }
             }
@@ -287,83 +287,6 @@ public static EthernetAddress fromInterface()
         return null;
     }
 
-    /**
-     * A factory method to return the ethernet address of a specified network interface.
-     *
-     * @since 4.1
-     */
-    public static EthernetAddress fromInterface(NetworkInterface nint) 
-    {
-        if (nint != null) {
-            try {
-                byte[] data = nint.getHardwareAddress();
-                if (data != null && data.length == 6) {
-                    return new EthernetAddress(data);
-                }
-            } catch (SocketException e) {
-                // could not get address
-            }
-        }
-        return null;
-    }
-
-    /**
-     * A factory method that will try to determine the ethernet address of
-     * the network interface that connects to the default network gateway.
-     * To do this it will try to open a connection to one of the root DNS
-     * servers, or barring that, to address 1.1.1.1, or finally if that also
-     * fails then to IPv6 address "1::1".  If a connection can be opened then
-     * the interface through which that connection is routed is determined
-     * to be the default egress interface, and the corresponding address of
-     * that interface will be returned.  If all attempts are unsuccessful,
-     * null will be returned.
-     *
-     * @since 4.1
-     */
-    public static EthernetAddress fromEgressInterface() 
-    {
-        String roots = "abcdefghijklm";
-        int index = new Random().nextInt(roots.length());
-        String name = roots.charAt(index) + ".root-servers.net";
-        // Specify standard/default port DNS uses; more robust on some platforms
-        // (MacOS/JDK 17), see:
-        // https://github.com/cowtowncoder/java-uuid-generator/pull/59
-        InetSocketAddress externalAddress = new InetSocketAddress(name, 53);
-        if (externalAddress.isUnresolved()) {
-            externalAddress = new InetSocketAddress("1.1.1.1", 0);
-        }
-        EthernetAddress ifAddr = fromEgressInterface(externalAddress);
-        if (ifAddr == null) {
-            return fromEgressInterface(new InetSocketAddress("1::1", 0));
-        } else {
-            return ifAddr;
-        }
-    }
-
-    /**
-     * A factory method to return the address of the interface used to route
-     * traffic to the specified IP address.
-     *
-     * @since 4.1
-     */
-    public static EthernetAddress fromEgressInterface(InetSocketAddress externalSocketAddress) 
-    {
-        DatagramSocket socket = null;
-        try {
-            socket = new DatagramSocket();
-            socket.connect(externalSocketAddress);
-            InetAddress localAddress = socket.getLocalAddress();
-            NetworkInterface egressIf = NetworkInterface.getByInetAddress(localAddress);
-            return fromInterface(egressIf);
-        } catch (SocketException e) {
-            return null;
-        } finally {
-            if (socket != null) {
-                socket.close();
-            }
-        }
-    }
-
     /**
      * Factory method that can be used to construct a random multicast
      * address; to be used in cases where there is no "real" ethernet

src/main/java/com/fasterxml/uuid/Generators.java

@@ -42,11 +42,6 @@ public class Generators
      */
     protected static UUIDTimer _sharedTimer;
 
-    /**
-     * The hardware address of the egress network interface.
-     */
-    protected static EthernetAddress _egressIfAddr = null;
-    
     // // Random-based generation
 
     /**
@@ -144,23 +139,6 @@ public static TimeBasedEpochGenerator timeBasedEpochGenerator(Random random)
 
     // // Time+location-based generation
 
-    /**
-     * Factory method for constructing UUID generator that generates UUID using variant 1
-     * (time+location based). This method will use the ethernet address of the interface
-     * that routes to the default gateway. For most simple and common networking configurations
-     * this will be the most appropriate address to use. The default interface is determined
-     * by the calling {@link EthernetAddress#fromEgressInterface()}.  Note that this will only
-     * identify the egress interface once: if you have a complex network setup where your
-     * outbound routes/interfaces may change dynamically, and you want your UUIDs to
-     * accurately reflect which interface is being actively used, this method is not for you.
-     *
-     * @since 4.1
-     */
-    public static TimeBasedGenerator egressTimeBasedGenerator()
-    {
-        return timeBasedGenerator(egressInterfaceAddress());
-    }
-
     /**
      * Factory method for constructing UUID generator that generates UUID using
      * variant 1 (time+location based).
@@ -283,12 +261,4 @@ private static synchronized UUIDTimer sharedTimer()
         }
         return _sharedTimer;
     }
-
-    private static synchronized EthernetAddress egressInterfaceAddress() 
-    {
-    	  if (_egressIfAddr == null) {
-    	      _egressIfAddr = EthernetAddress.fromEgressInterface();
-    	  }
-    	  return _egressIfAddr;
-  	}
 }

src/test/java/com/fasterxml/uuid/EthernetAddressTest.java

@@ -32,7 +32,6 @@
  *
  * @author Eric Bie
  * @author Tatu Saloranta (changes for version 3.0)
- * @author Paul Galbraith (egress-related tests)
  */
 public class EthernetAddressTest extends TestCase
 {
@@ -1310,34 +1309,6 @@ public void testFromInterface() throws Exception
         assertNotNull(addr.toString());
     }
 
-    // 20-Jun-2022, tatu: Not sure why @Ignore didn't work but
-    //   need to comment out until [#52] is fully resolved
-/*
-    public void testFromEgressInterfaceRoot() throws Exception
-    {
-        InetSocketAddress extAddr = new InetSocketAddress("a.root-servers.net", 0);
-        EthernetAddress ifAddr = EthernetAddress.fromEgressInterface(extAddr);
-        assertNotNull(ifAddr);
-        assertNotNull(ifAddr.toString());
-    }
-
-    public void testFromEgressInterface() throws Exception
-    {
-        EthernetAddress ifAddr = EthernetAddress.fromEgressInterface();
-        assertNotNull(ifAddr);
-        assertNotNull(ifAddr.toString());
-    }
-    */
-
-    public void testDefaultTimeBasedGenerator()
-    {
-        TimeBasedGenerator generator = Generators.egressTimeBasedGenerator();
-        assertNotNull(generator);
-        EthernetAddress ifAddr = generator.getEthernetAddress();
-        assertNotNull(ifAddr);
-        assertNotNull(ifAddr.toString());
-    }
-
     public void testBogus() throws Exception
     {
         // First, two using pseudo-random; verify they are different