org.modeshape.jcr.locking

Interface LockingService

All Known Implementing Classes:

AbstractLockingService, DbLockingService, JGroupsLockingService, StandaloneLockingService

public interface LockingService

A service which allows the locking/unlocking of named locks as batch operations. This is purely a locking abstraction and does not take into account other concepts such as transactions.

For realizing the purpose of ACID and strong consistency, the LocalDocumentStore is the place where locking and transactions are tied together.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
boolean	shutdown() Shuts down this locking service.
boolean	tryLock(long time, TimeUnit unit, String... names) Attempts to acquire a series of locks, waiting a maximum amount of time to obtain each lock.
boolean	tryLock(String... names) Attempts to acquire a series of locks using the default lock timeout.
boolean	unlock(String... names) Unlocks a number of locks.

Method Detail

tryLock

boolean tryLock(long time,
                TimeUnit unit,
                String... names)
         throws InterruptedException

Attempts to acquire a series of locks, waiting a maximum amount of time to obtain each lock.

NOTE: Implementors must make sure that either all the locks are obtained, or none. Otherwise possible deadlocks can occur.

Parameters:

time - an amount of time

unit - a TimeUnit; may not be null

names - the names of the locks to acquire

Returns:

true if *all* the locks were successfully acquired, false otherwise

Throws:

InterruptedException - if this thread is interrupted while waiting to obtain the locks

tryLock

boolean tryLock(String... names)
         throws InterruptedException

Attempts to acquire a series of locks using the default lock timeout. If not timeout is explicitly set, this will not wait to obtain the lock.

NOTE: Implementors must make sure that either all the locks are obtained, or none. Otherwise possible deadlocks can occur.

Parameters:

names - the names of the locks to acquire

Returns:

true if *all* the locks were successfully acquired, false otherwise

Throws:

InterruptedException - if this thread is interrupted while waiting to obtain the locks

unlock

boolean unlock(String... names)

Unlocks a number of locks.

Parameters:

names - the names of the locks to unlock

Returns:

a true if all the locks were successfully unlocked and false if at least one lock could not be released.

shutdown

boolean shutdown()

Shuts down this locking service.

Returns:

true if the service was shutdown successfully or false if the service was already shutdown prior to this call.