com.epam.reportportal.service

Class LockFile

java.lang.Object

com.epam.reportportal.service.LockFile

All Implemented Interfaces:

LaunchIdLock

public class LockFile
extends java.lang.Object
implements LaunchIdLock

A service to perform blocking I/O operations on '.lock' and '.sync' file to get single launch UUID for multiple clients on a machine. This class uses a local storage disk, therefore applicable in scope of a single hardware machine. You can control lock and sync file paths with ListenerProperty.LOCK_FILE_NAME and ListenerProperty.SYNC_FILE_NAME properties.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCK_FILE_CHARSET

Constructor Summary

Constructors

Constructor and Description
LockFile(ListenerParameters parameters)

Method Summary

Modifier and Type	Method and Description
void	finishInstanceUuid(java.lang.String uuid) Remove self UUID from sync file, means that a client finished its Launch.
java.lang.String	obtainLaunchUuid(java.lang.String uuid) Returns a Launch UUID for many Clients launched on one machine.

Methods inherited from class java.lang.Object

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

Field Detail

LOCK_FILE_CHARSET

public static final java.lang.String LOCK_FILE_CHARSET

See Also:

Constant Field Values

Constructor Detail

LockFile

public LockFile(ListenerParameters parameters)

Method Detail

obtainLaunchUuid

public java.lang.String obtainLaunchUuid(@Nonnull
                                         java.lang.String uuid)

Returns a Launch UUID for many Clients launched on one machine.

Specified by:

obtainLaunchUuid in interface LaunchIdLock

Parameters:

uuid - a Client instance UUID, which will be written to lock and sync files and, if it the first thread which managed to obtain lock on '.lock' file, returned to every client instance.

Returns:

either a Client instance UUID, either the first UUID which thread managed to place a lock on a '.lock' file.

finishInstanceUuid

public void finishInstanceUuid(java.lang.String uuid)

Remove self UUID from sync file, means that a client finished its Launch. If this is the last UUID in the sync file, lock and sync files will be removed.

Specified by:

finishInstanceUuid in interface LaunchIdLock

Parameters:

uuid - a Client instance UUID.