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.runtime.supervision.comm;
  22
  23 import java.util.List;
  24 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantControlLoopStateChange;
  25 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  26 import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClient;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 /**
  31  * This class is used to send ParticipantControlLoopStateChangePublisher messages to participants on DMaaP.
  32  */
  33 public class ParticipantControlLoopStateChangePublisher {
  34     private static final Logger LOGGER = LoggerFactory.getLogger(ParticipantControlLoopStateChangePublisher.class);
  35
  36     private TopicSinkClient topicSinkClient;
  37
  38     /**
  39      * Constructor for instantiating ParticipantControlLoopStateChangePublisherPublisher.
  40      *
  41      * @param topicSinks the topic sinks
  42      * @param interval time interval to send ParticipantControlLoopStateChangePublisher messages
  43      */
  44     public ParticipantControlLoopStateChangePublisher(final List<TopicSink> topicSinks, final long interval) {
  45         // TODO: Should not be dependent on the order of topic sinks in the config
  46         this.topicSinkClient = new TopicSinkClient(topicSinks.get(0));
  47     }
  48
  49     /**
  50      * Terminates the current timer.
  51      */
  52     public void terminate() {
  53         // This is a user initiated message and doesn't need a timer.
  54     }
  55
  56     /**
  57      * Get the current time interval used by the timer task.
  58      *
  59      * @return interval the current time interval
  60      */
  61     public long getInterval() {
  62         // This is a user initiated message and doesn't need a timer.
  63         return -1;
  64     }
  65
  66     /**
  67      * Method to send ParticipantControlLoopStateChangePublisher status message to participants on demand.
  68      *
  69      * @param controlLoopStateChange the ParticipantControlLoopStateChangePublisher message
  70      */
  71     public void send(final ParticipantControlLoopStateChange controlLoopStateChange) {
  72         topicSinkClient.send(controlLoopStateChange);
  73         LOGGER.debug("Sent ParticipantControlLoopStateChange to Participants - {}", controlLoopStateChange);
  74     }
  75 }