org.modeshape.jcr.locking

Class AbstractLockingService<T extends Lock>

java.lang.Object

org.modeshape.jcr.locking.AbstractLockingService<T>

All Implemented Interfaces:

LockingService

Direct Known Subclasses:

ClusteredLockingService, StandaloneLockingService

@ThreadSafe
public abstract class AbstractLockingService<T extends Lock>
extends Object
implements LockingService

Base class for LockingService implementations.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLockingService()
protected	AbstractLockingService(long lockTimeoutMillis)

Method Summary

Modifier and Type	Method and Description
protected abstract T	createLock(String name)
protected boolean	doLock(T lock, String name, long time, TimeUnit timeUnit)
protected void	doShutdown()
protected abstract boolean	releaseLock(T lock)
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.
protected boolean	unlock(String name)
protected abstract void	validateLock(T lock)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final Logger logger

Constructor Detail

AbstractLockingService

protected AbstractLockingService()

AbstractLockingService

protected AbstractLockingService(long lockTimeoutMillis)

Method Detail

tryLock

public boolean tryLock(String... names)
                throws InterruptedException

Description copied from interface: LockingService

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.

Specified by:

tryLock in interface LockingService

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

tryLock

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

Description copied from interface: LockingService

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.

Specified by:

tryLock in interface LockingService

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

unlock

public boolean unlock(String... names)

Description copied from interface: LockingService

Unlocks a number of locks.

Specified by:

unlock in interface LockingService

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.

unlock

protected boolean unlock(String name)

shutdown

public boolean shutdown()

Description copied from interface: LockingService

Shuts down this locking service.

Specified by:

shutdown in interface LockingService

Returns:

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

doShutdown

protected void doShutdown()

doLock

protected boolean doLock(T lock,
                         String name,
                         long time,
                         TimeUnit timeUnit)
                  throws InterruptedException

Throws:

InterruptedException

createLock

protected abstract T createLock(String name)

validateLock

protected abstract void validateLock(T lock)

releaseLock

protected abstract boolean releaseLock(T lock)