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.participant.intermediary.comm;
  22
  23 import java.util.List;
  24 import javax.ws.rs.core.Response.Status;
  25 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopRuntimeException;
  26 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ControlLoopAck;
  27 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantDeregister;
  28 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantRegister;
  29 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantStatus;
  30 import org.onap.policy.clamp.controlloop.models.messages.dmaap.participant.ParticipantUpdateAck;
  31 import org.onap.policy.clamp.controlloop.participant.intermediary.handler.Publisher;
  32 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  33 import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClient;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36 import org.springframework.stereotype.Component;
  37
  38 /**
  39  * This class is used to send Participant Status messages to clamp using TopicSinkClient.
  40  *
  41  */
  42 @Component
  43 public class ParticipantMessagePublisher implements Publisher {
  44     private static final Logger LOGGER = LoggerFactory.getLogger(ParticipantMessagePublisher.class);
  45
  46     private boolean active = false;
  47     private TopicSinkClient topicSinkClient;
  48
  49     /**
  50      * Constructor for instantiating ParticipantMessagePublisher.
  51      *
  52      * @param topicSinks the topic sinks
  53      */
  54     @Override
  55     public void active(List<TopicSink> topicSinks) {
  56         if (topicSinks.size() != 1) {
  57             throw new IllegalArgumentException("Configuration unsupported, Topic sinks greater than 1");
  58         }
  59         this.topicSinkClient = new TopicSinkClient(topicSinks.get(0));
  60         active = true;
  61     }
  62
  63     /**
  64      * Method to send Participant Status message to clamp on demand.
  65      *
  66      * @param participantStatus the Participant Status
  67      */
  68     public void sendParticipantStatus(final ParticipantStatus participantStatus) {
  69         if (!active) {
  70             throw new ControlLoopRuntimeException(Status.NOT_ACCEPTABLE, "Not Active!");
  71         }
  72         topicSinkClient.send(participantStatus);
  73         LOGGER.debug("Sent Participant Status message to CLAMP - {}", participantStatus);
  74     }
  75
  76     /**
  77      * Method to send Participant Status message to clamp on demand.
  78      *
  79      * @param participantRegister the Participant Status
  80      */
  81     public void sendParticipantRegister(final ParticipantRegister participantRegister) {
  82         if (!active) {
  83             throw new ControlLoopRuntimeException(Status.NOT_ACCEPTABLE, "Not Active!");
  84         }
  85         topicSinkClient.send(participantRegister);
  86         LOGGER.debug("Sent Participant Register message to CLAMP - {}", participantRegister);
  87     }
  88
  89     /**
  90      * Method to send Participant Status message to clamp on demand.
  91      *
  92      * @param participantDeregister the Participant Status
  93      */
  94     public void sendParticipantDeregister(final ParticipantDeregister participantDeregister) {
  95         if (!active) {
  96             throw new ControlLoopRuntimeException(Status.NOT_ACCEPTABLE, "Not Active!");
  97         }
  98         topicSinkClient.send(participantDeregister);
  99         LOGGER.debug("Sent Participant Deregister message to CLAMP - {}", participantDeregister);
 100     }
 101
 102     /**
 103      * Method to send Participant Update Ack message to runtime.
 104      *
 105      * @param participantUpdateAck the Participant Update Ack
 106      */
 107     public void sendParticipantUpdateAck(final ParticipantUpdateAck participantUpdateAck) {
 108         if (!active) {
 109             throw new ControlLoopRuntimeException(Status.NOT_ACCEPTABLE, "Not Active!");
 110         }
 111         topicSinkClient.send(participantUpdateAck);
 112         LOGGER.debug("Sent Participant Update Ack message to CLAMP - {}", participantUpdateAck);
 113     }
 114
 115     /**
 116      * Method to send ControlLoop Update/StateChange Ack message to runtime.
 117      *
 118      * @param controlLoopAck ControlLoop Update/StateChange Ack
 119      */
 120     public void sendControlLoopAck(final ControlLoopAck controlLoopAck) {
 121         if (!active) {
 122             throw new ControlLoopRuntimeException(Status.NOT_ACCEPTABLE, "Not Active!");
 123         }
 124         topicSinkClient.send(controlLoopAck);
 125         LOGGER.debug("Sent ControlLoop Update/StateChange Ack to runtime - {}", controlLoopAck);
 126     }
 127
 128     /**
 129      * Method to send Participant heartbeat to clamp on demand.
 130      *
 131      * @param participantStatus the Participant Status
 132      */
 133     public void sendHeartbeat(final ParticipantStatus participantStatus) {
 134         if (!active) {
 135             throw new ControlLoopRuntimeException(Status.NOT_ACCEPTABLE, "Not Active!");
 136         }
 137         topicSinkClient.send(participantStatus);
 138         LOGGER.debug("Sent Participant heartbeat to CLAMP - {}", participantStatus);
 139     }
 140
 141     @Override
 142     public void stop() {
 143         active = false;
 144     }
 145 }