001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.pool2;
018
019/**
020 * A base implementation of <code>PoolableObjectFactory</code>.
021 * <p>
022 * All operations defined here are essentially no-op's.
023 * <p>
024 * This class is immutable, and therefore thread-safe
025 *
026 * @param <T> Type of element managed in this factory.
027 *
028 * @see PooledObjectFactory
029 * @see BaseKeyedPooledObjectFactory
030 *
031 * @version $Revision: 1333925 $
032 *
033 * @since 2.0
034 */
035public abstract class BasePooledObjectFactory<T> implements PooledObjectFactory<T> {
036    /**
037     * Creates an object instance, to be wrapped in a {@link PooledObject}.
038     * <p>This method <strong>must</strong> support concurrent, multi-threaded
039     * activation.</p>
040     *
041     * @return an instance to be served by the pool
042     *
043     * @throws Exception if there is a problem creating a new instance,
044     *    this will be propagated to the code requesting an object.
045     */
046    public abstract T create() throws Exception;
047
048    /**
049     * Wrap the provided instance with an implementation of
050     * {@link PooledObject}.
051     *
052     * @param obj the instance to wrap
053     *
054     * @return The provided instance, wrapped by a {@link PooledObject}
055     */
056    public abstract PooledObject<T> wrap(T obj);
057
058    @Override
059    public PooledObject<T> makeObject() throws Exception {
060        return wrap(create());
061    }
062
063    /**
064     *  No-op.
065     *
066     *  @param p ignored
067     */
068    @Override
069    public void destroyObject(PooledObject<T> p)
070        throws Exception  {
071    }
072
073    /**
074     * This implementation always returns {@code true}.
075     *
076     * @param p ignored
077     *
078     * @return {@code true}
079     */
080    @Override
081    public boolean validateObject(PooledObject<T> p) {
082        return true;
083    }
084
085    /**
086     *  No-op.
087     *
088     *  @param p ignored
089     */
090    @Override
091    public void activateObject(PooledObject<T> p) throws Exception {
092    }
093
094    /**
095     *  No-op.
096     *
097     * @param p ignored
098     */
099    @Override
100    public void passivateObject(PooledObject<T> p)
101        throws Exception {
102    }
103}