You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@santuario.apache.org by mu...@apache.org on 2021/10/22 13:40:08 UTC

[santuario-xml-security-java] branch 2.2.x-fixes updated: Replace calls to deprecated Class.newInstance() API with Class.getDeclaredConstructor().newInstance().

This is an automated email from the ASF dual-hosted git repository.

mullan pushed a commit to branch 2.2.x-fixes
in repository https://gitbox.apache.org/repos/asf/santuario-xml-security-java.git


The following commit(s) were added to refs/heads/2.2.x-fixes by this push:
     new 7d0c9ef  Replace calls to deprecated Class.newInstance() API with Class.getDeclaredConstructor().newInstance().
7d0c9ef is described below

commit 7d0c9ef1e3c83aba1dd258e87648a9fffba4372a
Author: Sean Mullan <se...@oracle.com>
AuthorDate: Mon Oct 4 09:59:18 2021 -0400

    Replace calls to deprecated Class.newInstance() API with Class.getDeclaredConstructor().newInstance().
---
 .../security/algorithms/SignatureAlgorithm.java    |  2 +-
 .../apache/xml/security/c14n/Canonicalizer.java    |  2 +-
 .../xml/security/keys/keyresolver/KeyResolver.java | 11 ++++++-----
 .../stax/config/ResourceResolverMapper.java        |  3 ++-
 .../xml/security/stax/ext/XMLSecurityUtils.java    |  3 ++-
 .../stax/securityToken/SecurityTokenFactory.java   |  3 ++-
 .../apache/xml/security/transforms/Transform.java  |  4 ++--
 .../org/apache/xml/security/utils/JavaUtils.java   | 22 ++++++++++++++++++++++
 .../org/apache/xml/security/utils/XMLUtils.java    |  3 ++-
 .../security/utils/resolver/ResourceResolver.java  |  8 ++++----
 10 files changed, 44 insertions(+), 17 deletions(-)

diff --git a/src/main/java/org/apache/xml/security/algorithms/SignatureAlgorithm.java b/src/main/java/org/apache/xml/security/algorithms/SignatureAlgorithm.java
index 2d52f55..519175a 100644
--- a/src/main/java/org/apache/xml/security/algorithms/SignatureAlgorithm.java
+++ b/src/main/java/org/apache/xml/security/algorithms/SignatureAlgorithm.java
@@ -187,7 +187,7 @@ public class SignatureAlgorithm extends Algorithm {
                 }
             }
 
-            return implementingClass.newInstance();
+            return JavaUtils.newInstanceWithEmptyConstructor(implementingClass);
 
         }  catch (IllegalAccessException | InstantiationException | InvocationTargetException | NullPointerException ex) {
             Object[] exArgs = { algorithmURI, ex.getMessage() };
diff --git a/src/main/java/org/apache/xml/security/c14n/Canonicalizer.java b/src/main/java/org/apache/xml/security/c14n/Canonicalizer.java
index 83211f3..d02a91c 100644
--- a/src/main/java/org/apache/xml/security/c14n/Canonicalizer.java
+++ b/src/main/java/org/apache/xml/security/c14n/Canonicalizer.java
@@ -104,7 +104,7 @@ public final class Canonicalizer {
             Class<? extends CanonicalizerSpi> implementingClass =
                 canonicalizerHash.get(algorithmURI);
 
-            canonicalizerSpi = implementingClass.newInstance();
+            canonicalizerSpi = JavaUtils.newInstanceWithEmptyConstructor(implementingClass);
         } catch (Exception e) {
             Object[] exArgs = { algorithmURI };
             throw new InvalidCanonicalizerException(
diff --git a/src/main/java/org/apache/xml/security/keys/keyresolver/KeyResolver.java b/src/main/java/org/apache/xml/security/keys/keyresolver/KeyResolver.java
index 14a4bcf..a17b4da 100644
--- a/src/main/java/org/apache/xml/security/keys/keyresolver/KeyResolver.java
+++ b/src/main/java/org/apache/xml/security/keys/keyresolver/KeyResolver.java
@@ -165,8 +165,8 @@ public class KeyResolver {
     public static void register(String className)
         throws ClassNotFoundException, IllegalAccessException, InstantiationException {
         JavaUtils.checkRegisterPermission();
-        KeyResolverSpi keyResolverSpi =
-            (KeyResolverSpi) ClassLoaderUtils.loadClass(className, KeyResolver.class).newInstance();
+        KeyResolverSpi keyResolverSpi = (KeyResolverSpi)
+            JavaUtils.newInstanceWithEmptyConstructor(ClassLoaderUtils.loadClass(className, KeyResolver.class));
         register(keyResolverSpi, false);
     }
 
@@ -188,7 +188,8 @@ public class KeyResolver {
         KeyResolverSpi keyResolverSpi = null;
         Exception ex = null;
         try {
-            keyResolverSpi = (KeyResolverSpi) ClassLoaderUtils.loadClass(className, KeyResolver.class).newInstance();
+            keyResolverSpi = (KeyResolverSpi)
+                JavaUtils.newInstanceWithEmptyConstructor(ClassLoaderUtils.loadClass(className, KeyResolver.class));
             register(keyResolverSpi, true);
         } catch (ClassNotFoundException | IllegalAccessException | InstantiationException e) {
             ex = e;
@@ -247,8 +248,8 @@ public class KeyResolver {
         JavaUtils.checkRegisterPermission();
         List<KeyResolverSpi> keyResolverList = new ArrayList<>(classNames.size());
         for (String className : classNames) {
-            KeyResolverSpi keyResolverSpi =
-                (KeyResolverSpi)ClassLoaderUtils.loadClass(className, KeyResolver.class).newInstance();
+            KeyResolverSpi keyResolverSpi = (KeyResolverSpi)
+                JavaUtils.newInstanceWithEmptyConstructor(ClassLoaderUtils.loadClass(className, KeyResolver.class));
             keyResolverList.add(keyResolverSpi);
         }
         resolverList.addAll(keyResolverList);
diff --git a/src/main/java/org/apache/xml/security/stax/config/ResourceResolverMapper.java b/src/main/java/org/apache/xml/security/stax/config/ResourceResolverMapper.java
index 275894d..5b54ca7 100644
--- a/src/main/java/org/apache/xml/security/stax/config/ResourceResolverMapper.java
+++ b/src/main/java/org/apache/xml/security/stax/config/ResourceResolverMapper.java
@@ -22,6 +22,7 @@ import org.apache.xml.security.exceptions.XMLSecurityException;
 import org.apache.xml.security.stax.ext.ResourceResolver;
 import org.apache.xml.security.stax.ext.ResourceResolverLookup;
 import org.apache.xml.security.utils.ClassLoaderUtils;
+import org.apache.xml.security.utils.JavaUtils;
 import org.apache.xml.security.configuration.ResolverType;
 import org.apache.xml.security.configuration.ResourceResolversType;
 
@@ -44,7 +45,7 @@ public final class ResourceResolverMapper {
         for (int i = 0; i < handlerList.size(); i++) {
             ResolverType uriResolverType = handlerList.get(i);
             resourceResolvers.add((ResourceResolverLookup)
-                    ClassLoaderUtils.loadClass(uriResolverType.getJAVACLASS(), callingClass).newInstance());
+                    JavaUtils.newInstanceWithEmptyConstructor(ClassLoaderUtils.loadClass(uriResolverType.getJAVACLASS(), callingClass)));
         }
     }
 
diff --git a/src/main/java/org/apache/xml/security/stax/ext/XMLSecurityUtils.java b/src/main/java/org/apache/xml/security/stax/ext/XMLSecurityUtils.java
index 7372a2a..8a7ea05 100644
--- a/src/main/java/org/apache/xml/security/stax/ext/XMLSecurityUtils.java
+++ b/src/main/java/org/apache/xml/security/stax/ext/XMLSecurityUtils.java
@@ -69,6 +69,7 @@ import org.apache.xml.security.stax.securityEvent.X509TokenSecurityEvent;
 import org.apache.xml.security.stax.securityToken.InboundSecurityToken;
 import org.apache.xml.security.stax.securityToken.SecurityTokenConstants;
 import org.apache.xml.security.utils.ClassLoaderUtils;
+import org.apache.xml.security.utils.JavaUtils;
 import org.apache.xml.security.utils.XMLUtils;
 
 /**
@@ -137,7 +138,7 @@ public class XMLSecurityUtils {
         Transformer childTransformer = null;
 
         try {
-            childTransformer = transformerClass.newInstance();
+            childTransformer = JavaUtils.newInstanceWithEmptyConstructor(transformerClass);
             if (properties != null) {
                 childTransformer.setProperties(properties);
             }
diff --git a/src/main/java/org/apache/xml/security/stax/securityToken/SecurityTokenFactory.java b/src/main/java/org/apache/xml/security/stax/securityToken/SecurityTokenFactory.java
index 324d396..0f628e1 100644
--- a/src/main/java/org/apache/xml/security/stax/securityToken/SecurityTokenFactory.java
+++ b/src/main/java/org/apache/xml/security/stax/securityToken/SecurityTokenFactory.java
@@ -24,6 +24,7 @@ import org.apache.xml.security.stax.config.ConfigurationProperties;
 import org.apache.xml.security.stax.ext.InboundSecurityContext;
 import org.apache.xml.security.stax.ext.XMLSecurityProperties;
 import org.apache.xml.security.utils.ClassLoaderUtils;
+import org.apache.xml.security.utils.JavaUtils;
 
 /**
  * Factory to create SecurityToken Objects from keys in XML
@@ -49,7 +50,7 @@ public abstract class SecurityTokenFactory {
                 @SuppressWarnings("unchecked")
                 Class<SecurityTokenFactory> securityTokenFactoryClass =
                         (Class<SecurityTokenFactory>) ClassLoaderUtils.loadClass(stf, callingClass);
-                instance = securityTokenFactoryClass.newInstance();
+                instance = JavaUtils.newInstanceWithEmptyConstructor(securityTokenFactoryClass);
             } catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
                 throw new XMLSecurityException(e, "algorithm.ClassDoesNotExist", new Object[]{stf});
             }
diff --git a/src/main/java/org/apache/xml/security/transforms/Transform.java b/src/main/java/org/apache/xml/security/transforms/Transform.java
index fe6bb5f..ffb01a7 100644
--- a/src/main/java/org/apache/xml/security/transforms/Transform.java
+++ b/src/main/java/org/apache/xml/security/transforms/Transform.java
@@ -195,7 +195,7 @@ public final class Transform extends SignatureElementProxy {
             (Class<? extends TransformSpi>)
                 ClassLoaderUtils.loadClass(implementingClass, Transform.class);
         try {
-            transformSpiHash.put(algorithmURI, transformSpiClass.newInstance());
+            transformSpiHash.put(algorithmURI, JavaUtils.newInstanceWithEmptyConstructor(transformSpiClass));
         } catch (InstantiationException | IllegalAccessException ex) {
             Object[] exArgs = { algorithmURI };
             throw new InvalidTransformException(
@@ -226,7 +226,7 @@ public final class Transform extends SignatureElementProxy {
             throw new AlgorithmAlreadyRegisteredException("algorithm.alreadyRegistered", exArgs);
         }
         try {
-            transformSpiHash.put(algorithmURI, implementingClass.newInstance());
+            transformSpiHash.put(algorithmURI, JavaUtils.newInstanceWithEmptyConstructor(implementingClass));
         } catch (InstantiationException | IllegalAccessException ex) {
             Object[] exArgs = { algorithmURI };
             throw new InvalidTransformException(
diff --git a/src/main/java/org/apache/xml/security/utils/JavaUtils.java b/src/main/java/org/apache/xml/security/utils/JavaUtils.java
index cde9669..e1273fc 100644
--- a/src/main/java/org/apache/xml/security/utils/JavaUtils.java
+++ b/src/main/java/org/apache/xml/security/utils/JavaUtils.java
@@ -22,6 +22,7 @@ import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.lang.reflect.InvocationTargetException;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.security.SecurityPermission;
@@ -218,4 +219,25 @@ public final class JavaUtils {
             sm.checkPermission(REGISTER_PERMISSION);
         }
     }
+
+    /**
+     * Creates a new instance of this class with the empty constructor.
+     *
+     * @param clazz the class
+     * @param <T> the type of the class
+     * @return the new instance
+     * @throws InstantiationException
+     * @throws IllegalAccessException
+     */
+    public static <T> T newInstanceWithEmptyConstructor(Class<T> clazz)
+            throws InstantiationException, IllegalAccessException {
+        try {
+            return clazz.getDeclaredConstructor().newInstance();
+        } catch (NoSuchMethodException | InvocationTargetException e) {
+            // wrap exception to preserve compatibility with APIs
+            // that call this method
+            throw (InstantiationException)
+                    new InstantiationException(clazz.getName()).initCause(e);
+        }
+    }
 }
diff --git a/src/main/java/org/apache/xml/security/utils/XMLUtils.java b/src/main/java/org/apache/xml/security/utils/XMLUtils.java
index 277b685..47d307f 100644
--- a/src/main/java/org/apache/xml/security/utils/XMLUtils.java
+++ b/src/main/java/org/apache/xml/security/utils/XMLUtils.java
@@ -64,7 +64,8 @@ public final class XMLUtils {
                         String xmlParserClass = System.getProperty("org.apache.xml.security.XMLParser");
                         if (xmlParserClass != null) {
                             try {
-                                return (XMLParser) ClassLoaderUtils.loadClass(xmlParserClass, XMLUtils.class).newInstance();
+                                return (XMLParser) JavaUtils.newInstanceWithEmptyConstructor(
+                                        ClassLoaderUtils.loadClass(xmlParserClass, XMLUtils.class));
                             } catch (ClassNotFoundException | IllegalAccessException | InstantiationException e) {
                                 LOG.error("Error instantiating XMLParser. Falling back to XMLParserImpl");
                             }
diff --git a/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java b/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java
index f3de97b..2c574c3 100644
--- a/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java
+++ b/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java
@@ -63,7 +63,7 @@ public class ResourceResolver {
         Class<ResourceResolverSpi> resourceResolverClass =
             (Class<ResourceResolverSpi>)
             ClassLoaderUtils.loadClass(className, ResourceResolver.class);
-        register(resourceResolverClass.newInstance(), false);
+        register(JavaUtils.newInstanceWithEmptyConstructor(resourceResolverClass), false);
     }
 
     /**
@@ -82,7 +82,7 @@ public class ResourceResolver {
         Class<ResourceResolverSpi> resourceResolverClass =
             (Class<ResourceResolverSpi>)
             ClassLoaderUtils.loadClass(className, ResourceResolver.class);
-        register(resourceResolverClass.newInstance(), true);
+        register(JavaUtils.newInstanceWithEmptyConstructor(resourceResolverClass), true);
     }
 
     /**
@@ -118,8 +118,8 @@ public class ResourceResolver {
 
         List<ResourceResolverSpi> resourceResolversToAdd = new ArrayList<>(classNames.size());
         for (String className : classNames) {
-            ResourceResolverSpi resourceResolverSpi =
-                (ResourceResolverSpi)ClassLoaderUtils.loadClass(className, ResourceResolver.class).newInstance();
+            ResourceResolverSpi resourceResolverSpi = (ResourceResolverSpi)
+                JavaUtils.newInstanceWithEmptyConstructor(ClassLoaderUtils.loadClass(className, ResourceResolver.class));
             resourceResolversToAdd.add(resourceResolverSpi);
         }
         resolverList.addAll(resourceResolversToAdd);