plugins/plugins-context/plugins-context-distribution/plugins-context-distribution-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/distribution/hazelcast/HazelcastContextDistributor.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.distribution.hazelcast;
  22
  23 import com.hazelcast.core.Hazelcast;
  24 import com.hazelcast.core.HazelcastInstance;
  25
  26 import java.util.Map;
  27
  28 import org.onap.policy.apex.context.ContextException;
  29 import org.onap.policy.apex.context.impl.distribution.AbstractDistributor;
  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  * This context distributor distributes context across threads in multiple JVMs on multiple hosts.
  36  * It uses hazelcast to distribute maps.
  37  *
  38  * @author Liam Fallon (liam.fallon@ericsson.com)
  39  */
  40 public class HazelcastContextDistributor extends AbstractDistributor {
  41     // Logger for this class
  42     private static final XLogger LOGGER = XLoggerFactory.getXLogger(HazelcastContextDistributor.class);
  43
  44     // The hazelcast instance for distributing context for this JVM
  45     private static HazelcastInstance hazelcastInstance = null;
  46
  47     /**
  48      * Create an instance of a Hazelcast Context Distributor.
  49      *
  50      * @throws ContextException On errors creating the context distributor
  51      */
  52     public HazelcastContextDistributor() throws ContextException {
  53         super();
  54         LOGGER.entry("HazelcastContextDistributor()");
  55
  56         LOGGER.exit("HazelcastContextDistributor()");
  57     }
  58
  59     /**
  60      * {@inheritDoc}.
  61      */
  62     @Override
  63     public void init(final AxArtifactKey key) throws ContextException {
  64         LOGGER.entry("init(" + key + ")");
  65
  66         super.init(key);
  67
  68         // Create the hazelcast instance if it does not already exist
  69         if (hazelcastInstance == null) {
  70             setHazelcastInstance(Hazelcast.newHazelcastInstance());
  71         }
  72
  73         LOGGER.exit("init(" + key + ")");
  74     }
  75
  76     /**
  77      * Set the hazelcast instance statically.
  78      * @param newHazelcastInstance the hazelcast instance
  79      */
  80     private static void setHazelcastInstance(HazelcastInstance newHazelcastInstance) {
  81         hazelcastInstance = newHazelcastInstance;
  82     }
  83
  84     /**
  85      * {@inheritDoc}.
  86      */
  87     @Override
  88     public Map<String, Object> getContextAlbumMap(final AxArtifactKey contextAlbumKey) {
  89         // Get the map from Hazelcast
  90         LOGGER.info("HazelcastContextDistributor: create album: " + contextAlbumKey.getId());
  91         return hazelcastInstance.getMap(contextAlbumKey.getId());
  92     }
  93
  94     /**
  95      * {@inheritDoc}.
  96      */
  97     @Override
  98     public void shutdown() {
  99         // Shut down the hazelcast instance
 100         if (hazelcastInstance != null) {
 101             hazelcastInstance.shutdown();
 102         }
 103         setHazelcastInstance(null);
 104     }
 105 }