org.apache.james.mailbox.store.mail

Interface UidProvider<Id>

Type Parameters:

Id -

All Known Implementing Classes:

AbstractLockingUidProvider, HBaseUidProvider, InMemoryUidProvider, JCRUidProvider, JPAUidProvider, MaildirStore, ZooUidProvider

public interface UidProvider<Id>

Take care of provide uids for a given Mailbox. Be aware that implementations need to be thread-safe!

Method Summary

Methods

Modifier and Type	Method and Description
long	lastUid(MailboxSession session, Mailbox<Id> mailbox) Return the last uid which were used for storing a Message in the Mailbox
long	nextUid(MailboxSession session, Mailbox<Id> mailbox) Return the next uid which can be used while append a Message to the Mailbox.

Method Detail

nextUid

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

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

Parameters:

session -

mailbox -

Returns:

nextUid

Throws:

MailboxException

lastUid

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

Return the last uid which were used for storing a Message in the Mailbox

Parameters:

session -

mailbox -

Returns:

lastUid

Throws:

MailboxException