com.smartbear.ready.core.utils

Class MachineResourceService

java.lang.Object

com.smartbear.ready.core.utils.MachineResourceService

public class MachineResourceService
extends Object

Service providing an interface to the local machine resources where ReadyAPI is running.

Constructor Summary

Constructors

Constructor and Description
MachineResourceService()

Method Summary

Modifier and Type	Method and Description
int	findFreePortStartingFrom(int port) Attempts to find a free port starting from the given port, then increasing by one until a free port is found.
Set<String>	getLocalHostsAddresses() Get addresses of the localhost
boolean	isPortFree(int port) To know if a port is free or used
boolean	isValidPort(int port)
protected ServerSocket	socketOnPort(int port)
FileLock	tryAcquireLock(String lockName) Try to acquire a lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

MachineResourceService

public MachineResourceService()

Method Detail

findFreePortStartingFrom

public int findFreePortStartingFrom(int port)
                             throws ReadyApiException

Attempts to find a free port starting from the given port, then increasing by one until a free port is found.

A valid port (0 < port number <= 65535) number equal to or larger than the initial number given is returned unless none can be found, in which case an Exception is thrown.

Parameters:

port - the initial port to try. If (port < 0) or (port > 65535) ReadyApiException is thrown immediately

Returns:

a free port

Throws:

ReadyApiException - if can't get any free port

isPortFree

public boolean isPortFree(int port)

To know if a port is free or used

Parameters:

port -

Returns:

true if the port is free, false otherwise.

isValidPort

public boolean isValidPort(int port)

Parameters:

port -

Returns:

true if the port is within the valid range for port numbers, false otherwise.

socketOnPort

protected ServerSocket socketOnPort(int port)
                             throws IOException

Throws:

IOException

tryAcquireLock

public FileLock tryAcquireLock(String lockName)
                        throws OverlappingFileLockException

Try to acquire a lock. The lock only gets returned if it was successfully acquired. An Exception is thrown if the lock cannot be acquired for any reason.

Parameters:

lockName - will become a file at ${READY_API_HOME_DIR}/lockName.lock

Returns:

FileLock

Throws:

OverlappingFileLockException - if cannot acquire lock for any reason

getLocalHostsAddresses

public Set<String> getLocalHostsAddresses()
                                   throws SocketException

Get addresses of the localhost

Returns:

list of addresses

Throws:

SocketException