001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/naming/factory/MailSessionFactory.java,v 1.2 2001/03/26 03:26:05 glenn Exp $
003: * $Revision: 1.2 $
004: * $Date: 2001/03/26 03:26:05 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999-2001 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.naming.factory;
065:
066: import java.security.AccessController;
067: import java.security.PrivilegedAction;
068: import java.util.Enumeration;
069: import java.util.Hashtable;
070: import java.util.Properties;
071: import javax.mail.Session;
072: import javax.naming.Name;
073: import javax.naming.Context;
074: import javax.naming.RefAddr;
075: import javax.naming.Reference;
076: import javax.naming.spi.ObjectFactory;
077:
078: /**
079: * <p>Factory class that creates a JNDI named JavaMail Session factory,
080: * which can be used for managing inbound and outbound electronic mail
081: * messages via JavaMail APIs. All messaging environment properties
082: * described in the JavaMail Specification may be passed to the Session
083: * factory; however the following properties are the most commonly used:</p>
084: * <ul>
085: * <li>
086: * <li><strong>mail.smtp.host</strong> - Hostname for outbound transport
087: * connections. Defaults to <code>localhost</code> if not specified.</li>
088: * </ul>
089: *
090: * <p>This factory can be configured in a <code><DefaultContext></code>
091: * or <code><Context></code> element in your <code>conf/server.xml</code>
092: * configuration file. An example of factory configuration is:</p>
093: * <pre>
094: * <Resource name="mail/smtp" auth="CONTAINER"
095: * type="javax.mail.Session"/>
096: * <ResourceParams name="mail/smtp">
097: * <parameter>
098: * <name>factory</name>
099: * <value>org.apache.naming.factory.MailSessionFactory</value>
100: * </parameter>
101: * <parameter>
102: * <name>mail.smtp.host</name>
103: * <value>mail.mycompany.com</value>
104: * </parameter>
105: * </ResourceParams>
106: * </pre>
107: *
108: * @author Craig R. McClanahan
109: * @version $Revision: 1.2 $ $Date: 2001/03/26 03:26:05 $
110: */
111:
112: public class MailSessionFactory implements ObjectFactory {
113:
114: /**
115: * The Java type for which this factory knows how to create objects.
116: */
117: protected static final String factoryType = "javax.mail.Session";
118:
119: /**
120: * Create and return an object instance based on the specified
121: * characteristics.
122: *
123: * @param refObj Reference information containing our parameters, or null
124: * if there are no parameters
125: * @param name The name of this object, relative to context, or null
126: * if there is no name
127: * @param context The context to which name is relative, or null if name
128: * is relative to the default initial context
129: * @param env Environment variables, or null if there are none
130: *
131: * @exception Exception if an error occurs during object creation
132: */
133: public Object getObjectInstance(Object refObj, Name name,
134: Context context, Hashtable env) throws Exception {
135:
136: // Return null if we cannot create an object of the requested type
137: final Reference ref = (Reference) refObj;
138: if (!ref.getClassName().equals(factoryType))
139: return (null);
140:
141: // Create a new Session inside a doPrivileged block, so that JavaMail
142: // can read its default properties without throwing Security
143: // exceptions
144: return AccessController.doPrivileged(new PrivilegedAction() {
145: public Object run() {
146:
147: // Create the JavaMail properties we will use
148: Properties props = new Properties();
149: props.put("mail.transport.protocol", "smtp");
150: props.put("mail.smtp.host", "localhost");
151: Enumeration attrs = ref.getAll();
152: while (attrs.hasMoreElements()) {
153: RefAddr attr = (RefAddr) attrs.nextElement();
154: if ("factory".equals(attr.getType()))
155: continue;
156: props.put(attr.getType(), (String) attr
157: .getContent());
158: }
159:
160: // Create and return the new Session object
161: Session session = Session.getInstance(props, null);
162: return (session);
163:
164: }
165: });
166:
167: }
168:
169: }
|