org.apache.james.mailbox.jcr.mail

Class JCRMessageMapper

java.lang.Object

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

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

org.apache.james.mailbox.jcr.mail.JCRMessageMapper

All Implemented Interfaces:

JCRImapConstants, MessageMapper<String>, Mapper

public class JCRMessageMapper
extends AbstractMessageMapper<String>
implements JCRImapConstants

JCR implementation of a MessageMapper. The implementation store each message as a seperate child node under the mailbox

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
static int	MESSAGE_SCALE_DAY Store the messages under a year/month/day directory in the mailbox: .../mailbox/2010/05/01/
static int	MESSAGE_SCALE_HOUR Store the messages under a year/month/day/hour directory in the mailbox: .../mailbox/2010/05/02/11
static int	MESSAGE_SCALE_MINUTE Store the messages under a year/month/day/hour/min directory in the mailbox: .../mailbox/2010/05/02/11/59
static int	MESSAGE_SCALE_MONTH Store the messages under a year/month directory in the mailbox: .../mailbox/2010/05/
static int	MESSAGE_SCALE_NONE Store the messages directly in the mailbox: .../mailbox/
static int	MESSAGE_SCALE_YEAR Store the messages under a year directory in the mailbox: .../mailbox/2010/

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

mailboxSession

Fields inherited from interface org.apache.james.mailbox.jcr.JCRImapConstants

NODE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
JCRMessageMapper(MailboxSessionJCRRepository repos, MailboxSession session, UidProvider<String> uidProvider, ModSeqProvider<String> modSeqProvider) Construct a new JCRMessageMapper instance using MESSAGE_SCALE_DAY as default
JCRMessageMapper(MailboxSessionJCRRepository repository, MailboxSession mSession, UidProvider<String> uidProvider, ModSeqProvider<String> modSeqProvider, int scaleType) Construct a new JCRMessageMapper instance

Method Summary

Methods

Modifier and Type	Method and Description
protected void	begin() Begin is not supported by level 1 JCR implementations, however we refresh the session
protected void	commit() Just call save on the underlying JCR Session, because level 1 JCR implementation does not offer Transactions
protected MessageMetaData	copy(Mailbox<String> mailbox, long uid, long modSeq, Message<String> original) Copy the Message to the Mailbox, using the given uid and modSeq for the new Message
long	countMessagesInMailbox(Mailbox<String> mailbox) Return the count of messages in the mailbox
long	countUnseenMessagesInMailbox(Mailbox<String> mailbox) Return the count of unseen messages in the mailbox
void	delete(Mailbox<String> mailbox, Message<String> message) Delete the given Message
void	endRequest() Logout from open JCR Session
Map<Long,MessageMetaData>	expungeMarkedForDeletionInMailbox(Mailbox<String> 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<String> mailbox) Return the uid of the first unseen message.
Iterator<Message<String>>	findInMailbox(Mailbox<String> 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<String> mailbox) Return a List of Message which are recent.
protected javax.jcr.Session	getSession() Return the JCR Session
protected void	rollback() Rollback is not supported by level 1 JCR implementations, so just do nothing
protected MessageMetaData	save(Mailbox<String> mailbox, Message<String> 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.transaction.Mapper

execute

Field Detail

MESSAGE_SCALE_NONE

public static final int MESSAGE_SCALE_NONE

Store the messages directly in the mailbox: .../mailbox/

See Also:

Constant Field Values

MESSAGE_SCALE_YEAR

public static final int MESSAGE_SCALE_YEAR

Store the messages under a year directory in the mailbox: .../mailbox/2010/

See Also:

Constant Field Values

MESSAGE_SCALE_MONTH

public static final int MESSAGE_SCALE_MONTH

Store the messages under a year/month directory in the mailbox: .../mailbox/2010/05/

See Also:

Constant Field Values

MESSAGE_SCALE_DAY

public static final int MESSAGE_SCALE_DAY

Store the messages under a year/month/day directory in the mailbox: .../mailbox/2010/05/01/

See Also:

Constant Field Values

MESSAGE_SCALE_HOUR

public static final int MESSAGE_SCALE_HOUR

Store the messages under a year/month/day/hour directory in the mailbox: .../mailbox/2010/05/02/11

See Also:

Constant Field Values

MESSAGE_SCALE_MINUTE

public static final int MESSAGE_SCALE_MINUTE

Store the messages under a year/month/day/hour/min directory in the mailbox: .../mailbox/2010/05/02/11/59

See Also:

Constant Field Values

Constructor Detail

JCRMessageMapper

public JCRMessageMapper(MailboxSessionJCRRepository repository,
                MailboxSession mSession,
                UidProvider<String> uidProvider,
                ModSeqProvider<String> modSeqProvider,
                int scaleType)

Construct a new JCRMessageMapper instance

Parameters:

repository - MailboxSessionJCRRepository to use

mSession - MailboxSession to which the mapper is bound

uidProvider - UidProvider to use

modSeqProvider - ModSeqProvider to use

scaleType - message scale type either MESSAGE_SCALE_DAY, MESSAGE_SCALE_HOUR, MESSAGE_SCALE_MINUTE, MESSAGE_SCALE_MONTH, MESSAGE_SCALE_NONE or MESSAGE_SCALE_YEAR

JCRMessageMapper

public JCRMessageMapper(MailboxSessionJCRRepository repos,
                MailboxSession session,
                UidProvider<String> uidProvider,
                ModSeqProvider<String> modSeqProvider)

Construct a new JCRMessageMapper instance using MESSAGE_SCALE_DAY as default

Parameters:

repos - MailboxSessionJCRRepository to use

session - MailboxSession to which the mapper is bound

uidProvider - UidProvider to use

modSeqProvider - ModSeqProvider to use

Method Detail

getSession

protected javax.jcr.Session getSession()
                                throws javax.jcr.RepositoryException

Return the JCR Session

Returns:

session

Throws:

javax.jcr.RepositoryException

begin

protected void begin()
              throws MailboxException

Begin is not supported by level 1 JCR implementations, however we refresh the session

Specified by:

begin in class TransactionalMapper

Throws:

MailboxException

commit

protected void commit()
               throws MailboxException

Just call save on the underlying JCR Session, because level 1 JCR implementation does not offer Transactions

Specified by:

commit in class TransactionalMapper

Throws:

MailboxException

rollback

protected void rollback()
                 throws MailboxException

Rollback is not supported by level 1 JCR implementations, so just do nothing

Specified by:

rollback in class TransactionalMapper

Throws:

MailboxException

countMessagesInMailbox

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

Description copied from interface: MessageMapper

Return the count of messages in the mailbox

Specified by:

countMessagesInMailbox in interface MessageMapper<String>

Returns:

count

Throws:

MailboxException

countUnseenMessagesInMailbox

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

Description copied from interface: MessageMapper

Return the count of unseen messages in the mailbox

Specified by:

countUnseenMessagesInMailbox in interface MessageMapper<String>

Returns:

unseenCount

Throws:

MailboxException

delete

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

Description copied from interface: MessageMapper

Delete the given Message

Specified by:

delete in interface MessageMapper<String>

Throws:

MailboxException

findInMailbox

public Iterator<Message<String>> findInMailbox(Mailbox<String> 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<String>

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

findRecentMessageUidsInMailbox

public List<Long> findRecentMessageUidsInMailbox(Mailbox<String> 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<String>

Returns:

recentList

Throws:

MailboxException

findFirstUnseenMessageUid

public Long findFirstUnseenMessageUid(Mailbox<String> 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<String>

Returns:

uid or null

Throws:

MailboxException

endRequest

public void endRequest()

Logout from open JCR Session

Specified by:

endRequest in interface Mapper

copy

protected MessageMetaData copy(Mailbox<String> mailbox,
                   long uid,
                   long modSeq,
                   Message<String> 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<String>

Returns:

metaData

Throws:

MailboxException

save

protected MessageMetaData save(Mailbox<String> mailbox,
                   Message<String> 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<String>

Returns:

metaData

Throws:

MailboxException

expungeMarkedForDeletionInMailbox

public Map<Long,MessageMetaData> expungeMarkedForDeletionInMailbox(Mailbox<String> 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<String>

Returns:

uids

Throws:

MailboxException