org.apache.james.mailbox.store

Class AbstractDelegatingMailboxListener

java.lang.Object

org.apache.james.mailbox.store.AbstractDelegatingMailboxListener

All Implemented Interfaces:

MailboxListener, MailboxListenerSupport

Direct Known Subclasses:

HashMapDelegatingMailboxListener

public abstract class AbstractDelegatingMailboxListener
extends Object
implements MailboxListener, MailboxListenerSupport

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

Modifier	Constructor and Description
protected	AbstractDelegatingMailboxListener()

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 path, 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	event(MailboxListener.Event event) Receive the event and dispatch it to the right MailboxListener depending on MailboxListener.Event.getMailboxPath()
protected abstract List<MailboxListener>	getGlobalListeners() Return the List which is used tos tore the global MailboxListener
protected abstract Map<MailboxPath,List<MailboxListener>>	getListeners() Return the Map which is used to store the MailboxListener
void	removeGlobalListener(MailboxListener listener, MailboxSession session) Remove the MailboxListener
void	removeListener(MailboxPath mailboxPath, MailboxListener listener, MailboxSession session) Remove the MailboxListener

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDelegatingMailboxListener

protected AbstractDelegatingMailboxListener()

Method Detail

event

public void event(MailboxListener.Event event)

Receive the event and dispatch it to the right MailboxListener depending on MailboxListener.Event.getMailboxPath()

Specified by:

event in interface MailboxListener

Parameters:

event - not null

addListener

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

Description copied from interface: MailboxListenerSupport

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

Specified by:

addListener in interface MailboxListenerSupport

Parameters:

path - not null

listener - not null

session - not null

Throws:

MailboxException

See Also:

MailboxListenerSupport.addListener(org.apache.james.mailbox.model.MailboxPath, org.apache.james.mailbox.MailboxListener, org.apache.james.mailbox.MailboxSession)

addGlobalListener

public void addGlobalListener(MailboxListener listener,
                     MailboxSession session)
                       throws MailboxException

Description copied from interface: MailboxListenerSupport

Add a MailboxListener which get fired for ever MailboxPath

Specified by:

addGlobalListener in interface MailboxListenerSupport

Throws:

MailboxException

See Also:

MailboxListenerSupport.addGlobalListener(org.apache.james.mailbox.MailboxListener, org.apache.james.mailbox.MailboxSession)

removeListener

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

Description copied from interface: MailboxListenerSupport

Remove the MailboxListener

Specified by:

removeListener in interface MailboxListenerSupport

Throws:

MailboxException

See Also:

MailboxListenerSupport.removeListener(org.apache.james.mailbox.model.MailboxPath, org.apache.james.mailbox.MailboxListener, org.apache.james.mailbox.MailboxSession)

removeGlobalListener

public void removeGlobalListener(MailboxListener listener,
                        MailboxSession session)
                          throws MailboxException

Description copied from interface: MailboxListenerSupport

Remove the MailboxListener

Specified by:

removeGlobalListener in interface MailboxListenerSupport

Throws:

MailboxException

See Also:

MailboxListenerSupport.removeGlobalListener(org.apache.james.mailbox.MailboxListener, org.apache.james.mailbox.MailboxSession)

getListeners

protected abstract Map<MailboxPath,List<MailboxListener>> getListeners()

Return the Map which is used to store the MailboxListener

Returns:

listeners

getGlobalListeners

protected abstract List<MailboxListener> getGlobalListeners()

Return the List which is used tos tore the global MailboxListener

Returns:

globalListeners