gerrit.onap Code Review - policy/models.git/blob

   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.models.sim.pdp.handler;
  22
  23 import java.util.ArrayList;
  24 import java.util.List;
  25
  26
  27 import org.onap.policy.common.utils.services.Registry;
  28 import org.onap.policy.models.pdp.concepts.PdpResponseDetails;
  29 import org.onap.policy.models.pdp.concepts.PdpStatus;
  30 import org.onap.policy.models.pdp.enums.PdpHealthStatus;
  31 import org.onap.policy.models.pdp.enums.PdpResponseStatus;
  32 import org.onap.policy.models.pdp.enums.PdpState;
  33 import org.onap.policy.models.sim.pdp.PdpSimulatorConstants;
  34 import org.onap.policy.models.sim.pdp.parameters.PdpStatusParameters;
  35 import org.onap.policy.models.sim.pdp.parameters.ToscaPolicyTypeIdentifierParameters;
  36 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  37 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyIdentifier;
  38 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  39
  40 /**
  41  * This class supports the handling of pdp messages.
  42  *
  43  * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
  44  */
  45 public class PdpMessageHandler {
  46
  47     /**
  48      * Method to create PdpStatus message from the parameters which will be saved to the context.
  49      *
  50      * @param instanceId instance id of the pdp
  51      * @param pdpStatusParameters pdp status parameters read from the configuration file
  52      *
  53      * @return pdpStatus the pdp status message
  54      */
  55     public PdpStatus createPdpStatusFromParameters(final String instanceId,
  56             final PdpStatusParameters pdpStatusParameters) {
  57         final PdpStatus pdpStatus = new PdpStatus();
  58         pdpStatus.setPdpType(pdpStatusParameters.getPdpType());
  59         pdpStatus.setState(PdpState.PASSIVE);
  60         pdpStatus.setHealthy(PdpHealthStatus.HEALTHY);
  61         pdpStatus.setDescription(pdpStatusParameters.getDescription());
  62         pdpStatus.setName(instanceId);
  63         pdpStatus.setSupportedPolicyTypes(getSupportedPolicyTypesFromParameters(pdpStatusParameters));
  64         return pdpStatus;
  65     }
  66
  67     /**
  68      * Method to get supported policy types from the parameters.
  69      *
  70      * @param pdpStatusParameters pdp status parameters
  71      * @return supportedPolicyTypes list of PolicyTypeIdent
  72      */
  73     private List<ToscaPolicyTypeIdentifier> getSupportedPolicyTypesFromParameters(
  74             final PdpStatusParameters pdpStatusParameters) {
  75         final List<ToscaPolicyTypeIdentifier> supportedPolicyTypes =
  76                 new ArrayList<>(pdpStatusParameters.getSupportedPolicyTypes().size());
  77         for (final ToscaPolicyTypeIdentifierParameters policyTypeIdentParameters : pdpStatusParameters
  78                 .getSupportedPolicyTypes()) {
  79             supportedPolicyTypes.add(new ToscaPolicyTypeIdentifier(policyTypeIdentParameters.getName(),
  80                     policyTypeIdentParameters.getVersion()));
  81         }
  82         return supportedPolicyTypes;
  83     }
  84
  85     /**
  86      * Method to create PdpStatus message from the context, which is to be sent by pdp simulator to pap.
  87      *
  88      * @return PdpStatus the pdp status message
  89      */
  90     public PdpStatus createPdpStatusFromContext() {
  91         final PdpStatus pdpStatusContext = Registry.get(PdpSimulatorConstants.REG_PDP_STATUS_OBJECT, PdpStatus.class);
  92         final PdpStatus pdpStatus = new PdpStatus();
  93         pdpStatus.setName(pdpStatusContext.getName());
  94         pdpStatus.setPdpType(pdpStatusContext.getPdpType());
  95         pdpStatus.setState(pdpStatusContext.getState());
  96         pdpStatus.setHealthy(pdpStatusContext.getHealthy());
  97         pdpStatus.setDescription(pdpStatusContext.getDescription());
  98         pdpStatus.setSupportedPolicyTypes(pdpStatusContext.getSupportedPolicyTypes());
  99         pdpStatus.setPolicies(pdpStatusContext.getPolicies());
 100         pdpStatus.setPdpGroup(pdpStatusContext.getPdpGroup());
 101         pdpStatus.setPdpSubgroup(pdpStatusContext.getPdpSubgroup());
 102         return pdpStatus;
 103     }
 104
 105     /**
 106      * Method to get a final pdp status when the simulator is shut down.
 107      *
 108      * @return PdpStatus the pdp status message
 109      */
 110     public PdpStatus getTerminatedPdpStatus() {
 111         final PdpStatus pdpStatusInContext = Registry.get(PdpSimulatorConstants.REG_PDP_STATUS_OBJECT, PdpStatus.class);
 112         pdpStatusInContext.setState(PdpState.TERMINATED);
 113         pdpStatusInContext.setDescription("Pdp Simulator shutting down.");
 114         return createPdpStatusFromContext();
 115     }
 116
 117     /**
 118      * Method create PdpResponseDetails which will be sent as part of pdp status to PAP.
 119      *
 120      * @param requestId request id of the PdpUpdate message from pap
 121      * @param status response status to be sent back
 122      * @param responseMessage response message to be sent back
 123      *
 124      * @return PdpResponseDetails
 125      */
 126     public PdpResponseDetails createPdpResonseDetails(final String requestId, final PdpResponseStatus status,
 127             final String responseMessage) {
 128         final PdpResponseDetails pdpResponseDetails = new PdpResponseDetails();
 129         pdpResponseDetails.setResponseTo(requestId);
 130         pdpResponseDetails.setResponseStatus(status);
 131         pdpResponseDetails.setResponseMessage(responseMessage);
 132         return pdpResponseDetails;
 133     }
 134
 135     /**
 136      * Method to retrieve list of ToscaPolicyIdentifier from the list of ToscaPolicy.
 137      *
 138      * @param policies list of ToscaPolicy
 139      *
 140      * @return policyTypeIdentifiers
 141      */
 142     public List<ToscaPolicyIdentifier> getToscaPolicyIdentifiers(final List<ToscaPolicy> policies) {
 143         final List<ToscaPolicyIdentifier> policyIdentifiers = new ArrayList<>(policies.size());
 144         for (final ToscaPolicy policy : policies) {
 145             if (null != policy.getName() && null != policy.getVersion()) {
 146                 policyIdentifiers.add(new ToscaPolicyIdentifier(policy.getName(), policy.getVersion()));
 147             }
 148         }
 149         return policyIdentifiers;
 150     }
 151 }