Class AvailablePortFinder

    • Field Detail

      • MIN_PORT_NUMBER

        public static final int MIN_PORT_NUMBER
        The minimum number of server port number.
        See Also:
        Constant Field Values
      • MAX_PORT_NUMBER

        public static final int MAX_PORT_NUMBER
        The maximum number of server port number.
        See Also:
        Constant Field Values
    • Method Detail

      • getAvailablePorts

        public static Set<Integer> getAvailablePorts()
        Returns:
        the Set of currently available port numbers (Integer). This method is identical to getAvailablePorts(MIN_PORT_NUMBER, MAX_PORT_NUMBER). WARNING: this can take a very long time.
      • getNextAvailable

        public static int getNextAvailable()
        Returns:
        an available port, selected by the system.
        Throws:
        NoSuchElementException - if there are no ports available
      • getNextAvailable

        public static int getNextAvailable​(int fromPort)
        Parameters:
        fromPort - the port to scan for availability
        Returns:
        the next available port starting at a port.
        Throws:
        NoSuchElementException - if there are no ports available
      • available

        public static boolean available​(int port)
        Checks to see if a specific port is available.
        Parameters:
        port - the port to check for availability
        Returns:
        true if the port is available
      • getAvailablePorts

        public static Set<Integer> getAvailablePorts​(int fromPort,
                                                     int toPort)
        Parameters:
        fromPort - The port we start from
        toPort - The posrt we stop at
        Returns:
        the Set of currently avalaible port numbers (Integer) between the specified port range.
        Throws:
        IllegalArgumentException - if port range is not between MIN_PORT_NUMBER and MAX_PORT_NUMBER or fromPort if greater than toPort.