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.impl;
018
019import org.apache.commons.pool2.PooledObject;
020
021/**
022 * Provides the default implementation of {@link EvictionPolicy} used by the
023 * pools. Objects will be evicted if the following conditions are met:
024 * <ul>
025 * <li>the object has been idle longer than
026 *     {@link GenericObjectPool#getMinEvictableIdleTimeMillis()} /
027 *     {@link GenericKeyedObjectPool#getMinEvictableIdleTimeMillis()}</li>
028 * <li>there are more than {@link GenericObjectPool#getMinIdle()} /
029 *     {@link GenericKeyedObjectPoolConfig#getMinIdlePerKey()} idle objects in
030 *     the pool and the object has been idle for longer than
031 *     {@link GenericObjectPool#getSoftMinEvictableIdleTimeMillis()} /
032 *     {@link GenericKeyedObjectPool#getSoftMinEvictableIdleTimeMillis()}
033 * </ul>
034 * <p>
035 * This class is immutable and thread-safe.
036 * </p>
037 *
038 * @param <T> the type of objects in the pool
039 *
040 * @since 2.0
041 */
042public class DefaultEvictionPolicy<T> implements EvictionPolicy<T> {
043
044    @Override
045    public boolean evict(final EvictionConfig config, final PooledObject<T> underTest,
046            final int idleCount) {
047
048        if ((config.getIdleSoftEvictTime() < underTest.getIdleTimeMillis() &&
049                config.getMinIdle() < idleCount) ||
050                config.getIdleEvictTime() < underTest.getIdleTimeMillis()) {
051            return true;
052        }
053        return false;
054    }
055}