org.firebirdsql.pool.PooledObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk17 Show documentation

JDBC Driver for the Firebird RDBMS

There is a newer version: 4.0.10.java7

/*
 * Firebird Open Source J2ee connector - jdbc driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a CVS history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.pool;

/**
 * Represents an object that can be stored in the pool.
 * 
 * @author Roman Rokytskyy
 */
public interface PooledObject {

    final long INSTANT_IN_USE = -1L;

    /**
     * Deallocate this object. This method deallocated the object
     * and releases all associated resources. This method is invoked when
     * object pool is shutdown and is needed to gracefully release resources.
     */
    void deallocate();
    
    /**
     * Check if this pooled object is still valid.
     * 
     * @return true when the object is valid.
     */
    boolean isValid();
    
    /**
     * Check whether this object is currently in pool or had been released
     * to the application.
     * 
     * @return true if the object is currently in pool. 
     */
    boolean isInPool();
    
    /**
     * Set the "inPool" flag to this object. This method should be called only
     * by the pool implementation.
     * 
     * @param inPool true if object is in pool, otherwise 
     * false.
     */
    void setInPool(boolean inPool);

    /**
     * @return The instant in time when this object was last used, or {@link #INSTANT_IN_USE} when object is currently in use.
     */
    long getInstantInPool();

    PooledConnectionQueue getOwningQueue();
}