org.objectweb.jonas.mail.MailService Interface Reference

Inherited by org.objectweb.jonas.mail.MailServiceImpl.

Inheritance diagram for org.objectweb.jonas.mail.MailService:

[legend]List of all members.

Public Member Functions
void	createMailFactory (String name, Properties props) throws MailServiceException
Package Functions
void	recreateJavaMailFactory (JavaMail factory) throws MailServiceException
void	renameJavaMailFactory (String oldName, JavaMail factory) throws MailServiceException
void	unbindMailFactories () throws MailServiceException

---

Detailed Description

This interface provides a description of the JavaMail service.

Author:

Ludovic Bert

Florent Benoit

Definition at line 41 of file MailService.java.

---

Member Function Documentation

void org.objectweb.jonas.mail.MailService.createMailFactory (  String  name, Properties  props )  throws MailServiceException

Create a mail factory with the specified properties and register it into the registry. The created object is an instance of one of the 2 classes : JavaMailSession or JavaMailMimePartDS. Parameters: name  the mail factory name props  the properties used to configure the mail factory. Exceptions: MailServiceException  if the creation or the registration of the factory failed. Implemented in org.objectweb.jonas.mail.MailServiceImpl.

void org.objectweb.jonas.mail.MailService.recreateJavaMailFactory (  JavaMail  factory  )  throws MailServiceException [package]

This method is used when a Mail Factory configuration is modified via jonasAdmin. In this case, the updated JavaMail object (JavaMailSession or JavaMailMimePartDS object) must be rebound in JNDI Parameters: factory  the factory Exceptions: MailServiceException  if the recreation of the factory failed. Implemented in org.objectweb.jonas.mail.MailServiceImpl.

void org.objectweb.jonas.mail.MailService.renameJavaMailFactory (  String  oldName, JavaMail  factory )  throws MailServiceException [package]

This method is used when a particular Mail Factory configuration operation is done via jonasAdmin : when the JNDI name of this resource is modified. In this case, the initial JavaMail object (JavaMailSession or JavaMailMimePartDS object) must be unbound and the updated JavaMail object must be reloaded. Also, the Mail Service private data structures must be updated. Parameters: oldName  old name of the factory factory  the new factory Exceptions: MailServiceException  if the rename of the the factory failed. Implemented in org.objectweb.jonas.mail.MailServiceImpl.

void org.objectweb.jonas.mail.MailService.unbindMailFactories (   )  throws MailServiceException [package]

Unregister all the binding factories on the server. Exceptions: MailServiceException  if the unregistration of the factories failed. Implemented in org.objectweb.jonas.mail.MailServiceImpl.

---

The documentation for this interface was generated from the following file:

• src/org/objectweb/jonas/mail/MailService.java

---