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.participant.simulator.simulation;
  22
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.UUID;
  26 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
  27 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
  28 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoops;
  29 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.Participant;
  30 import org.onap.policy.clamp.controlloop.models.messages.rest.TypedSimpleResponse;
  31 import org.onap.policy.clamp.controlloop.participant.intermediary.api.ParticipantIntermediaryApi;
  32 import org.springframework.stereotype.Service;
  33
  34 /**
  35  * This provider class simulation of participants and control loop elements.
  36  */
  37 @Service
  38 public class SimulationProvider {
  39
  40     private final ParticipantIntermediaryApi intermediaryApi;
  41
  42     /**
  43      * Create a participant simulation provider.
  44      * @param intermediaryApi the intermediary to use for talking to the CLAMP runtime
  45      */
  46     public SimulationProvider(ParticipantIntermediaryApi intermediaryApi) {
  47         this.intermediaryApi = intermediaryApi;
  48     }
  49
  50     /**
  51      * Get the control loops.
  52      *
  53      * @param name the controlLoop, null to get all
  54      * @param version the controlLoop, null to get all
  55      * @return the control loops
  56      * @throws ControlLoopException on errors getting the control loops
  57      */
  58     public ControlLoops getControlLoops(String name, String version) throws ControlLoopException {
  59         return intermediaryApi.getControlLoops(name, version);
  60     }
  61
  62     /**
  63      * Get the simulated control loop elements.
  64      *
  65      * @param name the controlLoopElement, null to get all
  66      * @param version the controlLoopElement, null to get all
  67      * @return the control loop elements
  68      */
  69     public Map<UUID, ControlLoopElement> getControlLoopElements(String name, String version) {
  70         return intermediaryApi.getControlLoopElements(name, version);
  71     }
  72
  73     /**
  74      * Update the given control loop element in the simulator.
  75      *
  76      * @param element the control loop element to update
  77      * @return response simple response returned
  78      */
  79     public TypedSimpleResponse<ControlLoopElement> updateControlLoopElement(ControlLoopElement element) {
  80         TypedSimpleResponse<ControlLoopElement> response = new TypedSimpleResponse<>();
  81         response.setResponse(intermediaryApi.updateControlLoopElementState(element.getId(), element.getOrderedState(),
  82                 element.getState()));
  83         return response;
  84     }
  85
  86     /**
  87      * Get the current simulated participants.
  88      *
  89      * @param name the participant, null to get all
  90      * @param version the participant, null to get all
  91      * @return the list of participants
  92      */
  93     public List<Participant> getParticipants(String name, String version) {
  94         return intermediaryApi.getParticipants(name, version);
  95     }
  96
  97     /**
  98      * Update a simulated participant.
  99      *
 100      * @param participant the participant to update
 101      * @return TypedSimpleResponse simple response
 102      */
 103     public TypedSimpleResponse<Participant> updateParticipant(Participant participant) {
 104         TypedSimpleResponse<Participant> response = new TypedSimpleResponse<>();
 105         response.setResponse(
 106                 intermediaryApi.updateParticipantState(participant.getDefinition(), participant.getParticipantState()));
 107         return response;
 108     }
 109 }