Package com.mimecast.robin.sasl

Class SqlUserLookup

java.lang.Object

com.mimecast.robin.sasl.SqlUserLookup

All Implemented Interfaces:

AutoCloseable

public class SqlUserLookup
extends Object
implements AutoCloseable

SqlUserLookup provides user existence lookup against a configured SQL database. It is intended as an alternative to the Dovecot UNIX domain socket userdb lookup. Usage: construct with a JDBC URL/user/password or provide a HikariDataSource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SqlUserLookup.UserRecord

Field Summary

Fields

Modifier and Type	Field	Description
private final String	aliasQuery
private final String	domainQuery
private final com.zaxxer.hikari.HikariDataSource	ds
private static final org.apache.logging.log4j.Logger	log
private final String	userQuery

Constructor Summary

Constructors

Constructor	Description
SqlUserLookup(com.zaxxer.hikari.HikariDataSource ds, String userQuery)
SqlUserLookup(com.zaxxer.hikari.HikariDataSource sharedDs, String userQuery, boolean unused)
SqlUserLookup(com.zaxxer.hikari.HikariDataSource ds, String userQuery, String domainQuery, String aliasQuery)
SqlUserLookup(String jdbcUrl, String user, String password, String userQuery)
SqlUserLookup(String jdbcUrl, String user, String password, String userQuery, String domainQuery, String aliasQuery)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isDomainServed(String domain)	Checks if a domain is served by this mail system.
Optional<SqlUserLookup.UserRecord>	lookup(String email)
Optional<String>	resolveAlias(String email)	Resolves an email alias to its real destination address.

Methods inherited from class java.lang.Object

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

Field Details

log

private static final org.apache.logging.log4j.Logger log

ds

private final com.zaxxer.hikari.HikariDataSource ds

userQuery

private final String userQuery

domainQuery

private final String domainQuery

aliasQuery

private final String aliasQuery

Constructor Details

SqlUserLookup

public SqlUserLookup(String jdbcUrl,
 String user,
 String password,
 String userQuery)

SqlUserLookup

public SqlUserLookup(String jdbcUrl,
 String user,
 String password,
 String userQuery,
 String domainQuery,
 String aliasQuery)

SqlUserLookup

public SqlUserLookup(com.zaxxer.hikari.HikariDataSource ds,
 String userQuery)

SqlUserLookup

public SqlUserLookup(com.zaxxer.hikari.HikariDataSource ds,
 String userQuery,
 String domainQuery,
 String aliasQuery)

SqlUserLookup

public SqlUserLookup(com.zaxxer.hikari.HikariDataSource sharedDs,
 String userQuery,
 boolean unused)

Method Details

lookup

public Optional<SqlUserLookup.UserRecord> lookup(String email)

isDomainServed

public boolean isDomainServed(String domain)

Checks if a domain is served by this mail system. Returns true if domainQuery is not configured (backward compatible).

Parameters:

domain - Domain to check (e.g. "example.com").

Returns:

True if the domain is served or no domain query is configured.

resolveAlias

public Optional<String> resolveAlias(String email)

Resolves an email alias to its real destination address. Returns empty if aliasQuery is not configured (backward compatible).

Parameters:

email - Email address to resolve.

Returns:

Optional destination address, or empty if no alias exists.

close

public void close()

Specified by:

close in interface AutoCloseable