org.apache.james.mailbox.store

Class StoreMessageManager<Id>

java.lang.Object

org.apache.james.mailbox.store.StoreMessageManager<Id>

All Implemented Interfaces:

MessageManager

Direct Known Subclasses:

HBaseMessageManager, JCRMessageManager, JPAMessageManager

public class StoreMessageManager<Id>
extends Object
implements MessageManager

Base class for MessageManager implementations. This base class take care of dispatching events to the registered MailboxListener and so help with handling concurrent MailboxSession's.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.MessageManager

MessageManager.MetaData

Field Summary

Fields

Modifier and Type	Field and Description
protected static javax.mail.Flags	MINIMAL_PERMANET_FLAGS The minimal Permanent flags the MessageManager must support.

Constructor Summary

Constructors

Constructor and Description
StoreMessageManager(MessageMapperFactory<Id> mapperFactory, MessageSearchIndex<Id> index, MailboxEventDispatcher<Id> dispatcher, MailboxPathLocker locker, Mailbox<Id> mailbox, MailboxACLResolver aclResolver, GroupMembershipResolver groupMembershipResolver)

Method Summary

Methods

Modifier and Type	Method and Description
long	appendMessage(InputStream msgIn, Date internalDate, MailboxSession mailboxSession, boolean isRecent, javax.mail.Flags flagsToBeSet) Appends a message to this mailbox.
protected MessageMetaData	appendMessageToStore(Message<Id> message, MailboxSession session)
List<MessageRange>	copyTo(MessageRange set, StoreMessageManager<Id> toMailbox, MailboxSession session) Copy the MessageRange to the StoreMessageManager
protected long	countUnseenMessagesInMailbox(MailboxSession session) Return the count of unseen messages
protected Message<Id>	createMessage(Date internalDate, int size, int bodyStartOctet, javax.mail.internet.SharedInputStream content, javax.mail.Flags flags, PropertyBuilder propertyBuilder) Create a new Message for the given data
protected Map<Long,MessageMetaData>	deleteMarkedInMailbox(MessageRange range, MailboxSession session)
Iterator<Long>	expunge(MessageRange set, MailboxSession mailboxSession) Expunges messages in the given range from this mailbox.
protected Long	findFirstUnseenMessageUid(MailboxSession session) Return the uid of the first unseen message or null of none is found
protected MailboxEventDispatcher<Id>	getDispatcher() Return the MailboxEventDispatcher for this Mailbox
protected MailboxPathLocker	getLocker() Return the MailboxPathLocker
Mailbox<Id>	getMailboxEntity() Return the underlying Mailbox
long	getMessageCount(MailboxSession mailboxSession) Return the count
MessageResultIterator	getMessages(MessageRange set, MessageResult.FetchGroup fetchGroup, MailboxSession mailboxSession) Gets messages in the given range.
MessageManager.MetaData	getMetaData(boolean resetRecent, MailboxSession mailboxSession, MessageManager.MetaData.FetchGroup fetchGroup) Gets current meta data for the mailbox. Consolidates common calls together to allow improved performance. The meta-data returned should be immutable and represent the current state of the mailbox.
protected javax.mail.Flags	getPermanentFlags(MailboxSession session) Return Flags which are permanent stored by the mailbox.
protected MailboxACL	getResolvedMailboxACL(MailboxSession mailboxSession) Applies the global ACL (if there are any) to the mailbox ACL.
protected javax.mail.Flags	getSharedPermanentFlags(MailboxSession session) Returns the flags which are shared for the current mailbox, i.e.
boolean	hasRight(MailboxACL.MailboxACLRight right, MailboxSession session) Tells whether the given MailboxSession's user has the given MailboxACL.MailboxACLRight for this MessageManager's mailbox.
protected boolean	isGroupFolder(MailboxSession session) Returns true if the current mailbox does not reside neither in private nor other users' namespace.
boolean	isModSeqPermanent(MailboxSession session) Return true.
boolean	isWriteable(MailboxSession session) This mailbox is writable
MailboxACL.MailboxACLRights[]	listRigths(MailboxACL.MailboxACLEntryKey key, MailboxSession session) Computes a result suitable for the LISTRIGHTS IMAP command.
MailboxACL.MailboxACLRights	myRights(MailboxSession session) Returns the rights applicable to the user who has sent the current request.
protected List<Long>	recent(boolean reset, MailboxSession mailboxSession) Return a List which holds all uids of recent messages and optional reset the recent flag on the messages for the uids
Iterator<Long>	search(SearchQuery query, MailboxSession mailboxSession) Searches for messages matching the given query.
void	setFetchBatchSize(int fetchBatchSize)
Map<Long,javax.mail.Flags>	setFlags(javax.mail.Flags flags, boolean value, boolean replace, MessageRange set, MailboxSession mailboxSession) Sets flags on messages within the given range.
void	setRights(MailboxACL.MailboxACLEntryKey mailboxACLEntryKey, MailboxACL.EditMode editMode, MailboxACL.MailboxACLRights mailboxAclRights) TODO setRights.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MINIMAL_PERMANET_FLAGS

protected static final javax.mail.Flags MINIMAL_PERMANET_FLAGS

The minimal Permanent flags the MessageManager must support.
Be sure this static instance will never get modifed later!

Constructor Detail

StoreMessageManager

public StoreMessageManager(MessageMapperFactory<Id> mapperFactory,
                   MessageSearchIndex<Id> index,
                   MailboxEventDispatcher<Id> dispatcher,
                   MailboxPathLocker locker,
                   Mailbox<Id> mailbox,
                   MailboxACLResolver aclResolver,
                   GroupMembershipResolver groupMembershipResolver)
                    throws MailboxException

Throws:

MailboxException

Method Detail

setFetchBatchSize

public void setFetchBatchSize(int fetchBatchSize)

getLocker

protected MailboxPathLocker getLocker()

Return the MailboxPathLocker

Returns:

locker

getDispatcher

protected MailboxEventDispatcher<Id> getDispatcher()

Return the MailboxEventDispatcher for this Mailbox

Returns:

dispatcher

getMailboxEntity

public Mailbox<Id> getMailboxEntity()
                             throws MailboxException

Return the underlying Mailbox

Returns:

mailbox

Throws:

MailboxException

getPermanentFlags

protected javax.mail.Flags getPermanentFlags(MailboxSession session)

Return Flags which are permanent stored by the mailbox. By default this are the following flags:
Flags.Flag.ANSWERED, Flags.Flag.DELETED, Flags.Flag.DRAFT, Flags.Flag.FLAGGED, Flags.Flag.RECENT, Flags.Flag.SEEN
Which in fact does not allow to permanent store user flags / keywords. If the sub-class does allow to store "any" user flag / keyword it MUST override this method and add Flags.Flag.USER to the list of returned Flags. If only a special set of user flags / keywords should be allowed just add them directly.

Parameters:

session -

Returns:

flags

getSharedPermanentFlags

protected javax.mail.Flags getSharedPermanentFlags(MailboxSession session)

Returns the flags which are shared for the current mailbox, i.e. the flags set up so that changes to those flags are visible to another user. See RFC 4314 section 5.2. In this implementation, all permanent flags are shared, ergo we simply return getPermanentFlags(MailboxSession)

Parameters:

session -

Returns:

See Also:

UnionMailboxACLResolver#isReadWrite(MailboxACLRights, Flags)

isModSeqPermanent

public boolean isModSeqPermanent(MailboxSession session)

Return true. If an subclass don't want to store mod-sequences in a permanent way just override this and return false

Specified by:

isModSeqPermanent in interface MessageManager

Returns:

true

expunge

public Iterator<Long> expunge(MessageRange set,
                     MailboxSession mailboxSession)
                       throws MailboxException

Description copied from interface: MessageManager

Expunges messages in the given range from this mailbox.

Specified by:

expunge in interface MessageManager

Parameters:

set - not null

mailboxSession - not null

Returns:

uid iterator

Throws:

MailboxException - if anything went wrong

See Also:

MessageManager.expunge(org.apache.james.mailbox.model.MessageRange, org.apache.james.mailbox.MailboxSession)

appendMessage

public long appendMessage(InputStream msgIn,
                 Date internalDate,
                 MailboxSession mailboxSession,
                 boolean isRecent,
                 javax.mail.Flags flagsToBeSet)
                   throws MailboxException

Description copied from interface: MessageManager

Appends a message to this mailbox. This method must return a higher UID as the last call in every case which also needs to be unique for the lifetime of the mailbox.

Specified by:

appendMessage in interface MessageManager

internalDate - the time of addition to be set, not null

mailboxSession - not null

isRecent - true when the message should be marked recent, false otherwise

flagsToBeSet - optionally set these flags on created message, or null when no additional flags should be set

Returns:

uid for the newly added message

Throws:

MailboxException - when message cannot be appended

See Also:

MessageManager.appendMessage(java.io.InputStream, java.util.Date, org.apache.james.mailbox.MailboxSession, boolean, javax.mail.Flags)

createMessage

protected Message<Id> createMessage(Date internalDate,
                        int size,
                        int bodyStartOctet,
                        javax.mail.internet.SharedInputStream content,
                        javax.mail.Flags flags,
                        PropertyBuilder propertyBuilder)
                             throws MailboxException

Create a new Message for the given data

Parameters:

internalDate -

size -

bodyStartOctet -

content -

flags -

Returns:

membership

Throws:

MailboxException

isWriteable

public boolean isWriteable(MailboxSession session)
                    throws MailboxException

This mailbox is writable

Specified by:

isWriteable in interface MessageManager

Returns:

writable

Throws:

MailboxException

getMetaData

public MessageManager.MetaData getMetaData(boolean resetRecent,
                                  MailboxSession mailboxSession,
                                  MessageManager.MetaData.FetchGroup fetchGroup)
                                    throws MailboxException

Description copied from interface: MessageManager

Gets current meta data for the mailbox.
Consolidates common calls together to allow improved performance.
The meta-data returned should be immutable and represent the current state of the mailbox.

Specified by:

getMetaData in interface MessageManager

Parameters:

resetRecent - true when recent flags should be reset, false otherwise

mailboxSession - context, not null

fetchGroup - describes which optional data should be returned

Returns:

meta data, not null

Throws:

MailboxException

See Also:

MessageManager.getMetaData(boolean, MailboxSession, org.apache.james.mailbox.MessageManager.MetaData.FetchGroup)

setFlags

public Map<Long,javax.mail.Flags> setFlags(javax.mail.Flags flags,
                                  boolean value,
                                  boolean replace,
                                  MessageRange set,
                                  MailboxSession mailboxSession)
                                    throws MailboxException

Description copied from interface: MessageManager

Sets flags on messages within the given range. The new flags are returned for each message altered.

Specified by:

setFlags in interface MessageManager

Parameters:

flags - Flags to be set

value - true = set, false = unset

replace - replace all Flags with this flags, value has to be true

set - the range of messages

mailboxSession - not null

Returns:

new flags indexed by UID

Throws:

MailboxException

See Also:

MessageManager.setFlags(javax.mail.Flags, boolean, boolean, org.apache.james.mailbox.model.MessageRange, org.apache.james.mailbox.MailboxSession)

copyTo

public List<MessageRange> copyTo(MessageRange set,
                        StoreMessageManager<Id> toMailbox,
                        MailboxSession session)
                          throws MailboxException

Copy the MessageRange to the StoreMessageManager

Parameters:

set -

toMailbox -

session -

Throws:

MailboxException

appendMessageToStore

protected MessageMetaData appendMessageToStore(Message<Id> message,
                                   MailboxSession session)
                                        throws MailboxException

Throws:

MailboxException

getMessageCount

public long getMessageCount(MailboxSession mailboxSession)
                     throws MailboxException

Description copied from interface: MessageManager

Return the count

Specified by:

getMessageCount in interface MessageManager

Returns:

count

Throws:

MailboxException

See Also:

MessageManager.getMessageCount(org.apache.james.mailbox.MailboxSession)

getMessages

public MessageResultIterator getMessages(MessageRange set,
                                MessageResult.FetchGroup fetchGroup,
                                MailboxSession mailboxSession)
                                  throws MailboxException

Description copied from interface: MessageManager

Gets messages in the given range. The messages may get fetched under the-hood in batches so the caller should check if MessageResultIterator.getException() returns null after Iterator.hasNext() returns false.

Specified by:

getMessages in interface MessageManager

fetchGroup - data to fetch

mailboxSession - not null

Returns:

MessageResult with the fields defined by FetchGroup

Throws:

MailboxException

See Also:

MessageManager.getMessages(org.apache.james.mailbox.model.MessageRange, org.apache.james.mailbox.model.MessageResult.FetchGroup, org.apache.james.mailbox.MailboxSession)

recent

protected List<Long> recent(boolean reset,
                MailboxSession mailboxSession)
                     throws MailboxException

Return a List which holds all uids of recent messages and optional reset the recent flag on the messages for the uids

Parameters:

reset -

mailboxSession -

Returns:

list

Throws:

MailboxException

deleteMarkedInMailbox

protected Map<Long,MessageMetaData> deleteMarkedInMailbox(MessageRange range,
                                              MailboxSession session)
                                                   throws MailboxException

Throws:

MailboxException

search

public Iterator<Long> search(SearchQuery query,
                    MailboxSession mailboxSession)
                      throws MailboxException

Description copied from interface: MessageManager

Searches for messages matching the given query. The result must be ordered

Specified by:

search in interface MessageManager

mailboxSession - not null

Returns:

uid iterator

Throws:

UnsupportedCriteriaException - when any of the search parameters are not supported by this mailbox

MailboxException - when search fails for other reasons

See Also:

MessageManager.search(org.apache.james.mailbox.model.SearchQuery, org.apache.james.mailbox.MailboxSession)

countUnseenMessagesInMailbox

protected long countUnseenMessagesInMailbox(MailboxSession session)
                                     throws MailboxException

Return the count of unseen messages

Parameters:

session -

Returns:

count of unseen messages

Throws:

MailboxException

findFirstUnseenMessageUid

protected Long findFirstUnseenMessageUid(MailboxSession session)
                                  throws MailboxException

Return the uid of the first unseen message or null of none is found

Parameters:

session -

Returns:

uid

Throws:

MailboxException

hasRight

public boolean hasRight(MailboxACL.MailboxACLRight right,
               MailboxSession session)
                 throws UnsupportedRightException

Description copied from interface: MessageManager

Tells whether the given MailboxSession's user has the given MailboxACL.MailboxACLRight for this MessageManager's mailbox.

Specified by:

hasRight in interface MessageManager

Returns:

true if the given MailboxSession's user has the given MailboxACL.MailboxACLRight for this MessageManager's mailbox; false otherwise.

Throws:

UnsupportedRightException

See Also:

org.apache.james.mailbox.MessageManager#hasRight(org.apache.james.mailbox.MailboxACL.MailboxACLRight, org.apache.james.mailbox.MailboxSession)

myRights

public MailboxACL.MailboxACLRights myRights(MailboxSession session)
                                     throws MailboxException

Description copied from interface: MessageManager

Returns the rights applicable to the user who has sent the current request.

Specified by:

myRights in interface MessageManager

Returns:

the rights applicable to the user who has sent the request, returns SimpleMailboxACL.NO_RIGHTS if session.getUser() is null.

Throws:

UnsupportedRightException

MailboxException

See Also:

MessageManager.myRights(org.apache.james.mailbox.MailboxSession)

listRigths

public MailboxACL.MailboxACLRights[] listRigths(MailboxACL.MailboxACLEntryKey key,
                                       MailboxSession session)
                                         throws UnsupportedRightException

Description copied from interface: MessageManager

Computes a result suitable for the LISTRIGHTS IMAP command. The result is computed for this mailbox and the given identifier. From RFC 4314 section 3.7: The first element of the resulting array contains the (possibly empty) set of rights the identifier will always be granted in the mailbox. Following this are zero or more right sets the identifier can be granted in the mailbox. Rights mentioned in the same set are tied together. The server MUST either grant all tied rights to the identifier in the mailbox or grant none. The same right MUST NOT be listed more than once in the LISTRIGHTS command.

Specified by:

listRigths in interface MessageManager

Parameters:

key - the identifier from the LISTRIGHTS command.

Returns:

Throws:

UnsupportedRightException

See Also:

org.apache.james.mailbox.MessageManager#listRigths(java.lang.String, org.apache.james.mailbox.MailboxSession)

setRights

public void setRights(MailboxACL.MailboxACLEntryKey mailboxACLEntryKey,
             MailboxACL.EditMode editMode,
             MailboxACL.MailboxACLRights mailboxAclRights)
               throws UnsupportedRightException

Description copied from interface: MessageManager

TODO setRights.

Specified by:

setRights in interface MessageManager

Throws:

UnsupportedRightException

See Also:

org.apache.james.mailbox.MessageManager#setRights(java.lang.String, org.apache.james.mailbox.model.MailboxACL.EditMode, org.apache.james.mailbox.model.MailboxACL.MailboxACLRights)

getResolvedMailboxACL

protected MailboxACL getResolvedMailboxACL(MailboxSession mailboxSession)
                                    throws UnsupportedRightException

Applies the global ACL (if there are any) to the mailbox ACL.

Parameters:

mailboxSession -

Returns:

the ACL of the present mailbox merged with the global ACL (if there are any).

Throws:

UnsupportedRightException

isGroupFolder

protected boolean isGroupFolder(MailboxSession session)

Returns true if the current mailbox does not reside neither in private nor other users' namespace.

Parameters:

session -

Returns: