org.apache.james.mailbox.store.quota

Class ListeningQuotaManager

java.lang.Object

org.apache.james.mailbox.store.quota.ListeningQuotaManager

All Implemented Interfaces:

MailboxListener, QuotaManager

Direct Known Subclasses:

FixedQuotaManager, PerUserQuotaManager

public abstract class ListeningQuotaManager
extends Object
implements QuotaManager, MailboxListener

QuotaManager which will keep track of quota by listing for MailboxListener.Event's. The whole quota is keeped in memory after it was lazy-fetched on the first access *

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
ListeningQuotaManager(StoreMailboxManager<?> manager)

Method Summary

Methods

Modifier and Type	Method and Description
void	event(MailboxListener.Event event) Informs this listener about the given event.
protected MailboxSessionMapperFactory<?>	getFactory()
protected abstract long	getMaxMessage(MailboxSession session) Return the maximum message count which is allowed for the given MailboxSession (in fact the user which the session is bound to)
protected abstract long	getMaxStorage(MailboxSession session) Return the maximum storage which is allowed for the given MailboxSession (in fact the user which the session is bound to) The returned valued must be in bytes
Quota	getMessageQuota(MailboxSession session) Return the message count Quota for the given MailboxSession (which in fact is bound to a user)
Quota	getStorageQuota(MailboxSession session) Return the message storage Quota for the given MailboxSession (which in fact is bound to a user)
boolean	isClosed() Get never closed
void	setCalculateUsedWhenUnlimited(boolean calculateWhenUnlimited)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListeningQuotaManager

public ListeningQuotaManager(StoreMailboxManager<?> manager)
                      throws MailboxException

Throws:

MailboxException

Method Detail

getFactory

protected MailboxSessionMapperFactory<?> getFactory()

setCalculateUsedWhenUnlimited

public void setCalculateUsedWhenUnlimited(boolean calculateWhenUnlimited)

getMessageQuota

public Quota getMessageQuota(MailboxSession session)
                      throws MailboxException

Description copied from interface: QuotaManager

Return the message count Quota for the given MailboxSession (which in fact is bound to a user)

Specified by:

getMessageQuota in interface QuotaManager

Returns:

quota

Throws:

MailboxException

getStorageQuota

public Quota getStorageQuota(MailboxSession session)
                      throws MailboxException

Description copied from interface: QuotaManager

Return the message storage Quota for the given MailboxSession (which in fact is bound to a user)

Specified by:

getStorageQuota in interface QuotaManager

Returns:

quota

Throws:

MailboxException

getMaxStorage

protected abstract long getMaxStorage(MailboxSession session)
                               throws MailboxException

Return the maximum storage which is allowed for the given MailboxSession (in fact the user which the session is bound to) The returned valued must be in bytes

Parameters:

session -

Returns:

maxBytes

Throws:

MailboxException

getMaxMessage

protected abstract long getMaxMessage(MailboxSession session)
                               throws MailboxException

Return the maximum message count which is allowed for the given MailboxSession (in fact the user which the session is bound to)

Parameters:

session -

Returns:

maximum of allowed message count

Throws:

MailboxException

event

public void event(MailboxListener.Event event)

Description copied from interface: MailboxListener

Informs this listener about the given event.

Specified by:

event in interface MailboxListener

Parameters:

event - not null

isClosed

public boolean isClosed()

Get never closed

Returns:

false