io.fabric8.jube.process.service

Class AvailablePortFinder

java.lang.Object

io.fabric8.jube.process.service.AvailablePortFinder

public class AvailablePortFinder
extends Object

Finds currently available server ports.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PORT_NUMBER The maximum server currentMinPort number for IPv4.
static int	MIN_PORT_NUMBER The minimum server currentMinPort number for IPv4.

Constructor Summary

Constructors

Constructor and Description
AvailablePortFinder(int minPortNumber) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available(int port) Checks to see if a specific port is available.
int	getNextAvailable() Gets the next available port starting at the lowest number.
int	getNextAvailable(int fromPort) Gets the next available port starting at a given from port.

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 server currentMinPort number for IPv4. We use port ranges starting from 48000

See Also:

Constant Field Values

MAX_PORT_NUMBER

public static final int MAX_PORT_NUMBER

The maximum server currentMinPort number for IPv4.

See Also:

Constant Field Values

Constructor Detail

AvailablePortFinder

public AvailablePortFinder(int minPortNumber)

Creates a new instance.

Method Detail

getNextAvailable

public int getNextAvailable()

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.

Returns:

the available port

Throws:

IllegalArgumentException - is thrown if the port number is out of range

NoSuchElementException - if there are no ports available

getNextAvailable

public int getNextAvailable(int fromPort)

Gets the next available port starting at a given from port.

Parameters:

fromPort - the from port to scan for availability

Returns:

the available port

Throws:

IllegalArgumentException - is thrown if the port number is out of range

NoSuchElementException - if there are no ports available

available

public boolean available(int port)
                  throws IllegalArgumentException

Checks to see if a specific port is available.

Parameters:

port - the port number to check for availability

Returns:

true if the port is available, or false if not

Throws:

IllegalArgumentException - is thrown if the port number is out of range