plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.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.Hazelcast;
  24 import com.hazelcast.core.HazelcastInstance;
  25 import java.util.concurrent.locks.ReadWriteLock;
  26 import org.onap.policy.apex.context.ContextException;
  27 import org.onap.policy.apex.context.impl.locking.AbstractLockManager;
  28 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  29 import org.slf4j.ext.XLogger;
  30 import org.slf4j.ext.XLoggerFactory;
  31
  32 /**
  33  * The Class HazelcastLockManager manages Hazelcast locks for locks on items in Apex context albums.
  34  *
  35  * @author Liam Fallon (liam.fallon@ericsson.com)
  36  */
  37 public class HazelcastLockManager extends AbstractLockManager {
  38     // Logger for this class
  39     private static final XLogger LOGGER = XLoggerFactory.getXLogger(HazelcastLockManager.class);
  40
  41     private HazelcastInstance hazelcastInstance;
  42
  43     /**
  44      * Constructor, set up a lock manager that uses Hazelcast locking.
  45      *
  46      * @throws ContextException On errors connecting to the Hazelcast cluster
  47      */
  48     public HazelcastLockManager() throws ContextException {
  49         LOGGER.entry("HazelcastLockManager(): setting up the Hazelcast lock manager . . .");
  50
  51         LOGGER.exit("HazelcastLockManager(): Hazelcast lock manager set up");
  52     }
  53
  54     /**
  55      * {@inheritDoc}.
  56      */
  57     @Override
  58     public void init(final AxArtifactKey key) throws ContextException {
  59         LOGGER.entry("init(" + key + ")");
  60
  61         super.init(key);
  62
  63         // Set up the Hazelcast instance for lock handling
  64         hazelcastInstance = Hazelcast.newHazelcastInstance();
  65
  66         LOGGER.exit("init(" + key + ")");
  67     }
  68
  69     /**
  70      * {@inheritDoc}.
  71      */
  72     @Override
  73     public ReadWriteLock getReentrantReadWriteLock(final String lockId) throws ContextException {
  74         // Check if the framework is active
  75         if (hazelcastInstance != null && hazelcastInstance.getLifecycleService().isRunning()) {
  76             return new HazelcastLock(hazelcastInstance, lockId);
  77         } else {
  78             throw new ContextException("creation of hazelcast lock failed, see error log for details");
  79         }
  80     }
  81
  82     /**
  83      * {@inheritDoc}.
  84      */
  85     @Override
  86     public void shutdown() {
  87         if (hazelcastInstance == null) {
  88             return;
  89         }
  90         hazelcastInstance.shutdown();
  91         hazelcastInstance = null;
  92     }
  93 }