one.edee.darwin.storage

Interface LockStorage

All Known Implementing Classes:

DefaultDatabaseLockStorage, TransactionalDatabaseLockStorage

public interface LockStorage

Interface for storing lock information for Locker class.

Author:

Jan Novotný, FG Forrest a.s. (c) 2007

Method Summary

Modifier and Type	Method and Description
LockState	createLock(String processName, LocalDateTime until, String unlockKey) Method stores lock.
LocalDateTime	getCurrentDatabaseTime() Returns current database time, that is shared among nodes.
LockState	getProcessLock(String processName, LocalDateTime currentDate) Method returns data about existing / nonexistent lock.
LockState	releaseProcess(String processName, String unlockKey) Method releases lock.
LockState	renewLease(String processName, String unlockKey, LocalDateTime until) Renews lease date for particular process, if you have correct unlock key (otherwise exception is thrown)

Method Detail

getCurrentDatabaseTime

LocalDateTime getCurrentDatabaseTime()

Returns current database time, that is shared among nodes.

getProcessLock

LockState getProcessLock(String processName,
                         LocalDateTime currentDate)

Method returns data about existing / nonexistent lock.

createLock

LockState createLock(String processName,
                     LocalDateTime until,
                     String unlockKey)

Method stores lock.

Parameters:

processName - name of the process we want to lock

until - date until lock should be kept providing no one has unlock it by then

unlockKey - unlock key to be stored with lock

releaseProcess

LockState releaseProcess(String processName,
                         String unlockKey)
                  throws IllegalStateException

Method releases lock.

Parameters:

processName - name of the process we want to unlock

unlockKey - key for unlocking the process

Throws:

IllegalStateException - when no lock for the process was found

renewLease

LockState renewLease(String processName,
                     String unlockKey,
                     LocalDateTime until)

Renews lease date for particular process, if you have correct unlock key (otherwise exception is thrown)