enh: cleaned up all compiler warnings

apache · Dec 20, 2023 · 5755721 · 5755721
1 parent 6ecb862
commit 5755721
Show file tree

Hide file tree

Showing 77 changed files with 384 additions and 155 deletions.
diff --git a/cache/src/main/java/org/apache/shiro/cache/AbstractCacheManager.java b/cache/src/main/java/org/apache/shiro/cache/AbstractCacheManager.java
@@ -38,13 +38,13 @@ public abstract class AbstractCacheManager implements CacheManager, Destroyable
     /**
      * Retains all Cache objects maintained by this cache manager.
      */
-    private final ConcurrentMap<String, Cache> caches;
+    private final ConcurrentMap<String, Cache<?, ?>> caches;
 
     /**
      * Default no-arg constructor that instantiates an internal name-to-cache {@code ConcurrentMap}.
      */
     public AbstractCacheManager() {
-        this.caches = new ConcurrentHashMap<String, Cache>();
+        this.caches = new ConcurrentHashMap<>();
     }
 
     /**
@@ -56,17 +56,18 @@ public AbstractCacheManager() {
      * @throws IllegalArgumentException if the {@code name} argument is {@code null} or does not contain text.
      * @throws CacheException           if there is a problem lazily creating a {@code Cache} instance.
      */
+    @SuppressWarnings("unchecked")
     public <K, V> Cache<K, V> getCache(String name) throws IllegalArgumentException, CacheException {
         if (!StringUtils.hasText(name)) {
             throw new IllegalArgumentException("Cache name cannot be null or empty.");
         }
 
-        Cache cache;
+        Cache<K, V> cache;
 
-        cache = caches.get(name);
+        cache = (Cache<K, V>) caches.get(name);
         if (cache == null) {
             cache = createCache(name);
-            Cache existing = caches.putIfAbsent(name, cache);
+            Cache<K, V> existing = (Cache<K, V>) caches.putIfAbsent(name, cache);
             if (existing != null) {
                 cache = existing;
             }
@@ -83,7 +84,7 @@ public <K, V> Cache<K, V> getCache(String name) throws IllegalArgumentException,
      * @return a new {@code Cache} instance associated with the specified {@code name}.
      * @throws CacheException if the {@code Cache} instance cannot be created.
      */
-    protected abstract Cache createCache(String name) throws CacheException;
+    protected abstract <K, V> Cache<K, V> createCache(String name) throws CacheException;
 
     /**
      * Cleanup method that first {@link LifecycleUtils#destroy destroys} all of it's managed caches and then
@@ -101,7 +102,7 @@ public void destroy() throws Exception {
     }
 
     public String toString() {
-        Collection<Cache> values = caches.values();
+        Collection<Cache<?, ?>> values = caches.values();
         StringBuilder sb = new StringBuilder(getClass().getSimpleName())
                 .append(" with ")
                 .append(caches.size())

diff --git a/cache/src/main/java/org/apache/shiro/cache/MemoryConstrainedCacheManager.java b/cache/src/main/java/org/apache/shiro/cache/MemoryConstrainedCacheManager.java
@@ -42,7 +42,7 @@ public class MemoryConstrainedCacheManager extends AbstractCacheManager {
      * @return a new {@link MapCache MapCache} instance backed by a {@link SoftHashMap}.
      */
     @Override
-    protected Cache createCache(String name) {
-        return new MapCache<Object, Object>(name, new SoftHashMap<Object, Object>());
+    protected <K, V> Cache<K, V> createCache(String name) {
+        return new MapCache<>(name, new SoftHashMap<>());
     }
 }
diff --git a/config/ogdl/src/main/java/org/apache/shiro/config/ogdl/CommonsInterpolator.java b/config/ogdl/src/main/java/org/apache/shiro/config/ogdl/CommonsInterpolator.java
@@ -20,8 +20,7 @@
 
 import org.apache.commons.configuration2.interpol.ConfigurationInterpolator;
 import org.apache.commons.configuration2.interpol.ConstantLookup;
-import org.apache.commons.configuration2.interpol.EnvironmentLookup;
-import org.apache.commons.configuration2.interpol.SystemPropertiesLookup;
+import org.apache.commons.configuration2.interpol.DefaultLookups;
 
 /**
  * Commons-Config interpolation wrapper. This implementation uses a {@link ConfigurationInterpolator} with the default
@@ -61,8 +60,8 @@ public CommonsInterpolator() {
         this.interpolator = new ConfigurationInterpolator();
 
         interpolator.registerLookup("const", new ConstantLookup());
-        interpolator.addDefaultLookup(new SystemPropertiesLookup());
-        interpolator.addDefaultLookup(new EnvironmentLookup());
+        interpolator.addDefaultLookup(DefaultLookups.SYSTEM_PROPERTIES.getLookup());
+        interpolator.addDefaultLookup(DefaultLookups.ENVIRONMENT.getLookup());
     }
 
     @Override

diff --git a/config/ogdl/src/main/java/org/apache/shiro/config/ogdl/ReflectionBuilder.java b/config/ogdl/src/main/java/org/apache/shiro/config/ogdl/ReflectionBuilder.java
@@ -126,9 +126,10 @@ public ReflectionBuilder(Map<String, ?> defaults) {
         // SHIRO-739
         beanUtilsBean = new BeanUtilsBean(new ConvertUtilsBean() {
             @Override
-            public Object convert(String value, Class clazz) {
+            @SuppressWarnings("unchecked")
+            public Object convert(String value, Class<?> clazz) {
                 if (clazz.isEnum()) {
-                    return Enum.valueOf(clazz, value);
+                    return Enum.valueOf((Class<Enum>) clazz, value);
                 } else {
                     return super.convert(value, clazz);
                 }
@@ -460,7 +461,7 @@ protected Object resolveReference(String reference) {
         return referencedObject;
     }
 
-    protected boolean isTypedProperty(Object object, String propertyName, Class clazz) {
+    protected boolean isTypedProperty(Object object, String propertyName, Class<?> clazz) {
         if (clazz == null) {
             throw new NullPointerException("type (class) argument cannot be null.");
         }
@@ -471,7 +472,7 @@ protected boolean isTypedProperty(Object object, String propertyName, Class claz
                         + "type " + object.getClass().getName() + ".";
                 throw new ConfigurationException(msg);
             }
-            Class propertyClazz = descriptor.getPropertyType();
+            Class<?> propertyClazz = descriptor.getPropertyType();
             return clazz.isAssignableFrom(propertyClazz);
         } catch (ConfigurationException ce) {
             //let it propagate:
@@ -666,7 +667,8 @@ protected void applyProperty(Object object, String propertyPath, Object value) {
             } else {
                 //we're assigning a map or array entry.  Check to see which we should call:
                 if (isTypedProperty(object, mapPropertyPath, Map.class)) {
-                    Map map = (Map) getProperty(object, mapPropertyPath);
+                    @SuppressWarnings("unchecked")
+                    var map = (Map<Object, Object>) getProperty(object, mapPropertyPath);
                     Object mapKey = resolveValue(keyString);
                     //noinspection unchecked
                     map.put(mapKey, value);

diff --git a/core/pom.xml b/core/pom.xml
@@ -143,6 +143,10 @@
             <scope>provided</scope>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-configuration2</artifactId>
+        </dependency>
 
         <!-- Test dependencies -->
         <dependency>

diff --git a/core/src/main/java/org/apache/shiro/authc/credential/HashedCredentialsMatcher.java b/core/src/main/java/org/apache/shiro/authc/credential/HashedCredentialsMatcher.java
@@ -21,7 +21,6 @@
 import org.apache.shiro.authc.AuthenticationInfo;
 import org.apache.shiro.authc.AuthenticationToken;
 import org.apache.shiro.authc.SaltedAuthenticationInfo;
-import org.apache.shiro.crypto.hash.AbstractHash;
 import org.apache.shiro.crypto.hash.Hash;
 import org.apache.shiro.crypto.hash.SimpleHash;
 import org.apache.shiro.lang.codec.Base64;
@@ -294,11 +293,7 @@ public int getHashIterations() {
      * @param hashIterations the number of times to hash a submitted {@code AuthenticationToken}'s credentials.
      */
     public void setHashIterations(int hashIterations) {
-        if (hashIterations < 1) {
-            this.hashIterations = 1;
-        } else {
-            this.hashIterations = hashIterations;
-        }
+        this.hashIterations = Math.max(hashIterations, 1);
     }
 
     /**
@@ -362,7 +357,7 @@ protected Object getCredentials(AuthenticationInfo info) {
                 storedBytes = Base64.decode(storedBytes);
             }
         }
-        AbstractHash hash = newHashInstance();
+        SimpleHash hash = newHashInstance();
         hash.setBytes(storedBytes);
         return hash;
     }
@@ -460,7 +455,7 @@ protected Hash hashProvidedCredentials(Object credentials, Object salt, int hash
      *
      * @return a new, <em>uninitialized</em> instance, without its byte array set.
      */
-    protected AbstractHash newHashInstance() {
+    protected SimpleHash newHashInstance() {
         String hashAlgorithmName = assertHashAlgorithmName();
         return new SimpleHash(hashAlgorithmName);
     }

diff --git a/core/src/main/java/org/apache/shiro/authc/credential/Sha256CredentialsMatcher.java b/core/src/main/java/org/apache/shiro/authc/credential/Sha256CredentialsMatcher.java
@@ -29,6 +29,7 @@
  * @deprecated since 1.1 - use the HashedCredentialsMatcher directly and set its
  * {@link HashedCredentialsMatcher#setHashAlgorithmName(String) hashAlgorithmName} property.
  */
+@Deprecated
 public class Sha256CredentialsMatcher extends HashedCredentialsMatcher {
 
     public Sha256CredentialsMatcher() {

diff --git a/core/src/main/java/org/apache/shiro/authc/credential/Sha384CredentialsMatcher.java b/core/src/main/java/org/apache/shiro/authc/credential/Sha384CredentialsMatcher.java
@@ -29,6 +29,7 @@
  * @deprecated since 1.1 - use the HashedCredentialsMatcher directly and set its
  * {@link HashedCredentialsMatcher#setHashAlgorithmName(String) hashAlgorithmName} property.
  */
+@Deprecated
 public class Sha384CredentialsMatcher extends HashedCredentialsMatcher {
 
     public Sha384CredentialsMatcher() {

diff --git a/core/src/main/java/org/apache/shiro/authc/credential/Sha512CredentialsMatcher.java b/core/src/main/java/org/apache/shiro/authc/credential/Sha512CredentialsMatcher.java
@@ -29,6 +29,7 @@
  * @deprecated since 1.1 - use the HashedCredentialsMatcher directly and set its
  * {@link HashedCredentialsMatcher#setHashAlgorithmName(String) hashAlgorithmName} property.
  */
+@Deprecated
 public class Sha512CredentialsMatcher extends HashedCredentialsMatcher {
 
     public Sha512CredentialsMatcher() {

diff --git a/core/src/main/java/org/apache/shiro/env/BasicIniEnvironment.java b/core/src/main/java/org/apache/shiro/env/BasicIniEnvironment.java
@@ -33,11 +33,15 @@
  * @since 1.5
  */
 public class BasicIniEnvironment extends DefaultEnvironment {
+    @SuppressWarnings({"deprecation", "checkstyle:JavadocVariable"})
+    public static final String INI_REALM_NAME = IniSecurityManagerFactory.INI_REALM_NAME;
+
     public BasicIniEnvironment(Ini ini) {
         this(ini, (name) -> null);
     }
 
     public BasicIniEnvironment(Ini ini, Function<String, ?> alternateObjectSupplier) {
+        @SuppressWarnings("deprecation")
         var securityManagerFactory = new IniSecurityManagerFactory(ini);
         securityManagerFactory.getReflectionBuilder().setAlternateObjectSupplier(alternateObjectSupplier);
         setSecurityManager(securityManagerFactory.getInstance());

diff --git a/core/src/main/java/org/apache/shiro/jndi/JndiObjectFactory.java b/core/src/main/java/org/apache/shiro/jndi/JndiObjectFactory.java
@@ -33,6 +33,7 @@ public class JndiObjectFactory<T> extends JndiLocator implements Factory<T> {
     private String resourceName;
     private Class<? extends T> requiredType;
 
+    @SuppressWarnings("unchecked")
     public T getInstance() {
         try {
             if (requiredType != null) {

diff --git a/core/src/main/java/org/apache/shiro/realm/AuthenticatingRealm.java b/core/src/main/java/org/apache/shiro/realm/AuthenticatingRealm.java
@@ -223,7 +223,7 @@ public void setCredentialsMatcher(CredentialsMatcher credentialsMatcher) {
      * @return the authenticationToken class supported by this realm.
      * @see #setAuthenticationTokenClass
      */
-    public Class getAuthenticationTokenClass() {
+    public Class<? extends AuthenticationToken> getAuthenticationTokenClass() {
         return authenticationTokenClass;
     }
 

diff --git a/core/src/main/java/org/apache/shiro/realm/ldap/JndiLdapRealm.java b/core/src/main/java/org/apache/shiro/realm/ldap/JndiLdapRealm.java
@@ -25,6 +25,7 @@
  * @since 1.1
  * @deprecated Renamed to {@link DefaultLdapRealm}, this class will be removed prior to 2.0
  */
+@Deprecated
 public class JndiLdapRealm extends DefaultLdapRealm {
 
 }
diff --git a/core/src/main/java/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.java b/core/src/main/java/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.java
@@ -54,8 +54,8 @@ public class EnterpriseCacheSessionDAO extends CachingSessionDAO {
     public EnterpriseCacheSessionDAO() {
         setCacheManager(new AbstractCacheManager() {
             @Override
-            protected Cache<Serializable, Session> createCache(String name) throws CacheException {
-                return new MapCache<Serializable, Session>(name, new ConcurrentHashMap<Serializable, Session>());
+            protected <Serializable, Session> Cache<Serializable, Session> createCache(String name) throws CacheException {
+                return new MapCache<>(name, new ConcurrentHashMap<>());
             }
         });
     }

diff --git a/core/src/main/java/org/apache/shiro/util/CollectionUtils.java b/core/src/main/java/org/apache/shiro/util/CollectionUtils.java
@@ -38,6 +38,7 @@ public final class CollectionUtils {
     private CollectionUtils() {
     }
 
+    @SafeVarargs
     public static <E> Set<E> asSet(E... elements) {
         if (elements == null || elements.length == 0) {
             return Collections.emptySet();
@@ -116,6 +117,7 @@ public static boolean isEmpty(PrincipalCollection principals) {
         return principals == null || principals.isEmpty();
     }
 
+    @SafeVarargs
     public static <E> List<E> asList(E... elements) {
         if (elements == null || elements.length == 0) {
             return Collections.emptyList();

diff --git a/core/src/main/java/org/apache/shiro/util/OsgiDependencies.java b/core/src/main/java/org/apache/shiro/util/OsgiDependencies.java
@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.shiro.util;
+
+import org.apache.commons.beanutils.BeanUtils;
+import org.apache.commons.configuration2.BaseConfiguration;
+
+/**
+ * This class only exists to satisfy the OSGi plugin
+ */
+class OsgiDependencies {
+    BeanUtils bu;
+    BaseConfiguration bc;
+}
diff --git a/...src/test/java/org/apache/shiro/authc/credential/AbstractHashedCredentialsMatcherTest.java b/...src/test/java/org/apache/shiro/authc/credential/AbstractHashedCredentialsMatcherTest.java
@@ -25,7 +25,7 @@
 import org.apache.shiro.authc.AuthenticationToken;
 import org.apache.shiro.authc.SimpleAuthenticationInfo;
 import org.apache.shiro.authc.UsernamePasswordToken;
-import org.apache.shiro.crypto.hash.AbstractHash;
+import org.apache.shiro.crypto.hash.SimpleHash;
 import org.apache.shiro.lang.util.ClassUtils;
 import org.junit.jupiter.api.Test;
 
@@ -36,7 +36,7 @@ public abstract class AbstractHashedCredentialsMatcherTest {
 
     public abstract Class<? extends HashedCredentialsMatcher> getMatcherClass();
 
-    public abstract AbstractHash hash(Object credentials);
+    public abstract SimpleHash hash(Object credentials);
 
     @Test
     void testBasic() {

diff --git a/core/src/test/java/org/apache/shiro/authc/credential/HashedCredentialsMatcherTest.java b/core/src/test/java/org/apache/shiro/authc/credential/HashedCredentialsMatcherTest.java
@@ -95,6 +95,7 @@ public Object getCredentials() {
      * <a href="https://issues.apache.org/jira/browse/SHIRO-186">SHIRO-186</a> edits.
      */
     @Test
+    @SuppressWarnings("deprecation")
     void testBackwardsCompatibleSaltedAuthenticationInfo() {
         HashedCredentialsMatcher matcher = new HashedCredentialsMatcher(Sha512Hash.ALGORITHM_NAME);
         //enable this for Shiro 1.0 backwards compatibility:

diff --git a/core/src/test/java/org/apache/shiro/authc/credential/Sha256CredentialsMatcherTest.java b/core/src/test/java/org/apache/shiro/authc/credential/Sha256CredentialsMatcherTest.java
@@ -18,20 +18,21 @@
  */
 package org.apache.shiro.authc.credential;
 
-import org.apache.shiro.crypto.hash.AbstractHash;
 import org.apache.shiro.crypto.hash.Sha256Hash;
+import org.apache.shiro.crypto.hash.SimpleHash;
 
 
 /**
  * @since Jun 10, 2008 5:01:00 PM
  */
+@Deprecated
 public class Sha256CredentialsMatcherTest extends AbstractHashedCredentialsMatcherTest {
 
     public Class<? extends HashedCredentialsMatcher> getMatcherClass() {
         return Sha256CredentialsMatcher.class;
     }
 
-    public AbstractHash hash(Object credentials) {
+    public SimpleHash hash(Object credentials) {
         return new Sha256Hash(credentials);
     }
 }
diff --git a/core/src/test/java/org/apache/shiro/authc/credential/Sha384CredentialsMatcherTest.java b/core/src/test/java/org/apache/shiro/authc/credential/Sha384CredentialsMatcherTest.java
@@ -18,20 +18,21 @@
  */
 package org.apache.shiro.authc.credential;
 
-import org.apache.shiro.crypto.hash.AbstractHash;
 import org.apache.shiro.crypto.hash.Sha384Hash;
+import org.apache.shiro.crypto.hash.SimpleHash;
 
 
 /**
  * @since Jun 10, 2008 5:02:27 PM
  */
+@Deprecated
 public class Sha384CredentialsMatcherTest extends AbstractHashedCredentialsMatcherTest {
 
     public Class<? extends HashedCredentialsMatcher> getMatcherClass() {
         return Sha384CredentialsMatcher.class;
     }
 
-    public AbstractHash hash(Object credentials) {
+    public SimpleHash hash(Object credentials) {
         return new Sha384Hash(credentials);
     }
 }
diff --git a/core/src/test/java/org/apache/shiro/authc/credential/Sha512CredentialsMatcherTest.java b/core/src/test/java/org/apache/shiro/authc/credential/Sha512CredentialsMatcherTest.java
@@ -18,20 +18,21 @@
  */
 package org.apache.shiro.authc.credential;
 
-import org.apache.shiro.crypto.hash.AbstractHash;
 import org.apache.shiro.crypto.hash.Sha512Hash;
+import org.apache.shiro.crypto.hash.SimpleHash;
 
 
 /**
  * @since Jun 10, 2008 5:02:58 PM
  */
+@Deprecated
 public class Sha512CredentialsMatcherTest extends AbstractHashedCredentialsMatcherTest {
 
     public Class<? extends HashedCredentialsMatcher> getMatcherClass() {
         return Sha512CredentialsMatcher.class;
     }
 
-    public AbstractHash hash(Object credentials) {
+    public SimpleHash hash(Object credentials) {
         return new Sha512Hash(credentials);
     }
 }