Merge pull request #472 from offa/nullability_annotations

Add missing nullability annotations
jenkinsci · Jan 24, 2023 · e8ba173 · e8ba173
2 parents 71755e3 + dd8b989
commit e8ba173
Show file tree

Hide file tree

Showing 19 changed files with 87 additions and 53 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/groovy/ClassLoaderWhitelist.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/groovy/ClassLoaderWhitelist.java
@@ -1,5 +1,6 @@
 package org.jenkinsci.plugins.scriptsecurity.sandbox.groovy;
 
+import edu.umd.cs.findbugs.annotations.NonNull;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist;
 
 import java.lang.reflect.Constructor;
@@ -23,31 +24,31 @@ private boolean permits(Class<?> declaringClass) {
         return declaringClass.getClassLoader() == scriptLoader;
     }
 
-    @Override public boolean permitsMethod(Method method, Object receiver, Object[] args) {
+    @Override public boolean permitsMethod(@NonNull Method method, @NonNull Object receiver, @NonNull Object[] args) {
         return permits(method.getDeclaringClass()) && !isIllegalSyntheticMethod(method);
     }
 
-    @Override public boolean permitsConstructor(Constructor<?> constructor, Object[] args) {
+    @Override public boolean permitsConstructor(@NonNull Constructor<?> constructor, @NonNull Object[] args) {
         return permits(constructor.getDeclaringClass()) && !isIllegalSyntheticConstructor(constructor);
     }
 
-    @Override public boolean permitsStaticMethod(Method method, Object[] args) {
+    @Override public boolean permitsStaticMethod(@NonNull Method method, @NonNull Object[] args) {
         return permits(method.getDeclaringClass()) && !isIllegalSyntheticMethod(method);
     }
 
-    @Override public boolean permitsFieldGet(Field field, Object receiver) {
+    @Override public boolean permitsFieldGet(@NonNull Field field, @NonNull Object receiver) {
         return permits(field.getDeclaringClass()) && !isIllegalSyntheticField(field);
     }
 
-    @Override public boolean permitsFieldSet(Field field, Object receiver, Object value) {
+    @Override public boolean permitsFieldSet(@NonNull Field field, @NonNull Object receiver, Object value) {
         return permits(field.getDeclaringClass()) && !isIllegalSyntheticField(field);
     }
 
-    @Override public boolean permitsStaticFieldGet(Field field) {
+    @Override public boolean permitsStaticFieldGet(@NonNull Field field) {
         return permits(field.getDeclaringClass()) && !isIllegalSyntheticField(field);
     }
 
-    @Override public boolean permitsStaticFieldSet(Field field, Object value) {
+    @Override public boolean permitsStaticFieldSet(@NonNull Field field, Object value) {
         return permits(field.getDeclaringClass()) && !isIllegalSyntheticField(field);
     }
 

diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/groovy/SecureGroovyScript.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/groovy/SecureGroovyScript.java
@@ -524,6 +524,7 @@ private final class CleanClassCollector extends ClassCollector {
 
     @Extension public static final class DescriptorImpl extends Descriptor<SecureGroovyScript> {
 
+        @NonNull
         @Override public String getDisplayName() {
             return ""; // not intended to be displayed on its own
         }

diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/AbstractWhitelist.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/AbstractWhitelist.java
@@ -27,6 +27,8 @@
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist;
 
 /**
@@ -36,31 +38,31 @@
  */
 public abstract class AbstractWhitelist extends Whitelist {
 
-    @Override public boolean permitsMethod(Method method, Object receiver, Object[] args) {
+    @Override public boolean permitsMethod(@NonNull Method method, @NonNull Object receiver, @NonNull Object[] args) {
         return false;
     }
 
-    @Override public boolean permitsConstructor(Constructor<?> constructor, Object[] args) {
+    @Override public boolean permitsConstructor(@NonNull Constructor<?> constructor, @NonNull Object[] args) {
         return false;
     }
 
-    @Override public boolean permitsStaticMethod(Method method, Object[] args) {
+    @Override public boolean permitsStaticMethod(@NonNull Method method, @NonNull Object[] args) {
         return false;
     }
 
-    @Override public boolean permitsFieldSet(Field field, Object receiver, Object value) {
+    @Override public boolean permitsFieldSet(@NonNull Field field, @NonNull Object receiver, Object value) {
         return false;
     }
 
-    @Override public boolean permitsFieldGet(Field field, Object receiver) {
+    @Override public boolean permitsFieldGet(@NonNull Field field, @NonNull Object receiver) {
         return false;
     }
 
-    @Override public boolean permitsStaticFieldSet(Field field, Object value) {
+    @Override public boolean permitsStaticFieldSet(@NonNull Field field, Object value) {
         return false;
     }
 
-    @Override public boolean permitsStaticFieldGet(Field field) {
+    @Override public boolean permitsStaticFieldGet(@NonNull Field field) {
         return false;
     }
 

diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/AclAwareWhitelist.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/AclAwareWhitelist.java
@@ -24,6 +24,7 @@
 
 package org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists;
 
+import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.security.ACL;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
@@ -60,31 +61,31 @@ private static boolean authenticated() {
         return !ACL.SYSTEM2.equals(Jenkins.getAuthentication2());
     }
 
-    @Override public boolean permitsMethod(Method method, Object receiver, Object[] args) {
+    @Override public boolean permitsMethod(@NonNull Method method, @NonNull Object receiver, @NonNull Object[] args) {
         return unrestricted.permitsMethod(method, receiver, args) || authenticated() && restricted.permitsMethod(method, receiver, args);
     }
 
-    @Override public boolean permitsConstructor(Constructor<?> constructor, Object[] args) {
+    @Override public boolean permitsConstructor(@NonNull Constructor<?> constructor, @NonNull Object[] args) {
         return unrestricted.permitsConstructor(constructor, args) || authenticated() && restricted.permitsConstructor(constructor, args);
     }
 
-    @Override public boolean permitsStaticMethod(Method method, Object[] args) {
+    @Override public boolean permitsStaticMethod(@NonNull Method method, @NonNull Object[] args) {
         return unrestricted.permitsStaticMethod(method, args) || authenticated() && restricted.permitsStaticMethod(method, args);
     }
 
-    @Override public boolean permitsFieldGet(Field field, Object receiver) {
+    @Override public boolean permitsFieldGet(@NonNull Field field, @NonNull Object receiver) {
         return unrestricted.permitsFieldGet(field, receiver);
     }
 
-    @Override public boolean permitsFieldSet(Field field, Object receiver, Object value) {
+    @Override public boolean permitsFieldSet(@NonNull Field field, @NonNull Object receiver, Object value) {
         return unrestricted.permitsFieldSet(field, receiver, value);
     }
 
-    @Override public boolean permitsStaticFieldGet(Field field) {
+    @Override public boolean permitsStaticFieldGet(@NonNull Field field) {
         return unrestricted.permitsStaticFieldGet(field);
     }
 
-    @Override public boolean permitsStaticFieldSet(Field field, Object value) {
+    @Override public boolean permitsStaticFieldSet(@NonNull Field field, Object value) {
         return unrestricted.permitsStaticFieldSet(field, value);
     }
 

diff --git a/...main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/AnnotatedWhitelist.java b/...main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/AnnotatedWhitelist.java
@@ -60,31 +60,31 @@ private boolean allowed(@NonNull AccessibleObject o) {
             return ann.restricted() == restricted;
         }
 
-        @Override public boolean permitsMethod(Method method, Object receiver, Object[] args) {
+        @Override public boolean permitsMethod(@NonNull Method method, @NonNull Object receiver, @NonNull Object[] args) {
             return allowed(method);
         }
 
-        @Override public boolean permitsConstructor(Constructor<?> constructor, Object[] args) {
+        @Override public boolean permitsConstructor(@NonNull Constructor<?> constructor, @NonNull Object[] args) {
             return allowed(constructor);
         }
 
-        @Override public boolean permitsStaticMethod(Method method, Object[] args) {
+        @Override public boolean permitsStaticMethod(@NonNull Method method, @NonNull Object[] args) {
             return allowed(method);
         }
 
-        @Override public boolean permitsFieldGet(Field field, Object receiver) {
+        @Override public boolean permitsFieldGet(@NonNull Field field, @NonNull Object receiver) {
             return allowed(field);
         }
 
-        @Override public boolean permitsFieldSet(Field field, Object receiver, Object value) {
+        @Override public boolean permitsFieldSet(@NonNull Field field, @NonNull Object receiver, Object value) {
             return allowed(field);
         }
 
-        @Override public boolean permitsStaticFieldGet(Field field) {
+        @Override public boolean permitsStaticFieldGet(@NonNull Field field) {
             return allowed(field);
         }
 
-        @Override public boolean permitsStaticFieldSet(Field field, Object value) {
+        @Override public boolean permitsStaticFieldSet(@NonNull Field field, Object value) {
             return allowed(field);
         }
 

diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/BlanketWhitelist.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/BlanketWhitelist.java
@@ -27,6 +27,8 @@
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist;
 
 /**
@@ -35,31 +37,31 @@
  */
 public final class BlanketWhitelist extends Whitelist {
 
-    @Override public boolean permitsMethod(Method method, Object receiver, Object[] args) {
+    @Override public boolean permitsMethod(@NonNull Method method, @NonNull Object receiver, @NonNull Object[] args) {
         return true;
     }
 
-    @Override public boolean permitsConstructor(Constructor<?> constructor, Object[] args) {
+    @Override public boolean permitsConstructor(@NonNull Constructor<?> constructor, @NonNull Object[] args) {
         return true;
     }
 
-    @Override public boolean permitsStaticMethod(Method method, Object[] args) {
+    @Override public boolean permitsStaticMethod(@NonNull Method method, @NonNull Object[] args) {
         return true;
     }
 
-    @Override public boolean permitsFieldSet(Field field, Object receiver, Object value) {
+    @Override public boolean permitsFieldSet(@NonNull Field field, @NonNull Object receiver, Object value) {
         return true;
     }
 
-    @Override public boolean permitsFieldGet(Field field, Object receiver) {
+    @Override public boolean permitsFieldGet(@NonNull Field field, @NonNull Object receiver) {
         return true;
     }
 
-    @Override public boolean permitsStaticFieldSet(Field field, Object value) {
+    @Override public boolean permitsStaticFieldSet(@NonNull Field field, Object value) {
         return true;
     }
 
-    @Override public boolean permitsStaticFieldGet(Field field) {
+    @Override public boolean permitsStaticFieldGet(@NonNull Field field) {
         return true;
     }
 

diff --git a/...in/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/EnumeratingWhitelist.java b/...in/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/EnumeratingWhitelist.java
@@ -86,7 +86,7 @@ final void clearCache() {
         this.permittedCache = new ConcurrentHashMap<>();
     }
 
-    @Override public final boolean permitsMethod(Method method, Object receiver, Object[] args) {
+    @Override public final boolean permitsMethod(@NonNull Method method, @NonNull Object receiver, @NonNull Object[] args) {
         String key = canonicalMethodSig(method);
         Boolean b = permittedCache.get(key);
         if (b != null) {
@@ -104,7 +104,7 @@ final void clearCache() {
         return output;
     }
 
-    @Override public final boolean permitsConstructor(Constructor<?> constructor, Object[] args) {
+    @Override public final boolean permitsConstructor(@NonNull Constructor<?> constructor, @NonNull Object[] args) {
         String key = canonicalConstructorSig(constructor);
         Boolean b = permittedCache.get(key);
         if (b != null) {
@@ -122,7 +122,7 @@ final void clearCache() {
         return output;
     }
 
-    @Override public final boolean permitsStaticMethod(Method method, Object[] args) {
+    @Override public final boolean permitsStaticMethod(@NonNull Method method, @NonNull Object[] args) {
         String key = canonicalStaticMethodSig(method);
         Boolean b = permittedCache.get(key);
         if (b != null) {
@@ -140,7 +140,7 @@ final void clearCache() {
         return output;
     }
 
-    @Override public final boolean permitsFieldGet(Field field, Object receiver) {
+    @Override public final boolean permitsFieldGet(@NonNull Field field, @NonNull Object receiver) {
         String key = canonicalFieldSig(field);
         Boolean b = permittedCache.get(key);
         if (b != null) {
@@ -158,11 +158,11 @@ final void clearCache() {
         return output;
     }
 
-    @Override public final boolean permitsFieldSet(Field field, Object receiver, Object value) {
+    @Override public final boolean permitsFieldSet(@NonNull Field field, @NonNull Object receiver, Object value) {
         return permitsFieldGet(field, receiver);
     }
 
-    @Override public final boolean permitsStaticFieldGet(Field field) {
+    @Override public final boolean permitsStaticFieldGet(@NonNull Field field) {
         String key = canonicalStaticFieldSig(field);
         Boolean b = permittedCache.get(key);
         if (b != null) {
@@ -180,7 +180,7 @@ final void clearCache() {
         return output;
     }
 
-    @Override public final boolean permitsStaticFieldSet(Field field, Object value) {
+    @Override public final boolean permitsStaticFieldSet(@NonNull Field field, Object value) {
         return permitsStaticFieldGet(field);
     }
 

diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/ProxyWhitelist.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/sandbox/whitelists/ProxyWhitelist.java
@@ -28,6 +28,7 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 
+import edu.umd.cs.findbugs.annotations.NonNull;
 import net.jcip.annotations.GuardedBy;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist;
 import java.util.ArrayList;
@@ -185,7 +186,7 @@ public ProxyWhitelist(Whitelist... delegates) {
         this(Arrays.asList(delegates));
     }
 
-    @Override public final boolean permitsMethod(Method method, Object receiver, Object[] args) {
+    @Override public final boolean permitsMethod(@NonNull Method method, @NonNull Object receiver, @NonNull Object[] args) {
         lock.readLock().lock();
         try {
             for (Whitelist delegate : delegates) {
@@ -199,7 +200,7 @@ public ProxyWhitelist(Whitelist... delegates) {
         return false;
     }
 
-    @Override public final boolean permitsConstructor(Constructor<?> constructor, Object[] args) {
+    @Override public final boolean permitsConstructor(@NonNull Constructor<?> constructor, @NonNull Object[] args) {
         lock.readLock().lock();
         try {
             for (Whitelist delegate : delegates) {
@@ -213,7 +214,7 @@ public ProxyWhitelist(Whitelist... delegates) {
         return false;
     }
 
-    @Override public final boolean permitsStaticMethod(Method method, Object[] args) {
+    @Override public final boolean permitsStaticMethod(@NonNull Method method, @NonNull Object[] args) {
         lock.readLock().lock();
         try {
             for (Whitelist delegate : delegates) {
@@ -227,7 +228,7 @@ public ProxyWhitelist(Whitelist... delegates) {
         return false;
     }
 
-    @Override public final boolean permitsFieldGet(Field field, Object receiver) {
+    @Override public final boolean permitsFieldGet(@NonNull Field field, @NonNull Object receiver) {
         lock.readLock().lock();
         try {
             for (Whitelist delegate : delegates) {
@@ -241,7 +242,7 @@ public ProxyWhitelist(Whitelist... delegates) {
         return false;
     }
 
-    @Override public final boolean permitsFieldSet(Field field, Object receiver, Object value) {
+    @Override public final boolean permitsFieldSet(@NonNull Field field, @NonNull Object receiver, Object value) {
         lock.readLock().lock();
         try {
             for (Whitelist delegate : delegates) {
@@ -256,7 +257,7 @@ public ProxyWhitelist(Whitelist... delegates) {
         return false;
     }
 
-    @Override public final boolean permitsStaticFieldGet(Field field) {
+    @Override public final boolean permitsStaticFieldGet(@NonNull Field field) {
         lock.readLock().lock();
         try {
             for (Whitelist delegate : delegates) {
@@ -270,7 +271,7 @@ public ProxyWhitelist(Whitelist... delegates) {
         return false;
     }
 
-    @Override public final boolean permitsStaticFieldSet(Field field, Object value) {
+    @Override public final boolean permitsStaticFieldSet(@NonNull Field field, Object value) {
         lock.readLock().lock();
         try {
             for (Whitelist delegate : delegates) {

diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/scripts/ClasspathEntry.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/scripts/ClasspathEntry.java
@@ -197,6 +197,7 @@ public boolean equals(Object obj) {
 
     @Extension
     public static class DescriptorImpl extends Descriptor<ClasspathEntry> {
+        @NonNull
         @Override
         public String getDisplayName() {
             return "ClasspathEntry";

diff --git a/src/main/java/org/jenkinsci/plugins/scriptsecurity/scripts/ScriptApproval.java b/src/main/java/org/jenkinsci/plugins/scriptsecurity/scripts/ScriptApproval.java
@@ -116,6 +116,7 @@ protected XmlFile getConfigFile() {
         return new XmlFile(XSTREAM2, new File(Jenkins.get().getRootDir(),getUrlName() + ".xml"));
     }
 
+    @NonNull
     @Override
     public GlobalConfigurationCategory getCategory() {
         return GlobalConfigurationCategory.get(GlobalConfigurationCategory.Security.class);
@@ -379,9 +380,11 @@ public Language getLanguage() {
                 }
             }
             return new Language() {
+                @NonNull
                 @Override public String getName() {
                     return language;
                 }
+                @NonNull
                 @Override public String getDisplayName() {
                     return "<missing language: " + language + ">";
                 }
-Original file line number
+Diff line change
@@ Expand Up @@
         @Extension public static final class DescriptorImpl extends Descriptor<SecureGroovyScript> {
+            @NonNull
             @Override public String getDisplayName() {
                 return ""; // not intended to be displayed on its own
             }
@@ Expand Down @@