Package org.apache.mina.util

Class AvailablePortFinder

  • public class AvailablePortFinder
extends java.lang.Object
    Finds currently available server ports.
    Author:
    Apache MINA Project
    See Also:
    IANA.org

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int MAX_PORT_NUMBER
      The maximum number of server port number.
      static int MIN_PORT_NUMBER
      The minimum number of server port number.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean available​(int port)
      Checks to see if a specific port is available.
      static java.util.Set<java.lang.Integer> getAvailablePorts()  
      static java.util.Set<java.lang.Integer> getAvailablePorts​(int fromPort, int toPort)  
      static int getNextAvailable()  
      static int getNextAvailable​(int fromPort)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • 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 java.util.Set<java.lang.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:
        java.util.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:
        java.util.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 java.util.Set<java.lang.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:
        java.lang.IllegalArgumentException - if port range is not between MIN_PORT_NUMBER and MAX_PORT_NUMBER or fromPort if greater than toPort.