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