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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021 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.clamp.controlloop.runtime.instantiation;
  22
  23 import java.io.Closeable;
  24 import java.io.IOException;
  25 import java.util.ArrayList;
  26 import java.util.Collections;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.function.UnaryOperator;
  30 import java.util.stream.Collectors;
  31 import javax.ws.rs.core.Response;
  32 import javax.ws.rs.core.Response.Status;
  33 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
  34 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
  35 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
  36 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopState;
  37 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
  38 import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
  39 import org.onap.policy.clamp.controlloop.models.messages.rest.instantiation.InstantiationCommand;
  40 import org.onap.policy.clamp.controlloop.models.messages.rest.instantiation.InstantiationResponse;
  41 import org.onap.policy.clamp.controlloop.runtime.commissioning.CommissioningProvider;
  42 import org.onap.policy.common.parameters.BeanValidationResult;
  43 import org.onap.policy.common.parameters.ObjectValidationResult;
  44 import org.onap.policy.common.parameters.ValidationResult;
  45 import org.onap.policy.common.parameters.ValidationStatus;
  46 import org.onap.policy.models.base.PfModelException;
  47 import org.onap.policy.models.base.PfModelRuntimeException;
  48 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  51
  52 /**
  53  * This class is dedicated to the Instantiation of Commissioned control loop.
  54  */
  55 public class ControlLoopInstantiationProvider implements Closeable {
  56     private final ControlLoopProvider controlLoopProvider;
  57     private final CommissioningProvider commissioningProvider;
  58
  59     private static final Object lockit = new Object();
  60
  61     /**
  62      * Create a instantiation provider.
  63      *
  64      * @param databaseProviderParameters the parameters for database access
  65      */
  66     public ControlLoopInstantiationProvider(PolicyModelsProviderParameters databaseProviderParameters) {
  67         try {
  68             controlLoopProvider = new ControlLoopProvider(databaseProviderParameters);
  69             commissioningProvider = new CommissioningProvider(databaseProviderParameters);
  70         } catch (PfModelException e) {
  71             throw new PfModelRuntimeException(e);
  72         }
  73     }
  74
  75     @Override
  76     public void close() throws IOException {
  77         controlLoopProvider.close();
  78     }
  79
  80     /**
  81      * Create control loops.
  82      *
  83      * @param controlLoops the control loop
  84      * @return the result of the instantiation operation
  85      * @throws PfModelException on creation errors
  86      */
  87     public InstantiationResponse createControlLoops(ControlLoops controlLoops) throws PfModelException {
  88
  89         synchronized (lockit) {
  90             for (ControlLoop controlLoop : controlLoops.getControlLoopList()) {
  91                 ControlLoop checkControlLoop = controlLoopProvider.getControlLoop(controlLoop.getKey().asIdentifier());
  92                 if (checkControlLoop != null) {
  93                     throw new PfModelException(Response.Status.BAD_REQUEST,
  94                             controlLoop.getKey().asIdentifier() + " already defined");
  95                 }
  96             }
  97             BeanValidationResult validationResult = validateControlLoops(controlLoops);
  98             if (!validationResult.isValid()) {
  99                 throw new PfModelException(Response.Status.BAD_REQUEST, validationResult.getResult());
 100             }
 101             controlLoopProvider.createControlLoops(controlLoops.getControlLoopList());
 102         }
 103
 104         InstantiationResponse response = new InstantiationResponse();
 105         response.setAffectedControlLoops(controlLoops.getControlLoopList().stream()
 106                 .map(cl -> cl.getKey().asIdentifier()).collect(Collectors.toList()));
 107
 108         return response;
 109     }
 110
 111     /**
 112      * Update control loops.
 113      *
 114      * @param controlLoops the control loop
 115      * @return the result of the instantiation operation
 116      * @throws PfModelException on update errors
 117      */
 118     public InstantiationResponse updateControlLoops(ControlLoops controlLoops) throws PfModelException {
 119         synchronized (lockit) {
 120             BeanValidationResult validationResult = validateControlLoops(controlLoops);
 121             if (!validationResult.isValid()) {
 122                 throw new PfModelException(Response.Status.BAD_REQUEST, validationResult.getResult());
 123             }
 124             controlLoopProvider.updateControlLoops(controlLoops.getControlLoopList());
 125         }
 126
 127         InstantiationResponse response = new InstantiationResponse();
 128         response.setAffectedControlLoops(controlLoops.getControlLoopList().stream()
 129                 .map(cl -> cl.getKey().asIdentifier()).collect(Collectors.toList()));
 130
 131         return response;
 132     }
 133
 134     /**
 135      * Validate ControlLoops.
 136      *
 137      * @param controlLoops ControlLoops to validate
 138      * @result the result of validation
 139      * @throws PfModelException if controlLoops is not valid
 140      */
 141     private BeanValidationResult validateControlLoops(ControlLoops controlLoops) throws PfModelException {
 142
 143         BeanValidationResult validationResult = new BeanValidationResult("ControlLoops", controlLoops);
 144
 145         for (ControlLoop controlLoop : controlLoops.getControlLoopList()) {
 146
 147             List<ToscaNodeTemplate> toscaNodeTemplates = commissioningProvider.getControlLoopDefinitions(
 148                     controlLoop.getDefinition().getName(), controlLoop.getDefinition().getVersion());
 149
 150             if (toscaNodeTemplates.isEmpty()) {
 151                 validationResult
 152                         .addResult(new ObjectValidationResult("ControlLoop", controlLoop.getDefinition().getName(),
 153                                 ValidationStatus.INVALID, "Commissioned control loop definition not FOUND"));
 154             } else if (toscaNodeTemplates.size() > 1) {
 155                 validationResult
 156                         .addResult(new ObjectValidationResult("ControlLoop", controlLoop.getDefinition().getName(),
 157                                 ValidationStatus.INVALID, "Commissioned control loop definition not VALID"));
 158             } else {
 159
 160                 List<ToscaNodeTemplate> clElementDefinitions =
 161                         commissioningProvider.getControlLoopElementDefinitions(toscaNodeTemplates.get(0));
 162
 163                 // @formatter:off
 164                 Map<String, ToscaConceptIdentifier> definitions = clElementDefinitions
 165                         .stream()
 166                         .map(nodeTemplate -> nodeTemplate.getKey().asIdentifier())
 167                         .collect(Collectors.toMap(ToscaConceptIdentifier::getName, UnaryOperator.identity()));
 168                 // @formatter:on
 169
 170                 for (ControlLoopElement element : controlLoop.getElements()) {
 171                     validationResult.addResult(validateDefinition(definitions, element.getDefinition()));
 172                 }
 173             }
 174         }
 175         return validationResult;
 176     }
 177
 178     /**
 179      * Validate ToscaConceptIdentifier, checking if exist in ToscaConceptIdentifiers map.
 180      *
 181      * @param definitions map of all ToscaConceptIdentifiers
 182      * @param definition ToscaConceptIdentifier to validate
 183      * @result result the validation result
 184      */
 185     private ValidationResult validateDefinition(Map<String, ToscaConceptIdentifier> definitions,
 186             ToscaConceptIdentifier definition) {
 187         BeanValidationResult result = new BeanValidationResult(definition.getName(), definition);
 188         ToscaConceptIdentifier identifier = definitions.get(definition.getName());
 189         if (identifier == null) {
 190             result.setResult(ValidationStatus.INVALID, "Not FOUND");
 191         } else if (!identifier.equals(definition)) {
 192             result.setResult(ValidationStatus.INVALID, "Version not matching");
 193         } else {
 194             result.setResult(ValidationStatus.CLEAN);
 195         }
 196         return (result.isClean() ? null : result);
 197     }
 198
 199     /**
 200      * Delete the control loop with the given name and version.
 201      *
 202      * @param name the name of the control loop to delete
 203      * @param version the version of the control loop to delete
 204      * @return the result of the deletion
 205      * @throws PfModelException on deletion errors
 206      */
 207     public InstantiationResponse deleteControlLoop(String name, String version) throws PfModelException {
 208         InstantiationResponse response = new InstantiationResponse();
 209         synchronized (lockit) {
 210             List<ControlLoop> controlLoops = controlLoopProvider.getControlLoops(name, version);
 211             if (controlLoops.isEmpty()) {
 212                 throw new PfModelException(Response.Status.NOT_FOUND, "Control Loop not found");
 213             }
 214             for (ControlLoop controlLoop : controlLoops) {
 215                 if (!ControlLoopState.UNINITIALISED.equals(controlLoop.getState())) {
 216                     throw new PfModelException(Response.Status.BAD_REQUEST,
 217                             "Control Loop State is still " + controlLoop.getState());
 218                 }
 219             }
 220
 221             response.setAffectedControlLoops(Collections
 222                     .singletonList(controlLoopProvider.deleteControlLoop(name, version).getKey().asIdentifier()));
 223         }
 224         return response;
 225     }
 226
 227     /**
 228      * Get the requested control loops.
 229      *
 230      * @param name the name of the control loop to get, null for all control loops
 231      * @param version the version of the control loop to get, null for all control loops
 232      * @return the control loops
 233      * @throws PfModelException on errors getting control loops
 234      */
 235     public ControlLoops getControlLoops(String name, String version) throws PfModelException {
 236         ControlLoops controlLoops = new ControlLoops();
 237         controlLoops.setControlLoopList(controlLoopProvider.getControlLoops(name, version));
 238
 239         return controlLoops;
 240     }
 241
 242     /**
 243      * Issue a command to control loops, setting their ordered state.
 244      *
 245      * @param command the command to issue to control loops
 246      * @return the result of the initiation command
 247      * @throws PfModelException on errors setting the ordered state on the control loops
 248      * @throws ControlLoopException on ordered state invalid
 249      */
 250     public InstantiationResponse issueControlLoopCommand(InstantiationCommand command)
 251             throws ControlLoopException, PfModelException {
 252
 253         if (command.getOrderedState() == null) {
 254             throw new ControlLoopException(Status.BAD_REQUEST, "ordered state invalid or not specified on command");
 255         }
 256
 257         synchronized (lockit) {
 258             List<ControlLoop> controlLoops = new ArrayList<>(command.getControlLoopIdentifierList().size());
 259             for (ToscaConceptIdentifier id : command.getControlLoopIdentifierList()) {
 260                 ControlLoop controlLoop = controlLoopProvider.getControlLoop(id);
 261                 controlLoop.setCascadedOrderedState(command.getOrderedState());
 262                 controlLoops.add(controlLoop);
 263             }
 264             controlLoopProvider.updateControlLoops(controlLoops);
 265         }
 266
 267         InstantiationResponse response = new InstantiationResponse();
 268         response.setAffectedControlLoops(command.getControlLoopIdentifierList());
 269
 270         return response;
 271     }
 272 }