JERSEY-2878: Enabled InputStream.close() on jersey client returned stream by unwrapping InputStream from UnCloseableInputStream in InputStreamProvider, if backing stream KeepAliveStream is used, throwing IOException on access if stream is closed in order to comply with InputStream contract.

stepanv · stepanv · commit 4d7ce9e4b160 · 2015-08-12T10:15:19.000+02:00
Change-Id: I48d64ac9d3ed9d03553f156570d70a16400aef8f
diff --git a/core-client/src/main/java/org/glassfish/jersey/client/internal/HttpUrlConnector.java b/core-client/src/main/java/org/glassfish/jersey/client/internal/HttpUrlConnector.java
@@ -185,34 +185,71 @@ public InputStream get() throws IOException {
                 }
             });
 
+            private volatile boolean closed = false;
+
+            /**
+             * The motivation for this method is to straighten up a behaviour of {@link sun.net.www.http.KeepAliveStream} which
+             * is used here as a backing {@link InputStream}. The problem is that its access methods (e.g., {@link
+             * sun.net.www.http.KeepAliveStream#read()}) do not throw {@link IOException} if the stream is closed. This behaviour
+             * contradicts with {@link InputStream} contract.
+             * <p/>
+             * This is a part of fix of JERSEY-2878
+             * <p/>
+             * Note that {@link java.io.FilterInputStream} also changes the contract of
+             * {@link java.io.FilterInputStream#read(byte[], int, int)} as it doesn't state that closed stream causes an {@link
+             * IOException} which might be questionable. Nevertheless, our contract is {@link InputStream} and as such, the
+             * stream we're offering must comply with it.
+             *
+             * @throws IOException
+             */
+            private void throwIOExceptionIfClosed() throws IOException {
+                if (closed) {
+                    throw new IOException("Stream closed");
+                }
+            }
+
             @Override
             public int read() throws IOException {
-                return in.get().read();
+                int result = in.get().read();
+                throwIOExceptionIfClosed();
+                return result;
             }
 
             @Override
             public int read(byte[] b) throws IOException {
-                return in.get().read(b);
+                int result = in.get().read(b);
+                throwIOExceptionIfClosed();
+                return result;
             }
 
             @Override
             public int read(byte[] b, int off, int len) throws IOException {
-                return in.get().read(b, off, len);
+                int result = in.get().read(b, off, len);
+                throwIOExceptionIfClosed();
+                return result;
             }
 
             @Override
             public long skip(long n) throws IOException {
-                return in.get().skip(n);
+                long result = in.get().skip(n);
+                throwIOExceptionIfClosed();
+                return result;
             }
 
             @Override
             public int available() throws IOException {
-                return in.get().available();
+                int result = in.get().available();
+                throwIOExceptionIfClosed();
+                return result;
             }
 
             @Override
             public void close() throws IOException {
-                in.get().close();
+                try {
+                    in.get().close();
+                } finally {
+                    closed = true;
+                }
             }
 
             @Override
@@ -227,6 +264,7 @@ public void mark(int readLimit) {
             @Override
             public void reset() throws IOException {
                 in.get().reset();
+                throwIOExceptionIfClosed();
             }
 
             @Override
diff --git a/core-common/src/main/java/org/glassfish/jersey/message/internal/InputStreamProvider.java b/core-common/src/main/java/org/glassfish/jersey/message/internal/InputStreamProvider.java
@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2010-2014 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010-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
@@ -75,7 +75,7 @@ public InputStream readFrom(
             MediaType mediaType,
             MultivaluedMap<String, String> httpHeaders,
             InputStream entityStream) throws IOException {
-        return entityStream;
+        return ReaderInterceptorExecutor.closeableInputStream(entityStream);
     }
 
     @Override
diff --git a/core-common/src/main/java/org/glassfish/jersey/message/internal/ReaderInterceptorExecutor.java b/core-common/src/main/java/org/glassfish/jersey/message/internal/ReaderInterceptorExecutor.java
@@ -250,22 +250,17 @@ private Object invokeReadFrom(final ReaderInterceptorContext context, final Mess
 
             final TracingLogger tracingLogger = getTracingLogger();
             final long timestamp = tracingLogger.timestamp(MsgTraceEvent.MBR_READ_FROM);
-            final UnCloseableInputStream stream = new UnCloseableInputStream(input, reader);
+            final InputStream stream = new UnCloseableInputStream(input, reader);
 
             try {
-                final Object entity;
+                return reader.readFrom(context.getType(), context.getGenericType(), context.getAnnotations(),
+                        context.getMediaType(), context.getHeaders(), stream);
+            } catch (final NoContentException ex) {
                 if (translateNce) {
-                    try {
-                        entity = reader.readFrom(context.getType(), context.getGenericType(), context.getAnnotations(),
-                                context.getMediaType(), context.getHeaders(), stream);
-                    } catch (final NoContentException ex) {
-                        throw new BadRequestException(ex);
-                    }
+                    throw new BadRequestException(ex);
                 } else {
-                    entity = reader.readFrom(context.getType(), context.getGenericType(), context.getAnnotations(),
-                            context.getMediaType(), context.getHeaders(), stream);
+                    throw ex;
                 }
-                return entity;
             } finally {
                 tracingLogger.logDuration(MsgTraceEvent.MBR_READ_FROM, timestamp, reader);
             }
@@ -332,5 +327,25 @@ public void close() throws IOException {
                 LOGGER.log(Level.FINE, LocalizationMessages.MBR_TRYING_TO_CLOSE_STREAM(reader.getClass()));
             }
         }
+
+        private InputStream unwrap() {
+            return original;
+        }
+    }
+
+    /**
+     * Make the {@link InputStream} able to close.
+     * <p/>
+     * The purpose of this utility method is to undo effect of {@link ReaderInterceptorExecutor.UnCloseableInputStream}.
+     *
+     * @param inputStream Potential {@link ReaderInterceptorExecutor.UnCloseableInputStream} to undo its effect
+     * @return Input stream that is possible to close
+     */
+    static InputStream closeableInputStream(InputStream inputStream) {
+        if (inputStream instanceof ReaderInterceptorExecutor.UnCloseableInputStream) {
+            return ((ReaderInterceptorExecutor.UnCloseableInputStream) inputStream).unwrap();
+        } else {
+            return inputStream;
+        }
     }
 }
diff --git a/tests/integration/jersey-2878/pom.xml b/tests/integration/jersey-2878/pom.xml
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    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.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.glassfish.jersey.tests.integration</groupId>
+        <artifactId>project</artifactId>
+        <version>2.21-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>jersey-2878</artifactId>
+    <packaging>war</packaging>
+    <name>jersey-tests-integration-jersey-2878</name>
+
+    <description>
+        Reproducer of JERSEY-2878.
+    </description>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.glassfish.jersey.containers</groupId>
+            <artifactId>jersey-container-servlet</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.glassfish.jersey.test-framework.providers</groupId>
+            <artifactId>jersey-test-framework-provider-external</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.glassfish.jersey.connectors</groupId>
+            <artifactId>jersey-apache-connector</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.mortbay.jetty</groupId>
+                <artifactId>jetty-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
diff --git a/tests/integration/jersey-2878/src/main/java/org/glassfish/jersey/tests/integration/jersey2878/TestApplication.java b/tests/integration/jersey-2878/src/main/java/org/glassfish/jersey/tests/integration/jersey2878/TestApplication.java
@@ -0,0 +1,58 @@
+/*
+ * 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.tests.integration.jersey2878;
+
+import javax.ws.rs.ApplicationPath;
+
+import org.glassfish.jersey.server.ResourceConfig;
+
+/**
+ * Jersey application for JERSEY-2878.
+ *
+ * @author Stepan Vavra (stepan.vavra at oracle.com)
+ */
+@ApplicationPath("/")
+public class TestApplication extends ResourceConfig {
+
+    public TestApplication() {
+        register(TestResource.class);
+    }
+}
diff --git a/tests/integration/jersey-2878/src/main/java/org/glassfish/jersey/tests/integration/jersey2878/TestResource.java b/tests/integration/jersey-2878/src/main/java/org/glassfish/jersey/tests/integration/jersey2878/TestResource.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.tests.integration.jersey2878;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+
+/**
+ * A simple resource that returns a string.
+ *
+ * @author Stepan Vavra (stepan.vavra at oracle.com)
+ */
+@Path("string")
+public class TestResource {
+
+    @GET
+    public String string() {
+        return "Hello, World! "
+                + "In production this response would be large, "
+                + "and unsuitable for buffering in memory";
+    }
+}
diff --git a/tests/integration/jersey-2878/src/test/java/org/glassfish/jersey/tests/integration/jersey2878/Jersey2878ApacheITCase.java b/tests/integration/jersey-2878/src/test/java/org/glassfish/jersey/tests/integration/jersey2878/Jersey2878ApacheITCase.java
diff --git a/tests/integration/jersey-2878/src/test/java/org/glassfish/jersey/tests/integration/jersey2878/Jersey2878ITCase.java b/tests/integration/jersey-2878/src/test/java/org/glassfish/jersey/tests/integration/jersey2878/Jersey2878ITCase.java
diff --git a/tests/integration/pom.xml b/tests/integration/pom.xml

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/*`
`2`	`2`	`* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.`
`3`	`3`	`*`
`4`		`- * Copyright (c) 2010-2014 Oracle and/or its affiliates. All rights reserved.`
	`4`	`+ * Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.`
`5`	`5`	`*`
`6`	`6`	`* The contents of this file are subject to the terms of either the GNU`
`7`	`7`	`* General Public License Version 2 only ("GPL") or the Common Development`
`@@ -75,7 +75,7 @@ public InputStream readFrom(`
`75`	`75`	`MediaType mediaType,`
`76`	`76`	`MultivaluedMap<String, String> httpHeaders,`
`77`	`77`	`InputStream entityStream) throws IOException {`
`78`		`- return entityStream;`
	`78`	`+ return ReaderInterceptorExecutor.closeableInputStream(entityStream);`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`@Override`