org.masukomi.aspirin.core.config

Class Configuration

java.lang.Object

org.masukomi.aspirin.core.config.Configuration

All Implemented Interfaces:

ConfigurationMBean

public class Configuration
extends Object
implements ConfigurationMBean

This class represents the configuration of Aspirin. You can configure this software two ways:

1. Get the configuration instance and set parameters.
2. Get the instance and initialize with a Properties object.

There is a way to change behavior of Aspirin dinamically. You can use JMX to change configuration parameters. In the parameters list we marked the parameters which are applied immediately. For more informations view ConfigurationMBean.

Name	Type	Description
aspirin.delivery.attempt.delay	Integer	The delay of next attempt to delivery in milliseconds. Change by JMX applied immediately.
aspirin.delivery.attempt.count	Integer	Maximal number of delivery attempts of an email. Change by JMX applied immediately.
aspirin.delivery.bounce-on-failure	Boolean	If true, a bounce email will be send to postmaster on failure. Change by JMX applied immediately.
aspirin.delivery.debug	Boolean	If true, full SMTP communication will be logged. Change by JMX applied immediately.
aspirin.delivery.expiry	Long	Time of sending expiry in milliseconds. The queue send an email until current time = queueing time + expiry. Default value is -1, it means forever (no expiration time). Change by JMX applied immediately.
aspirin.delivery.threads.active.max	Integer	Maximum number of active delivery threads in the pool. Change by JMX applied immediately.
aspirin.delivery.threads.idle.max	Integer	Maximum number of idle delivery threads in the pool (the deilvery threads over this limit will be shutdown). Change by JMX applied immediately.
aspirin.delivery.timeout	Integer	Socket and Transport timeout in milliseconds. Change by JMX applied immediately.
aspirin.encoding	String	The MIME encoding. Change by JMX applied immediately.
aspirin.hostname	String	The hostname. Change by JMX applied immediately.
aspirin.logger.name	String	The name of the logger. Change by JMX applied immediately. WARNING! Changing logger name cause replacing of logger.
aspirin.logger.prefix	String	The prefix of the logger. This will be put in the logs at the first position. Change by JMX applied immediately.
aspirin.postmaster.email	String	The email address of the postmaster. Change by JMX applied immediately.
aspirin.mailstore.class	String	The class name of mail store. Default class is SimpleMailStore in org.masukomi.aspirin.core.store package.
aspirin.queuestore.class	String	The class name of queue store. Default class is SimpleQueueStore in org.masukomi.aspirin.core.queue package.

Author:

Kate Rhodes masukomi at masukomi dot org, Laszlo Solova

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	Configuration.Parameter

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Object>	configParameters
private Object	listenerLock
private List<ConfigurationChangeListener>	listeners
private static org.slf4j.Logger	log
private static String	MAIL_MIME_CHARSET
private static String	MAIL_SMTP_CONNECTIONTIMEOUT
private static String	MAIL_SMTP_HOST
private static String	MAIL_SMTP_LOCALHOST
private static String	MAIL_SMTP_TIMEOUT
private javax.mail.Session	mailSession
private MailStore	mailStore
protected javax.mail.internet.InternetAddress	postmaster

Fields inherited from interface org.masukomi.aspirin.core.config.ConfigurationMBean

NEVER_EXPIRES, PARAM_DELIVERY_ATTEMPT_COUNT, PARAM_DELIVERY_ATTEMPT_DELAY, PARAM_DELIVERY_BOUNCE_ON_FAILURE, PARAM_DELIVERY_DEBUG, PARAM_DELIVERY_EXPIRY, PARAM_DELIVERY_THREADS_ACTIVE_MAX, PARAM_DELIVERY_THREADS_IDLE_MAX, PARAM_DELIVERY_TIMEOUT, PARAM_ENCODING, PARAM_HOSTNAME, PARAM_LOGGER_NAME, PARAM_LOGGER_PREFIX, PARAM_MAILSTORE_CLASS, PARAM_POSTMASTER_EMAIL

Constructor Summary

Constructors

Constructor and Description
Configuration()
Configuration(Properties props)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ConfigurationChangeListener listener)
int	getDeliveryAttemptCount()
int	getDeliveryAttemptDelay()
int	getDeliveryThreadsActiveMax()
int	getDeliveryThreadsIdleMax()
int	getDeliveryTimeout()
String	getEncoding()
long	getExpiry()
String	getHostname()
String	getLoggerName()
String	getLoggerPrefix()
javax.mail.Session	getMailSession()
MailStore	getMailStore()
String	getMailStoreClassName()
javax.mail.internet.InternetAddress	getPostmaster()
String	getPostmasterEmail()
Object	getProperty(String name)
void	init(Properties props)
boolean	isDeliveryBounceOnFailure()
boolean	isDeliveryDebug()
private void	notifyListeners(String changedParameterName)
void	removeListener(ConfigurationChangeListener listener)
void	setDeliveryAttemptCount(int attemptCount) Set the maximal count of delivery tries of a temporary undeliverable email.
void	setDeliveryAttemptDelay(int delay) Set the time interval between two delivery attempts of a temporary undeliverable email.
void	setDeliveryBounceOnFailure(boolean bounce) Set the bounce email sending (on delivery failures).
void	setDeliveryDebug(boolean debug) Set the debug of full SMTP communication.
void	setDeliveryThreadsActiveMax(int activeThreadsMax) Set the maximal count of paralel running delivery threads.
void	setDeliveryThreadsIdleMax(int idleThreadsMax) Set the maximal count of idle delivery threads stored in pool.
void	setDeliveryTimeout(int timeout) Set the timeout of Transport and Socket which is used if communication is too slow.
void	setEncoding(String encoding) Set the encoding of MIME messages.
void	setExpiry(long expiry) Set the default expiry of MIME messages.
void	setHostname(String hostname) Set the hostname, which is used in HELO command of SMTP communication.
void	setMailStore(MailStore mailStore)
void	setMailStoreClassName(String className) Set the mail store class name, where MimeMessages will be stored.
void	setPostmasterEmail(String emailAddress) Set the email address of postmaster.
void	setProperty(String name, Object value)
private void	updateMailSession()

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.slf4j.Logger log

configParameters

private Map<String,Object> configParameters

mailStore

private MailStore mailStore

postmaster

protected javax.mail.internet.InternetAddress postmaster

mailSession

private javax.mail.Session mailSession

listeners

private List<ConfigurationChangeListener> listeners

listenerLock

private Object listenerLock

MAIL_MIME_CHARSET

private static final String MAIL_MIME_CHARSET

See Also:

Constant Field Values

MAIL_SMTP_CONNECTIONTIMEOUT

private static final String MAIL_SMTP_CONNECTIONTIMEOUT

See Also:

Constant Field Values

MAIL_SMTP_HOST

private static final String MAIL_SMTP_HOST

See Also:

Constant Field Values

MAIL_SMTP_LOCALHOST

private static final String MAIL_SMTP_LOCALHOST

See Also:

Constant Field Values

MAIL_SMTP_TIMEOUT

private static final String MAIL_SMTP_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration()

Configuration

public Configuration(Properties props)

Method Detail

init

public void init(Properties props)

getPostmaster

public javax.mail.internet.InternetAddress getPostmaster()

Returns:

The email address of the postmaster in a MailAddress object.

getHostname

public String getHostname()

Specified by:

getHostname in interface ConfigurationMBean

Returns:

The hostname of this server. It is used in HELO SMTP command.

setHostname

public void setHostname(String hostname)

Description copied from interface: ConfigurationMBean

Set the hostname, which is used in HELO command of SMTP communication. This hostname identifies us for other hosts. If the hostname is invalid or not correctly configured for this server, the delivery could be failed in various reasons.

Specified by:

setHostname in interface ConfigurationMBean

Parameters:

hostname - The name of this server or application.

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface ConfigurationMBean

Returns:

The name of MIME encoding of emails.

setEncoding

public void setEncoding(String encoding)

Description copied from interface: ConfigurationMBean

Set the encoding of MIME messages. For example: "UTF-8".

Specified by:

setEncoding in interface ConfigurationMBean

Parameters:

encoding - The MIME encoding.

getDeliveryAttemptCount

public int getDeliveryAttemptCount()

Specified by:

getDeliveryAttemptCount in interface ConfigurationMBean

Returns:

The maximal count of delivery attempts of an email.

getDeliveryAttemptDelay

public int getDeliveryAttemptDelay()

Specified by:

getDeliveryAttemptDelay in interface ConfigurationMBean

Returns:

The time between two delivery attempt of an email.

getDeliveryThreadsActiveMax

public int getDeliveryThreadsActiveMax()

Specified by:

getDeliveryThreadsActiveMax in interface ConfigurationMBean

Returns:

The maximal count of delivery threads running paralel.

getDeliveryThreadsIdleMax

public int getDeliveryThreadsIdleMax()

Specified by:

getDeliveryThreadsIdleMax in interface ConfigurationMBean

Returns:

The maximal count of delivery threads stored as idle in delivery pool.

getDeliveryTimeout

public int getDeliveryTimeout()

Specified by:

getDeliveryTimeout in interface ConfigurationMBean

Returns:

The socket and Transport timeout in a delivery.

getExpiry

public long getExpiry()

Specified by:

getExpiry in interface ConfigurationMBean

Returns:

The value of default email expiry time.

getLoggerName

public String getLoggerName()

Specified by:

getLoggerName in interface ConfigurationMBean

Returns:

The name of the logger.

getLoggerPrefix

public String getLoggerPrefix()

Specified by:

getLoggerPrefix in interface ConfigurationMBean

Returns:

The prefix appended to the start of the log entries.

getMailStore

public MailStore getMailStore()

getPostmasterEmail

public String getPostmasterEmail()

Specified by:

getPostmasterEmail in interface ConfigurationMBean

Returns:

The email address of the postmaster.

isDeliveryBounceOnFailure

public boolean isDeliveryBounceOnFailure()

Specified by:

isDeliveryBounceOnFailure in interface ConfigurationMBean

Returns:

If true, then a bounce email will be send to postmaster on delivery failures.

isDeliveryDebug

public boolean isDeliveryDebug()

Specified by:

isDeliveryDebug in interface ConfigurationMBean

Returns:

If true, then the full SMTP communication will be logged.

setDeliveryAttemptCount

public void setDeliveryAttemptCount(int attemptCount)

Description copied from interface: ConfigurationMBean

Set the maximal count of delivery tries of a temporary undeliverable email.

Specified by:

setDeliveryAttemptCount in interface ConfigurationMBean

Parameters:

attemptCount - The count of deliery attempts.

setDeliveryAttemptDelay

public void setDeliveryAttemptDelay(int delay)

Description copied from interface: ConfigurationMBean

Set the time interval between two delivery attempts of a temporary undeliverable email.

Specified by:

setDeliveryAttemptDelay in interface ConfigurationMBean

Parameters:

delay - The value of delay in milliseconds.

setDeliveryBounceOnFailure

public void setDeliveryBounceOnFailure(boolean bounce)

Description copied from interface: ConfigurationMBean

Set the bounce email sending (on delivery failures).

Specified by:

setDeliveryBounceOnFailure in interface ConfigurationMBean

Parameters:

bounce - If true, then a bounce email will be send to postmaster on delivery failures.

setDeliveryDebug

public void setDeliveryDebug(boolean debug)

Description copied from interface: ConfigurationMBean

Set the debug of full SMTP communication.

Specified by:

setDeliveryDebug in interface ConfigurationMBean

Parameters:

debug - If true, then the full communication will be logged.

setDeliveryThreadsActiveMax

public void setDeliveryThreadsActiveMax(int activeThreadsMax)

Description copied from interface: ConfigurationMBean

Set the maximal count of paralel running delivery threads.

Specified by:

setDeliveryThreadsActiveMax in interface ConfigurationMBean

setDeliveryThreadsIdleMax

public void setDeliveryThreadsIdleMax(int idleThreadsMax)

Description copied from interface: ConfigurationMBean

Set the maximal count of idle delivery threads stored in pool.

Specified by:

setDeliveryThreadsIdleMax in interface ConfigurationMBean

setDeliveryTimeout

public void setDeliveryTimeout(int timeout)

Description copied from interface: ConfigurationMBean

Set the timeout of Transport and Socket which is used if communication is too slow.

Specified by:

setDeliveryTimeout in interface ConfigurationMBean

Parameters:

timeout - The value of timeout in milliseconds.

setExpiry

public void setExpiry(long expiry)

Description copied from interface: ConfigurationMBean

Set the default expiry of MIME messages. Default value is -1, it means forever.

Specified by:

setExpiry in interface ConfigurationMBean

Parameters:

expiry - The default expiry time.

setMailStore

public void setMailStore(MailStore mailStore)

setPostmasterEmail

public void setPostmasterEmail(String emailAddress)

Description copied from interface: ConfigurationMBean

Set the email address of postmaster. If delivery failed, you can get an email about the failure to this address.

Specified by:

setPostmasterEmail in interface ConfigurationMBean

Parameters:

emailAddress - The email address of postmaster.

addListener

public void addListener(ConfigurationChangeListener listener)

removeListener

public void removeListener(ConfigurationChangeListener listener)

notifyListeners

private void notifyListeners(String changedParameterName)

getMailStoreClassName

public String getMailStoreClassName()

Specified by:

getMailStoreClassName in interface ConfigurationMBean

Returns:

The directory object's class name where the mimemessage objects could be stored.

setMailStoreClassName

public void setMailStoreClassName(String className)

Description copied from interface: ConfigurationMBean

Set the mail store class name, where MimeMessages will be stored. Built-in stores are SimpleMailStore and FileMailStore.

Specified by:

setMailStoreClassName in interface ConfigurationMBean

getMailSession

public javax.mail.Session getMailSession()

getProperty

public Object getProperty(String name)

setProperty

public void setProperty(String name,
               Object value)

updateMailSession

private void updateMailSession()