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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021-2023 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.models.acm.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.clamp.models.acm.concepts.ParticipantState;
  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     private UUID compositionId;
  50
  51     /**
  52      * Participant ID, or {@code null} for messages from participants.
  53      */
  54     private UUID participantId;
  55
  56     /**
  57      * Participant State, or {@code null} for messages from participants.
  58      */
  59     private ParticipantState state;
  60
  61     /**
  62      * Constructor for instantiating a participant ack message class.
  63      *
  64      * @param messageType the message type
  65      */
  66     public ParticipantAckMessage(final ParticipantMessageType messageType) {
  67         this.messageType = messageType;
  68     }
  69
  70     /**
  71      * Constructs the object, making a deep copy.
  72      *
  73      * @param source source from which to copy
  74      */
  75     public ParticipantAckMessage(ParticipantAckMessage source) {
  76         this.responseTo = source.responseTo;
  77         this.result = source.result;
  78         this.message = source.message;
  79         this.messageType = source.messageType;
  80         this.participantId = source.participantId;
  81         this.state = source.state;
  82     }
  83
  84     /**
  85      * Determines if this message applies to this participant type.
  86      *
  87      * @param participantId id of the participant to match against
  88      * @return {@code true} if this message applies to this participant, {@code false} otherwise
  89      */
  90     public boolean appliesTo(@NonNull final UUID participantId) {
  91         // Broadcast message to all participants
  92         if (this.participantId == null) {
  93             return true;
  94         }
  95
  96         // Targeted message at this specific participant
  97         return participantId.equals(this.participantId);
  98     }
  99 }