ScanStorageConfiguration.kt

/*
 * Copyright (C) 2017 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>)
 *
 * 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.model.config

import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.annotation.JsonSubTypes
import com.fasterxml.jackson.annotation.JsonSubTypes.Type
import com.fasterxml.jackson.annotation.JsonTypeInfo

import org.ossreviewtoolkit.model.Package
import org.ossreviewtoolkit.model.Provenance
import org.ossreviewtoolkit.utils.ort.storage.FileStorage

/**
 * Root of a class hierarchy for configuration classes for scan storage implementations.
 *
 * Based on this hierarchy, it is possible to have multiple different scan storages enabled and to configure them
 * dynamically.
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.MINIMAL_CLASS)
@JsonSubTypes(
    Type(ClearlyDefinedStorageConfiguration::class),
    Type(FileBasedStorageConfiguration::class),
    Type(PostgresStorageConfiguration::class),
    Type(Sw360StorageConfiguration::class)
)
sealed interface ScanStorageConfiguration

/**
 * The configuration model of a storage based on ClearlyDefined.
 */
data class ClearlyDefinedStorageConfiguration(
    /**
     * The URL of the ClearlyDefined server.
     */
    val serverUrl: String
) : ScanStorageConfiguration

/**
 * The configuration model of a file based storage.
 */
data class FileBasedStorageConfiguration(
    /**
     * The configuration of the [FileStorage] used to store the files.
     */
    val backend: FileStorageConfiguration,

    /**
     * The way that scan results are stored, defaults to [StorageType.PROVENANCE_BASED].
     */
    val type: StorageType = StorageType.PROVENANCE_BASED
) : ScanStorageConfiguration

/**
 * A class to hold the configuration for using Postgres as a storage.
 */
data class PostgresStorageConfiguration(
    /**
     * The configuration of the PostgreSQL database.
     */
    val connection: PostgresConnection,

    /**
     * The way that scan results are stored, defaults to [StorageType.PROVENANCE_BASED].
     */
    val type: StorageType = StorageType.PROVENANCE_BASED
) : ScanStorageConfiguration

/**
 * A class to hold the configuration for SW360.
 */
data class Sw360StorageConfiguration(
    /**
     * The REST API URL of SW360.
     */
    val restUrl: String,

    /**
     * The authentication URL of your SW360 instance.
     */
    val authUrl: String,

    /**
     * The username for the requests to SW360.
     */
    val username: String,

    /**
     * The password of the SW360 user.
     */
    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    val password: String = "",

    /**
     * The client ID of the SW360 instance for the two-step authentication.
     */
    val clientId: String,

    /**
     * The password of the client ID.
     */
    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    val clientPassword: String = "",

    /**
     * Optional access token that can be used instead of the [authUrl], [username], [password], [clientId] and
     * [clientPassword] if the token is already known.
     */
    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    val token: String = ""
) : ScanStorageConfiguration

/**
 * An enum to describe different types of storages.
 */
enum class StorageType {
    /**
     * A storage that stores scan results by [Package].
     */
    PACKAGE_BASED,

    /**
     * A storage that stores scan results by [Provenance].
     */
    PROVENANCE_BASED
}