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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021 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.controlloop.models.messages.dmaap.participant;
  22
  23 import java.util.UUID;
  24 import lombok.AccessLevel;
  25 import lombok.Getter;
  26 import lombok.NonNull;
  27 import lombok.Setter;
  28 import lombok.ToString;
  29 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  30
  31 /**
  32  * Class to represent the base class for various messages that will be exchanged between
  33  * the control loop runtime and participants.
  34  */
  35 @Getter
  36 @Setter
  37 @ToString
  38 public class ParticipantMessage {
  39     @Setter(AccessLevel.NONE)
  40     private ParticipantMessageType messageType;
  41
  42     private UUID requestId = UUID.randomUUID();
  43
  44     /**
  45      * Time-stamp, in milliseconds, when the message was created. Defaults to the current
  46      * time.
  47      */
  48     private long timestampMs = System.currentTimeMillis();
  49
  50     /**
  51      * Participant ID, or {@code null} for state-change broadcast messages.
  52      */
  53     private ToscaConceptIdentifier participantId;
  54
  55     /**
  56      * Control loop ID. For state-change messages, this may be {@code null}.
  57      */
  58     private ToscaConceptIdentifier controlLoopId;
  59
  60     /**
  61      * Constructor for instantiating a participant message class.
  62      *
  63      * @param messageType the message type
  64      */
  65     public ParticipantMessage(final ParticipantMessageType messageType) {
  66         this.messageType = messageType;
  67     }
  68
  69     /**
  70      * Constructs the object, making a deep copy. Does <i>not</i> copy the request id or
  71      * 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.controlLoopId = source.controlLoopId;
  79     }
  80
  81     /**
  82      * Determines if this message applies to this participant.
  83      *
  84      * @param participantId id of the participant to match against
  85      * @return {@code true} if this message applies to this participant, {@code false} otherwise
  86      */
  87     public boolean appliesTo(@NonNull final ToscaConceptIdentifier participantId) {
  88         if (participantId.equals(this.participantId)) {
  89             return true;
  90         }
  91
  92         // false: message included a participant ID, but it does not match
  93         // true: its a broadcast message
  94         return this.participantId == null;
  95     }
  96 }