All Implemented Interfaces:


public final class OrtConfiguration

The configuration model for all ORT components.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`OrtConfiguration.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`addAuthorsToCopyrights`
`private final Set<String>`	`allowedProcessEnvironmentVariableNames`
`private final Set<String>`	`deniedProcessEnvironmentVariablesSubstrings`
`private final Boolean`	`enableRepositoryPackageConfigurations`
`private final Boolean`	`enableRepositoryPackageCurations`
`private final Boolean`	`forceOverwrite`
`private final LicenseFilePatterns`	`licenseFilePatterns`
`private final List<ProviderPluginConfiguration>`	`packageConfigurationProviders`
`private final List<ProviderPluginConfiguration>`	`packageCurationProviders`
`private final Severity`	`severeIssueThreshold`
`private final Severity`	`severeRuleViolationThreshold`
`private final AnalyzerConfiguration`	`analyzer`
`private final AdvisorConfiguration`	`advisor`
`private final DownloaderConfiguration`	`downloader`
`private final ScannerConfiguration`	`scanner`
`private final ReporterConfiguration`	`reporter`
`private final NotifierConfiguration`	`notifier`
`public final static OrtConfiguration.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
OrtConfiguration(Boolean addAuthorsToCopyrights, Set<String> allowedProcessEnvironmentVariableNames, Set<String> deniedProcessEnvironmentVariablesSubstrings, Boolean enableRepositoryPackageConfigurations, Boolean enableRepositoryPackageCurations, Boolean forceOverwrite, LicenseFilePatterns licenseFilePatterns, List<ProviderPluginConfiguration> packageConfigurationProviders, List<ProviderPluginConfiguration> packageCurationProviders, Severity severeIssueThreshold, Severity severeRuleViolationThreshold, AnalyzerConfiguration analyzer, AdvisorConfiguration advisor, DownloaderConfiguration downloader, ScannerConfiguration scanner, ReporterConfiguration reporter, NotifierConfiguration notifier)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getAddAuthorsToCopyrights()`	A flag to indicate whether authors should be considered as copyright holders.
`final Set<String>`	`getAllowedProcessEnvironmentVariableNames()`	A set with the names of environment variables that are explicitly allowed to be passed to child processes, even if they are matched by one of the deniedProcessEnvironmentVariablesSubstrings.
`final Set<String>`	`getDeniedProcessEnvironmentVariablesSubstrings()`	A set with substrings to filter out environment variables before creating child processes to prevent that those processes can access sensitive information.
`final Boolean`	`getEnableRepositoryPackageConfigurations()`	Enable the usage of project-local package configurations from the RepositoryConfiguration.
`final Boolean`	`getEnableRepositoryPackageCurations()`	Enable the usage of project-local package curations from the RepositoryConfiguration.
`final Boolean`	`getForceOverwrite()`	Force overwriting of any existing output files.
`final LicenseFilePatterns`	`getLicenseFilePatterns()`	The license file patterns.
`final List<ProviderPluginConfiguration>`	`getPackageConfigurationProviders()`	The package configuration providers to use.
`final List<ProviderPluginConfiguration>`	`getPackageCurationProviders()`	The package curation providers to use.
`final Severity`	`getSevereIssueThreshold()`	The threshold from which on issues count as severe.
`final Severity`	`getSevereRuleViolationThreshold()`	The threshold from which on rule violations count as severe.
`final AnalyzerConfiguration`	`getAnalyzer()`	The configuration of the analyzer.
`final AdvisorConfiguration`	`getAdvisor()`	The configuration of the advisors, using the advisor's name as the key.
`final DownloaderConfiguration`	`getDownloader()`	The configuration of the downloader.
`final ScannerConfiguration`	`getScanner()`	The configuration of the scanner.
`final ReporterConfiguration`	`getReporter()`	The configuration of the reporter.
`final NotifierConfiguration`	`getNotifier()`	The configuration of the notifier.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OrtConfiguration
```
OrtConfiguration(Boolean addAuthorsToCopyrights, Set<String> allowedProcessEnvironmentVariableNames, Set<String> deniedProcessEnvironmentVariablesSubstrings, Boolean enableRepositoryPackageConfigurations, Boolean enableRepositoryPackageCurations, Boolean forceOverwrite, LicenseFilePatterns licenseFilePatterns, List<ProviderPluginConfiguration> packageConfigurationProviders, List<ProviderPluginConfiguration> packageCurationProviders, Severity severeIssueThreshold, Severity severeRuleViolationThreshold, AnalyzerConfiguration analyzer, AdvisorConfiguration advisor, DownloaderConfiguration downloader, ScannerConfiguration scanner, ReporterConfiguration reporter, NotifierConfiguration notifier)
```
- Method Detail
  - getAddAuthorsToCopyrights
```
 final Boolean getAddAuthorsToCopyrights()
```
    A flag to indicate whether authors should be considered as copyright holders.
  - getAllowedProcessEnvironmentVariableNames
```
 final Set<String> getAllowedProcessEnvironmentVariableNames()
```
    A set with the names of environment variables that are explicitly allowed to be passed to child processes, even if they are matched by one of the deniedProcessEnvironmentVariablesSubstrings. See EnvironmentVariableFilter for further details.
  - getDeniedProcessEnvironmentVariablesSubstrings
```
 final Set<String> getDeniedProcessEnvironmentVariablesSubstrings()
```
    A set with substrings to filter out environment variables before creating child processes to prevent that those processes can access sensitive information. See EnvironmentVariableFilter for further details.
  - getEnableRepositoryPackageConfigurations
```
 final Boolean getEnableRepositoryPackageConfigurations()
```
    Enable the usage of project-local package configurations from the RepositoryConfiguration. If set to true, apply package configurations from a local .ort.yml file before applying those specified via the command line i.e. configurations from the .ort.yml take precedence.
  - getEnableRepositoryPackageCurations
```
 final Boolean getEnableRepositoryPackageCurations()
```
    Enable the usage of project-local package curations from the RepositoryConfiguration. If set to true, apply package curations from a local .ort.yml file before applying those specified via the command line i.e. curations from the .ort.yml take precedence.
  - getForceOverwrite
```
 final Boolean getForceOverwrite()
```
    Force overwriting of any existing output files.
  - getLicenseFilePatterns
```
 final LicenseFilePatterns getLicenseFilePatterns()
```
    The license file patterns.
  - getPackageConfigurationProviders
```
 final List<ProviderPluginConfiguration> getPackageConfigurationProviders()
```
    The package configuration providers to use. Defaults to the provider ORT_PACKAGE_CONFIGURATIONS_DIRNAME configuration location.
  - getPackageCurationProviders
```
 final List<ProviderPluginConfiguration> getPackageCurationProviders()
```
    The package curation providers to use. Defaults to providers for the default ORT_PACKAGE_CURATIONS_FILENAME and ORT_PACKAGE_CURATIONS_DIRNAME configuration locations. The order of this list defines the priority of the providers: Providers that appear earlier in the list can overwrite curations for the same package from providers that appear later in the list.
  - getSevereIssueThreshold
```
 final Severity getSevereIssueThreshold()
```
    The threshold from which on issues count as severe.
  - getSevereRuleViolationThreshold
```
 final Severity getSevereRuleViolationThreshold()
```
    The threshold from which on rule violations count as severe.
  - getAnalyzer
```
 final AnalyzerConfiguration getAnalyzer()
```
    The configuration of the analyzer.
  - getAdvisor
```
 final AdvisorConfiguration getAdvisor()
```
    The configuration of the advisors, using the advisor's name as the key.
  - getDownloader
```
 final DownloaderConfiguration getDownloader()
```
    The configuration of the downloader.
  - getScanner
```
 final ScannerConfiguration getScanner()
```
    The configuration of the scanner.
  - getReporter
```
 final ReporterConfiguration getReporter()
```
    The configuration of the reporter.
  - getNotifier
```
 final NotifierConfiguration getNotifier()
```
    The configuration of the notifier.

Class OrtConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrtConfiguration

Method Detail

getAddAuthorsToCopyrights

getAllowedProcessEnvironmentVariableNames

getDeniedProcessEnvironmentVariablesSubstrings

getEnableRepositoryPackageConfigurations

getEnableRepositoryPackageCurations

getForceOverwrite

getLicenseFilePatterns

getPackageConfigurationProviders

getPackageCurationProviders

getSevereIssueThreshold

getSevereRuleViolationThreshold

getAnalyzer

getAdvisor

getDownloader

getScanner

getReporter

getNotifier