org.apache.james.transport.matchers

Class AbstractStorageQuota

java.lang.Object

org.apache.mailet.base.GenericMatcher

org.apache.james.transport.matchers.AbstractQuotaMatcher

org.apache.james.transport.matchers.AbstractStorageQuota

All Implemented Interfaces:

org.apache.mailet.Matcher, org.apache.mailet.MatcherConfig

Direct Known Subclasses:

MailboxQuotaFixed

public abstract class AbstractStorageQuota
extends org.apache.james.transport.matchers.AbstractQuotaMatcher

Experimental: Abstract matcher checking whether a recipient has exceeded a maximum allowed storage quota for messages standing in his inbox.

"Storage quota" at this level is still an abstraction whose specific interpretation will be done by subclasses (e.g. could be specific for each user or common to all of them).

This matcher need to calculate the mailbox size everytime it is called. This can slow down things if there are many mails in the mailbox. Some users also report big problems with the matcher if a JDBC based mailrepository is used.

Since:

2.2.0

Constructor Summary

Constructors

Constructor and Description
AbstractStorageQuota()

Method Summary

Methods

Modifier and Type	Method and Description
protected long	getUsed(org.apache.mailet.MailAddress recipient, org.apache.mailet.Mail _) Gets the storage used in the recipient's inbox.
void	init()
protected boolean	isRecipientChecked(org.apache.mailet.MailAddress recipient) Checks the recipient. Does a super.isRecipientChecked and checks that the recipient is a known user in the local server. If a subclass overrides this method it should "and" super.isRecipientChecked to its check.
void	setMailboxManager(org.apache.james.mailbox.MailboxManager manager)
void	setUsersRepository(UsersRepository localusers)

Methods inherited from class org.apache.james.transport.matchers.AbstractQuotaMatcher

getQuota, isOverQuota, isSenderChecked, match, parseQuota

Methods inherited from class org.apache.mailet.base.GenericMatcher

destroy, getCondition, getMailetContext, getMatcherConfig, getMatcherInfo, getMatcherName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStorageQuota

public AbstractStorageQuota()

Method Detail

setMailboxManager

public void setMailboxManager(org.apache.james.mailbox.MailboxManager manager)

setUsersRepository

public void setUsersRepository(UsersRepository localusers)

isRecipientChecked

protected boolean isRecipientChecked(org.apache.mailet.MailAddress recipient)
                              throws javax.mail.MessagingException

Checks the recipient.
Does a super.isRecipientChecked and checks that the recipient is a known user in the local server.
If a subclass overrides this method it should "and" super.isRecipientChecked to its check.

Overrides:

isRecipientChecked in class org.apache.james.transport.matchers.AbstractQuotaMatcher

Parameters:

recipient - the recipient to check

Throws:

javax.mail.MessagingException

init

public void init()
          throws javax.mail.MessagingException

Overrides:

init in class org.apache.mailet.base.GenericMatcher

Throws:

javax.mail.MessagingException

getUsed

protected long getUsed(org.apache.mailet.MailAddress recipient,
           org.apache.mailet.Mail _)
                throws javax.mail.MessagingException

Gets the storage used in the recipient's inbox.

Specified by:

getUsed in class org.apache.james.transport.matchers.AbstractQuotaMatcher

Parameters:

recipient - the recipient to check

Throws:

javax.mail.MessagingException