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

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