aboutsummaryrefslogtreecommitdiffstats
path: root/vespajlib/src/main/java/com/yahoo/concurrent/classlock/ClassLocking.java
blob: 7c9403965acdab89fcc81fa56b93d94dd0afe30c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.concurrent.classlock;

import java.util.HashMap;
import java.util.Map;
import java.util.function.BooleanSupplier;

/**
 * This class is injectable to Vespa plugins and is used to acquire locks cross
 * application deployments.
 *
 * @author valerijf
 */
public class ClassLocking {

    private final Map<String, ClassLock> classLocks = new HashMap<>();
    private final Object monitor = new Object();

    /**
     * Locks key. This will block until the key is acquired.
     * Users of this <b>must</b> close any lock acquired.
     */
    public ClassLock lock(Class<?> clazz) {
        return lockWhile(clazz, () -> true);
    }

    /**
     * Locks key. This will block until the key is acquired or the interrupt condition is
     * no longer true. Condition is only checked at the start, everytime a lock is released
     * and when {@link #interrupt()} is called.
     *
     * Users of this <b>must</b> close any lock acquired.
     *
     * @throws LockInterruptException if interruptCondition returned false before
     * the lock could be acquired
     */
    public ClassLock lockWhile(Class<?> clazz, BooleanSupplier interruptCondition) {
        synchronized (monitor) {
            while (classLocks.containsKey(clazz.getName())) {
                try {
                    monitor.wait();
                } catch (InterruptedException ignored) {
                }

                if (!interruptCondition.getAsBoolean()) {
                    throw new LockInterruptException();
                }
            }

            ClassLock classLock = new ClassLock(this, clazz);
            classLocks.put(clazz.getName(), classLock);
            return classLock;
        }
    }

    void unlock(Class<?> clazz, ClassLock classLock) {
        synchronized (monitor) {
            if (classLock.equals(classLocks.get(clazz.getName()))) {
                classLocks.remove(clazz.getName());
                monitor.notifyAll();
            } else {
                throw new IllegalArgumentException("Lock has already been released");
            }
        }
    }

    /**
     * Notifies {@link #lockWhile} to check the interrupt condition
     */
    public void interrupt() {
        synchronized (monitor) {
            monitor.notifyAll();
        }
    }

}