Lock

Abstract lock that implements the default lock acquisition routine.

Implements: ILock, IReconfigurable

The Lock class represents an abstract lock that implements the defaul lock acquisition routine.

options:

retry_timeout: timeout in milliseconds to retry lock acquisition. (Default: 100)

Makes multiple attempts to acquire a lock by its key within a given time interval.

public void acquireLock(IContext context, String key, int ttl, long timeout) throws InterruptedException, ApplicationException

context: IContext - (optional) a context to trace execution through call chain.
key: String - a unique lock key to acquire.
ttl: int - a lock timeout (time to live) in milliseconds.
timeout: long - a lock acquisition timeout.

Configures component by passing configuration parameters.

public void configure(ConfigParams config)

Releases a prevously acquired lock by its key.

public abstract void releaseLock(IContext context, String key)

context: IContext - (optional) a context to trace execution through call chain.
key: string - a unique lock key to release.

Makes a single attempt to acquire a lock by its key. It returns immediately a positive or negative result.

public abstract boolean tryAcquireLock(IContext context, String key, int ttl)

context: IContext - (optional) a context to trace execution through call chain.
key: String - a unique lock key to acquire.
ttl: int - a lock timeout (time to live) in milliseconds.
returns: boolean - lock result