org.apache.james.mailbox.store.mail

Class AbstractLockingUidProvider<Id>

java.lang.Object

org.apache.james.mailbox.store.mail.AbstractLockingUidProvider<Id>

Type Parameters:

Id -

All Implemented Interfaces:

UidProvider<Id>

Direct Known Subclasses:

JCRUidProvider, JPAUidProvider

public abstract class AbstractLockingUidProvider<Id>
extends Object
implements UidProvider<Id>

Abstract base implementation of UidProvider which used the given MailboxPathLocker to lock the Mailbox while the next uid is generated

Constructor Summary

Constructors

Constructor and Description
AbstractLockingUidProvider(MailboxPathLocker locker)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract long	lockedNextUid(MailboxSession session, Mailbox<Id> mailbox) Generate the next uid to use while the Mailbox is locked
long	nextUid(MailboxSession session, Mailbox<Id> mailbox) Return the next uid which can be used while append a Message to the Mailbox.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.james.mailbox.store.mail.UidProvider

lastUid

Constructor Detail

AbstractLockingUidProvider

public AbstractLockingUidProvider(MailboxPathLocker locker)

Method Detail

nextUid

public long nextUid(MailboxSession session,
           Mailbox<Id> mailbox)
             throws MailboxException

Description copied from interface: UidProvider

Return the next uid which can be used while append a Message to the Mailbox. Its important that the returned uid is higher then the last used and that the next call of this method does return a higher one

Specified by:

nextUid in interface UidProvider<Id>

Returns:

nextUid

Throws:

MailboxException

lockedNextUid

protected abstract long lockedNextUid(MailboxSession session,
                 Mailbox<Id> mailbox)
                               throws MailboxException

Generate the next uid to use while the Mailbox is locked

Parameters:

session -

mailbox -

Returns:

nextUid

Throws:

MailboxException