9d4a5ca8fb9bdbfb07d12ef133ccf8205541091b
[policy/apex-pdp.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
4  * ================================================================================
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * 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  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.apex.plugins.context.locking.hazelcast;
22
23 import com.hazelcast.core.HazelcastInstance;
24 import com.hazelcast.core.ILock;
25
26 import java.util.concurrent.locks.Lock;
27 import java.util.concurrent.locks.ReadWriteLock;
28
29 /**
30  * This class maps a Hazelcast {@link ILock} to a Java {@link ReadWriteLock}.
31  *
32  * @author Liam Fallon (liam.fallon@ericsson.com)
33  */
34 public class HazelcastLock implements ReadWriteLock {
35     // The Lock ID
36     private final String lockId;
37
38     // The hazelcast lock
39     private final ILock readLock;
40     private final ILock writeLock;
41
42     /**
43      * Create a Hazelcast lock.
44      *
45      * @param hazelcastInstance the hazelcast instance to use to create the lock
46      * @param lockId The unique ID of the lock.
47      */
48     public HazelcastLock(final HazelcastInstance hazelcastInstance, final String lockId) {
49         this.lockId = lockId;
50
51         // Create the Hazelcast read and write locks
52         readLock = hazelcastInstance.getLock(lockId + "_READ");
53         writeLock = hazelcastInstance.getLock(lockId + "_WRITE");
54     }
55
56     /**
57      * Get the lock Id of the lock.
58      *
59      * @return the lock ID
60      */
61     public String getLockId() {
62         return lockId;
63     }
64
65     /*
66      * (non-Javadoc)
67      *
68      * @see java.util.concurrent.locks.ReadWriteLock#readLock()
69      */
70     @Override
71     public Lock readLock() {
72         return readLock;
73     }
74
75     /*
76      * (non-Javadoc)
77      *
78      * @see java.util.concurrent.locks.ReadWriteLock#writeLock()
79      */
80     @Override
81     public Lock writeLock() {
82         return writeLock;
83     }
84 }