org.apache.tomcat.dbcp.pool.BaseKeyedPoolableObjectFactory Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.dbcp.pool;
/**
* A base implementation of KeyedPoolableObjectFactory.
*
* All operations defined here are essentially no-op's.
*
*
* @see KeyedPoolableObjectFactory
*
* @author Rodney Waldhoff
* @version $Revision: 791907 $ $Date: 2009-07-07 12:56:33 -0400 (Tue, 07 Jul 2009) $
* @since Pool 1.0
*/
public abstract class BaseKeyedPoolableObjectFactory implements KeyedPoolableObjectFactory {
/**
* Create an instance that can be served by the pool.
*
* @param key the key used when constructing the object
* @return an instance that can be served by the pool
*/
public abstract Object makeObject(Object key)
throws Exception;
/**
* Destroy an instance no longer needed by the pool.
*
* The default implementation is a no-op.
*
*
* @param key the key used when selecting the instance
* @param obj the instance to be destroyed
*/
public void destroyObject(Object key, Object obj)
throws Exception {
}
/**
* Ensures that the instance is safe to be returned by the pool.
*
* The default implementation always returns true.
*
*
* @param key the key used when selecting the object
* @param obj the instance to be validated
* @return always true in the default implementation
*/
public boolean validateObject(Object key, Object obj) {
return true;
}
/**
* Reinitialize an instance to be returned by the pool.
*
* The default implementation is a no-op.
*
*
* @param key the key used when selecting the object
* @param obj the instance to be activated
*/
public void activateObject(Object key, Object obj)
throws Exception {
}
/**
* Uninitialize an instance to be returned to the idle object pool.
*
* The default implementation is a no-op.
*
*
* @param key the key used when selecting the object
* @param obj the instance to be passivated
*/
public void passivateObject(Object key, Object obj)
throws Exception {
}
}