org.apache.james.mailbox.jpa.mail

Class JPAMessageMapper

java.lang.Object

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

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

org.apache.james.mailbox.jpa.mail.JPAMessageMapper

All Implemented Interfaces:

MessageMapper<Long>, Mapper

public class JPAMessageMapper
extends AbstractMessageMapper<Long>
implements MessageMapper<Long>

JPA implementation of a MessageMapper. This class is not thread-safe!

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 javax.persistence.EntityManager	entityManager
protected javax.persistence.EntityManagerFactory	entityManagerFactory

Fields inherited from class org.apache.james.mailbox.store.mail.AbstractMessageMapper

mailboxSession

Constructor Summary

Constructors

Constructor and Description
JPAMessageMapper(MailboxSession session, UidProvider<Long> uidProvider, ModSeqProvider<Long> modSeqProvider, javax.persistence.EntityManagerFactory entityManagerFactory)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	begin() Begin transaction
protected void	commit() Commit the Transaction and close the EntityManager
protected MessageMetaData	copy(Mailbox<Long> mailbox, long uid, long modSeq, Message<Long> original) Copy the Message to the Mailbox, using the given uid and modSeq for the new Message
long	countMessagesInMailbox(Mailbox<Long> mailbox) Return the count of messages in the mailbox
long	countUnseenMessagesInMailbox(Mailbox<Long> mailbox) Return the count of unseen messages in the mailbox
void	delete(Mailbox<Long> mailbox, Message<Long> message) Delete the given Message
void	endRequest() Close open EntityManager
Map<Long,MessageMetaData>	expungeMarkedForDeletionInMailbox(Mailbox<Long> mailbox, MessageRange set) Return a Iterator which holds the uids for all deleted Messages for the given MessageRange which are marked for deletion The list must be ordered
Long	findFirstUnseenMessageUid(Mailbox<Long> mailbox) Return the uid of the first unseen message.
Iterator<Message<Long>>	findInMailbox(Mailbox<Long> mailbox, MessageRange set, MessageMapper.FetchType fType, int max) Return a Iterator which holds the messages for the given criterias The list must be ordered by the Message uid
List<Long>	findRecentMessageUidsInMailbox(Mailbox<Long> mailbox) Return a List of Message which are recent.
javax.persistence.EntityManager	getEntityManager() Return the currently used EntityManager or a new one if none exists.
protected void	rollback() Rollback transaction
protected MessageMetaData	save(Mailbox<Long> mailbox, Message<Long> message) Save the Message for the given Mailbox and return the MessageMetaData

Methods inherited from class org.apache.james.mailbox.store.mail.AbstractMessageMapper

add, copy, getHighestModSeq, getLastUid, updateFlags

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

execute

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

add, copy, getHighestModSeq, getLastUid, updateFlags

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

execute

Field Detail

entityManagerFactory

protected javax.persistence.EntityManagerFactory entityManagerFactory

entityManager

protected javax.persistence.EntityManager entityManager

Constructor Detail

JPAMessageMapper

public JPAMessageMapper(MailboxSession session,
                UidProvider<Long> uidProvider,
                ModSeqProvider<Long> modSeqProvider,
                javax.persistence.EntityManagerFactory entityManagerFactory)

Method Detail

getEntityManager

public javax.persistence.EntityManager getEntityManager()

Return the currently used EntityManager or a new one if none exists.

Returns:

entitymanger

begin

protected void begin()
              throws MailboxException

Description copied from class: TransactionalMapper

Begin transaction

Specified by:

begin in class TransactionalMapper

Throws:

MailboxException

See Also:

TransactionalMapper.begin()

commit

protected void commit()
               throws MailboxException

Commit the Transaction and close the EntityManager

Specified by:

commit in class TransactionalMapper

Throws:

MailboxException

rollback

protected void rollback()
                 throws MailboxException

Description copied from class: TransactionalMapper

Rollback transaction

Specified by:

rollback in class TransactionalMapper

Throws:

MailboxException

See Also:

TransactionalMapper.rollback()

endRequest

public void endRequest()

Close open EntityManager

Specified by:

endRequest in interface Mapper

findInMailbox

public Iterator<Message<Long>> findInMailbox(Mailbox<Long> mailbox,
                                    MessageRange set,
                                    MessageMapper.FetchType fType,
                                    int max)
                                      throws MailboxException

Description copied from interface: MessageMapper

Return a Iterator which holds the messages for the given criterias The list must be ordered by the Message uid

Specified by:

findInMailbox in interface MessageMapper<Long>

Parameters:

mailbox - The mailbox to search

set - message range for batch processing

max - the maximal limit of returned Message's. Use -1 to set no limit. In any case the caller MUST not expect the limit to get applied in all cases as the implementation MAY just ignore it

Throws:

MailboxException

See Also:

MessageMapper.findInMailbox(org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.model.MessageRange, org.apache.james.mailbox.store.mail.MessageMapper.FetchType, int)

countMessagesInMailbox

public long countMessagesInMailbox(Mailbox<Long> mailbox)
                            throws MailboxException

Description copied from interface: MessageMapper

Return the count of messages in the mailbox

Specified by:

countMessagesInMailbox in interface MessageMapper<Long>

Returns:

count

Throws:

MailboxException

See Also:

MessageMapper.countMessagesInMailbox(Mailbox)

countUnseenMessagesInMailbox

public long countUnseenMessagesInMailbox(Mailbox<Long> mailbox)
                                  throws MailboxException

Description copied from interface: MessageMapper

Return the count of unseen messages in the mailbox

Specified by:

countUnseenMessagesInMailbox in interface MessageMapper<Long>

Returns:

unseenCount

Throws:

MailboxException

See Also:

MessageMapper.countUnseenMessagesInMailbox(Mailbox)

delete

public void delete(Mailbox<Long> mailbox,
          Message<Long> message)
            throws MailboxException

Description copied from interface: MessageMapper

Delete the given Message

Specified by:

delete in interface MessageMapper<Long>

Throws:

MailboxException

See Also:

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

findFirstUnseenMessageUid

public Long findFirstUnseenMessageUid(Mailbox<Long> mailbox)
                               throws MailboxException

Description copied from interface: MessageMapper

Return the uid of the first unseen message. If non can be found null will get returned

Specified by:

findFirstUnseenMessageUid in interface MessageMapper<Long>

Returns:

uid or null

Throws:

MailboxException

See Also:

MessageMapper.findFirstUnseenMessageUid(Mailbox)

findRecentMessageUidsInMailbox

public List<Long> findRecentMessageUidsInMailbox(Mailbox<Long> mailbox)
                                          throws MailboxException

Description copied from interface: MessageMapper

Return a List of Message which are recent. The list must be ordered by the Message uid.

Specified by:

findRecentMessageUidsInMailbox in interface MessageMapper<Long>

Returns:

recentList

Throws:

MailboxException

See Also:

MessageMapper.findRecentMessageUidsInMailbox(Mailbox)

copy

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

Description copied from class: AbstractMessageMapper

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

Specified by:

copy in class AbstractMessageMapper<Long>

Returns:

metaData

Throws:

MailboxException

See Also:

AbstractMessageMapper.copy(Mailbox, long, long, Message)

save

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

Description copied from class: AbstractMessageMapper

Save the Message for the given Mailbox and return the MessageMetaData

Specified by:

save in class AbstractMessageMapper<Long>

Returns:

metaData

Throws:

MailboxException

See Also:

AbstractMessageMapper.save(Mailbox, Message)

expungeMarkedForDeletionInMailbox

public Map<Long,MessageMetaData> expungeMarkedForDeletionInMailbox(Mailbox<Long> mailbox,
                                                          MessageRange set)
                                                            throws MailboxException

Description copied from interface: MessageMapper

Return a Iterator which holds the uids for all deleted Messages for the given MessageRange which are marked for deletion The list must be ordered

Specified by:

expungeMarkedForDeletionInMailbox in interface MessageMapper<Long>

Returns:

uids

Throws:

MailboxException