org.masukomi.aspirin.core.config

Interface ConfigurationMBean

All Known Implementing Classes:

Configuration

public interface ConfigurationMBean

This is the JMX bean of Aspirin configuration. Some configuration parameter could be applied immediately.

Author:

Laszlo Solova

Field Summary

Fields

Modifier and Type	Field and Description
static long	NEVER_EXPIRES Value of never expiration.
static String	PARAM_DELIVERY_ATTEMPT_COUNT
static String	PARAM_DELIVERY_ATTEMPT_DELAY
static String	PARAM_DELIVERY_BOUNCE_ON_FAILURE
static String	PARAM_DELIVERY_DEBUG
static String	PARAM_DELIVERY_EXPIRY
static String	PARAM_DELIVERY_THREADS_ACTIVE_MAX
static String	PARAM_DELIVERY_THREADS_IDLE_MAX
static String	PARAM_DELIVERY_TIMEOUT
static String	PARAM_ENCODING
static String	PARAM_HOSTNAME
static String	PARAM_LOGGER_NAME
static String	PARAM_LOGGER_PREFIX
static String	PARAM_MAILSTORE_CLASS
static String	PARAM_POSTMASTER_EMAIL

Method Summary

Methods

Modifier and Type	Method and Description
int	getDeliveryAttemptCount()
int	getDeliveryAttemptDelay()
int	getDeliveryThreadsActiveMax()
int	getDeliveryThreadsIdleMax()
int	getDeliveryTimeout()
String	getEncoding()
long	getExpiry()
String	getHostname()
String	getLoggerName()
String	getLoggerPrefix()
String	getMailStoreClassName()
String	getPostmasterEmail()
boolean	isDeliveryBounceOnFailure()
boolean	isDeliveryDebug()
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	setMailStoreClassName(String className) Set the mail store class name, where MimeMessages will be stored.
void	setPostmasterEmail(String emailAddress) Set the email address of postmaster.

Field Detail

PARAM_DELIVERY_ATTEMPT_DELAY

static final String PARAM_DELIVERY_ATTEMPT_DELAY

See Also:

Constant Field Values

PARAM_DELIVERY_ATTEMPT_COUNT

static final String PARAM_DELIVERY_ATTEMPT_COUNT

See Also:

Constant Field Values

PARAM_DELIVERY_BOUNCE_ON_FAILURE

static final String PARAM_DELIVERY_BOUNCE_ON_FAILURE

See Also:

Constant Field Values

PARAM_DELIVERY_DEBUG

static final String PARAM_DELIVERY_DEBUG

See Also:

Constant Field Values

PARAM_DELIVERY_EXPIRY

static final String PARAM_DELIVERY_EXPIRY

See Also:

Constant Field Values

PARAM_DELIVERY_THREADS_ACTIVE_MAX

static final String PARAM_DELIVERY_THREADS_ACTIVE_MAX

See Also:

Constant Field Values

PARAM_DELIVERY_THREADS_IDLE_MAX

static final String PARAM_DELIVERY_THREADS_IDLE_MAX

See Also:

Constant Field Values

PARAM_DELIVERY_TIMEOUT

static final String PARAM_DELIVERY_TIMEOUT

See Also:

Constant Field Values

PARAM_ENCODING

static final String PARAM_ENCODING

See Also:

Constant Field Values

PARAM_HOSTNAME

static final String PARAM_HOSTNAME

See Also:

Constant Field Values

PARAM_LOGGER_NAME

static final String PARAM_LOGGER_NAME

See Also:

Constant Field Values

PARAM_LOGGER_PREFIX

static final String PARAM_LOGGER_PREFIX

See Also:

Constant Field Values

PARAM_POSTMASTER_EMAIL

static final String PARAM_POSTMASTER_EMAIL

See Also:

Constant Field Values

PARAM_MAILSTORE_CLASS

static final String PARAM_MAILSTORE_CLASS

See Also:

Constant Field Values

NEVER_EXPIRES

static final long NEVER_EXPIRES

Value of never expiration. If an email expire is marked with this value, the email sending could be done everytime.

See Also:

Constant Field Values

Method Detail

getDeliveryAttemptDelay

int getDeliveryAttemptDelay()

Returns:

The time between two delivery attempt of an email.

getDeliveryAttemptCount

int getDeliveryAttemptCount()

Returns:

The maximal count of delivery attempts of an email.

getDeliveryThreadsActiveMax

int getDeliveryThreadsActiveMax()

Returns:

The maximal count of delivery threads running paralel.

getDeliveryThreadsIdleMax

int getDeliveryThreadsIdleMax()

Returns:

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

getDeliveryTimeout

int getDeliveryTimeout()

Returns:

The socket and Transport timeout in a delivery.

getEncoding

String getEncoding()

Returns:

The name of MIME encoding of emails.

getExpiry

long getExpiry()

Returns:

The value of default email expiry time.

getLoggerName

String getLoggerName()

Returns:

The name of the logger.

getLoggerPrefix

String getLoggerPrefix()

Returns:

The prefix appended to the start of the log entries.

getMailStoreClassName

String getMailStoreClassName()

Returns:

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

getPostmasterEmail

String getPostmasterEmail()

Returns:

The email address of the postmaster.

getHostname

String getHostname()

Returns:

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

isDeliveryBounceOnFailure

boolean isDeliveryBounceOnFailure()

Returns:

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

isDeliveryDebug

boolean isDeliveryDebug()

Returns:

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

setDeliveryAttemptDelay

void setDeliveryAttemptDelay(int delay)

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

Parameters:

delay - The value of delay in milliseconds.

setDeliveryAttemptCount

void setDeliveryAttemptCount(int attemptCount)

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

Parameters:

attemptCount - The count of deliery attempts.

setDeliveryBounceOnFailure

void setDeliveryBounceOnFailure(boolean bounce)

Set the bounce email sending (on delivery failures).

Parameters:

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

setDeliveryDebug

void setDeliveryDebug(boolean debug)

Set the debug of full SMTP communication.

Parameters:

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

setDeliveryThreadsActiveMax

void setDeliveryThreadsActiveMax(int activeThreadsMax)

Set the maximal count of paralel running delivery threads.

Parameters:

threadsCount - The count of delivery threads.

setDeliveryThreadsIdleMax

void setDeliveryThreadsIdleMax(int idleThreadsMax)

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

Parameters:

threadsCount - The count of delivery threads.

setDeliveryTimeout

void setDeliveryTimeout(int timeout)

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

Parameters:

timeout - The value of timeout in milliseconds.

setEncoding

void setEncoding(String encoding)

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

Parameters:

encoding - The MIME encoding.

setExpiry

void setExpiry(long expiry)

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

Parameters:

expiry - The default expiry time.

setMailStoreClassName

void setMailStoreClassName(String className)

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

Parameters:

className -

setPostmasterEmail

void setPostmasterEmail(String emailAddress)

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

Parameters:

emailAddress - The email address of postmaster.

setHostname

void setHostname(String hostname)

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.

Parameters:

hostname - The name of this server or application.