plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java

   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 import java.util.concurrent.locks.Lock;
  26 import java.util.concurrent.locks.ReadWriteLock;
  27
  28 /**
  29  * This class maps a Hazelcast {@link ILock} to a Java {@link ReadWriteLock}.
  30  *
  31  * @author Liam Fallon (liam.fallon@ericsson.com)
  32  */
  33 public class HazelcastLock implements ReadWriteLock {
  34     // The Lock ID
  35     private final String lockId;
  36
  37     // The hazelcast lock
  38     private final ILock readLock;
  39     private final ILock writeLock;
  40
  41     /**
  42      * Create a Hazelcast lock.
  43      *
  44      * @param hazelcastInstance the hazelcast instance to use to create the lock
  45      * @param lockId The unique ID of the lock.
  46      */
  47     public HazelcastLock(final HazelcastInstance hazelcastInstance, final String lockId) {
  48         this.lockId = lockId;
  49
  50         // Create the Hazelcast read and write locks
  51         readLock = hazelcastInstance.getLock(lockId + "_READ");
  52         writeLock = hazelcastInstance.getLock(lockId + "_WRITE");
  53     }
  54
  55     /**
  56      * Get the lock Id of the lock.
  57      *
  58      * @return the lock ID
  59      */
  60     public String getLockId() {
  61         return lockId;
  62     }
  63
  64     /**
  65      * {@inheritDoc}.
  66      */
  67     @Override
  68     public Lock readLock() {
  69         return readLock;
  70     }
  71
  72     /**
  73      * {@inheritDoc}.
  74      */
  75     @Override
  76     public Lock writeLock() {
  77         return writeLock;
  78     }
  79 }