Merge "DefaultResourceFinderAdapter adds default implementation of remove() method which should always throw UnsupportedOperationException as defined in ResourceFinder. This enhancement also removes possible NPEs in some of the original remove() implementations."

Author: Marek Potociar

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/WebAppResourcesScanner.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012-2015 Oracle and/or its affiliates. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
@@ -48,7 +48,7 @@
 
 import javax.servlet.ServletContext;
 
-import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 import org.glassfish.jersey.server.internal.scanning.JarFileScanner;
 import org.glassfish.jersey.server.internal.scanning.ResourceFinderException;
 import org.glassfish.jersey.server.internal.scanning.ResourceFinderStack;
@@ -58,7 +58,7 @@
  *
  * @author Paul Sandoz
  */
-class WebAppResourcesScanner implements ResourceFinder {
+class WebAppResourcesScanner extends AbstractResourceFinderAdapter {
 
 //    private final String[] paths;
     private final ServletContext sc;
@@ -85,7 +85,7 @@ private void processPaths(String... paths) {
                 break;
             }
 
-            resourceFinderStack.push(new ResourceFinder() {
+            resourceFinderStack.push(new AbstractResourceFinderAdapter() {
 
                 private Deque<String> resourcePathsStack = new LinkedList<String>() {
 
@@ -132,11 +132,6 @@ public String next() {
                     throw new NoSuchElementException();
                 }
 
-                @Override
-                public void remove() {
-                    throw new UnsupportedOperationException();
-                }
-
                 @Override
                 public InputStream open() {
                     return sc.getResourceAsStream(current);
@@ -161,11 +156,6 @@ public String next() {
         return resourceFinderStack.next();
     }
 
-    @Override
-    public void remove() {
-        resourceFinderStack.remove();
-    }
-
     @Override
     public InputStream open() {
         return resourceFinderStack.open();

core-server/src/main/java/org/glassfish/jersey/server/internal/AbstractResourceFinderAdapter.java

@@ -0,0 +1,59 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.server.internal;
+
+import org.glassfish.jersey.server.ResourceFinder;
+
+/**
+ * This class provides partial default implementation of {@link org.glassfish.jersey.server.ResourceFinder}.
+ *
+ * @author Stepan Vavra (stepan.vavra at oracle.com)
+ * @since 2.18
+ */
+public abstract class AbstractResourceFinderAdapter implements ResourceFinder {
+
+    /**
+     * Default implementation of {@link #remove()} which complies with the defined contract.
+     */
+    @Override
+    public void remove() {
+        throw new UnsupportedOperationException();
+    }
+}

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/BundleSchemeResourceFinderFactory.java

@@ -47,7 +47,7 @@
 import java.util.NoSuchElementException;
 import java.util.Set;
 
-import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 
 /**
  * Preparations for OSGi support.
@@ -72,7 +72,7 @@ public BundleSchemeScanner create(URI uri, boolean recursive) {
         return new BundleSchemeScanner(uri);
     }
 
-    private class BundleSchemeScanner implements ResourceFinder {
+    private class BundleSchemeScanner extends AbstractResourceFinderAdapter {
 
         private BundleSchemeScanner(URI uri) {
             this.uri = uri;
@@ -107,11 +107,6 @@ public String next() {
             throw new NoSuchElementException();
         }
 
-        @Override
-        public void remove() {
-            throw new UnsupportedOperationException();
-        }
-
         @Override
         public InputStream open() {
             if (!accessed) {

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/FileSchemeResourceFinderFactory.java

@@ -49,7 +49,7 @@
 import java.util.Set;
 import java.util.Stack;
 
-import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 
 /**
  * A "file" scheme URI scanner that recursively scans directories.
@@ -75,7 +75,7 @@ public FileSchemeScanner create(URI uri, boolean recursive) {
         return new FileSchemeScanner(uri, recursive);
     }
 
-    private class FileSchemeScanner implements ResourceFinder {
+    private class FileSchemeScanner extends AbstractResourceFinderAdapter {
 
         private final ResourceFinderStack resourceFinderStack;
         private final boolean recursive;
@@ -97,11 +97,6 @@ public String next() {
             return resourceFinderStack.next();
         }
 
-        @Override
-        public void remove() {
-            resourceFinderStack.remove();
-        }
-
         @Override
         public InputStream open() {
             return resourceFinderStack.open();
@@ -113,7 +108,7 @@ public void reset() {
         }
 
         private void processFile(final File f) {
-            resourceFinderStack.push(new ResourceFinder() {
+            resourceFinderStack.push(new AbstractResourceFinderAdapter() {
 
                 Stack<File> files = new Stack<File>() {{
                     if (f.isDirectory()) {
@@ -158,11 +153,6 @@ public String next() {
                     throw new NoSuchElementException();
                 }
 
-                @Override
-                public void remove() {
-                    throw new UnsupportedOperationException();
-                }
-
                 @Override
                 public InputStream open() {
                     try {

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/FilesScanner.java

@@ -48,15 +48,15 @@
 import java.util.Stack;
 
 import org.glassfish.jersey.internal.util.Tokenizer;
-import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 
 /**
  * A scanner that recursively scans directories and jar files.
  * Files or jar entries are reported to a {@link ResourceProcessor}.
  *
  * @author Paul Sandoz
  */
-public class FilesScanner implements ResourceFinder {
+public class FilesScanner extends AbstractResourceFinderAdapter {
 
     private ResourceFinderStack resourceFinderStack = new ResourceFinderStack();
 
@@ -92,7 +92,7 @@ private void processFile(final File f) {
             }
 
         } else {
-            resourceFinderStack.push(new ResourceFinder() {
+            resourceFinderStack.push(new AbstractResourceFinderAdapter() {
 
                 Stack<File> files = new Stack<File>() {{
                     if (f.isDirectory()) {
@@ -139,11 +139,6 @@ public String next() {
                     throw new NoSuchElementException();
                 }
 
-                @Override
-                public void remove() {
-                    throw new UnsupportedOperationException();
-                }
-
                 @Override
                 public InputStream open() {
                     try {
@@ -170,11 +165,6 @@ public String next() {
         return resourceFinderStack.next();
     }
 
-    @Override
-    public void remove() {
-        resourceFinderStack.remove();
-    }
-
     @Override
     public InputStream open() {
         return resourceFinderStack.open();

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/JarFileScanner.java

@@ -47,14 +47,14 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 
 /**
  * A utility class that scans entries in jar files.
  *
  * @author Paul Sandoz
  */
-public final class JarFileScanner implements ResourceFinder {
+public final class JarFileScanner extends AbstractResourceFinderAdapter {
 
     private static final Logger LOGGER = Logger.getLogger(JarFileScanner.class.getName());
     // platform independent file separator within the jar file
@@ -130,11 +130,6 @@ public String next() {
         throw new NoSuchElementException();
     }
 
-    @Override
-    public void remove() {
-        throw new UnsupportedOperationException();
-    }
-
     @Override
     public void reset() {
         throw new UnsupportedOperationException();

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/JarZipSchemeResourceFinderFactory.java

@@ -51,7 +51,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 import org.glassfish.jersey.uri.UriComponent;
 
 /**
@@ -87,7 +87,7 @@ public JarZipSchemeScanner create(final URI uri, boolean recursive) {
         }
     }
 
-    private class JarZipSchemeScanner implements ResourceFinder {
+    private class JarZipSchemeScanner extends AbstractResourceFinderAdapter {
 
         private InputStream inputStream;
         private JarFileScanner jarFileScanner;
@@ -117,11 +117,6 @@ public String next() {
             return jarFileScanner.next();
         }
 
-        @Override
-        public void remove() {
-            jarFileScanner.remove();
-        }
-
         @Override
         public InputStream open() {
             return jarFileScanner.open();

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/PackageNamesScanner.java

@@ -53,7 +53,7 @@
 import org.glassfish.jersey.internal.OsgiRegistry;
 import org.glassfish.jersey.internal.util.ReflectionHelper;
 import org.glassfish.jersey.internal.util.Tokenizer;
-import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 import org.glassfish.jersey.uri.UriComponent;
 
 /**
@@ -85,7 +85,7 @@
  * @author Paul Sandoz
  * @author Jakub Podlesak (jakub.podlesak at oracle.com)
  */
-public class PackageNamesScanner implements ResourceFinder {
+public class PackageNamesScanner extends AbstractResourceFinderAdapter {
 
     private final boolean recursive;
     private final String[] packages;
@@ -170,11 +170,6 @@ public String next() {
         return resourceFinderStack.next();
     }
 
-    @Override
-    public void remove() {
-        resourceFinderStack.remove();
-    }
-
     @Override
     public InputStream open() {
         return resourceFinderStack.open();

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/ResourceFinderStack.java

@@ -45,6 +45,7 @@
 import java.util.NoSuchElementException;
 import java.util.Stack;
 
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 import org.glassfish.jersey.server.ResourceFinder;
 
 /**
@@ -54,7 +55,7 @@
  *
  * @author Pavel Bucek (pavel.bucek at oracle.com)
  */
-public class ResourceFinderStack implements ResourceFinder {
+public class ResourceFinderStack extends AbstractResourceFinderAdapter {
 
     private final Deque<ResourceFinder> stack = new LinkedList<ResourceFinder>();
     private ResourceFinder current = null;
@@ -90,11 +91,6 @@ public String next() {
         throw new NoSuchElementException();
     }
 
-    @Override
-    public void remove() {
-        current.remove();
-    }
-
     @Override
     public InputStream open() {
         return current.open();