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.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
  34  * the control loop runtime and 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
  47      * time.
  48      */
  49     private Instant timestamp = Instant.now();
  50
  51     /**
  52      * Participant ID, or {@code null} for state-change broadcast messages.
  53      */
  54     private ToscaConceptIdentifier participantId;
  55
  56     /**
  57      * Control loop ID. For state-change messages, this may be {@code null}.
  58      */
  59     private ToscaConceptIdentifier controlLoopId;
  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
  72      * the time stamp.
  73      *
  74      * @param source source from which to copy
  75      */
  76     public ParticipantMessage(final ParticipantMessage source) {
  77         this.messageType = source.messageType;
  78         this.participantId = source.participantId;
  79         this.controlLoopId = source.controlLoopId;
  80     }
  81
  82     /**
  83      * Determines if this message applies to this participant.
  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 ToscaConceptIdentifier participantId) {
  89         if (participantId.equals(this.participantId)) {
  90             return true;
  91         }
  92
  93         // false: message included a participant ID, but it does not match
  94         // true: its a broadcast message
  95         return this.participantId == null;
  96     }
  97 }