aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorReentrantReadWriteLock.java
blob: 0cc5ef5556c8c9daaa0a08762f6179f78b4cd66a (plain)
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
77
78
79
80
81
82
83
84
85
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.plugins.context.locking.curator;

import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.recipes.locks.InterProcessReadWriteLock;

/**
 * This class maps a Curator {@link InterProcessReadWriteLock} to a Java {@link ReadWriteLock}.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class CuratorReentrantReadWriteLock implements ReadWriteLock {
    // The Lock ID
    private final String lockId;

    // The Curator lock
    private final InterProcessReadWriteLock curatorReadWriteLock;

    // The Curator Lock facades for read and write locks
    private final CuratorLockFacade readLockFacade;
    private final CuratorLockFacade writeLockFacade;

    /**
     * Create a Curator lock.
     *
     * @param curatorFramework the Curator framework to use to create the lock
     * @param lockId The unique ID of the lock.
     */
    public CuratorReentrantReadWriteLock(final CuratorFramework curatorFramework, final String lockId) {
        this.lockId = lockId;

        // Create the Curator lock
        curatorReadWriteLock = new InterProcessReadWriteLock(curatorFramework, lockId);

        // Create the lock facades
        readLockFacade = new CuratorLockFacade(curatorReadWriteLock.readLock(), lockId);
        writeLockFacade = new CuratorLockFacade(curatorReadWriteLock.writeLock(), lockId);
    }

    /**
     * Get the lock Id of the lock.
     *
     * @return the lock ID
     */
    public String getLockId() {
        return lockId;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Lock readLock() {
        return readLockFacade;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Lock writeLock() {
        return writeLockFacade;
    }
}