toolkit.utils.common-utils.33.0.0.source-code.PluginManager.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-utils Show documentation

Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.

There is a newer version: 41.0.0

/*
 * Copyright (C) 2022 The ORT Project 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.ossreviewtoolkit.utils.common

import java.util.ServiceLoader

/**
 * Return a [ServiceLoader] that is capable of loading services of type [T].
 */
inline fun  getLoaderFor(): ServiceLoader = ServiceLoader.load(T::class.java)

/**
 * An interface to be implemented by any ORT plugin.
 */
interface Plugin {
    companion object {
        /**
         * Return instances for all ORT plugins of type [T].
         */
        inline fun  getAll() =
            getLoaderFor()
                .iterator()
                .asSequence()
                .associateByTo(sortedMapOf(String.CASE_INSENSITIVE_ORDER)) {
                    it.type
                }
    }

    /**
     * The type of the plugin.
     */
    val type: String

    /**
     * A flag to indicate whether the plugin should be enabled by default or not.
     */
    val isEnabledByDefault: Boolean
        get() = true
}

/**
 * An interface to be implemented by plugin factories. Plugin factories are required if a plugin needs configuration
 * on initialization and can therefore not be created directly by the [ServiceLoader].
 */
interface ConfigurablePluginFactory : Plugin {
    /**
     * Create a new instance of [PLUGIN] from [options] and [secrets].
     */
    fun create(options: Options, secrets: Options): PLUGIN
}

/**
 * An interface to be implemented by [configurable plugin factories][ConfigurablePluginFactory] that provide a
 * [typed configuration class][CONFIG]. The benefit of implementing this interface over [ConfigurablePluginFactory] is
 * that it enforces the separation of parsing the config map and creating the plugin.
 */
interface TypedConfigurablePluginFactory : ConfigurablePluginFactory {
    override fun create(options: Options, secrets: Options): PLUGIN = create(parseConfig(options, secrets))

    /**
     * Create a new instance of [PLUGIN] from [config].
     */
    fun create(config: CONFIG): PLUGIN

    /**
     * Parse the [options] and [secrets] map into a [CONFIG] object.
     */
    fun parseConfig(options: Options, secrets: Options): CONFIG
}