org.apache.james.mailbox

Interface MailboxPathLocker

All Known Implementing Classes:

AbstractMailboxPathLocker, JVMMailboxPathLocker

public interface MailboxPathLocker

The MailboxPathLocker is responsible to help to synchronize the access to a MailboxPath and execute an given MailboxPathLocker.LockAwareExecution Implementations that are not able to handle read / write locks in a different way are needed to handle all locks as write lock.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MailboxPathLocker.LockAwareExecution<T> Execute code while holding a lock

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	executeWithLock(MailboxSession session, MailboxPath path, MailboxPathLocker.LockAwareExecution<T> execution) Deprecated. use executeWithLock(MailboxSession, MailboxPath, LockAwareExecution, boolean) with argument true
<T> T	executeWithLock(MailboxSession session, MailboxPath path, MailboxPathLocker.LockAwareExecution<T> execution, boolean writeLock) Execute the MailboxPathLocker.LockAwareExecution while holding a lock on the MailboxPath.

Method Detail

executeWithLock

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

Deprecated. use executeWithLock(MailboxSession, MailboxPath, LockAwareExecution, boolean) with argument true

Throws:

MailboxException

executeWithLock

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

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.

Parameters:

session -

path -

execution -

writeLock -

Throws:

MailboxException