poapsis.ortserver.transport.transport-spi.0.1.0-RC3.source-code.MessagePublisher.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transport-spi Show documentation
Part of the ORT Server, the reference implementation of Eclipse Apoapsis.
There is a newer version: 0.1.0-RC6
/*
 * Copyright (C) 2022 The ORT Server Authors (See )
 *
 * 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
 *
 *     https://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-Filename: LICENSE
 */

package org.eclipse.apoapsis.ortserver.transport

import org.eclipse.apoapsis.ortserver.config.ConfigManager

import org.slf4j.LoggerFactory

private val log = LoggerFactory.getLogger(MessagePublisher::class.java)

/**
 * A helper class for sending messages to arbitrary supported endpoints.
 *
 * This class releases clients from the burden to manage dedicated [MessageSender] instances for all the endpoints
 * they have to interact with. It offers a simple [publish] function that expects the target endpoint and the
 * message and takes care about the internal plumbing of obtaining the correct sender from the factory.
 */
class MessagePublisher(
    /**
     * The configuration of this endpoint. This determines the transport implementations to be used when sending
     * messages.
     */
    private val configManager: ConfigManager
) {
    /** The sender to the Orchestrator endpoint. */
    private val orchestratorSender by lazy { MessageSenderFactory.createSender(OrchestratorEndpoint, configManager) }

    /** The sender to the Config endpoint. */
    private val configSender by lazy { MessageSenderFactory.createSender(ConfigEndpoint, configManager) }

    /** The sender to the Analyzer endpoint. */
    private val analyzerSender by lazy { MessageSenderFactory.createSender(AnalyzerEndpoint, configManager) }

    /** The sender to the Advisor endpoint. */
    private val advisorSender by lazy { MessageSenderFactory.createSender(AdvisorEndpoint, configManager) }

    /** The sender to the Scanner endpoint. */
    private val scannerSender by lazy { MessageSenderFactory.createSender(ScannerEndpoint, configManager) }

    /** The sender to the Evaluator endpoint. */
    private val evaluatorSender by lazy { MessageSenderFactory.createSender(EvaluatorEndpoint, configManager) }

    /** The sender to the Reporter endpoint. */
    private val reporterSender by lazy { MessageSenderFactory.createSender(ReporterEndpoint, configManager) }

    /** The sender to the Notifier endpoint. */
    private val notifierSender by lazy { MessageSenderFactory.createSender(NotifierEndpoint, configManager) }

    /**
     * Send the given [message] to the specified [endpoint][to].
     */
    fun  publish(to: Endpoint, message: Message) {
        log.info(
            "Sending '${message.payload::class.simpleName}' message " +
                    "to '${to::class.simpleName}'. " +
                    "TraceID: '${message.header.traceId}'."
        )

        @Suppress("UNCHECKED_CAST")
        val sender = when (to) {
            is OrchestratorEndpoint -> orchestratorSender
            is ConfigEndpoint -> configSender
            is AnalyzerEndpoint -> analyzerSender
            is AdvisorEndpoint -> advisorSender
            is ScannerEndpoint -> scannerSender
            is EvaluatorEndpoint -> evaluatorSender
            is ReporterEndpoint -> reporterSender
            is NotifierEndpoint -> notifierSender
        } as MessageSender

        sender.send(message)
    }
}