org.apache.james.mailbox.store

Class AbstractMailboxPathLocker

java.lang.Object

org.apache.james.mailbox.store.AbstractMailboxPathLocker

All Implemented Interfaces:

MailboxPathLocker

Direct Known Subclasses:

JVMMailboxPathLocker

public abstract class AbstractMailboxPathLocker
extends Object
implements MailboxPathLocker

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.MailboxPathLocker

MailboxPathLocker.LockAwareExecution<T>

Constructor Summary

Constructors

Constructor and Description
AbstractMailboxPathLocker()

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	executeWithLock(MailboxSession session, MailboxPath path, MailboxPathLocker.LockAwareExecution<T> execution)
<T> T	executeWithLock(MailboxSession session, MailboxPath path, MailboxPathLocker.LockAwareExecution<T> execution, boolean writeLock) Execute the MailboxPathLocker.LockAwareExecution while holding a lock on the MailboxPath.
protected abstract void	lock(MailboxSession session, MailboxPath path, boolean writeLock) Perform lock
protected abstract void	unlock(MailboxSession session, MailboxPath path, boolean writeLock) Release lock

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMailboxPathLocker

public AbstractMailboxPathLocker()

Method Detail

executeWithLock

public <T> T executeWithLock(MailboxSession session,
                    MailboxPath path,
                    MailboxPathLocker.LockAwareExecution<T> execution)
                  throws MailboxException

Specified by:

executeWithLock in interface MailboxPathLocker

Throws:

MailboxException

See Also:

MailboxPathLocker.executeWithLock(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.model.MailboxPath, org.apache.james.mailbox.MailboxPathLocker.LockAwareExecution)

executeWithLock

public <T> T executeWithLock(MailboxSession session,
                    MailboxPath path,
                    MailboxPathLocker.LockAwareExecution<T> execution,
                    boolean writeLock)
                  throws MailboxException

Description copied from interface: MailboxPathLocker

Execute the MailboxPathLocker.LockAwareExecution while holding a lock on the MailboxPath. If writeLock is true the implementation need to make sure that no other threads can read and write while the lock is hold. The contract is the same as documented in ReadWriteLock.

Specified by:

executeWithLock in interface MailboxPathLocker

Throws:

MailboxException

lock

protected abstract void lock(MailboxSession session,
        MailboxPath path,
        boolean writeLock)
                      throws MailboxException

Perform lock

Parameters:

session -

path -

Throws:

MailboxException

unlock

protected abstract void unlock(MailboxSession session,
          MailboxPath path,
          boolean writeLock)
                        throws MailboxException

Release lock

Parameters:

session -

path -

Throws:

MailboxException