michael@0: /*
michael@0:  * $Revision $
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.conn;
michael@0: 
michael@0: import java.io.InputStream;
michael@0: import java.io.IOException;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
michael@0: 
michael@0: /**
michael@0:  * Basic implementation of {@link EofSensorWatcher}. The underlying connection
michael@0:  * is released on close or EOF.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @NotThreadSafe
michael@0: public class BasicEofSensorWatcher implements EofSensorWatcher {
michael@0: 
michael@0:     /** The connection to auto-release. */
michael@0:     protected final ManagedClientConnection managedConn;
michael@0: 
michael@0:     /** Whether to keep the connection alive. */
michael@0:     protected final boolean attemptReuse;
michael@0: 
michael@0:     /**
michael@0:      * Creates a new watcher for auto-releasing a connection.
michael@0:      *
michael@0:      * @param conn      the connection to auto-release
michael@0:      * @param reuse     whether the connection should be re-used
michael@0:      */
michael@0:     public BasicEofSensorWatcher(ManagedClientConnection conn,
michael@0:                                  boolean reuse) {
michael@0:         if (conn == null)
michael@0:             throw new IllegalArgumentException
michael@0:                 ("Connection may not be null.");
michael@0: 
michael@0:         managedConn = conn;
michael@0:         attemptReuse = reuse;
michael@0:     }
michael@0: 
michael@0:     public boolean eofDetected(InputStream wrapped)
michael@0:         throws IOException {
michael@0: 
michael@0:         try {
michael@0:             if (attemptReuse) {
michael@0:                 // there may be some cleanup required, such as
michael@0:                 // reading trailers after the response body:
michael@0:                 wrapped.close();
michael@0:                 managedConn.markReusable();
michael@0:             }
michael@0:         } finally {
michael@0:             managedConn.releaseConnection();
michael@0:         }
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     public boolean streamClosed(InputStream wrapped)
michael@0:         throws IOException {
michael@0: 
michael@0:         try {
michael@0:             if (attemptReuse) {
michael@0:                 // this assumes that closing the stream will
michael@0:                 // consume the remainder of the response body:
michael@0:                 wrapped.close();
michael@0:                 managedConn.markReusable();
michael@0:             }
michael@0:         } finally {
michael@0:             managedConn.releaseConnection();
michael@0:         }
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     public boolean streamAbort(InputStream wrapped)
michael@0:         throws IOException {
michael@0: 
michael@0:         managedConn.abortConnection();
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0: }