org.apache.james.mailbox

Interface MailboxListenerSupport

All Known Subinterfaces:

MailboxManager

All Known Implementing Classes:

AbstractDelegatingMailboxListener, HashMapDelegatingMailboxListener, HBaseMailboxManager, JCRMailboxManager, JPAMailboxManager, OpenJPAMailboxManager, StoreMailboxManager

public interface MailboxListenerSupport

Implementations of this interface supports MailboxListener. Its needed that the events get handled in the submitted order

Method Summary

Methods

Modifier and Type	Method and Description
void	addGlobalListener(MailboxListener listener, MailboxSession session) Add a MailboxListener which get fired for ever MailboxPath
void	addListener(MailboxPath mailboxPath, MailboxListener listener, MailboxSession session) Implementations of Mailbox may interpret the fact that someone is listening and do some caching and even postpone persistence until everyone has removed itself.
void	removeGlobalListener(MailboxListener listner, MailboxSession session) Remove the MailboxListener
void	removeListener(MailboxPath mailboxPath, MailboxListener listner, MailboxSession session) Remove the MailboxListener

Method Detail

addListener

void addListener(MailboxPath mailboxPath,
               MailboxListener listener,
               MailboxSession session)
                 throws MailboxException

Implementations of Mailbox may interpret the fact that someone is listening and do some caching and even postpone persistence until everyone has removed itself.

Parameters:

mailboxPath - not null

listener - not null

session - not null

Throws:

MailboxException

removeListener

void removeListener(MailboxPath mailboxPath,
                  MailboxListener listner,
                  MailboxSession session)
                    throws MailboxException

Remove the MailboxListener

Parameters:

mailboxPath -

listner -

session -

Throws:

MailboxException

addGlobalListener

void addGlobalListener(MailboxListener listener,
                     MailboxSession session)
                       throws MailboxException

Add a MailboxListener which get fired for ever MailboxPath

Parameters:

listener -

session -

Throws:

MailboxException

removeGlobalListener

void removeGlobalListener(MailboxListener listner,
                        MailboxSession session)
                          throws MailboxException

Remove the MailboxListener

Parameters:

listner -

session -

Throws:

MailboxException