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.models.messages.dmaap.participant;
  22
  23 import java.util.LinkedHashMap;
  24 import java.util.Map;
  25 import java.util.UUID;
  26 import java.util.function.UnaryOperator;
  27 import lombok.Getter;
  28 import lombok.Setter;
  29 import lombok.ToString;
  30 import org.apache.commons.lang3.tuple.Pair;
  31 import org.onap.policy.models.base.PfUtils;
  32 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  33
  34 /**
  35  * Class to represent the CONTROLLOOP_ACK message that a participant sends
  36  * to control loop runtime as an acknowledgement to either ControlLoopUpdate
  37  * or ControlLoopStateChange message.
  38  */
  39 @Getter
  40 @Setter
  41 @ToString(callSuper = true)
  42 public class ControlLoopAck extends ParticipantAckMessage {
  43
  44     /**
  45      * Participant ID, or {@code null} for messages from participants.
  46      */
  47     private ToscaConceptIdentifier participantId;
  48
  49     /**
  50      * Participant Type, or {@code null} for messages from participants.
  51      */
  52     private ToscaConceptIdentifier participantType;
  53
  54     /**
  55      * Control loop ID, or {@code null} for messages to participants.
  56      */
  57     private ToscaConceptIdentifier controlLoopId;
  58
  59     // A map with ControlLoopElementID as its key, and a pair of result and message as value per
  60     // ControlLoopElement.
  61     private Map<UUID, Pair<Boolean, String>> controlLoopResultMap = new LinkedHashMap<>();
  62
  63     /**
  64      * Constructor for instantiating ParticipantRegisterAck class with message name.
  65      *
  66      */
  67     public ControlLoopAck(final ParticipantMessageType messageType) {
  68         super(messageType);
  69     }
  70
  71     /**
  72      * Constructs the object, making a deep copy.
  73      *
  74      * @param source source from which to copy
  75      */
  76     public ControlLoopAck(final ControlLoopAck source) {
  77         super(source);
  78         this.participantId = source.participantId;
  79         this.participantType = source.participantType;
  80         this.controlLoopId = source.controlLoopId;
  81         this.controlLoopResultMap = PfUtils.mapMap(source.controlLoopResultMap, UnaryOperator.identity());
  82     }
  83 }