2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019 AT&T Intellectual Property.
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.pap.main.startstop;
24 import java.util.Arrays;
25 import java.util.concurrent.atomic.AtomicReference;
26 import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
27 import org.onap.policy.common.endpoints.event.comm.TopicSource;
28 import org.onap.policy.common.endpoints.http.server.RestServer;
29 import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
30 import org.onap.policy.common.endpoints.listeners.RequestIdDispatcher;
31 import org.onap.policy.common.parameters.ParameterService;
32 import org.onap.policy.common.utils.services.Registry;
33 import org.onap.policy.common.utils.services.ServiceManagerContainer;
34 import org.onap.policy.models.pap.concepts.PolicyNotification;
35 import org.onap.policy.models.pdp.concepts.PdpMessage;
36 import org.onap.policy.models.pdp.concepts.PdpStatus;
37 import org.onap.policy.models.pdp.enums.PdpMessageType;
38 import org.onap.policy.pap.main.PapConstants;
39 import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
40 import org.onap.policy.pap.main.PolicyPapRuntimeException;
41 import org.onap.policy.pap.main.comm.PdpHeartbeatListener;
42 import org.onap.policy.pap.main.comm.PdpModifyRequestMap;
43 import org.onap.policy.pap.main.comm.PdpTracker;
44 import org.onap.policy.pap.main.comm.Publisher;
45 import org.onap.policy.pap.main.comm.TimerManager;
46 import org.onap.policy.pap.main.notification.PolicyNotifier;
47 import org.onap.policy.pap.main.parameters.PapParameterGroup;
48 import org.onap.policy.pap.main.parameters.PdpModifyRequestMapParams;
49 import org.onap.policy.pap.main.parameters.PdpParameters;
50 import org.onap.policy.pap.main.rest.HealthCheckRestControllerV1;
51 import org.onap.policy.pap.main.rest.PapAafFilter;
52 import org.onap.policy.pap.main.rest.PapStatisticsManager;
53 import org.onap.policy.pap.main.rest.PdpGroupHealthCheckControllerV1;
54 import org.onap.policy.pap.main.rest.PdpGroupQueryControllerV1;
55 import org.onap.policy.pap.main.rest.PdpGroupStateChangeControllerV1;
56 import org.onap.policy.pap.main.rest.StatisticsRestControllerV1;
57 import org.onap.policy.pap.main.rest.depundep.PdpGroupDeleteControllerV1;
58 import org.onap.policy.pap.main.rest.depundep.PdpGroupDeployControllerV1;
61 * This class activates Policy Administration (PAP) as a complete service together with all its controllers, listeners &
64 * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
66 public class PapActivator extends ServiceManagerContainer {
67 private static final String[] MSG_TYPE_NAMES = { "messageName" };
68 private static final String[] REQ_ID_NAMES = { "response", "responseTo" };
71 * Max number of heat beats that can be missed before PAP removes a PDP.
73 private static final int MAX_MISSED_HEARTBEATS = 3;
75 private final PapParameterGroup papParameterGroup;
78 * Listens for messages on the topic, decodes them into a {@link PdpStatus} message, and then dispatches them to
79 * {@link #reqIdDispatcher}.
81 private final MessageTypeDispatcher msgDispatcher;
84 * Listens for {@link PdpStatus} messages and then routes them to the listener associated with the ID of the
85 * originating request.
87 private final RequestIdDispatcher<PdpStatus> reqIdDispatcher;
90 * Listener for anonymous {@link PdpStatus} messages either for registration or heartbeat.
92 private final PdpHeartbeatListener pdpHeartbeatListener;
95 * Instantiate the activator for policy pap as a complete service.
97 * @param papParameterGroup the parameters for the pap service
99 public PapActivator(final PapParameterGroup papParameterGroup) {
102 TopicEndpointManager.getManager().addTopics(papParameterGroup.getTopicParameterGroup());
105 this.papParameterGroup = papParameterGroup;
106 this.msgDispatcher = new MessageTypeDispatcher(MSG_TYPE_NAMES);
107 this.reqIdDispatcher = new RequestIdDispatcher<>(PdpStatus.class, REQ_ID_NAMES);
108 this.pdpHeartbeatListener = new PdpHeartbeatListener();
110 } catch (final RuntimeException e) {
111 throw new PolicyPapRuntimeException(e);
114 papParameterGroup.getRestServerParameters().setName(papParameterGroup.getName());
116 final Object pdpUpdateLock = new Object();
117 final PdpParameters pdpParams = papParameterGroup.getPdpParameters();
118 final AtomicReference<Publisher<PdpMessage>> pdpPub = new AtomicReference<>();
119 final AtomicReference<Publisher<PolicyNotification>> notifyPub = new AtomicReference<>();
120 final AtomicReference<TimerManager> pdpUpdTimers = new AtomicReference<>();
121 final AtomicReference<TimerManager> pdpStChgTimers = new AtomicReference<>();
122 final AtomicReference<TimerManager> heartBeatTimers = new AtomicReference<>();
123 final AtomicReference<PolicyModelsProviderFactoryWrapper> daoFactory = new AtomicReference<>();
124 final AtomicReference<PdpModifyRequestMap> requestMap = new AtomicReference<>();
125 final AtomicReference<RestServer> restServer = new AtomicReference<>();
126 final AtomicReference<PolicyNotifier> notifier = new AtomicReference<>();
129 addAction("PAP parameters",
130 () -> ParameterService.register(papParameterGroup),
131 () -> ParameterService.deregister(papParameterGroup.getName()));
133 addAction("DAO Factory",
134 () -> daoFactory.set(new PolicyModelsProviderFactoryWrapper(
135 papParameterGroup.getDatabaseProviderParameters())),
136 () -> daoFactory.get().close());
138 addAction("DAO Factory registration",
139 () -> Registry.register(PapConstants.REG_PAP_DAO_FACTORY, daoFactory.get()),
140 () -> Registry.unregister(PapConstants.REG_PAP_DAO_FACTORY));
142 addAction("Pdp Heartbeat Listener",
143 () -> reqIdDispatcher.register(pdpHeartbeatListener),
144 () -> reqIdDispatcher.unregister(pdpHeartbeatListener));
146 addAction("Request ID Dispatcher",
147 () -> msgDispatcher.register(PdpMessageType.PDP_STATUS.name(), this.reqIdDispatcher),
148 () -> msgDispatcher.unregister(PdpMessageType.PDP_STATUS.name()));
150 addAction("Message Dispatcher",
151 this::registerMsgDispatcher,
152 this::unregisterMsgDispatcher);
155 TopicEndpointManager.getManager()::start,
156 TopicEndpointManager.getManager()::shutdown);
158 addAction("PAP statistics",
159 () -> Registry.register(PapConstants.REG_STATISTICS_MANAGER, new PapStatisticsManager()),
160 () -> Registry.unregister(PapConstants.REG_STATISTICS_MANAGER));
162 addAction("PDP publisher",
164 pdpPub.set(new Publisher<>(PapConstants.TOPIC_POLICY_PDP_PAP));
165 startThread(pdpPub.get());
167 () -> pdpPub.get().stop());
169 addAction("Policy Notification publisher",
171 notifyPub.set(new Publisher<>(PapConstants.TOPIC_POLICY_NOTIFICATION));
172 startThread(notifyPub.get());
173 notifier.set(new PolicyNotifier(notifyPub.get()));
175 () -> notifyPub.get().stop());
177 addAction("Policy Notifier",
178 () -> Registry.register(PapConstants.REG_POLICY_NOTIFIER, notifier.get()),
179 () -> Registry.unregister(PapConstants.REG_POLICY_NOTIFIER));
181 addAction("PDP heart beat timers",
183 long maxWaitHeartBeatMs = MAX_MISSED_HEARTBEATS * pdpParams.getHeartBeatMs();
184 heartBeatTimers.set(new TimerManager("heart beat", maxWaitHeartBeatMs));
185 startThread(heartBeatTimers.get());
187 () -> heartBeatTimers.get().stop());
189 addAction("PDP update timers",
191 pdpUpdTimers.set(new TimerManager("update", pdpParams.getUpdateParameters().getMaxWaitMs()));
192 startThread(pdpUpdTimers.get());
194 () -> pdpUpdTimers.get().stop());
196 addAction("PDP state-change timers",
198 pdpStChgTimers.set(new TimerManager("state-change", pdpParams.getUpdateParameters().getMaxWaitMs()));
199 startThread(pdpStChgTimers.get());
201 () -> pdpStChgTimers.get().stop());
203 addAction("PDP modification lock",
204 () -> Registry.register(PapConstants.REG_PDP_MODIFY_LOCK, pdpUpdateLock),
205 () -> Registry.unregister(PapConstants.REG_PDP_MODIFY_LOCK));
207 addAction("PDP modification requests",
209 requestMap.set(new PdpModifyRequestMap(
210 new PdpModifyRequestMapParams()
211 .setDaoFactory(daoFactory.get())
212 .setModifyLock(pdpUpdateLock)
213 .setParams(pdpParams)
214 .setPolicyNotifier(notifier.get())
215 .setPdpPublisher(pdpPub.get())
216 .setResponseDispatcher(reqIdDispatcher)
217 .setStateChangeTimers(pdpStChgTimers.get())
218 .setUpdateTimers(pdpUpdTimers.get())));
219 Registry.register(PapConstants.REG_PDP_MODIFY_MAP, requestMap.get());
221 () -> Registry.unregister(PapConstants.REG_PDP_MODIFY_MAP));
223 addAction("PDP heart beat tracker",
224 () -> Registry.register(PapConstants.REG_PDP_TRACKER, PdpTracker.builder()
225 .daoFactory(daoFactory.get())
226 .timers(heartBeatTimers.get())
227 .modifyLock(pdpUpdateLock)
228 .requestMap(requestMap.get())
230 () -> Registry.unregister(PapConstants.REG_PDP_TRACKER));
232 addAction("REST server",
234 RestServer server = new RestServer(papParameterGroup.getRestServerParameters(), PapAafFilter.class,
235 HealthCheckRestControllerV1.class,
236 StatisticsRestControllerV1.class,
237 PdpGroupDeployControllerV1.class,
238 PdpGroupDeleteControllerV1.class,
239 PdpGroupStateChangeControllerV1.class,
240 PdpGroupQueryControllerV1.class,
241 PdpGroupHealthCheckControllerV1.class);
242 restServer.set(server);
243 restServer.get().start();
245 () -> restServer.get().stop());
250 * Starts a background thread.
252 * @param runner function to run in the background
254 private void startThread(final Runnable runner) {
255 final Thread thread = new Thread(runner);
256 thread.setDaemon(true);
262 * Get the parameters used by the activator.
264 * @return the parameters of the activator
266 public PapParameterGroup getParameterGroup() {
267 return papParameterGroup;
271 * Registers the dispatcher with the topic source(s).
273 private void registerMsgDispatcher() {
274 for (final TopicSource source : TopicEndpointManager.getManager()
275 .getTopicSources(Arrays.asList(PapConstants.TOPIC_POLICY_PDP_PAP))) {
276 source.register(msgDispatcher);
281 * Unregisters the dispatcher from the topic source(s).
283 private void unregisterMsgDispatcher() {
284 for (final TopicSource source : TopicEndpointManager.getManager()
285 .getTopicSources(Arrays.asList(PapConstants.TOPIC_POLICY_PDP_PAP))) {
286 source.unregister(msgDispatcher);