org.apache.james.mailbox.hbase.mail

Class HBaseMessageMapper

java.lang.Object

org.apache.james.mailbox.store.transaction.NonTransactionalMapper

org.apache.james.mailbox.hbase.mail.HBaseMessageMapper

All Implemented Interfaces:

MessageMapper<UUID>, Mapper

public class HBaseMessageMapper
extends NonTransactionalMapper
implements MessageMapper<UUID>

HBase implementation of a MessageMapper. I don't know if this class is thread-safe! Asume it is not!

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

Constructor Summary

Constructors

Constructor and Description
HBaseMessageMapper(MailboxSession session, UidProvider<UUID> uidProvider, ModSeqProvider<UUID> modSeqProvider, org.apache.hadoop.conf.Configuration conf)

Method Summary

Methods

Modifier and Type	Method and Description
MessageMetaData	add(Mailbox<UUID> mailbox, Message<UUID> message) Add the given Message to the underlying storage.
MessageMetaData	copy(Mailbox<UUID> mailbox, Message<UUID> original) Copy the given Message to a new mailbox and return the uid of the copy.
long	countMessagesInMailbox(Mailbox<UUID> mailbox) Return the count of messages in the mailbox
long	countUnseenMessagesInMailbox(Mailbox<UUID> mailbox) Return the count of unseen messages in the mailbox
void	delete(Mailbox<UUID> mailbox, Message<UUID> message) Delete the given Message
void	endRequest() IMAP Request was complete.
Map<Long,MessageMetaData>	expungeMarkedForDeletionInMailbox(Mailbox<UUID> 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<UUID> mailbox) Return the uid of the first unseen message.
Iterator<Message<UUID>>	findInMailbox(Mailbox<UUID> 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<UUID> mailbox) Return a List of Message which are recent.
long	getHighestModSeq(Mailbox<UUID> mailbox) Return the higest mod-sequence which were used for storing a Message in the Mailbox
long	getLastUid(Mailbox<UUID> mailbox) Return the last uid which were used for storing a Message in the Mailbox
protected MessageMetaData	save(Mailbox<UUID> mailbox, Message<UUID> message) Save the Message for the given Mailbox and return the MessageMetaData
Iterator<UpdatedFlags>	updateFlags(Mailbox<UUID> 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.NonTransactionalMapper

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

Constructor Detail

HBaseMessageMapper

public HBaseMessageMapper(MailboxSession session,
                  UidProvider<UUID> uidProvider,
                  ModSeqProvider<UUID> modSeqProvider,
                  org.apache.hadoop.conf.Configuration conf)

Method Detail

endRequest

public void endRequest()

Description copied from interface: Mapper

IMAP Request was complete. Cleanup all Request scoped stuff

Specified by:

endRequest in interface Mapper

findInMailbox

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

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

expungeMarkedForDeletionInMailbox

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

Returns:

uids

Throws:

MailboxException

countMessagesInMailbox

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

Description copied from interface: MessageMapper

Return the count of messages in the mailbox

Specified by:

countMessagesInMailbox in interface MessageMapper<UUID>

Returns:

count

Throws:

MailboxException

countUnseenMessagesInMailbox

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

Description copied from interface: MessageMapper

Return the count of unseen messages in the mailbox

Specified by:

countUnseenMessagesInMailbox in interface MessageMapper<UUID>

Returns:

unseenCount

Throws:

MailboxException

delete

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

Description copied from interface: MessageMapper

Delete the given Message

Specified by:

delete in interface MessageMapper<UUID>

Throws:

MailboxException

findFirstUnseenMessageUid

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

Returns:

uid or null

Throws:

MailboxException

findRecentMessageUidsInMailbox

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

Returns:

recentList

Throws:

MailboxException

add

public MessageMetaData add(Mailbox<UUID> mailbox,
                  Message<UUID> 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<UUID>

Returns:

uid

Throws:

MailboxException

updateFlags

public Iterator<UpdatedFlags> updateFlags(Mailbox<UUID> 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<UUID>

Returns:

updatedFlags

Throws:

MailboxException

copy

public MessageMetaData copy(Mailbox<UUID> mailbox,
                   Message<UUID> 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<UUID>

Parameters:

mailbox - the Mailbox to copy to

original - the original to copy

Throws:

MailboxException

getLastUid

public long getLastUid(Mailbox<UUID> 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<UUID>

Returns:

lastUid

Throws:

MailboxException

getHighestModSeq

public long getHighestModSeq(Mailbox<UUID> 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<UUID>

Returns:

lastUid

Throws:

MailboxException

save

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

Save the Message for the given Mailbox and return the MessageMetaData

Parameters:

mailbox -

message -

Returns:

metaData

Throws:

MailboxException