View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.vfs2.provider.http5;
18  
19  import java.io.IOException;
20  
21  import org.apache.commons.vfs2.util.MonitorInputStream;
22  import org.apache.hc.core5.http.ClassicHttpResponse;
23  import org.apache.hc.core5.http.io.entity.NullEntity;
24  
25  /**
26   * An InputStream that cleans up the {@code org.apache.hc.core5.http.ClassicHttpResponse} on close.
27   */
28  final class MonitoredHttpResponseContentInputStream extends MonitorInputStream {
29  
30      private final ClassicHttpResponse httpResponse;
31  
32      public MonitoredHttpResponseContentInputStream(final ClassicHttpResponse httpResponse) throws IOException {
33          super(httpResponse.getEntity().getContent());
34          this.httpResponse = httpResponse;
35      }
36  
37      public MonitoredHttpResponseContentInputStream(final ClassicHttpResponse httpResponse, final int bufferSize) throws IOException {
38          super(httpResponse.getEntity().getContent(), bufferSize);
39          this.httpResponse = httpResponse;
40      }
41  
42      /**
43       * Prevent closing the stream itself if the httpResponse is closeable.
44       * Closing the stream may consume all remaining data no matter how large (VFS-805).
45       */
46      @Override
47      protected void closeSuper() throws IOException {
48          // Suppressed close() invocation on the underlying input stream
49      }
50  
51      @Override
52      protected void onClose() throws IOException {
53          // Replace the response's entity with a dummy entity in order to prevent
54          // exhausting all data (VFS-805)
55          httpResponse.setEntity(NullEntity.INSTANCE);
56          // Note that this also calls close on the dummy entity
57          httpResponse.close();
58      }
59  
60  }