001: /**
002: * JOnAS: Java(TM) Open Application Server
003: * Copyright (C) 1999 Bull S.A.
004: * Contact: jonas-team@objectweb.org
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2.1 of the License, or any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
019: * USA
020: *
021: * Initial developer(s): Florent BENOIT & Ludovic BERT
022: * --------------------------------------------------------------------------
023: * $Id: MailServiceImplMBean.java 4579 2004-04-09 10:00:58Z benoitf $
024: * --------------------------------------------------------------------------
025: */package org.objectweb.jonas.mail;
026:
027: //import java
028: import java.util.Properties;
029: import java.util.List;
030:
031: /**
032: * This interface provides a description for the mail service management.
033: * @author Ludovic Bert
034: * @author Florent Benoit
035: */
036: public interface MailServiceImplMBean {
037:
038: /**
039: * Create a mail factory with the specified properties and register it into
040: * the registry.
041: * @param name the name of the mail factory
042: * @param props the properties used to configure the mail factory.
043: * @param loadFromFile true if the mail factory is loaded from a .properties
044: * file
045: * @throws MailServiceException if the creation or the registration of the
046: * factory failed.
047: */
048: void createMailFactoryMBean(String name, Properties props,
049: Boolean loadFromFile) throws MailServiceException;
050:
051: /**
052: * @return Integer Total number of mail factories available in JOnAS
053: */
054: Integer getCurrentNumberOfMailFactories();
055:
056: /**
057: * @return Integer Number of internet.MimePartDataSource mail factories
058: * available in JOnAS
059: */
060: Integer getCurrentNumberOfMimeMailFactories();
061:
062: /**
063: * @return Integer Number of mail Session mail factories available in JOnAS
064: */
065: Integer getCurrentNumberOfSessionMailFactories();
066:
067: /**
068: * Gets the mail factory configuration properties from a local file
069: * @param configFile configuration to use
070: * @return mail factory configuration properties from a local file
071: * @throws Exception if it fails
072: */
073: Properties getMailFactoryPropertiesFile(String configFile)
074: throws Exception;
075:
076: /**
077: * @return the list of properties files describeing mail factories found in
078: * JONAS_BASE/conf
079: * @throws Exception if the list can't be returned
080: */
081: List getMailFactoryPropertiesFiles() throws Exception;
082:
083: /**
084: * @return the list of properties files describeing MimePartDataSource mail
085: * factories found in JONAS_BASE/conf
086: * @throws Exception if the list can't be returned
087: */
088: List getMimePartMailFactoryPropertiesFiles() throws Exception;
089:
090: /**
091: * @return the list of properties files describeing Session mail factories
092: * found in JONAS_BASE/conf
093: * @throws Exception if the list can't be returned
094: */
095: List getSessionMailFactoryPropertiesFiles() throws Exception;
096:
097: /**
098: * Unregister the factory binded with the given name.
099: * @param name the name of the factory.
100: * @throws MailServiceException if the unregistration of the factory failed.
101: */
102: void unbindMailFactoryMBean(String name)
103: throws MailServiceException;
104:
105: }
|