forked from boschglobal/oss-review-toolkit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ScanStorageConfiguration.kt
117 lines (102 loc) · 3.38 KB
/
ScanStorageConfiguration.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
* Copyright (C) 2017-2019 HERE Europe B.V.
* Copyright (C) 2020 Bosch.IO GmbH
*
* 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-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.utils.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)
)
sealed class 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
) : ScanStorageConfiguration()
/**
* A class to hold the configuration for using Postgres as a storage.
*/
data class PostgresStorageConfiguration(
/**
* The database URL in JDBC format.
*/
val url: String,
/**
* The name of the database to use.
*/
val schema: String,
/**
* The username to use for authentication.
*/
val username: String,
/**
* The password to use for authentication.
*/
@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
val password: String = "",
/**
* The SSL mode to use, one of "disable", "allow", "prefer", "require", "verify-ca" or "verify-full".
* See: https://jdbc.postgresql.org/documentation/head/ssl-client.html
*/
val sslmode: String = "verify-full",
/**
* The full path of the certificate file.
* See: https://jdbc.postgresql.org/documentation/head/connect.html
*/
val sslcert: String? = null,
/**
* The full path of the key file.
* See: https://jdbc.postgresql.org/documentation/head/connect.html
*/
val sslkey: String? = null,
/**
* The full path of the root certificate file.
* See: https://jdbc.postgresql.org/documentation/head/connect.html
*/
val sslrootcert: String? = null
/**
* TODO: Make additional parameters configurable, see:
* https://jdbc.postgresql.org/documentation/head/connect.html
*/
) : ScanStorageConfiguration()