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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021-2024 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.kafka.participant;
  22
  23 import java.time.Instant;
  24 import java.util.UUID;
  25 import lombok.AccessLevel;
  26 import lombok.Getter;
  27 import lombok.NonNull;
  28 import lombok.Setter;
  29 import lombok.ToString;
  30
  31 /**
  32  * Class to represent the base class for various messages that will be exchanged between the ACM runtime and
  33  * participants.
  34  */
  35 @Getter
  36 @Setter
  37 @ToString
  38 public class ParticipantMessage {
  39     @Setter(AccessLevel.NONE)
  40     private ParticipantMessageType messageType;
  41
  42     private UUID messageId = UUID.randomUUID();
  43
  44     /**
  45      * Time-stamp, in milliseconds, when the message was created. Defaults to the current time.
  46      */
  47     private Instant timestamp = Instant.now();
  48
  49     /**
  50      * Participant ID, or {@code null} for messages from participants.
  51      */
  52     private UUID participantId;
  53
  54     private UUID replicaId;
  55
  56     /**
  57      * Automation Composition ID, or {@code null} for messages to participants.
  58      */
  59     private UUID automationCompositionId;
  60
  61     private UUID compositionId;
  62
  63     /**
  64      * Constructor for instantiating a participant message class.
  65      *
  66      * @param messageType the message type
  67      */
  68     public ParticipantMessage(final ParticipantMessageType messageType) {
  69         this.messageType = messageType;
  70     }
  71
  72     /**
  73      * Constructs the object, making a deep copy. Does <i>not</i> copy the request id or the time stamp.
  74      *
  75      * @param source source from which to copy
  76      */
  77     public ParticipantMessage(final ParticipantMessage source) {
  78         this.messageType = source.messageType;
  79         this.participantId = source.participantId;
  80         this.replicaId = source.replicaId;
  81         this.automationCompositionId = source.automationCompositionId;
  82         this.compositionId = source.compositionId;
  83     }
  84
  85     /**
  86      * Determines if this message applies to this participant type.
  87      *
  88      * @param participantId id of the participant to match against
  89      * @param replicaId id of the participant to match against
  90      * @return {@code true} if this message applies to this participant, {@code false} otherwise
  91      */
  92     public boolean appliesTo(@NonNull final UUID participantId, @NonNull final UUID replicaId) {
  93         // Broadcast message to all participants
  94         if ((this.participantId == null)
  95                 || (participantId.equals(this.participantId) && this.replicaId == null)) {
  96             return true;
  97         }
  98
  99         // Targeted message at this specific participant
 100         return replicaId.equals(this.replicaId);
 101     }
 102 }