org.apache.james.mailbox.store.mail

Class AbstractMessageMapper<Id>

java.lang.Object

org.apache.james.mailbox.store.transaction.TransactionalMapper

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

Type Parameters:

Id -

All Implemented Interfaces:

MessageMapper<Id>, Mapper

Direct Known Subclasses:

InMemoryMessageMapper, JCRMessageMapper, JPAMessageMapper, MaildirMessageMapper

public abstract class AbstractMessageMapper<Id>
extends TransactionalMapper
implements MessageMapper<Id>

Abstract base class for MessageMapper implementation which already takes care of most uid / mod-seq handling

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.store.mail.MessageMapper

MessageMapper.FetchType

Nested classes/interfaces inherited from interface org.apache.james.mailbox.store.transaction.Mapper

Mapper.Transaction<T>, Mapper.VoidTransaction

Field Summary

Fields

Modifier and Type	Field and Description
protected MailboxSession	mailboxSession

Constructor Summary

Constructors

Constructor and Description
AbstractMessageMapper(MailboxSession mailboxSession, UidProvider<Id> uidProvider, ModSeqProvider<Id> modSeqProvider)

Method Summary

Methods

Modifier and Type	Method and Description
MessageMetaData	add(Mailbox<Id> mailbox, Message<Id> message) Add the given Message to the underlying storage.
protected abstract MessageMetaData	copy(Mailbox<Id> mailbox, long uid, long modSeq, Message<Id> original) Copy the Message to the Mailbox, using the given uid and modSeq for the new Message
MessageMetaData	copy(Mailbox<Id> mailbox, Message<Id> original) Copy the given Message to a new mailbox and return the uid of the copy.
long	getHighestModSeq(Mailbox<Id> mailbox) Return the higest mod-sequence which were used for storing a Message in the Mailbox
long	getLastUid(Mailbox<Id> mailbox) Return the last uid which were used for storing a Message in the Mailbox
protected abstract MessageMetaData	save(Mailbox<Id> mailbox, Message<Id> message) Save the Message for the given Mailbox and return the MessageMetaData
Iterator<UpdatedFlags>	updateFlags(Mailbox<Id> mailbox, javax.mail.Flags flags, boolean value, boolean replace, MessageRange set) Update flags for the given MessageRange.

Methods inherited from class org.apache.james.mailbox.store.transaction.TransactionalMapper

begin, commit, execute, rollback

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.MessageMapper

countMessagesInMailbox, countUnseenMessagesInMailbox, delete, expungeMarkedForDeletionInMailbox, findFirstUnseenMessageUid, findInMailbox, findRecentMessageUidsInMailbox

Methods inherited from interface org.apache.james.mailbox.store.transaction.Mapper

endRequest, execute

Field Detail

mailboxSession

protected final MailboxSession mailboxSession

Constructor Detail

AbstractMessageMapper

public AbstractMessageMapper(MailboxSession mailboxSession,
                     UidProvider<Id> uidProvider,
                     ModSeqProvider<Id> modSeqProvider)

Method Detail

getHighestModSeq

public long getHighestModSeq(Mailbox<Id> mailbox)
                      throws MailboxException

Description copied from interface: MessageMapper

Return the higest mod-sequence which were used for storing a Message in the Mailbox

Specified by:

getHighestModSeq in interface MessageMapper<Id>

Returns:

lastUid

Throws:

MailboxException

See Also:

MessageMapper.getHighestModSeq(org.apache.james.mailbox.store.mail.model.Mailbox)

getLastUid

public long getLastUid(Mailbox<Id> mailbox)
                throws MailboxException

Description copied from interface: MessageMapper

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

Specified by:

getLastUid in interface MessageMapper<Id>

Returns:

lastUid

Throws:

MailboxException

See Also:

MessageMapper.getLastUid(org.apache.james.mailbox.store.mail.model.Mailbox)

updateFlags

public Iterator<UpdatedFlags> updateFlags(Mailbox<Id> mailbox,
                                 javax.mail.Flags flags,
                                 boolean value,
                                 boolean replace,
                                 MessageRange set)
                                   throws MailboxException

Description copied from interface: MessageMapper

Update flags for the given MessageRange. Only the flags may be modified after a message was saved to a mailbox.

Specified by:

updateFlags in interface MessageMapper<Id>

Returns:

updatedFlags

Throws:

MailboxException

See Also:

MessageMapper.updateFlags(org.apache.james.mailbox.store.mail.model.Mailbox, javax.mail.Flags, boolean, boolean, org.apache.james.mailbox.model.MessageRange)

add

public MessageMetaData add(Mailbox<Id> mailbox,
                  Message<Id> message)
                    throws MailboxException

Description copied from interface: MessageMapper

Add the given Message to the underlying storage. Be aware that implementation may choose to replace the uid of the given message while storing. So you should only depend on the returned uid.

Specified by:

add in interface MessageMapper<Id>

Returns:

uid

Throws:

MailboxException

See Also:

MessageMapper.add(org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.store.mail.model.Message)

copy

public MessageMetaData copy(Mailbox<Id> mailbox,
                   Message<Id> original)
                     throws MailboxException

Description copied from interface: MessageMapper

Copy the given Message to a new mailbox and return the uid of the copy. Be aware that the given uid is just a suggestion for the uid of the copied message. Implementation may choose to use a different one, so only depend on the returned uid!

Specified by:

copy in interface MessageMapper<Id>

Parameters:

mailbox - the Mailbox to copy to

original - the original to copy

Throws:

MailboxException

See Also:

MessageMapper.copy(org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.store.mail.model.Message)

save

protected abstract MessageMetaData save(Mailbox<Id> mailbox,
                   Message<Id> message)
                                 throws MailboxException

Save the Message for the given Mailbox and return the MessageMetaData

Parameters:

mailbox -

message -

Returns:

metaData

Throws:

MailboxException

copy

protected abstract MessageMetaData copy(Mailbox<Id> mailbox,
                   long uid,
                   long modSeq,
                   Message<Id> original)
                                 throws MailboxException

Copy the Message to the Mailbox, using the given uid and modSeq for the new Message

Parameters:

mailbox -

uid -

modSeq -

original -

Returns:

metaData

Throws:

MailboxException