plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorReentrantReadWriteLock.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.curator;
  22
  23 import java.util.concurrent.locks.Lock;
  24 import java.util.concurrent.locks.ReadWriteLock;
  25 import org.apache.curator.framework.CuratorFramework;
  26 import org.apache.curator.framework.recipes.locks.InterProcessReadWriteLock;
  27
  28 /**
  29  * This class maps a Curator {@link InterProcessReadWriteLock} to a Java {@link ReadWriteLock}.
  30  *
  31  * @author Liam Fallon (liam.fallon@ericsson.com)
  32  */
  33 public class CuratorReentrantReadWriteLock implements ReadWriteLock {
  34     // The Lock ID
  35     private final String lockId;
  36
  37     // The Curator lock
  38     private final InterProcessReadWriteLock curatorReadWriteLock;
  39
  40     // The Curator Lock facades for read and write locks
  41     private final CuratorLockFacade readLockFacade;
  42     private final CuratorLockFacade writeLockFacade;
  43
  44     /**
  45      * Create a Curator lock.
  46      *
  47      * @param curatorFramework the Curator framework to use to create the lock
  48      * @param lockId The unique ID of the lock.
  49      */
  50     public CuratorReentrantReadWriteLock(final CuratorFramework curatorFramework, final String lockId) {
  51         this.lockId = lockId;
  52
  53         // Create the Curator lock
  54         curatorReadWriteLock = new InterProcessReadWriteLock(curatorFramework, lockId);
  55
  56         // Create the lock facades
  57         readLockFacade = new CuratorLockFacade(curatorReadWriteLock.readLock(), lockId);
  58         writeLockFacade = new CuratorLockFacade(curatorReadWriteLock.writeLock(), lockId);
  59     }
  60
  61     /**
  62      * Get the lock Id of the lock.
  63      *
  64      * @return the lock ID
  65      */
  66     public String getLockId() {
  67         return lockId;
  68     }
  69
  70     /**
  71      * {@inheritDoc}.
  72      */
  73     @Override
  74     public Lock readLock() {
  75         return readLockFacade;
  76     }
  77
  78     /**
  79      * {@inheritDoc}.
  80      */
  81     @Override
  82     public Lock writeLock() {
  83         return writeLockFacade;
  84     }
  85 }