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 lombok.Getter;
  27 import lombok.Setter;
  28 import lombok.ToString;
  29 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
  30 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantHealthStatus;
  31 import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantState;
  32 import org.onap.policy.models.base.PfUtils;
  33 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  34
  35 /**
  36  * Class to represent the PARTICIPANT_STATUS message that all the participants send to the control loop runtime.
  37  */
  38 @Getter
  39 @Setter
  40 @ToString(callSuper = true)
  41 public class ParticipantStatus extends ParticipantMessage {
  42     // The response should be completed if this message is a response to a request from the Control Loop Runtime
  43     private ParticipantResponseDetails response;
  44
  45     // State and health status of the participant
  46     private ParticipantState state;
  47     private ParticipantHealthStatus healthStatus;
  48
  49     // This map is a map of the state of all control loop elements the participant has. The ToscaConceptIdentifier key
  50     // of the outer map is a key that identifies the control loop. There is an inner map for each control loop the
  51     // participant has. Each inner map has the UUID that identifies the ControlLoopElement instance, and the value is
  52     // the ControlLoopInstance itself.
  53     private Map<ToscaConceptIdentifier, Map<UUID, ControlLoopElement>> elements;
  54
  55     // Description. May be left {@code null}.
  56     private String message;
  57
  58     /**
  59      * Constructor for instantiating ParticipantStatus class with message name.
  60      *
  61      */
  62     public ParticipantStatus() {
  63         super(ParticipantMessageType.PARTICIPANT_STATUS);
  64     }
  65
  66     /**
  67      * Constructs the object, making a deep copy.
  68      *
  69      * @param source source from which to copy
  70      */
  71     public ParticipantStatus(final ParticipantStatus source) {
  72         super(source);
  73
  74         this.state = source.state;
  75         this.healthStatus = source.healthStatus;
  76         this.message = source.message;
  77         this.elements = PfUtils.mapMap(elements, LinkedHashMap::new);
  78         this.response = (source.response == null ? null : new ParticipantResponseDetails(source.response));
  79     }
  80 }