| /* |
| * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved. |
| * Copyright 2004 The Apache Software Foundation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.apache.naming.factory; |
| |
| import java.security.AccessController; |
| import java.security.PrivilegedAction; |
| import java.util.Enumeration; |
| import java.util.Hashtable; |
| import java.util.Properties; |
| import jakarta.mail.Session; |
| import javax.naming.Name; |
| import javax.naming.Context; |
| import javax.naming.RefAddr; |
| import javax.naming.Reference; |
| import javax.naming.spi.ObjectFactory; |
| |
| /** |
| * <p>Factory class that creates a JNDI named Jakarta Mail Session factory, |
| * which can be used for managing inbound and outbound electronic mail |
| * messages via Jakarta Mail APIs. All messaging environment properties |
| * described in the Jakarta Mail Specification may be passed to the Session |
| * factory; however the following properties are the most commonly used:</p> |
| * <ul> |
| * <li> |
| * <li><strong>mail.smtp.host</strong> - Hostname for outbound transport |
| * connections. Defaults to <code>localhost</code> if not specified.</li> |
| * </ul> |
| * |
| * <p>This factory can be configured in a <code><DefaultContext></code> |
| * or <code><Context></code> element in your <code>conf/server.xml</code> |
| * configuration file. An example of factory configuration is:</p> |
| * <pre> |
| * <Resource name="mail/smtp" auth="CONTAINER" |
| * type="jakarta.mail.Session"/> |
| * <ResourceParams name="mail/smtp"> |
| * <parameter> |
| * <name>factory</name> |
| * <value>org.apache.naming.factory.MailSessionFactory</value> |
| * </parameter> |
| * <parameter> |
| * <name>mail.smtp.host</name> |
| * <value>mail.mycompany.com</value> |
| * </parameter> |
| * </ResourceParams> |
| * </pre> |
| * |
| * @author Craig R. McClanahan |
| * @version $Revision: 1.2 $ $Date: 2005/12/08 01:29:07 $ |
| */ |
| |
| public class MailSessionFactory implements ObjectFactory { |
| |
| |
| /** |
| * The Java type for which this factory knows how to create objects. |
| */ |
| protected static final String factoryType = "jakarta.mail.Session"; |
| |
| |
| /** |
| * Create and return an object instance based on the specified |
| * characteristics. |
| * |
| * @param refObj Reference information containing our parameters, or null |
| * if there are no parameters |
| * @param name The name of this object, relative to context, or null |
| * if there is no name |
| * @param context The context to which name is relative, or null if name |
| * is relative to the default initial context |
| * @param env Environment variables, or null if there are none |
| * |
| * @exception Exception if an error occurs during object creation |
| */ |
| @Override |
| public Object getObjectInstance(Object refObj, Name name, Context context, Hashtable<?, ?> env) throws Exception { |
| |
| // Return null if we cannot create an object of the requested type |
| final Reference ref = (Reference) refObj; |
| if (!ref.getClassName().equals(factoryType)) { |
| return (null); |
| } |
| |
| // Create a new Session inside a doPrivileged block, so that Jakarta |
| // Mail can read its default properties without throwing Security |
| // exceptions |
| return AccessController.doPrivileged(new PrivilegedAction<Session>() { |
| |
| @Override |
| public Session run() { |
| // Create the Jakarta Mail properties we will use |
| Properties props = new Properties(); |
| props.put("mail.transport.protocol", "smtp"); |
| props.put("mail.smtp.host", "localhost"); |
| Enumeration<RefAddr> attrs = ref.getAll(); |
| while (attrs.hasMoreElements()) { |
| RefAddr attr = attrs.nextElement(); |
| if ("factory".equals(attr.getType())) { |
| continue; |
| } |
| props.put(attr.getType(), attr.getContent()); |
| } |
| |
| // Create and return the new Session object |
| Session session = Session.getInstance(props, null); |
| return (session); |
| |
| } |
| }); |
| } |
| } |