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