org.sonar.api.utils

Interface DatabaseSemaphore

All Superinterfaces:

BatchComponent, ServerComponent

public interface DatabaseSemaphore
extends BatchComponent, ServerComponent

A semaphore shared among all the processes that can connect to the central database.

Since:

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DatabaseSemaphore.Lock

Method Summary

Methods

Modifier and Type	Method and Description
DatabaseSemaphore.Lock	acquire(String name) Try to acquire the lock on a name.
DatabaseSemaphore.Lock	acquire(String name, int maxDurationInSeconds) Try to acquire a lock on a name, for a given duration.
void	release(String name) Release the lock on a semaphore by its name.

Method Detail

acquire

DatabaseSemaphore.Lock acquire(String name,
                             int maxDurationInSeconds)

Try to acquire a lock on a name, for a given duration. The lock will be acquired if there's no existing lock on this name or if a lock exists but the max duration is reached.

Parameters:

name - the key of the semaphore

maxDurationInSeconds - the max duration in seconds the semaphore will be acquired (a value of zero can be used to always acquire a lock)

Returns:

a lock containing information if the lock could be acquired or not, the duration since locked, etc.

acquire

DatabaseSemaphore.Lock acquire(String name)

Try to acquire the lock on a name. The lock will be acquired only if there's no existing lock.

Parameters:

name - the key of the semaphore

Returns:

a lock containing information if the lock could be acquired or not, the duration since locked, etc.

release

void release(String name)

Release the lock on a semaphore by its name.

Parameters:

name - the key of the semaphore