org.apache.james.mailbox.store.search

Class LazyMessageSearchIndex<Id>

java.lang.Object

org.apache.james.mailbox.store.search.ListeningMessageSearchIndex<Id>

org.apache.james.mailbox.store.search.LazyMessageSearchIndex<Id>

Type Parameters:

Id -

All Implemented Interfaces:

MailboxListener, MessageSearchIndex<Id>

public class LazyMessageSearchIndex<Id>
extends ListeningMessageSearchIndex<Id>

ListeningMessageSearchIndex implementation which wraps another ListeningMessageSearchIndex and will forward all calls to it. The only special thing about this is that it will index all the mails in the mailbox on the first call of search(MailboxSession, Mailbox, SearchQuery) This class is mostly useful for in-memory indexes or for indexed that should be recreated on every server restart.

Nested Class Summary

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

MailboxListener.Added, MailboxListener.Event, MailboxListener.Expunged, MailboxListener.FlagsUpdated, MailboxListener.MailboxACLUpdated, MailboxListener.MailboxAdded, MailboxListener.MailboxDeletion, MailboxListener.MailboxRenamed, MailboxListener.MessageEvent

Constructor Summary

Constructors

Constructor and Description
LazyMessageSearchIndex(ListeningMessageSearchIndex<Id> index)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(MailboxSession session, Mailbox<Id> mailbox, Message<Id> message) Add the Message for the given Mailbox to the index
void	delete(MailboxSession session, Mailbox<Id> mailbox, MessageRange range) Delete the MessageRange for the given Mailbox from the index
Iterator<Long>	search(MailboxSession session, Mailbox<Id> mailbox, SearchQuery searchQuery) Lazy index the mailbox on first search request if it was not indexed before.
void	update(MailboxSession session, Mailbox<Id> mailbox, MessageRange range, javax.mail.Flags flags) Update the MessageRange for the given Mailbox with the new Flags in the index

Methods inherited from class org.apache.james.mailbox.store.search.ListeningMessageSearchIndex

event, getFactory, isClosed

Methods inherited from class java.lang.Object

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

Constructor Detail

LazyMessageSearchIndex

public LazyMessageSearchIndex(ListeningMessageSearchIndex<Id> index)

Method Detail

add

public void add(MailboxSession session,
       Mailbox<Id> mailbox,
       Message<Id> message)
         throws MailboxException

Description copied from class: ListeningMessageSearchIndex

Add the Message for the given Mailbox to the index

Specified by:

add in class ListeningMessageSearchIndex<Id>

Throws:

MailboxException

delete

public void delete(MailboxSession session,
          Mailbox<Id> mailbox,
          MessageRange range)
            throws MailboxException

Description copied from class: ListeningMessageSearchIndex

Delete the MessageRange for the given Mailbox from the index

Specified by:

delete in class ListeningMessageSearchIndex<Id>

Throws:

MailboxException

search

public Iterator<Long> search(MailboxSession session,
                    Mailbox<Id> mailbox,
                    SearchQuery searchQuery)
                      throws MailboxException

Lazy index the mailbox on first search request if it was not indexed before. After indexing is done it delegate the search request to the wrapped MessageSearchIndex. Be aware that concurrent search requests are blocked on the same "not-yet-indexed" mailbox till it the index process was complete

Returns:

Iterator on found uids

Throws:

MailboxException

update

public void update(MailboxSession session,
          Mailbox<Id> mailbox,
          MessageRange range,
          javax.mail.Flags flags)
            throws MailboxException

Description copied from class: ListeningMessageSearchIndex

Update the MessageRange for the given Mailbox with the new Flags in the index

Specified by:

update in class ListeningMessageSearchIndex<Id>

Throws:

MailboxException