01: /**
02: * JOnAS: Java(TM) Open Application Server
03: * Copyright (C) 1999 Bull S.A.
04: * Contact: jonas-team@objectweb.org
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * version 2.1 of the License, or any later version.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this library; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19: * USA
20: *
21: * Initial developer(s): Florent BENOIT & Ludovic BERT
22: * --------------------------------------------------------------------------
23: * $Id: MailService.java 4579 2004-04-09 10:00:58Z benoitf $
24: * --------------------------------------------------------------------------
25: */package org.objectweb.jonas.mail;
26:
27: //import java.util
28: import java.util.Properties;
29:
30: //import jonas
31: import org.objectweb.jonas.service.Service;
32: import org.objectweb.jonas.mail.factory.JavaMail;
33:
34: /**
35: * This interface provides a description of the JavaMail service.
36: * @author Ludovic Bert
37: * @author Florent Benoit
38: */
39: public interface MailService extends Service {
40:
41: /**
42: * Create a mail factory with the specified properties and register it into
43: * the registry. The created object is an instance of one of the 2 classes :
44: * JavaMailSession or JavaMailMimePartDS.
45: * @param name the mail factory name
46: * @param props the properties used to configure the mail factory.
47: * @throws MailServiceException if the creation or the registration of the
48: * factory failed.
49: */
50: void createMailFactory(String name, Properties props)
51: throws MailServiceException;
52:
53: /**
54: * This method is used when a Mail Factory configuration is modified via
55: * jonasAdmin. In this case, the updated JavaMail object (JavaMailSession or
56: * JavaMailMimePartDS object) must be rebound in JNDI
57: * @param factory the factory
58: * @throws MailServiceException if the recreation of the factory failed.
59: */
60: void recreateJavaMailFactory(JavaMail factory)
61: throws MailServiceException;
62:
63: /**
64: * This method is used when a particular Mail Factory configuration
65: * operation is done via jonasAdmin : when the JNDI name of this resource is
66: * modified. In this case, the initial JavaMail object (JavaMailSession or
67: * JavaMailMimePartDS object) must be unbound and the updated JavaMail
68: * object must be reloaded. Also, the Mail Service private data structures
69: * must be updated.
70: * @param oldName old name of the factory
71: * @param factory the new factory
72: * @throws MailServiceException if the rename of the the factory failed.
73: */
74: void renameJavaMailFactory(String oldName, JavaMail factory)
75: throws MailServiceException;
76:
77: /**
78: * Unregister all the binding factories on the server.
79: * @throws MailServiceException if the unregistration of the factories
80: * failed.
81: */
82: void unbindMailFactories() throws MailServiceException;
83:
84: }
|