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  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.plugins.context.distribution.hazelcast;
  23
  24 import com.hazelcast.core.Hazelcast;
  25 import com.hazelcast.core.HazelcastInstance;
  26 import java.util.Map;
  27 import lombok.AccessLevel;
  28 import lombok.Setter;
  29 import org.onap.policy.apex.context.ContextException;
  30 import org.onap.policy.apex.context.impl.distribution.AbstractDistributor;
  31 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  32 import org.slf4j.ext.XLogger;
  33 import org.slf4j.ext.XLoggerFactory;
  34
  35 /**
  36  * This context distributor distributes context across threads in multiple JVMs on multiple hosts.
  37  * It uses hazelcast to distribute maps.
  38  *
  39  * @author Liam Fallon (liam.fallon@ericsson.com)
  40  */
  41 public class HazelcastContextDistributor extends AbstractDistributor {
  42     // Logger for this class
  43     private static final XLogger LOGGER = XLoggerFactory.getXLogger(HazelcastContextDistributor.class);
  44
  45     // The hazelcast instance for distributing context for this JVM
  46     @Setter(AccessLevel.PRIVATE)
  47     private static HazelcastInstance hazelcastInstance = null;
  48
  49     /**
  50      * Create an instance of a Hazelcast Context Distributor.
  51      *
  52      * @throws ContextException On errors creating the context distributor
  53      */
  54     public HazelcastContextDistributor() throws ContextException {
  55         super();
  56         LOGGER.entry("HazelcastContextDistributor()");
  57
  58         LOGGER.exit("HazelcastContextDistributor()");
  59     }
  60
  61     /**
  62      * {@inheritDoc}.
  63      */
  64     @Override
  65     public void init(final AxArtifactKey key) throws ContextException {
  66         LOGGER.entry("init(" + key + ")");
  67
  68         super.init(key);
  69
  70         // Create the hazelcast instance if it does not already exist
  71         if (hazelcastInstance == null) {
  72             setHazelcastInstance(Hazelcast.newHazelcastInstance());
  73         }
  74
  75         LOGGER.exit("init(" + key + ")");
  76     }
  77
  78     /**
  79      * {@inheritDoc}.
  80      */
  81     @Override
  82     public Map<String, Object> getContextAlbumMap(final AxArtifactKey contextAlbumKey) {
  83         // Get the map from Hazelcast
  84         LOGGER.info("HazelcastContextDistributor: create album: " + contextAlbumKey.getId());
  85         return hazelcastInstance.getMap(contextAlbumKey.getId());
  86     }
  87
  88     /**
  89      * {@inheritDoc}.
  90      */
  91     @Override
  92     public void shutdown() {
  93         // Shut down the hazelcast instance
  94         if (hazelcastInstance != null) {
  95             hazelcastInstance.shutdown();
  96         }
  97         setHazelcastInstance(null);
  98     }
  99 }