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