Class MailMBean

java.lang.Object

ecmwf.common.technical.ThreadService.ConfigurableRunnable

ecmwf.common.technical.WakeupThread

ecmwf.common.ecaccess.ECaccessScheduler

ecmwf.common.ecaccess.MBeanScheduler

ecmwf.common.ecaccess.MBeanRepository<ecmwf.common.ecaccess.MailMessage>

ecmwf.common.ecaccess.MailMBean

All Implemented Interfaces:

MBeanService, MonitorCallback, Closeable, AutoCloseable, Runnable

public class MailMBean
extends MBeanRepository<ecmwf.common.ecaccess.MailMessage>

Manages sending and receiving emails through SMTP/IMAP/POP protocols.

Field Summary

Fields inherited from class ECaccessScheduler

NEXT_STEP_ABORT, NEXT_STEP_CONTINUE, NEXT_STEP_DELAY, NEXT_STEP_INIT, SCHEDULER_STATE_CLOSING, SCHEDULER_STATE_JAMMED, SCHEDULER_STATE_OFFLINE, SCHEDULER_STATE_ONHOLD, SCHEDULER_STATE_ONLINE, SCHEDULER_STATE_OPENING, states, steps

Constructor Summary

Constructors

Constructor	Description
MailMBean(String name)	Constructs a MailMBean with the specified name.
MailMBean(String group, String name)	Constructs a MailMBean with the specified group and name.

Method Summary

Modifier and Type	Method	Description
MailInterface[]	getMailInterfaces()	Returns the list of mail interfaces.
String	getStatus(ecmwf.common.ecaccess.MailMessage message)	Returns a string representation of the mail message status.
void	initialize()	Initializes the mail subsystem by configuring and creating a JavaMail Session based on the application's configuration.
int	nextStep()	Executes the next step in the MBean workflow: connect, send, receive.
void	sendMail(String from, String to, String subject, String content)	Sends an email without CC or attachment.
void	sendMail(String from, String to, String cc, String subject, String content, String attachmentName, String attachmentContent)	Sends an email with optional CC and attachment.
void	shutdown()	Shutdown.
void	shutdown(boolean graceful)	Shuts down the MBean and optionally sends pending messages.

Methods inherited from class MBeanRepository

clear, containsKey, containsValue, getAttribute, getComparator, getKey, getList, getList, getMBeanInfo, getSize, getStatus, getValue, getWakeup, invoke, put, removeKey, removeValue, setComparator, setMaxAuthorisedSize, setWakeup, sort

Methods inherited from class MBeanScheduler

close, getMonitorName, setAttribute

Methods inherited from class ECaccessScheduler

configurableRun, deactivateMonitor, getActivity, getDelay, getJammedTimeout, getLastStepTime, getMonitorManager, getNextStep, getSchedulerState, getStartDate, getStepTime, isInitialized, isJammed, isOnHold, isRunning, onHold, setDelay, setJammedTimeout, setOnhold, setTimeRanges, start, wakeup

Methods inherited from class WakeupThread

isSleeping, waitFor

Methods inherited from class ThreadService.ConfigurableRunnable

execute, execute, execute, getContextClassLoader, getPriority, getThreadName, interrupt, interrupted, isAlive, isStarted, join, join, run, setContextClassLoader, setForceCookie, setInheritCookie, setPriority, setThreadNameAndCookie

Methods inherited from class Object

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

Constructor Details

MailMBean

public MailMBean(String name)

Constructs a MailMBean with the specified name.

Parameters:

name - the MBean name

MailMBean

public MailMBean(String group,
 String name)

Constructs a MailMBean with the specified group and name.

Parameters:

group - the MBean group

name - the MBean name

Method Details

getStatus

public String getStatus(ecmwf.common.ecaccess.MailMessage message)

Returns a string representation of the mail message status.

Overrides:

getStatus in class MBeanRepository<ecmwf.common.ecaccess.MailMessage>

Parameters:

message - the mail message

Returns:

the status string

getMailInterfaces

public MailInterface[] getMailInterfaces()

Returns the list of mail interfaces.

Returns:

array of mail interfaces

sendMail

public void sendMail(String from,
 String to,
 String subject,
 String content)

Sends an email without CC or attachment.

Parameters:

from - the sender

to - the recipient(s)

subject - the subject

content - the message content

sendMail

public void sendMail(String from,
 String to,
 String cc,
 String subject,
 String content,
 String attachmentName,
 String attachmentContent)

Sends an email with optional CC and attachment.

Parameters:

from - the sender

to - the recipient(s)

cc - the CC recipient(s)

subject - the subject

content - the message content

attachmentName - the attachment name

attachmentContent - the attachment content

initialize

public void initialize()

Initializes the mail subsystem by configuring and creating a JavaMail Session based on the application's configuration.

This method sets up:

• SMTP (sending) — always enabled and configured using the "Mail.smtpHost", "Mail.port", "Mail.auth", and "Mail.starttls" settings.
• Mail store (receiving) — optionally enabled when both "Mail.storeHost" and "Mail.storeType" are provided. Supported store protocols include imap, imaps, pop3, and pop3s.

If no valid store configuration is present, the system operates in send‑only mode, and no IMAP/POP connection will be attempted.

All SSL/TLS settings for both SMTP and the mail store are applied using the corresponding configuration keys. A dedicated Authenticator is installed to supply credentials for both sending and receiving actions.

This method is thread‑safe and will initialize the session only once.

Configuration keys used:

• Mail.smtpHost – SMTP server hostname
• Mail.port – SMTP port
• Mail.auth – Enable SMTP authentication
• Mail.starttls – Enable SMTP STARTTLS
• Mail.storeHost – IMAP/POP server hostname (optional)
• Mail.storeType – One of: imap, imaps, pop3, pop3s (optional)
• Mail.storePort – Store port (optional, defaults per protocol)
• Mail.user – Username for both SMTP and store
• Mail.password – Password for authentication
• Mail.folderName – Folder to open when using a store (default: INBOX)
• Mail.debug – Enable JavaMail debug output

Thread-safety

The method is synchronized and will skip initialization if a session already exists, ensuring that the mail system is configured exactly once.

Logging

A summary of the effective configuration is logged, with credentials safely masked.

Overrides:

initialize in class ECaccessScheduler

nextStep

public int nextStep()

Executes the next step in the MBean workflow: connect, send, receive.

Specified by:

nextStep in class ECaccessScheduler

Returns:

delay until next step

shutdown

public void shutdown(boolean graceful)

Shuts down the MBean and optionally sends pending messages.

Parameters:

graceful - if true, send pending messages before shutdown

shutdown

public void shutdown()

Shutdown.

Overrides:

shutdown in class MBeanScheduler