org.apache.james.transport.matchers

Class AbstractSQLWhitelistMatcher

java.lang.Object

org.apache.mailet.base.GenericMatcher

org.apache.james.transport.matchers.AbstractSQLWhitelistMatcher

All Implemented Interfaces:

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

Direct Known Subclasses:

IsInWhiteList, NetworkIsInWhitelist

public abstract class AbstractSQLWhitelistMatcher
extends org.apache.mailet.base.GenericMatcher

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSource	datasource
protected SqlResources	sqlQueries Contains all of the sql strings for this component.
protected JDBCUtil	theJDBCUtil The JDBCUtil helper class

Constructor Summary

Constructors

Constructor and Description
AbstractSQLWhitelistMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getPrimaryName(String originalUsername) Gets the main name of a local customer, handling alias
protected abstract String	getSQLSectionName()
protected abstract String	getTableCreateQueryName()
protected abstract String	getTableName()
void	init()
protected void	initSqlQueries(Connection conn, org.apache.mailet.MailetContext mailetContext) Initializes the sql query environment from the SqlResources file. Will look for conf/sqlResources.xml. Will not create the database resources, if missing (this task is done, if needed, in the WhiteListManager initialization routine).
Collection<org.apache.mailet.MailAddress>	match(org.apache.mailet.Mail mail)
protected abstract boolean	matchedWhitelist(org.apache.mailet.MailAddress recipient, org.apache.mailet.Mail mail)
void	setDataSource(DataSource datasource)
void	setFilesystem(FileSystem fs)
void	setUsersRepository(UsersRepository localusers)

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

Field Detail

datasource

protected DataSource datasource

theJDBCUtil

protected final JDBCUtil theJDBCUtil

The JDBCUtil helper class

sqlQueries

protected SqlResources sqlQueries

Contains all of the sql strings for this component.

Constructor Detail

AbstractSQLWhitelistMatcher

public AbstractSQLWhitelistMatcher()

Method Detail

setDataSource

public void setDataSource(DataSource datasource)

setUsersRepository

public void setUsersRepository(UsersRepository localusers)

setFilesystem

public void setFilesystem(FileSystem fs)

init

public void init()
          throws javax.mail.MessagingException

Overrides:

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

Throws:

javax.mail.MessagingException

match

public Collection<org.apache.mailet.MailAddress> match(org.apache.mailet.Mail mail)
                                                throws javax.mail.MessagingException

Specified by:

match in interface org.apache.mailet.Matcher

Specified by:

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

Throws:

javax.mail.MessagingException

matchedWhitelist

protected abstract boolean matchedWhitelist(org.apache.mailet.MailAddress recipient,
                       org.apache.mailet.Mail mail)
                                     throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getPrimaryName

protected String getPrimaryName(String originalUsername)

Gets the main name of a local customer, handling alias

initSqlQueries

protected void initSqlQueries(Connection conn,
                  org.apache.mailet.MailetContext mailetContext)
                       throws Exception

Initializes the sql query environment from the SqlResources file.
Will look for conf/sqlResources.xml.
Will not create the database resources, if missing
(this task is done, if needed, in the WhiteListManager initialization routine).

Parameters:

conn - The connection for accessing the database

mailetContext - The current mailet context, for finding the conf/sqlResources.xml file

Throws:

Exception - If any error occurs

getTableName

protected abstract String getTableName()

getTableCreateQueryName

protected abstract String getTableCreateQueryName()

getSQLSectionName

protected abstract String getSQLSectionName()