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