View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.pool2.impl;
18  
19  import org.apache.commons.pool2.PooledObject;
20  
21  /**
22   * Provides the default implementation of {@link EvictionPolicy} used by the
23   * pools. Objects will be evicted if the following conditions are met:
24   * <ul>
25   * <li>the object has been idle longer than
26   *     {@link GenericObjectPool#getMinEvictableIdleTimeMillis()} /
27   *     {@link GenericKeyedObjectPool#getMinEvictableIdleTimeMillis()}</li>
28   * <li>there are more than {@link GenericObjectPool#getMinIdle()} /
29   *     {@link GenericKeyedObjectPoolConfig#getMinIdlePerKey()} idle objects in
30   *     the pool and the object has been idle for longer than
31   *     {@link GenericObjectPool#getSoftMinEvictableIdleTimeMillis()} /
32   *     {@link GenericKeyedObjectPool#getSoftMinEvictableIdleTimeMillis()}
33   * </ul>
34   * <p>
35   * This class is immutable and thread-safe.
36   * </p>
37   *
38   * @param <T> the type of objects in the pool
39   *
40   * @since 2.0
41   */
42  public class DefaultEvictionPolicy<T> implements EvictionPolicy<T> {
43  
44      @Override
45      public boolean evict(final EvictionConfig config, final PooledObject<T> underTest,
46              final int idleCount) {
47  
48          if ((config.getIdleSoftEvictTime() < underTest.getIdleTimeMillis() &&
49                  config.getMinIdle() < idleCount) ||
50                  config.getIdleEvictTime() < underTest.getIdleTimeMillis()) {
51              return true;
52          }
53          return false;
54      }
55  }