main/src/main/java/org/onap/policy/pap/main/comm/PdpStatusMessageHandler.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   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.pap.main.comm;
  22
  23 import java.util.ArrayList;
  24 import java.util.List;
  25 import java.util.Optional;
  26
  27 import org.onap.policy.common.utils.services.Registry;
  28 import org.onap.policy.models.base.PfModelException;
  29 import org.onap.policy.models.pdp.concepts.Pdp;
  30 import org.onap.policy.models.pdp.concepts.PdpGroup;
  31 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  32 import org.onap.policy.models.pdp.concepts.PdpStateChange;
  33 import org.onap.policy.models.pdp.concepts.PdpStatistics;
  34 import org.onap.policy.models.pdp.concepts.PdpStatus;
  35 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  36 import org.onap.policy.models.pdp.concepts.PdpUpdate;
  37 import org.onap.policy.models.pdp.enums.PdpState;
  38 import org.onap.policy.models.provider.PolicyModelsProvider;
  39 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  40 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
  41 import org.onap.policy.pap.main.PapConstants;
  42 import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
  43 import org.onap.policy.pap.main.PolicyPapException;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47
  48 /**
  49  * Handler for PDP Status messages which either represent registration or heart beat.
  50  *
  51  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  52  */
  53 public class PdpStatusMessageHandler {
  54
  55     private static final Logger LOGGER = LoggerFactory.getLogger(PdpStatusMessageHandler.class);
  56
  57     /**
  58      * Handles the PdpStatus message coming from various PDP's.
  59      *
  60      * @param message the PdpStatus message
  61      */
  62     public void handlePdpStatus(final PdpStatus message) {
  63         final PolicyModelsProviderFactoryWrapper modelProviderWrapper =
  64                 Registry.get(PapConstants.REG_PAP_DAO_FACTORY, PolicyModelsProviderFactoryWrapper.class);
  65         try (PolicyModelsProvider databaseProvider = modelProviderWrapper.create()) {
  66             if (message.getPdpGroup() == null && message.getPdpSubgroup() == null) {
  67                 handlePdpRegistration(message, databaseProvider);
  68             } else {
  69                 handlePdpHeartbeat(message, databaseProvider);
  70             }
  71         } catch (final PolicyPapException exp) {
  72             LOGGER.error("Operation Failed", exp);
  73         } catch (final Exception exp) {
  74             LOGGER.error("Failed connecting to database provider", exp);
  75         }
  76     }
  77
  78     private void handlePdpRegistration(final PdpStatus message, final PolicyModelsProvider databaseProvider)
  79             throws PfModelException, PolicyPapException {
  80         if (!findAndUpdatePdpGroup(message, databaseProvider)) {
  81             final String errorMessage = "Failed to register PDP. No matching PdpGroup/SubGroup Found - ";
  82             LOGGER.debug("{}{}", errorMessage, message);
  83             throw new PolicyPapException(errorMessage + message);
  84         }
  85     }
  86
  87     private boolean findAndUpdatePdpGroup(final PdpStatus message, final PolicyModelsProvider databaseProvider)
  88             throws PfModelException {
  89         boolean pdpGroupFound = false;
  90         Optional<PdpSubGroup> subGroup = null;
  91         final PdpGroupFilter filter = PdpGroupFilter.builder().pdpType(message.getPdpType())
  92                 .policyTypeList(message.getSupportedPolicyTypes()).matchPolicyTypesExactly(true).build();
  93         final List<PdpGroup> pdpGroups = databaseProvider.getFilteredPdpGroups(filter);
  94         for (final PdpGroup pdpGroup : pdpGroups) {
  95             subGroup = findPdpSubGroup(message, pdpGroup);
  96             if (subGroup.isPresent()) {
  97                 LOGGER.debug("Found pdpGroup - {}, going for registration of PDP - {}", pdpGroup, message);
  98                 if (!findPdpInstance(message, subGroup.get()).isPresent()) {
  99                     updatePdpSubGroup(pdpGroup, subGroup.get(), message, databaseProvider);
 100                 }
 101                 sendPdpMessage(pdpGroup.getName(), subGroup.get(), message.getName(), null, databaseProvider);
 102                 pdpGroupFound = true;
 103                 break;
 104             }
 105         }
 106         return pdpGroupFound;
 107     }
 108
 109     private void updatePdpSubGroup(final PdpGroup pdpGroup, final PdpSubGroup pdpSubGroup, final PdpStatus message,
 110             final PolicyModelsProvider databaseProvider) throws PfModelException {
 111
 112         final Pdp pdpInstance = new Pdp();
 113         pdpInstance.setInstanceId(message.getName());
 114         pdpInstance.setPdpState(PdpState.ACTIVE);
 115         pdpInstance.setHealthy(message.getHealthy());
 116         pdpInstance.setMessage(message.getDescription());
 117         pdpSubGroup.getPdpInstances().add(pdpInstance);
 118
 119         pdpSubGroup.setCurrentInstanceCount(pdpSubGroup.getCurrentInstanceCount() + 1);
 120
 121         databaseProvider.updatePdpSubGroup(pdpGroup.getName(), pdpGroup.getVersion(), pdpSubGroup);
 122
 123         LOGGER.debug("Updated PdpSubGroup in DB - {} belonging to PdpGroup - {}", pdpSubGroup, pdpGroup);
 124     }
 125
 126     private void handlePdpHeartbeat(final PdpStatus message, final PolicyModelsProvider databaseProvider)
 127             throws PfModelException, PolicyPapException {
 128         boolean pdpInstanceFound = false;
 129         Optional<PdpSubGroup> pdpSubgroup = null;
 130         Optional<Pdp> pdpInstance = null;
 131
 132         final PdpGroupFilter filter =
 133                 PdpGroupFilter.builder().name(message.getPdpGroup()).version(PdpGroupFilter.LATEST_VERSION).build();
 134         final List<PdpGroup> pdpGroups = databaseProvider.getFilteredPdpGroups(filter);
 135         if (!pdpGroups.isEmpty()) {
 136             final PdpGroup pdpGroup = pdpGroups.get(0);
 137             pdpSubgroup = findPdpSubGroup(message, pdpGroup);
 138             if (pdpSubgroup.isPresent()) {
 139                 pdpInstance = findPdpInstance(message, pdpSubgroup.get());
 140                 if (pdpInstance.isPresent()) {
 141                     processPdpDetails(message, pdpSubgroup.get(), pdpInstance.get(), pdpGroup, databaseProvider);
 142                     pdpInstanceFound = true;
 143                 }
 144             }
 145         }
 146         if (!pdpInstanceFound) {
 147             final String errorMessage = "Failed to process heartbeat. No matching PdpGroup/SubGroup Found - ";
 148             LOGGER.debug("{}{}", errorMessage, message);
 149             throw new PolicyPapException(errorMessage + message);
 150         }
 151     }
 152
 153     private Optional<PdpSubGroup> findPdpSubGroup(final PdpStatus message, final PdpGroup pdpGroup) {
 154         PdpSubGroup pdpSubgroup = null;
 155         for (final PdpSubGroup subGroup : pdpGroup.getPdpSubgroups()) {
 156             if (message.getPdpType().equals(subGroup.getPdpType())) {
 157                 pdpSubgroup = subGroup;
 158                 break;
 159             }
 160         }
 161         return Optional.ofNullable(pdpSubgroup);
 162     }
 163
 164     private Optional<Pdp> findPdpInstance(final PdpStatus message, final PdpSubGroup subGroup) {
 165         Pdp pdpInstance = null;
 166         for (final Pdp pdpInstanceDetails : subGroup.getPdpInstances()) {
 167             if (pdpInstanceDetails.getInstanceId().equals(message.getName())) {
 168                 pdpInstance = pdpInstanceDetails;
 169                 break;
 170             }
 171         }
 172         return Optional.ofNullable(pdpInstance);
 173     }
 174
 175     private void processPdpDetails(final PdpStatus message, final PdpSubGroup pdpSubGroup, final Pdp pdpInstance,
 176             final PdpGroup pdpGroup, final PolicyModelsProvider databaseProvider) throws PfModelException {
 177         if (PdpState.TERMINATED.equals(message.getState())) {
 178             processPdpTermination(message, pdpSubGroup, pdpInstance, pdpGroup, databaseProvider);
 179         } else if (validatePdpDetails(message, pdpGroup, pdpSubGroup, pdpInstance)) {
 180             LOGGER.debug("PdpInstance details are correct. Saving current state in DB - {}", pdpInstance);
 181             updatePdpHealthStatus(message, pdpSubGroup, pdpInstance, pdpGroup, databaseProvider);
 182         } else {
 183             LOGGER.debug("PdpInstance details are not correct. Sending PdpUpdate message - {}", pdpInstance);
 184             sendPdpMessage(pdpGroup.getName(), pdpSubGroup, pdpInstance.getInstanceId(), pdpInstance.getPdpState(),
 185                     databaseProvider);
 186         }
 187     }
 188
 189     private void processPdpTermination(final PdpStatus message, final PdpSubGroup pdpSubGroup, final Pdp pdpInstance,
 190             final PdpGroup pdpGroup, final PolicyModelsProvider databaseProvider) throws PfModelException {
 191         pdpSubGroup.getPdpInstances().remove(pdpInstance);
 192         pdpSubGroup.setCurrentInstanceCount(pdpSubGroup.getCurrentInstanceCount() - 1);
 193         databaseProvider.updatePdpSubGroup(pdpGroup.getName(), pdpGroup.getVersion(), pdpSubGroup);
 194
 195         LOGGER.debug("Deleted PdpInstance - {} belonging to PdpSubGroup - {} and PdpGroup - {}", pdpInstance,
 196                 pdpSubGroup, pdpGroup);
 197     }
 198
 199     private boolean validatePdpDetails(final PdpStatus message, final PdpGroup pdpGroup, final PdpSubGroup subGroup,
 200             final Pdp pdpInstanceDetails) {
 201
 202         return message.getPdpGroup().equals(pdpGroup.getName())
 203                 && message.getPdpSubgroup().equals(subGroup.getPdpType())
 204                 && message.getState().equals(pdpInstanceDetails.getPdpState())
 205                 && message.getSupportedPolicyTypes().containsAll(subGroup.getSupportedPolicyTypes())
 206                 && message.getPdpType().equals(subGroup.getPdpType());
 207     }
 208
 209     private void updatePdpHealthStatus(final PdpStatus message, final PdpSubGroup pdpSubgroup, final Pdp pdpInstance,
 210             final PdpGroup pdpGroup, final PolicyModelsProvider databaseProvider) throws PfModelException {
 211         pdpInstance.setHealthy(message.getHealthy());
 212         databaseProvider.updatePdp(pdpGroup.getName(), pdpGroup.getVersion(), pdpSubgroup.getPdpType(), pdpInstance);
 213
 214         LOGGER.debug("Updated Pdp in DB - {}", pdpInstance);
 215     }
 216
 217     private void sendPdpMessage(final String pdpGroupName, final PdpSubGroup subGroup, final String pdpInstanceId,
 218             final PdpState pdpState, final PolicyModelsProvider databaseProvider) throws PfModelException {
 219         final PdpUpdate pdpUpdatemessage =
 220                 createPdpUpdateMessage(pdpGroupName, subGroup, pdpInstanceId, databaseProvider);
 221         final PdpStateChange pdpStateChangeMessage =
 222                 createPdpStateChangeMessage(pdpGroupName, subGroup, pdpInstanceId, pdpState);
 223         final PdpModifyRequestMap requestMap = Registry.get(PapConstants.REG_PDP_MODIFY_MAP, PdpModifyRequestMap.class);
 224         requestMap.addRequest(pdpUpdatemessage, pdpStateChangeMessage);
 225         LOGGER.debug("Sent PdpUpdate message - {}", pdpUpdatemessage);
 226         LOGGER.debug("Sent PdpStateChange message - {}", pdpStateChangeMessage);
 227     }
 228
 229     private PdpUpdate createPdpUpdateMessage(final String pdpGroupName, final PdpSubGroup subGroup,
 230             final String pdpInstanceId, final PolicyModelsProvider databaseProvider) throws PfModelException {
 231
 232         final PdpUpdate update = new PdpUpdate();
 233         update.setName(pdpInstanceId);
 234         update.setPdpGroup(pdpGroupName);
 235         update.setPdpSubgroup(subGroup.getPdpType());
 236         update.setPolicies(getToscaPolicies(subGroup, databaseProvider));
 237
 238         LOGGER.debug("Created PdpUpdate message - {}", update);
 239         return update;
 240     }
 241
 242     private List<ToscaPolicy> getToscaPolicies(final PdpSubGroup subGroup, final PolicyModelsProvider databaseProvider)
 243             throws PfModelException {
 244         final List<ToscaPolicy> policies = new ArrayList<>();
 245         for (final ToscaPolicyIdentifier policyIdentifier : subGroup.getPolicies()) {
 246             policies.addAll(databaseProvider.getPolicyList(policyIdentifier.getName(), policyIdentifier.getVersion()));
 247         }
 248         LOGGER.debug("Created ToscaPolicy list - {}", policies);
 249         return policies;
 250     }
 251
 252     private PdpStateChange createPdpStateChangeMessage(final String pdpGroupName, final PdpSubGroup subGroup,
 253             final String pdpInstanceId, final PdpState pdpState) {
 254
 255         final PdpStateChange stateChange = new PdpStateChange();
 256         stateChange.setName(pdpInstanceId);
 257         stateChange.setPdpGroup(pdpGroupName);
 258         stateChange.setPdpSubgroup(subGroup.getPdpType());
 259         stateChange.setState(pdpState == null ? PdpState.ACTIVE : pdpState);
 260         LOGGER.debug("Created PdpStateChange message - {}", stateChange);
 261         return stateChange;
 262     }
 263 }