michael@0: /*
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.impl.conn.tsccm;
michael@0: 
michael@0: import java.lang.ref.ReferenceQueue;
michael@0: import java.util.concurrent.TimeUnit;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
michael@0: import ch.boye.httpclientandroidlib.conn.OperatedClientConnection;
michael@0: import ch.boye.httpclientandroidlib.conn.ClientConnectionOperator;
michael@0: import ch.boye.httpclientandroidlib.conn.routing.HttpRoute;
michael@0: import ch.boye.httpclientandroidlib.impl.conn.AbstractPoolEntry;
michael@0: 
michael@0: /**
michael@0:  * Basic implementation of a connection pool entry.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @NotThreadSafe
michael@0: public class BasicPoolEntry extends AbstractPoolEntry {
michael@0: 
michael@0:     private final long created;
michael@0: 
michael@0:     private long updated;
michael@0:     private long validUntil;
michael@0:     private long expiry;
michael@0: 
michael@0:     /**
michael@0:      * @deprecated do not use
michael@0:      */
michael@0:     @Deprecated
michael@0:     public BasicPoolEntry(ClientConnectionOperator op,
michael@0:                           HttpRoute route,
michael@0:                           ReferenceQueue<Object> queue) {
michael@0:         super(op, route);
michael@0:         if (route == null) {
michael@0:             throw new IllegalArgumentException("HTTP route may not be null");
michael@0:         }
michael@0:         this.created = System.currentTimeMillis();
michael@0:         this.validUntil = Long.MAX_VALUE;
michael@0:         this.expiry = this.validUntil;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a new pool entry.
michael@0:      *
michael@0:      * @param op      the connection operator
michael@0:      * @param route   the planned route for the connection
michael@0:      */
michael@0:     public BasicPoolEntry(ClientConnectionOperator op,
michael@0:                           HttpRoute route) {
michael@0:         this(op, route, -1, TimeUnit.MILLISECONDS);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a new pool entry with a specified maximum lifetime.
michael@0:      *
michael@0:      * @param op        the connection operator
michael@0:      * @param route     the planned route for the connection
michael@0:      * @param connTTL   maximum lifetime of this entry, <=0 implies "infinity"
michael@0:      * @param timeunit  TimeUnit of connTTL
michael@0:      *
michael@0:      * @since 4.1
michael@0:      */
michael@0:     public BasicPoolEntry(ClientConnectionOperator op,
michael@0:                           HttpRoute route, long connTTL, TimeUnit timeunit) {
michael@0:         super(op, route);
michael@0:         if (route == null) {
michael@0:             throw new IllegalArgumentException("HTTP route may not be null");
michael@0:         }
michael@0:         this.created = System.currentTimeMillis();
michael@0:         if (connTTL > 0) {
michael@0:             this.validUntil = this.created + timeunit.toMillis(connTTL);
michael@0:         } else {
michael@0:             this.validUntil = Long.MAX_VALUE;
michael@0:         }
michael@0:         this.expiry = this.validUntil;
michael@0:     }
michael@0: 
michael@0:     protected final OperatedClientConnection getConnection() {
michael@0:         return super.connection;
michael@0:     }
michael@0: 
michael@0:     protected final HttpRoute getPlannedRoute() {
michael@0:         return super.route;
michael@0:     }
michael@0: 
michael@0:     @Deprecated
michael@0:     protected final BasicPoolEntryRef getWeakRef() {
michael@0:         return null;
michael@0:     }
michael@0: 
michael@0:     @Override
michael@0:     protected void shutdownEntry() {
michael@0:         super.shutdownEntry();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @since 4.1
michael@0:      */
michael@0:     public long getCreated() {
michael@0:         return this.created;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @since 4.1
michael@0:      */
michael@0:     public long getUpdated() {
michael@0:         return this.updated;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @since 4.1
michael@0:      */
michael@0:     public long getExpiry() {
michael@0:         return this.expiry;
michael@0:     }
michael@0: 
michael@0:     public long getValidUntil() {
michael@0:         return this.validUntil;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @since 4.1
michael@0:      */
michael@0:     public void updateExpiry(long time, TimeUnit timeunit) {
michael@0:         this.updated = System.currentTimeMillis();
michael@0:         long newExpiry;
michael@0:         if (time > 0) {
michael@0:             newExpiry = this.updated + timeunit.toMillis(time);
michael@0:         } else {
michael@0:             newExpiry = Long.MAX_VALUE;
michael@0:         }
michael@0:         this.expiry = Math.min(validUntil, newExpiry);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @since 4.1
michael@0:      */
michael@0:     public boolean isExpired(long now) {
michael@0:         return now >= this.expiry;
michael@0:     }
michael@0: 
michael@0: }
michael@0: 
michael@0: