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.tomcat.dbcp.pool2.impl;
18
19 import java.util.Collection;
20 import java.util.concurrent.locks.Condition;
21 import java.util.concurrent.locks.ReentrantLock;
22
23 /**
24  * This sub-class was created to expose the waiting threads so that they can be
25  * interrupted when the pool using the queue that uses this lock is closed. The
26  * class is intended for internal use only.
27  * <p>
28  * This class is intended to be thread-safe.
29  * </p>
30  *
31  * @since 2.0
32  */
33 class InterruptibleReentrantLock extends ReentrantLock {
34
35     private static final long serialVersionUID = 1L;
36
37     /**
38      * Create a new InterruptibleReentrantLock with the given fairness policy.
39      *
40      * @param fairness true means threads should acquire contended locks as if
41      * waiting in a FIFO queue
42      */
43     public InterruptibleReentrantLock(final boolean fairness) {
44         super(fairness);
45     }
46
47     /**
48      * Interrupt the threads that are waiting on a specific condition
49      *
50      * @param condition the condition on which the threads are waiting.
51      */
52     public void interruptWaiters(final Condition condition) {
53         final Collection<Thread> threads = getWaitingThreads(condition);
54         for (final Thread thread : threads) {
55             thread.interrupt();
56         }
57     }
58 }
59