View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  package org.apache.http.conn;
28  
29  import java.io.IOException;
30  import java.io.InputStream;
31  
32  import org.apache.http.util.Args;
33  
34  /**
35   * Basic implementation of {@link EofSensorWatcher}. The underlying connection
36   * is released on close or EOF.
37   *
38   * @since 4.0
39   *
40   * @deprecated (4.3) do not use.
41   */
42  @Deprecated
43  public class BasicEofSensorWatcher implements EofSensorWatcher {
44  
45      /** The connection to auto-release. */
46      protected final ManagedClientConnection managedConn;
47  
48      /** Whether to keep the connection alive. */
49      protected final boolean attemptReuse;
50  
51      /**
52       * Creates a new watcher for auto-releasing a connection.
53       *
54       * @param conn      the connection to auto-release
55       * @param reuse     whether the connection should be re-used
56       */
57      public BasicEofSensorWatcher(final ManagedClientConnection conn,
58                                   final boolean reuse) {
59          Args.notNull(conn, "Connection");
60          managedConn = conn;
61          attemptReuse = reuse;
62      }
63  
64      @Override
65      public boolean eofDetected(final InputStream wrapped)
66          throws IOException {
67  
68          try {
69              if (attemptReuse) {
70                  // there may be some cleanup required, such as
71                  // reading trailers after the response body:
72                  wrapped.close();
73                  managedConn.markReusable();
74              }
75          } finally {
76              managedConn.releaseConnection();
77          }
78          return false;
79      }
80  
81      @Override
82      public boolean streamClosed(final InputStream wrapped)
83          throws IOException {
84  
85          try {
86              if (attemptReuse) {
87                  // this assumes that closing the stream will
88                  // consume the remainder of the response body:
89                  wrapped.close();
90                  managedConn.markReusable();
91              }
92          } finally {
93              managedConn.releaseConnection();
94          }
95          return false;
96      }
97  
98      @Override
99      public boolean streamAbort(final InputStream wrapped)
100         throws IOException {
101 
102         managedConn.abortConnection();
103         return false;
104     }
105 
106 }