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     /**
  55      * Automation Composition ID, or {@code null} for messages to participants.
  56      */
  57     private UUID automationCompositionId;
  58
  59     private UUID compositionId;
  60
  61     /**
  62      * Constructor for instantiating a participant message class.
  63      *
  64      * @param messageType the message type
  65      */
  66     public ParticipantMessage(final ParticipantMessageType messageType) {
  67         this.messageType = messageType;
  68     }
  69
  70     /**
  71      * Constructs the object, making a deep copy. Does <i>not</i> copy the request id or the time stamp.
  72      *
  73      * @param source source from which to copy
  74      */
  75     public ParticipantMessage(final ParticipantMessage source) {
  76         this.messageType = source.messageType;
  77         this.participantId = source.participantId;
  78         this.automationCompositionId = source.automationCompositionId;
  79         this.compositionId = source.compositionId;
  80     }
  81
  82     /**
  83      * Determines if this message applies to this participant type.
  84      *
  85      * @param participantId id of the participant to match against
  86      * @return {@code true} if this message applies to this participant, {@code false} otherwise
  87      */
  88     public boolean appliesTo(@NonNull final UUID participantId) {
  89         // Broadcast message to all participants
  90         if (this.participantId == null) {
  91             return true;
  92         }
  93
  94         // Targeted message at this specific participant
  95         return participantId.equals(this.participantId);
  96     }
  97 }