services/jakarta.mail.Provider override not working #777 (#779)

Signed-off-by: Jorge Bescos Gascon <[email protected]>

Author: jbescos

api/src/main/java/jakarta/mail/Provider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2023 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2025 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -19,7 +19,7 @@
 /**
  * The Provider is a class that describes a protocol
  * implementation.  The values typically come from the
- * javamail.providers and javamail.default.providers
+ * jakarta.providers and jakarta.default.providers
  * resource files.  An application may also create and
  * register a Provider object to dynamically add support
  * for a new provider.

api/src/main/java/jakarta/mail/Session.java

@@ -59,18 +59,18 @@
  * implement the <code>Store</code>, <code>Transport</code>, and related
  * classes.  The protocol providers are configured using the following files:
  * <ul>
- *  <li> <code>javamail.providers</code> and
- * 	<code>javamail.default.providers</code> </li>
- *  <li> <code>javamail.address.map</code> and
- * 	<code>javamail.default.address.map</code> </li>
+ *  <li> <code>jakarta.providers</code> and
+ * 	<code>jakarta.default.providers</code> </li>
+ *  <li> <code>jakarta.address.map</code> and
+ * 	<code>jakarta.default.address.map</code> </li>
  * </ul>
  * <p>
- * Each <code>javamail.</code><i>X</i> resource file is searched for using
+ * Each <code>jakarta.</code><i>X</i> resource file is searched for using
  * three methods in the following order:
  * <ol>
- *  <li> <code><i>java.home</i>/<i>conf</i>/javamail.</code><i>X</i> </li>
- *  <li> <code>META-INF/javamail.</code><i>X</i> </li>
- *  <li> <code>META-INF/javamail.default.</code><i>X</i> </li>
+ *  <li> <code><i>java.home</i>/<i>conf</i>/jakarta.</code><i>X</i> </li>
+ *  <li> <code>META-INF/jakarta.</code><i>X</i> </li>
+ *  <li> <code>META-INF/jakarta.default.</code><i>X</i> </li>
  * </ol>
  * <p>
  * (Where <i>java.home</i> is the value of the "java.home" System property
@@ -83,7 +83,7 @@
  * <code>java.home</code> property points.  The second method allows an
  * application that uses the Jakarta Mail APIs to include their own resource
  * files in their application's or jar file's <code>META-INF</code>
- * directory.  The <code>javamail.default.</code><i>X</i> default files
+ * directory.  The <code>jakarta.default.</code><i>X</i> default files
  * are part of the Jakarta Mail <code>mail.jar</code> file and should not be
  * supplied by users. <p>
  *
@@ -100,8 +100,8 @@
  * do not override, the default files included with the Jakarta Mail APIs.
  * This means that all entries in all files loaded will be available. <p>
  *
- * <b><code>javamail.providers</code></b> and
- * <b><code>javamail.default.providers</code></b><p>
+ * <b><code>jakarta.providers</code></b> and
+ * <b><code>jakarta.default.providers</code></b><p>
  *
  * These resource files specify the stores and transports that are
  * available on the system, allowing an application to "discover" what
@@ -142,7 +142,7 @@
  * </tr>
  * </table><p>
  *
- * Here's an example of <code>META-INF/javamail.default.providers</code>
+ * Here's an example of <code>META-INF/jakarta.default.providers</code>
  * file contents:
  * <pre>
  * protocol=imap; type=store; class=com.sun.mail.imap.IMAPStore; vendor=Oracle;
@@ -172,13 +172,13 @@
  * </pre>
  * <p>
  *
- * <b><code>javamail.address.map</code></b> and
- * <b><code>javamail.default.address.map</code></b><p>
+ * <b><code>jakarta.address.map</code></b> and
+ * <b><code>jakarta.default.address.map</code></b><p>
  *
  * These resource files map transport address types to the transport
  * protocol.  The <code>getType</code> method of
  * <code>jakarta.mail.Address</code> returns the address type.  The
- * <code>javamail.address.map</code> file maps the transport type to the
+ * <code>jakarta.address.map</code> file maps the transport type to the
  * protocol.  The file format is a series of name-value pairs.  Each key
  * name should correspond to an address type that is currently installed
  * on the system; there should also be an entry for each
@@ -190,7 +190,7 @@
  * the client should install a Transport provider supporting the nntp
  * protocol. <p>
  *
- * Here are the typical contents of a <code>javamail.address.map</code> file:
+ * Here are the typical contents of a <code>jakarta.address.map</code> file:
  * <pre>
  * rfc822=smtp
  * news=nntp
@@ -206,6 +206,12 @@ public final class Session {
     // Support legacy @DefaultProvider
     private static final String DEFAULT_PROVIDER = "org.eclipse.angus.mail.util.DefaultProvider";
 
+    // This is for backwards compatibility. Eventually we have to remove the second value of the next arrays.
+    private static final String[] DEFAULT_ADDRESS_MAP_RESOURCES = new String[] {"/META-INF/jakarta.default.address.map", "/META-INF/javamail.default.address.map"};
+    private static final String[] ADDRESS_MAP_RESOURCES = new String[] {"META-INF/jakarta.address.map", "META-INF/javamail.address.map"};
+    private static final String[] DEFAULT_PROVIDER_RESOURCES = new String[] {"/META-INF/jakarta.default.providers", "/META-INF/javamail.default.providers"};
+    private static final String[] PROVIDER_RESOURCES = new String[] {"META-INF/jakarta.providers", "META-INF/javamail.providers"};
+
     private final StreamProvider streamProvider;
     private final Properties props;
     private final Authenticator authenticator;
@@ -484,7 +490,7 @@ public synchronized PrintStream getDebugOut() {
 
     /**
      * This method returns an array of all the implementations installed
-     * via the javamail.[default.]providers files that can
+     * via the jakarta.[default.]providers files that can
      * be loaded using the ClassLoader available to this application.
      *
      * @return Array of configured providers
@@ -966,11 +972,11 @@ public void load(InputStream is) throws IOException {
             }
         };
 
-        // load system-wide javamail.providers from the
+        // load system-wide jakarta.providers from the
         // <java.home>/{conf,lib} directory
         try {
             if (confDir != null)
-                loadFile(confDir + "javamail.providers", loader);
+                loadFile(loader, confDir + "jakarta.providers", confDir + "javamail.providers");
         } catch (SecurityException ex) {
         }
 
@@ -998,11 +1004,11 @@ public void load(InputStream is) throws IOException {
                 addProvider(p);
         }
 
-        // load the META-INF/javamail.providers file supplied by an application
-        loadAllResources("META-INF/javamail.providers", cl, loader);
+        // load the META-INF/jakarta.providers file supplied by an application
+        loadAllResources(cl, loader, PROVIDER_RESOURCES);
 
-        // load default META-INF/javamail.default.providers from mail.jar file
-        loadResource("/META-INF/javamail.default.providers", cl, loader, false);
+        // load default META-INF/jakarta.default.providers from mail.jar file
+        loadResource(cl, loader, false, DEFAULT_PROVIDER_RESOURCES);
 
         // finally, add all the default services
         sl = ServiceLoader.load(Provider.class, gcl);
@@ -1137,17 +1143,17 @@ public void load(InputStream is) throws IOException {
             }
         };
 
-        // load default META-INF/javamail.default.address.map from mail.jar
-        loadResource("/META-INF/javamail.default.address.map", cl, loader, true);
+        // load default META-INF/jakarta.default.address.map from mail.jar
+        loadResource(cl, loader, true, DEFAULT_ADDRESS_MAP_RESOURCES);
 
-        // load the META-INF/javamail.address.map file supplied by an app
-        loadAllResources("META-INF/javamail.address.map", cl, loader);
+        // load the META-INF/jakarta.address.map file supplied by an app
+        loadAllResources(cl, loader, ADDRESS_MAP_RESOURCES);
 
-        // load system-wide javamail.address.map from the
+        // load system-wide jakarta.address.map from the
         // <java.home>/{conf,lib} directory
         try {
             if (confDir != null)
-                loadFile(confDir + "javamail.address.map", loader);
+                loadFile(loader, confDir + "jakarta.address.map", confDir + "javamail.address.map");
         } catch (SecurityException ex) {
         }
 
@@ -1160,8 +1166,8 @@ public void load(InputStream is) throws IOException {
     /**
      * Set the default transport protocol to use for addresses of
      * the specified type.  Normally the default is set by the
-     * <code>javamail.default.address.map</code> or
-     * <code>javamail.address.map</code> files or resources.
+     * <code>jakarta.default.address.map</code> or
+     * <code>jakarta.address.map</code> files or resources.
      *
      * @param addresstype type of address
      * @param protocol    name of protocol
@@ -1178,41 +1184,46 @@ public synchronized void setProtocolForAddress(String addresstype, String protoc
     /**
      * Load from the named file.
      */
-    private void loadFile(String name, StreamLoader loader) {
+    private void loadFile(StreamLoader loader, String ... names) {
         InputStream clis = null;
-        try {
-            clis = new BufferedInputStream(new FileInputStream(name));
-            loader.load(clis);
-            logger.log(Level.CONFIG, "successfully loaded file: {0}", name);
-        } catch (FileNotFoundException fex) {
-            // ignore it
-        } catch (IOException | SecurityException e) {
-            if (logger.isLoggable(Level.CONFIG))
-                logger.log(Level.CONFIG, "not loading file: " + name, e);
-        } finally {
+        for (String name : names) {
             try {
-                if (clis != null)
-                    clis.close();
-            } catch (IOException ex) {
-            }    // ignore it
+                clis = new BufferedInputStream(new FileInputStream(name));
+                loader.load(clis);
+                logger.log(Level.CONFIG, "successfully loaded file: {0}", name);
+                break;
+            } catch (FileNotFoundException fex) {
+                // ignore it
+            } catch (IOException | SecurityException e) {
+                if (logger.isLoggable(Level.CONFIG))
+                    logger.log(Level.CONFIG, "not loading file: " + name, e);
+            } finally {
+                try {
+                    if (clis != null)
+                        clis.close();
+                } catch (IOException ex) {
+                }    // ignore it
+            }
         }
     }
 
     /**
      * Load from the named resource.
      */
-    private void loadResource(String name, Class<?> cl, StreamLoader loader, boolean expected) {
+    private void loadResource(Class<?> cl, StreamLoader loader, boolean expected, String ... names) {
         InputStream clis = null;
         try {
-            clis = getResourceAsStream(cl, name);
-            if (clis != null) {
-                loader.load(clis);
-                logger.log(Level.CONFIG, "successfully loaded resource: {0}",
-                        name);
-            } else {
+            for (String name : names) {
+                clis = getResourceAsStream(cl, name);
+                if (clis != null) {
+                    loader.load(clis);
+                    logger.log(Level.CONFIG, "successfully loaded resource: {0}", name);
+                    break;
+                }
+            }
+            if (clis == null) {
                 if (expected)
-                    logger.log(Level.WARNING,
-                            "expected resource not found: {0}", name);
+                    logger.log(Level.WARNING, "expected resource not found: {0}", Arrays.asList(names));
             }
         } catch (IOException | SecurityException e) {
             logger.log(Level.CONFIG, "Exception loading resource", e);
@@ -1228,45 +1239,48 @@ private void loadResource(String name, Class<?> cl, StreamLoader loader, boolean
     /**
      * Load all of the named resource.
      */
-    private void loadAllResources(String name, Class<?> cl, StreamLoader loader) {
+    private void loadAllResources(Class<?> cl, StreamLoader loader, String ... names) {
         boolean anyLoaded = false;
         try {
-            URL[] urls;
-            ClassLoader cld = null;
-            // First try the "application's" class loader.
-            cld = getContextClassLoader();
-            if (cld == null)
-                cld = cl.getClassLoader();
-            if (cld != null)
-                urls = getResources(cld, name);
-            else
-                urls = getSystemResources(name);
-            if (urls != null) {
-                for (int i = 0; i < urls.length; i++) {
-                    URL url = urls[i];
-                    InputStream clis = null;
-                    logger.log(Level.CONFIG, "URL {0}", url);
-                    try {
-                        clis = openStream(url);
-                        if (clis != null) {
-                            loader.load(clis);
-                            anyLoaded = true;
-                            logger.log(Level.CONFIG,
-                                    "successfully loaded resource: {0}", url);
-                        } else {
-                            logger.log(Level.CONFIG,
-                                    "not loading resource: {0}", url);
-                        }
-                    } catch (FileNotFoundException fex) {
-                        // ignore it
-                    } catch (IOException | SecurityException ioex) {
-                        logger.log(Level.CONFIG, "Exception loading resource",
-                                ioex);
-                    } finally {
+            for (String name : names) {
+                URL[] urls;
+                ClassLoader cld = null;
+                // First try the "application's" class loader.
+                cld = getContextClassLoader();
+                if (cld == null)
+                    cld = cl.getClassLoader();
+                if (cld != null)
+                    urls = getResources(cld, name);
+                else
+                    urls = getSystemResources(name);
+                if (urls != null) {
+                    for (int i = 0; i < urls.length; i++) {
+                        URL url = urls[i];
+                        InputStream clis = null;
+                        logger.log(Level.CONFIG, "URL {0}", url);
                         try {
-                            if (clis != null)
-                                clis.close();
-                        } catch (IOException cex) {
+                            clis = openStream(url);
+                            if (clis != null) {
+                                loader.load(clis);
+                                anyLoaded = true;
+                                logger.log(Level.CONFIG,
+                                        "successfully loaded resource: {0}", url);
+                                break;
+                            } else {
+                                logger.log(Level.CONFIG,
+                                        "not loading resource: {0}", url);
+                            }
+                        } catch (FileNotFoundException fex) {
+                            // ignore it
+                        } catch (IOException | SecurityException ioex) {
+                            logger.log(Level.CONFIG, "Exception loading resource",
+                                    ioex);
+                        } finally {
+                            try {
+                                if (clis != null)
+                                    clis.close();
+                            } catch (IOException cex) {
+                            }
                         }
                     }
                 }
@@ -1277,10 +1291,11 @@ private void loadAllResources(String name, Class<?> cl, StreamLoader loader) {
 
         // if failed to load anything, fall back to old technique, just in case
         if (!anyLoaded) {
-		    /*
-		    logger.config("!anyLoaded");
-		    */
-            loadResource("/" + name, cl, loader, false);
+            String[] resources = new String[names.length];
+            for (int i = 0; i < names.length; i++) {
+                resources[i] = "/" + names[i];
+            }
+            loadResource(cl, loader, false, resources);
         }
     }