Changes for checkstyle 8.32
[policy/apex-pdp.git] / plugins / plugins-context / plugins-context-distribution / plugins-context-distribution-infinispan / src / main / java / org / onap / policy / apex / plugins / context / distribution / infinispan / InfinispanContextDistributor.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.infinispan;
22
23 import java.util.Map;
24 import org.onap.policy.apex.context.ContextException;
25 import org.onap.policy.apex.context.impl.distribution.AbstractDistributor;
26 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
27 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
28 import org.onap.policy.common.parameters.ParameterService;
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. It uses Infinispan to
34  * distribute maps.
35  *
36  * @author Liam Fallon (liam.fallon@ericsson.com)
37  */
38 public class InfinispanContextDistributor extends AbstractDistributor {
39     // Logger for this class
40     private static final XLogger LOGGER = XLoggerFactory.getXLogger(InfinispanContextDistributor.class);
41
42     // The infinispan manager for distributing context for this JVM
43     private static InfinispanManager infinispanManager = null;
44
45     /**
46      * Create an instance of an Infinispan Context Distributor.
47      *
48      * @throws ContextException On errors creating the context distributor
49      */
50     public InfinispanContextDistributor() throws ContextException {
51         LOGGER.entry("InfinispanContextDistributor()");
52
53         LOGGER.exit("InfinispanContextDistributor()");
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         // Create the infinispan manager if it does not already exist
66         if (infinispanManager == null) {
67             // Get the parameters from the parameter service
68             final InfinispanDistributorParameters parameters = ParameterService
69                             .get(ContextParameterConstants.DISTRIBUTOR_GROUP_NAME);
70
71             LOGGER.debug("initiating Infinispan with the parameters: {}", parameters);
72
73             // Create the manager
74             setInfinispanManager(new InfinispanManager(parameters));
75         }
76
77         LOGGER.exit("init(" + key + ")");
78     }
79
80     /**
81      * Set the infinispan manager statically.
82      * @param newInfinispanManager the new infinspan manager instance
83      */
84     private static void setInfinispanManager(InfinispanManager newInfinispanManager) {
85         infinispanManager = newInfinispanManager;
86     }
87
88     /**
89      * {@inheritDoc}.
90      */
91     @Override
92     public Map<String, Object> getContextAlbumMap(final AxArtifactKey contextAlbumKey) {
93         LOGGER.info("InfinispanContextDistributor: create album: " + contextAlbumKey.getId());
94
95         // Get the Cache from Infinispan
96         return infinispanManager.getCacheManager().getCache(contextAlbumKey.getId().replace(':', '_'));
97     }
98
99     /**
100      * {@inheritDoc}.
101      */
102     @Override
103     public void shutdown() {
104         // Shut down the infinispan manager
105         if (infinispanManager != null) {
106             infinispanManager.shutdown();
107         }
108         setInfinispanManager(null);
109     }
110 }