Extract ObjectStreamClassPredicate for reuse outside an input stream,

Author: garydgregory

src/main/java/org/apache/commons/io/serialization/ObjectStreamClassPredicate.java

@@ -0,0 +1,185 @@
+package org.apache.commons.io.serialization;
+
+import java.io.ObjectStreamClass;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.Predicate;
+import java.util.regex.Pattern;
+import java.util.stream.Stream;
+
+/**
+ * A predicate (boolean-valued function) of one argument to accept and reject classes.
+ * <p>
+ * The reject list takes precedence over the accept list.
+ * </p>
+ *
+ * @since 2.18.0
+ */
+public class ObjectStreamClassPredicate implements Predicate<ObjectStreamClass> {
+
+    // This is not a Set for now to avoid ClassNameMatchers requiring proper implementations of hashCode() and equals().
+    private final List<ClassNameMatcher> acceptMatchers = new ArrayList<>();
+
+    // This is not a Set for now to avoid ClassNameMatchers requiring proper implementations of hashCode() and equals().
+    private final List<ClassNameMatcher> rejectMatchers = new ArrayList<>();
+
+    /**
+     * Constructs a new instance.
+     */
+    public ObjectStreamClassPredicate() {
+        // empty
+    }
+
+    /**
+     * Accepts the specified classes for deserialization, unless they are otherwise rejected.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param classes Classes to accept
+     * @return this object
+     */
+    public ObjectStreamClassPredicate accept(final Class<?>... classes) {
+        Stream.of(classes).map(c -> new FullClassNameMatcher(c.getName())).forEach(acceptMatchers::add);
+        return this;
+    }
+
+    /**
+     * Accepts class names where the supplied ClassNameMatcher matches for deserialization, unless they are otherwise rejected.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param matcher a class name matcher to <em>accept</em> objects.
+     * @return this instance.
+     */
+    public ObjectStreamClassPredicate accept(final ClassNameMatcher matcher) {
+        acceptMatchers.add(matcher);
+        return this;
+    }
+
+    /**
+     * Accepts class names that match the supplied pattern for deserialization, unless they are otherwise rejected.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param pattern a Pattern for compiled regular expression.
+     * @return this instance.
+     */
+    public ObjectStreamClassPredicate accept(final Pattern pattern) {
+        acceptMatchers.add(new RegexpClassNameMatcher(pattern));
+        return this;
+    }
+
+    /**
+     * Accepts the wildcard specified classes for deserialization, unless they are otherwise rejected.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param patterns Wildcard file name patterns as defined by {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String)
+     *                 FilenameUtils.wildcardMatch}
+     * @return this instance.
+     */
+    public ObjectStreamClassPredicate accept(final String... patterns) {
+        Stream.of(patterns).map(WildcardClassNameMatcher::new).forEach(acceptMatchers::add);
+        return this;
+    }
+
+    /**
+     * Rejects the specified classes for deserialization, even if they are otherwise accepted.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param classes Classes to reject
+     * @return this instance.
+     */
+    public ObjectStreamClassPredicate reject(final Class<?>... classes) {
+        Stream.of(classes).map(c -> new FullClassNameMatcher(c.getName())).forEach(rejectMatchers::add);
+        return this;
+    }
+
+    /**
+     * Rejects class names where the supplied ClassNameMatcher matches for deserialization, even if they are otherwise accepted.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param m the matcher to use
+     * @return this instance.
+     */
+    public ObjectStreamClassPredicate reject(final ClassNameMatcher m) {
+        rejectMatchers.add(m);
+        return this;
+    }
+
+    /**
+     * Rejects class names that match the supplied pattern for deserialization, even if they are otherwise accepted.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param pattern standard Java regexp
+     * @return this instance.
+     */
+    public ObjectStreamClassPredicate reject(final Pattern pattern) {
+        rejectMatchers.add(new RegexpClassNameMatcher(pattern));
+        return this;
+    }
+
+    /**
+     * Rejects the wildcard specified classes for deserialization, even if they are otherwise accepted.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param patterns Wildcard file name patterns as defined by {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String)
+     *                 FilenameUtils.wildcardMatch}
+     * @return this instance.
+     */
+    public ObjectStreamClassPredicate reject(final String... patterns) {
+        Stream.of(patterns).map(WildcardClassNameMatcher::new).forEach(rejectMatchers::add);
+        return this;
+    }
+
+    /**
+     * Tests that the ObjectStreamClass conforms to requirements.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param objectStreamClass The ObjectStreamClass to test.
+     * @return true if the input is accepted, false if rejected, false if neither.
+     */
+    @Override
+    public boolean test(final ObjectStreamClass objectStreamClass) {
+        return test(objectStreamClass.getName());
+    }
+
+    /**
+     * Tests that the class name conforms to requirements.
+     * <p>
+     * The reject list takes precedence over the accept list.
+     * </p>
+     *
+     * @param name The class name to test.
+     * @return true if the input is accepted, false if rejected, false if neither.
+     */
+    public boolean test(final String name) {
+        // The reject list takes precedence over the accept list.
+        for (final ClassNameMatcher m : rejectMatchers) {
+            if (m.matches(name)) {
+                return false;
+            }
+        }
+        for (final ClassNameMatcher m : acceptMatchers) {
+            if (m.matches(name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+}

src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java

@@ -23,11 +23,7 @@
 import java.io.InvalidClassException;
 import java.io.ObjectInputStream;
 import java.io.ObjectStreamClass;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.function.Predicate;
 import java.util.regex.Pattern;
-import java.util.stream.Stream;
 
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
@@ -247,183 +243,6 @@ public Builder setPredicate(final ObjectStreamClassPredicate predicate) {
 
     }
 
-    /**
-     * A predicate (boolean-valued function) of one argument to accept and reject classes.
-     * <p>
-     * The reject list takes precedence over the accept list.
-     * </p>
-     *
-     * @since 2.18.0
-     */
-    public static class ObjectStreamClassPredicate implements Predicate<ObjectStreamClass> {
-
-        // This is not a Set for now to avoid ClassNameMatchers requiring proper implementations of hashCode() and equals().
-        private final List<ClassNameMatcher> acceptMatchers = new ArrayList<>();
-
-        // This is not a Set for now to avoid ClassNameMatchers requiring proper implementations of hashCode() and equals().
-        private final List<ClassNameMatcher> rejectMatchers = new ArrayList<>();
-
-        /**
-         * Constructs a new instance.
-         */
-        public ObjectStreamClassPredicate() {
-            // empty
-        }
-
-        /**
-         * Accepts the specified classes for deserialization, unless they are otherwise rejected.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param classes Classes to accept
-         * @return this object
-         */
-        public ObjectStreamClassPredicate accept(final Class<?>... classes) {
-            Stream.of(classes).map(c -> new FullClassNameMatcher(c.getName())).forEach(acceptMatchers::add);
-            return this;
-        }
-
-        /**
-         * Accepts class names where the supplied ClassNameMatcher matches for deserialization, unless they are otherwise rejected.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param matcher a class name matcher to <em>accept</em> objects.
-         * @return this instance.
-         */
-        public ObjectStreamClassPredicate accept(final ClassNameMatcher matcher) {
-            acceptMatchers.add(matcher);
-            return this;
-        }
-
-        /**
-         * Accepts class names that match the supplied pattern for deserialization, unless they are otherwise rejected.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param pattern a Pattern for compiled regular expression.
-         * @return this instance.
-         */
-        public ObjectStreamClassPredicate accept(final Pattern pattern) {
-            acceptMatchers.add(new RegexpClassNameMatcher(pattern));
-            return this;
-        }
-
-        /**
-         * Accepts the wildcard specified classes for deserialization, unless they are otherwise rejected.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param patterns Wildcard file name patterns as defined by {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String)
-         *                 FilenameUtils.wildcardMatch}
-         * @return this instance.
-         */
-        public ObjectStreamClassPredicate accept(final String... patterns) {
-            Stream.of(patterns).map(WildcardClassNameMatcher::new).forEach(acceptMatchers::add);
-            return this;
-        }
-
-        /**
-         * Rejects the specified classes for deserialization, even if they are otherwise accepted.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param classes Classes to reject
-         * @return this instance.
-         */
-        public ObjectStreamClassPredicate reject(final Class<?>... classes) {
-            Stream.of(classes).map(c -> new FullClassNameMatcher(c.getName())).forEach(rejectMatchers::add);
-            return this;
-        }
-
-        /**
-         * Rejects class names where the supplied ClassNameMatcher matches for deserialization, even if they are otherwise accepted.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param m the matcher to use
-         * @return this instance.
-         */
-        public ObjectStreamClassPredicate reject(final ClassNameMatcher m) {
-            rejectMatchers.add(m);
-            return this;
-        }
-
-        /**
-         * Rejects class names that match the supplied pattern for deserialization, even if they are otherwise accepted.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param pattern standard Java regexp
-         * @return this instance.
-         */
-        public ObjectStreamClassPredicate reject(final Pattern pattern) {
-            rejectMatchers.add(new RegexpClassNameMatcher(pattern));
-            return this;
-        }
-
-        /**
-         * Rejects the wildcard specified classes for deserialization, even if they are otherwise accepted.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param patterns Wildcard file name patterns as defined by {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String)
-         *                 FilenameUtils.wildcardMatch}
-         * @return this instance.
-         */
-        public ObjectStreamClassPredicate reject(final String... patterns) {
-            Stream.of(patterns).map(WildcardClassNameMatcher::new).forEach(rejectMatchers::add);
-            return this;
-        }
-
-        /**
-         * Tests that the ObjectStreamClass conforms to requirements.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param objectStreamClass The ObjectStreamClass to test.
-         * @return true if the input is accepted, false if rejected, false if neither.
-         */
-        @Override
-        public boolean test(final ObjectStreamClass objectStreamClass) {
-            return test(objectStreamClass.getName());
-        }
-
-        /**
-         * Tests that the class name conforms to requirements.
-         * <p>
-         * The reject list takes precedence over the accept list.
-         * </p>
-         *
-         * @param name The class name to test.
-         * @return true if the input is accepted, false if rejected, false if neither.
-         */
-        public boolean test(final String name) {
-            // The reject list takes precedence over the accept list.
-            for (final ClassNameMatcher m : rejectMatchers) {
-                if (m.matches(name)) {
-                    return false;
-                }
-            }
-            for (final ClassNameMatcher m : acceptMatchers) {
-                if (m.matches(name)) {
-                    return true;
-                }
-            }
-            return false;
-        }
-
-    }
-
     /**
      * Constructs a new {@link Builder}.
      *

src/test/java/org/apache/commons/io/serialization/ValidatingObjectInputStreamTest.java

@@ -34,7 +34,6 @@
 import java.util.regex.Pattern;
 
 import org.apache.commons.io.serialization.ValidatingObjectInputStream.Builder;
-import org.apache.commons.io.serialization.ValidatingObjectInputStream.ObjectStreamClassPredicate;
 import org.apache.commons.lang3.SerializationUtils;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;