org.zalando.resourcelock

Interface ResourceLockManager

All Known Implementing Classes:

ResourceLockManagerEtcdImpl, ResourceLockManagerJdbcFunctionImpl, ResourceLockManagerJdbcImpl

public interface ResourceLockManager

A resource lock manager.

Method Summary

Modifier and Type	Method and Description
boolean	acquireLock(String resourceName, String lockName) Acquires a lock for the given resource name using the given lock name.
boolean	acquireLock(String resourceName, String lockName, int ttl) Acquires a lock for the given resource name using the given lock name.
void	releaseLock(String resourceName, String lockName) Releases a lock for the given resource name using the given lock name.

Method Detail

acquireLock

boolean acquireLock(String resourceName,
                    String lockName)
             throws ResourceLockException

Acquires a lock for the given resource name using the given lock name.

Parameters:

resourceName - the resource name to be locked on

lockName - the name of the lock

Returns:

true if the lock was acquired, false otherwise

Throws:

ResourceLockException - in case an error occurs

acquireLock

boolean acquireLock(String resourceName,
                    String lockName,
                    int ttl)
             throws ResourceLockException

Acquires a lock for the given resource name using the given lock name.

Parameters:

resourceName - the resource name to be locked on

lockName - the name of the lock

ttl - the time the lock exists in seconds

Returns:

true if the lock was acquired, false otherwise

Throws:

ResourceLockException - in case an error occurs

releaseLock

void releaseLock(String resourceName,
                 String lockName)
          throws ResourceLockException

Releases a lock for the given resource name using the given lock name.

Parameters:

resourceName - the resource name to be locked on

lockName - the name of the lock

Throws:

ResourceLockException - in case an error occurs