org.objectweb.jonas.mail
Interface MailService

All Superinterfaces:
Service
All Known Implementing Classes:
MailServiceImpl

public interface MailService
extends Service

This interface provides a description of the JavaMail service.

Author:
Ludovic Bert, Florent Benoit

Method Summary
 void createMailFactory(java.lang.String name, java.util.Properties props)
          Create a mail factory with the specified properties and register it into the registry.
 void recreateMailFactory(JMail factory)
          This method is used when a Mail Factory configuration is modified via Jadmin.
 void renameMailFactory(java.lang.String oldName, JMail factory)
          This method is used when a particular Mail Factory configuration operation is done via Jadmin : when the JNDI name of this resource is modified.
 void unbindMailFactories()
          Unregister all the binding factories on the server.
 
Methods inherited from interface org.objectweb.jonas.service.Service
getName, init, isStarted, setName, start, stop
 

Method Detail

createMailFactory

public void createMailFactory(java.lang.String name,
                              java.util.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 : JMailSession or

Parameters:
name - the mail factory name
props - the properties used to configure the mail factory.
Throws:
MailServiceException - if the creation or the registration of the factory failed.

recreateMailFactory

public void recreateMailFactory(JMail factory)
                         throws MailServiceException
This method is used when a Mail Factory configuration is modified via Jadmin. In this case, the updated JMail object (JMailSession or JMailMimePartDS object) must be rebound in JNDI

Parameters:
factory - the factory
Throws:
MailServiceException - if the recreation of the factory failed.

renameMailFactory

public void renameMailFactory(java.lang.String oldName,
                              JMail factory)
                       throws MailServiceException
This method is used when a particular Mail Factory configuration operation is done via Jadmin : when the JNDI name of this resource is modified. In this case, the initial JMail object (JMailSession or JMailMimePartDS object) must be unbound and the updated JMail 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
Throws:
MailServiceException - if the rename of the the factory failed.

unbindMailFactories

public void unbindMailFactories()
                         throws MailServiceException
Unregister all the binding factories on the server.

Throws:
MailServiceException - if the unregistration of the factories failed.