org.apache.james.mailbox.store.mail

Interface ModSeqProvider<Id>

Type Parameters:

Id -

All Known Implementing Classes:

AbstractLockingModSeqProvider, HBaseModSeqProvider, InMemoryModSeqProvider, JCRModSeqProvider, JPAModSeqProvider, MaildirStore

public interface ModSeqProvider<Id>

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

Method Summary

Methods

Modifier and Type	Method and Description
long	highestModSeq(MailboxSession session, Mailbox<Id> mailbox) Return the highest mod-sequence which were used for the Mailbox
long	nextModSeq(MailboxSession session, Mailbox<Id> mailbox) Return the next mod-sequence which can be used for the Mailbox.

Method Detail

nextModSeq

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

Return the next mod-sequence which can be used for the Mailbox. Its important that the returned mod-sequence is higher then the last used and that the next call of this method does return a higher one. The first mod-seq must be >= 1

Parameters:

session -

mailbox -

Returns:

modSeq

Throws:

MailboxException

highestModSeq

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

Return the highest mod-sequence which were used for the Mailbox

Parameters:

session -

mailbox -

Returns:

highest

Throws:

MailboxException