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.UUID;
  24 import lombok.Getter;
  25 import lombok.NonNull;
  26 import lombok.Setter;
  27 import lombok.ToString;
  28 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  29
  30 /**
  31  * Class to represent participant Ack message.
  32  */
  33 @Getter
  34 @Setter
  35 @ToString
  36 public class ParticipantAckMessage {
  37
  38     // The responseTo field should match the original request id in the request.
  39     private UUID responseTo;
  40
  41     // Result: Success/Fail.
  42     private Boolean result;
  43
  44     // Message indicating reason for failure
  45     private String message;
  46
  47     private ParticipantMessageType messageType;
  48
  49     /**
  50      * Participant Type, or {@code null} for messages from participants.
  51      */
  52     private ToscaConceptIdentifier participantType;
  53
  54     /**
  55      * Participant ID, or {@code null} for messages from participants.
  56      */
  57     private ToscaConceptIdentifier participantId;
  58
  59     /**
  60      * Constructor for instantiating a participant ack message class.
  61      *
  62      * @param messageType the message type
  63      */
  64     public ParticipantAckMessage(final ParticipantMessageType messageType) {
  65         this.messageType = messageType;
  66     }
  67
  68     /**
  69      * Constructs the object, making a deep copy.
  70      *
  71      * @param source source from which to copy
  72      */
  73     public ParticipantAckMessage(ParticipantAckMessage source) {
  74         this.responseTo = source.responseTo;
  75         this.result = source.result;
  76         this.message = source.message;
  77         this.messageType = source.messageType;
  78         this.participantType = source.participantType;
  79         this.participantId = source.participantId;
  80     }
  81
  82     /**
  83      * Determines if this message applies to this participant type.
  84      *
  85      * @param participantType type of the participant to match against
  86      * @param participantId id of the participant to match against
  87      * @return {@code true} if this message applies to this participant, {@code false} otherwise
  88      */
  89     public boolean appliesTo(@NonNull final ToscaConceptIdentifier participantType,
  90             @NonNull final ToscaConceptIdentifier participantId) {
  91         // Broadcast message to all participants
  92         if (this.participantType == null) {
  93             return true;
  94         }
  95
  96         if (!participantType.equals(this.participantType)) {
  97             return false;
  98         }
  99
 100         // Broadcast message to all control loop elements on this participant
 101         if (this.participantId == null) {
 102             return true;
 103         }
 104
 105         // Targeted message at this specific participant
 106         return participantId.equals(this.participantId);
 107     }
 108 }