org.apache.james.mailbox.store.search

Class ListeningMessageSearchIndex<Id>

java.lang.Object

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

Type Parameters:

Id -

All Implemented Interfaces:

MailboxListener, MessageSearchIndex<Id>

Direct Known Subclasses:

LazyMessageSearchIndex, LuceneMessageSearchIndex

public abstract class ListeningMessageSearchIndex<Id>
extends Object
implements MessageSearchIndex<Id>, MailboxListener

MessageSearchIndex which needs to get registered as global MailboxListener and so get notified about message changes. This will then allow to update the underlying index.

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
ListeningMessageSearchIndex(MessageMapperFactory<Id> factory)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	add(MailboxSession session, Mailbox<Id> mailbox, Message<Id> message) Add the Message for the given Mailbox to the index
abstract void	delete(MailboxSession session, Mailbox<Id> mailbox, MessageRange range) Delete the MessageRange for the given Mailbox from the index
void	event(MailboxListener.Event event) Process the MailboxListener.Event and update the index if something relevant is received
protected MessageMapperFactory<Id>	getFactory() Return the MessageMapperFactory
boolean	isClosed() Never closed
abstract 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 java.lang.Object

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

Methods inherited from interface org.apache.james.mailbox.store.search.MessageSearchIndex

search

Constructor Detail

ListeningMessageSearchIndex

public ListeningMessageSearchIndex(MessageMapperFactory<Id> factory)

Method Detail

getFactory

protected MessageMapperFactory<Id> getFactory()

Return the MessageMapperFactory

Returns:

factory

event

public void event(MailboxListener.Event event)

Process the MailboxListener.Event and update the index if something relevant is received

Specified by:

event in interface MailboxListener

Parameters:

event - not null

isClosed

public boolean isClosed()

Never closed

add

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

Add the Message for the given Mailbox to the index

Parameters:

session -

mailbox -

message -

Throws:

MailboxException

delete

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

Delete the MessageRange for the given Mailbox from the index

Parameters:

session -

mailbox -

range -

Throws:

MailboxException

update

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

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

Parameters:

session -

mailbox -

range -

flags -

Throws:

MailboxException