com.tplan.robot.util

Class FileLockFactory

java.lang.Object

com.tplan.robot.util.FileLockFactory

public class FileLockFactory
extends Object

Factory allowing to create named file locks. These can be used to for synchronization across standalone Robot processes running on the local system.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
int	getDefaultLockTimeout() Get the maximum time to wait for a lock for.
static FileLockFactory	getInstance() Get the shared factory instance.
FileLock	getLock(String name) Create a named lock with the default timeout value.
FileLock	getLock(String name, Integer timeout) Create a named lock.
void	setDefaultLockTimeout(int lockTimeout) Set the maximum time to wait for a lock for.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FileLockFactory getInstance()

Get the shared factory instance.

Returns:

the factory instance.

getLock

public FileLock getLock(String name,
                        Integer timeout)
                 throws IOException

Create a named lock.

Parameters:

name - the lock name (ID).

timeout - the maximum time to wait for the lock.

Returns:

the lock or null if the the time out is reached.

Throws:

IOException - when the file the lock is being created on can not be created.

getLock

public FileLock getLock(String name)
                 throws IOException

Create a named lock with the default timeout value.

Parameters:

name - the lock name (ID).

Returns:

the lock or null if the the time out is reached.

Throws:

IOException - when the file the lock is being created on can not be created.

getDefaultLockTimeout

public int getDefaultLockTimeout()

Get the maximum time to wait for a lock for.

Returns:

the maximum wait time in milliseconds.

setDefaultLockTimeout

public void setDefaultLockTimeout(int lockTimeout)

Set the maximum time to wait for a lock for.

Parameters:

lockTimeout - the lock time out in milliseconds.