Format.
authorGary Gregory <garydgregory@gmail.com>
Fri, 2 Mar 2018 16:14:09 +0000 (09:14 -0700)
committerGary Gregory <garydgregory@gmail.com>
Fri, 2 Mar 2018 16:14:09 +0000 (09:14 -0700)
commons-testing-generic/src/main/java/org/apache/commons/testing/net/AvailableServerPortFinder.java

index 656a97a..4aff121 100644 (file)
-/*\r
- * Licensed to the Apache Software Foundation (ASF) under one or more\r
- * contributor license agreements. See the NOTICE file distributed with\r
- * this work for additional information regarding copyright ownership.\r
- * The ASF licenses this file to You under the Apache license, Version 2.0\r
- * (the "License"); you may not use this file except in compliance with\r
- * the License. You may obtain a copy of the License at\r
- *\r
- *      http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the license for the specific language governing permissions and\r
- * limitations under the license.\r
- */\r
-\r
-package org.apache.commons.testing.net;\r
-\r
-import java.io.IOException;\r
-import java.net.DatagramSocket;\r
-import java.net.ServerSocket;\r
-import java.util.NoSuchElementException;\r
-import java.util.concurrent.atomic.AtomicInteger;\r
-\r
-import org.apache.commons.testing.Closer;\r
-\r
-/**\r
- * Finds currently available server ports.\r
- */\r
-public final class AvailableServerPortFinder {\r
-\r
-    /**\r
-     * The minimum server currentMinPort number for IPv4.\r
-     * Set at 1100 to avoid returning privileged currentMinPort numbers.\r
-     */\r
-    public static final int MIN_PORT_NUMBER = 1100;\r
-\r
-    /**\r
-     * Incremented to the next lowest available port when getNextAvailable() is called.\r
-     */\r
-    private static AtomicInteger currentMinPort = new AtomicInteger(MIN_PORT_NUMBER);\r
-\r
-    /**\r
-     * We'll hold open the lowest port in this process\r
-     * so parallel processes won't use the same block\r
-     * of ports. They'll go up to the next block.\r
-     */\r
-    private static final ServerSocket LOCK;\r
-\r
-    /**\r
-     * The maximum server currentMinPort number for IPv4.\r
-     */\r
-    public static final int MAX_PORT_NUMBER = 65535;\r
-\r
-    static {\r
-        int port = MIN_PORT_NUMBER;\r
-        ServerSocket ss = null;\r
-\r
-        while (ss == null) {\r
-            try {\r
-                ss = new ServerSocket(port);\r
-            } catch (final Exception e) {\r
-                ss = null;\r
-                port += 200;\r
-            }\r
-        }\r
-        LOCK = ss;\r
-        Runtime.getRuntime().addShutdownHook(new Thread() {\r
-            @Override\r
-            public void run() {\r
-                close();\r
-            }\r
-        });\r
-        currentMinPort.set(port + 1);\r
-    }\r
-\r
-    /**\r
-     * Checks to see if a specific port is available.\r
-     *\r
-     * @param port the port number to check for availability\r
-     * @return {@code true} if the port is available, or {@code false} if not\r
-     * @throws IllegalArgumentException is thrown if the port number is out of range\r
-     */\r
-    public static synchronized boolean available(final int port) throws IllegalArgumentException {\r
-        if (port < currentMinPort.get() || port > MAX_PORT_NUMBER) {\r
-            throw new IllegalArgumentException("Invalid start currentMinPort: " + port);\r
-        }\r
-\r
-        ServerSocket ss = null;\r
-        DatagramSocket ds = null;\r
-        try {\r
-            ss = new ServerSocket(port);\r
-            ss.setReuseAddress(true);\r
-            ds = new DatagramSocket(port);\r
-            ds.setReuseAddress(true);\r
-            return true;\r
-        } catch (final IOException e) {\r
-            // Do nothing\r
-        } finally {\r
-            Closer.closeSilently(ds);\r
-            Closer.closeSilently(ss);\r
-        }\r
-\r
-        return false;\r
-    }\r
-\r
-    public static void close() {\r
-        Closer.closeSilently(LOCK);\r
-    }\r
-\r
-    /**\r
-     * Gets the next available port starting at the lowest number. This is the preferred\r
-     * method to use. The port return is immediately marked in use and doesn't rely on the caller actually opening\r
-     * the port.\r
-     *\r
-     * @throws IllegalArgumentException is thrown if the port number is out of range\r
-     * @throws NoSuchElementException if there are no ports available\r
-     * @return the available port\r
-     */\r
-    public static synchronized int getNextAvailable() {\r
-        final int next = getNextAvailable(currentMinPort.get());\r
-        currentMinPort.set(next + 1);\r
-        return next;\r
-    }\r
-\r
-    /**\r
-     * Gets the next available port starting at a given from port.\r
-     *\r
-     * @param fromPort the from port to scan for availability\r
-     * @throws IllegalArgumentException is thrown if the port number is out of range\r
-     * @throws NoSuchElementException if there are no ports available\r
-     * @return the available port\r
-     */\r
-    public static synchronized int getNextAvailable(final int fromPort) {\r
-        if (fromPort < currentMinPort.get() || fromPort > MAX_PORT_NUMBER) {\r
-            throw new IllegalArgumentException("From port number not in valid range: " + fromPort);\r
-        }\r
-\r
-        for (int i = fromPort; i <= MAX_PORT_NUMBER; i++) {\r
-            if (available(i)) {\r
-                return i;\r
-            }\r
-        }\r
-\r
-        throw new NoSuchElementException("Could not find an available port above " + fromPort);\r
-    }\r
-\r
-    /**\r
-     * Creates a new instance.\r
-     */\r
-    private AvailableServerPortFinder() {\r
-        // Do nothing\r
-    }\r
-\r
-}\r
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache license, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the license for the specific language governing permissions and
+ * limitations under the license.
+ */
+
+package org.apache.commons.testing.net;
+
+import java.io.IOException;
+import java.net.DatagramSocket;
+import java.net.ServerSocket;
+import java.util.NoSuchElementException;
+import java.util.concurrent.atomic.AtomicInteger;
+
+import org.apache.commons.testing.Closer;
+
+/**
+ * Finds currently available server ports.
+ */
+public final class AvailableServerPortFinder {
+
+    /**
+     * The minimum server currentMinPort number for IPv4. Set at 1100 to avoid returning privileged currentMinPort
+     * numbers.
+     */
+    public static final int MIN_PORT_NUMBER = 1100;
+
+    /**
+     * Incremented to the next lowest available port when getNextAvailable() is called.
+     */
+    private static AtomicInteger currentMinPort = new AtomicInteger(MIN_PORT_NUMBER);
+
+    /**
+     * We'll hold open the lowest port in this process so parallel processes won't use the same block of ports. They'll
+     * go up to the next block.
+     */
+    private static final ServerSocket LOCK;
+
+    /**
+     * The maximum server currentMinPort number for IPv4.
+     */
+    public static final int MAX_PORT_NUMBER = 65535;
+
+    static {
+        int port = MIN_PORT_NUMBER;
+        ServerSocket ss = null;
+
+        while (ss == null) {
+            try {
+                ss = new ServerSocket(port);
+            } catch (final Exception e) {
+                ss = null;
+                port += 200;
+            }
+        }
+        LOCK = ss;
+        Runtime.getRuntime().addShutdownHook(new Thread() {
+            @Override
+            public void run() {
+                close();
+            }
+        });
+        currentMinPort.set(port + 1);
+    }
+
+    /**
+     * Checks to see if a specific port is available.
+     *
+     * @param port
+     *            the port number to check for availability
+     * @return {@code true} if the port is available, or {@code false} if not
+     * @throws IllegalArgumentException
+     *             is thrown if the port number is out of range
+     */
+    public static synchronized boolean available(final int port) throws IllegalArgumentException {
+        if (port < currentMinPort.get() || port > MAX_PORT_NUMBER) {
+            throw new IllegalArgumentException("Invalid start currentMinPort: " + port);
+        }
+
+        ServerSocket ss = null;
+        DatagramSocket ds = null;
+        try {
+            ss = new ServerSocket(port);
+            ss.setReuseAddress(true);
+            ds = new DatagramSocket(port);
+            ds.setReuseAddress(true);
+            return true;
+        } catch (final IOException e) {
+            // Do nothing
+        } finally {
+            Closer.closeSilently(ds);
+            Closer.closeSilently(ss);
+        }
+
+        return false;
+    }
+
+    public static void close() {
+        Closer.closeSilently(LOCK);
+    }
+
+    /**
+     * Gets the next available port starting at the lowest number. This is the preferred method to use. The port return
+     * is immediately marked in use and doesn't rely on the caller actually opening the port.
+     *
+     * @throws IllegalArgumentException
+     *             is thrown if the port number is out of range
+     * @throws NoSuchElementException
+     *             if there are no ports available
+     * @return the available port
+     */
+    public static synchronized int getNextAvailable() {
+        final int next = getNextAvailable(currentMinPort.get());
+        currentMinPort.set(next + 1);
+        return next;
+    }
+
+    /**
+     * Gets the next available port starting at a given from port.
+     *
+     * @param fromPort
+     *            the from port to scan for availability
+     * @throws IllegalArgumentException
+     *             is thrown if the port number is out of range
+     * @throws NoSuchElementException
+     *             if there are no ports available
+     * @return the available port
+     */
+    public static synchronized int getNextAvailable(final int fromPort) {
+        if (fromPort < currentMinPort.get() || fromPort > MAX_PORT_NUMBER) {
+            throw new IllegalArgumentException("From port number not in valid range: " + fromPort);
+        }
+
+        for (int i = fromPort; i <= MAX_PORT_NUMBER; i++) {
+            if (available(i)) {
+                return i;
+            }
+        }
+
+        throw new NoSuchElementException("Could not find an available port above " + fromPort);
+    }
+
+    /**
+     * Creates a new instance.
+     */
+    private AvailableServerPortFinder() {
+        // Do nothing
+    }
+
+}