src/java/org/apache/commons/pool/KeyedPoolableObjectFactory.java

/*
 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//pool/src/java/org/apache/commons/pool/KeyedPoolableObjectFactory.java,v 1.1 2001/04/14 16:40:47 rwaldhoff Exp $
 * $Revision: 1.1 $
 * $Date: 2001/04/14 16:40:47 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.commons.pool;

/**
 * A simple interface defining life-cycle methods for
 * <tt>Object</tt>s to be used in a
 * {@link KeyedObjectPool <tt>KeyedObjectPool</tt>}.
 * <p>
 * By contract, when an {@link KeyedObjectPool <tt>KeyedObjectPool</tt>}
 * delegates to a <tt>KeyedPoolableObjectFactory</tt>,
 * <ol>
 *  <li>
 *   {@link #makeObject(java.lang.Object) <tt>makeObject</tt>} is called whenever a new <tt>Object</tt>
 *   is needed.
 *  </li>
 *  <li>
 *   {@link #activateObject(java.lang.Object,java.lang.Object) <tt>activateObject</tt>} is invoked
 *   on every <tt>Object</tt> before it is returned from the
 *   {@link KeyedObjectPool <tt>KeyedObjectPool</tt>}.
 *  </li>
 *  <li>
 *   {@link #passivateObject(java.lang.Object,java.lang.Object) <tt>passivateObject</tt>} is invoked
 *   on every <tt>Object</tt> when it is returned to the
 *   {@link KeyedObjectPool <tt>KeyedObjectPool</tt>}.
 *  </li>
 *  <li>
 *   {@link #destroyObject(java.lang.Object,java.lang.Object) <tt>destroyObject</tt>} is invoked
 *   on every <tt>Object</tt> when it is being "dropped" from the
 *   {@link KeyedObjectPool <tt>KeyedObjectPool</tt>} (whether due to the response from
 *   {@link #validateObject(java.lang.Object,java.lang.Object) <tt>validateObject</tt>}, or
 *   for reasons specific to the {@link KeyedObjectPool <tt>KeyedObjectPool</tt>} implementation.)
 *  </li>
 *  <li>
 *   {@link #validateObject(java.lang.Object,java.lang.Object) <tt>validateObject</tt>} is invoked
 *   in an implementation-specific fashion to determine if an <tt>Object</tt>
 *   is still valid to be returned by the{@link KeyedObjectPool <tt>KeyedObjectPool</tt>}.
 *   It will only be invoked on an {@link #activateObject(java.lang.Object,java.lang.Object) "activated"}
 *   <tt>Object</tt>.
 *  </li>
 * </ol>
 *
 * @author Rodney Waldhoff
 * @version $Id: KeyedPoolableObjectFactory.java,v 1.1 2001/04/14 16:40:47 rwaldhoff Exp $
 *
 * @see KeyedObjectPool
 */
public interface KeyedPoolableObjectFactory {
    /**
     * Create an Object that can be returned by the pool.
     * @param key the key used when constructing the object
     * @return an Object that can be returned by the pool.
     */
    public abstract Object makeObject(Object key);

    /**
     * Destroy an Object no longer needed by the pool.
     * @param key the key used when selecting the object
     * @param obj the Object to be destroyed
     */
    public abstract void destroyObject(Object key, Object obj);

    /**
     * Ensures that the Object is safe to be returned by the pool.
     * Returns <tt>false</tt> if this object should be destroyed.
     * @param key the key used when selecting the object
     * @param obj the <tt>Object</tt> to be validated
     * @return <tt>false</tt> if this <i>obj</i> is not valid and should
     *         be dropped from the pool, <tt>true</tt> otherwise.
     */
    public abstract boolean validateObject(Object key, Object obj);

    /**
     * Reinitialize an Object to be returned by the pool.
     * @param key the key used when selecting the object
     * @param obj the <tt>Object</tt> to be activated
     */
    public abstract void activateObject(Object key, Object obj);

    /**
     * Uninitialize an Object to be returned to the pool.
     * @param key the key used when selecting the object
     * @param obj the <tt>Object</tt> to be passivated
     */
    public abstract void passivateObject(Object key, Object obj);
}