[policy/clamp.git] /

/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2021-2025 OpenInfra Foundation Europe. All rights reserved.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.clamp.acm.participant.intermediary.comm;

import io.micrometer.core.annotation.Timed;
import jakarta.ws.rs.core.Response.Status;
import java.util.List;
import lombok.Getter;
import org.onap.policy.clamp.acm.participant.intermediary.handler.Publisher;
import org.onap.policy.clamp.common.acm.exception.AutomationCompositionRuntimeException;
import org.onap.policy.clamp.common.acm.utils.NetLoggerUtil;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.AutomationCompositionDeployAck;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantDeregister;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantPrimeAck;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantRegister;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantReqSync;
import org.onap.policy.clamp.models.acm.messages.kafka.participant.ParticipantStatus;
import org.onap.policy.common.message.bus.event.TopicSink;
import org.onap.policy.common.message.bus.event.client.TopicSinkClient;
import org.springframework.stereotype.Component;

/**
 * This class is used to send Participant Status messages to clamp using TopicSinkClient.
 *
 */
@Component
public class ParticipantMessagePublisher implements Publisher {
    private static final String NOT_ACTIVE_TEXT = "Not Active!";

    @Getter
    private boolean active = false;
    private TopicSinkClient topicSinkClient;

    /**
     * Constructor for instantiating ParticipantMessagePublisher.
     *
     * @param topicSinks the topic sinks
     */
    @Override
    public void active(List<TopicSink> topicSinks) {
        if (topicSinks.size() != 1) {
            throw new IllegalArgumentException("Configuration unsupported, Topic sinks greater than 1");
        }
        this.topicSinkClient = new TopicSinkClient(topicSinks.get(0));
        active = true;
    }

    /**
     * Method to send Participant Request Sync message to clamp.
     *
     * @param participantReqSync the Participant Request Sync
     */
    @Timed(value = "publisher.participant_req_sync", description = "PARTICIPANT_REQ_SYNC_MSG messages published")
    public void sendParticipantReqSync(final ParticipantReqSync participantReqSync) {
        validate();
        topicSinkClient.send(participantReqSync);
        NetLoggerUtil.log(NetLoggerUtil.EventType.OUT, topicSinkClient.getSink().getTopicCommInfrastructure(),
                topicSinkClient.getTopic(), "Sent Participant Request Sync to CLAMP - "
                        + participantReqSync.toString());
    }

    /**
     * Method to send Participant Status message to clamp on demand.
     *
     * @param participantStatus the Participant Status
     */
    @Timed(value = "publisher.participant_status", description = "PARTICIPANT_STATUS messages published")
    public void sendParticipantStatus(final ParticipantStatus participantStatus) {
        validate();
        topicSinkClient.send(participantStatus);
        NetLoggerUtil.log(NetLoggerUtil.EventType.OUT, topicSinkClient.getSink().getTopicCommInfrastructure(),
                topicSinkClient.getTopic(), "Sent Participant Status message to CLAMP - "
                        + participantStatus.toString());
    }

    /**
     * Method to send Participant Status message to clamp on demand.
     *
     * @param participantRegister the Participant Status
     */
    @Timed(value = "publisher.participant_register", description = "PARTICIPANT_REGISTER messages published")
    public void sendParticipantRegister(final ParticipantRegister participantRegister) {
        validate();
        topicSinkClient.send(participantRegister);
        NetLoggerUtil.log(NetLoggerUtil.EventType.OUT, topicSinkClient.getSink().getTopicCommInfrastructure(),
                topicSinkClient.getTopic(), "Sent Participant Register message to CLAMP - "
                        + participantRegister.toString());
    }

    /**
     * Method to send Participant Status message to clamp on demand.
     *
     * @param participantDeregister the Participant Status
     */
    @Timed(value = "publisher.participant_deregister", description = "PARTICIPANT_DEREGISTER messages published")
    public void sendParticipantDeregister(final ParticipantDeregister participantDeregister) {
        validate();
        topicSinkClient.send(participantDeregister);
        NetLoggerUtil.log(NetLoggerUtil.EventType.OUT, topicSinkClient.getSink().getTopicCommInfrastructure(),
                topicSinkClient.getTopic(), "Sent Participant Deregister message to CLAMP - "
                        + participantDeregister.toString());
    }

    /**
     * Method to send Participant Prime Ack message to runtime.
     *
     * @param participantPrimeAck the Participant Prime Ack
     */
    @Timed(value = "publisher.participant_prime_ack", description = "PARTICIPANT_PRIME_ACK messages published")
    public void sendParticipantPrimeAck(final ParticipantPrimeAck participantPrimeAck) {
        validate();
        topicSinkClient.send(participantPrimeAck);
        NetLoggerUtil.log(NetLoggerUtil.EventType.OUT, topicSinkClient.getSink().getTopicCommInfrastructure(),
                topicSinkClient.getTopic(), "Sent Participant Prime Ack message to CLAMP - "
                        + participantPrimeAck.toString());
    }

    /**
     * Method to send AutomationComposition Update/StateChange Ack message to runtime.
     *
     * @param automationCompositionAck AutomationComposition Update/StateChange Ack
     */
    @Timed(value = "publisher.automation_composition_update_ack",
            description = "AUTOMATION_COMPOSITION_UPDATE_ACK/AUTOMATION_COMPOSITION_STATECHANGE_ACK messages published")
    public void sendAutomationCompositionAck(final AutomationCompositionDeployAck automationCompositionAck) {
        validate();
        NetLoggerUtil.log(NetLoggerUtil.EventType.OUT, topicSinkClient.getSink().getTopicCommInfrastructure(),
                topicSinkClient.getTopic(), "Sent AutomationComposition Update/StateChange Ack to runtime - "
                        + automationCompositionAck.toString());
    }

    private void validate() {
        if (!active) {
            throw new AutomationCompositionRuntimeException(Status.NOT_ACCEPTABLE, NOT_ACTIVE_TEXT);
        }
    }

    @Override
    public void stop() {
        active = false;
    }
}