Index

A B C D E F G H L M N O R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addExternalReference(String, String) - Method in class org.cyclonedx.gradle.model.SbomMetaData

addRepository(Repository) - Method in class org.cyclonedx.gradle.GradleAssistedMavenModelResolverImpl

addRepository(Repository, boolean) - Method in class org.cyclonedx.gradle.GradleAssistedMavenModelResolverImpl

aggregate() - Method in class org.cyclonedx.gradle.CyclonedxAggregateTask

apply(Project) - Method in class org.cyclonedx.gradle.CyclonedxPlugin

B

BaseCyclonedxTask - Class in org.cyclonedx.gradle

BaseCyclonedxTask() - Constructor for class org.cyclonedx.gradle.BaseCyclonedxTask

build() - Method in class org.cyclonedx.gradle.model.SbomComponent.Builder

Builder() - Constructor for class org.cyclonedx.gradle.model.SbomComponent.Builder

C

compare(Component, Component) - Method in class org.cyclonedx.gradle.model.ComponentComparator

compare(Dependency, Dependency) - Method in class org.cyclonedx.gradle.model.DependencyComparator

complementByEnvironment(Component) - Static method in class org.cyclonedx.gradle.utils.ExternalReferencesUtil

ComponentComparator - Class in org.cyclonedx.gradle.model

ComponentComparator() - Constructor for class org.cyclonedx.gradle.model.ComponentComparator

ConfigurationScope - Class in org.cyclonedx.gradle.model

ConfigurationScope(String, String) - Constructor for class org.cyclonedx.gradle.model.ConfigurationScope

configureExternalArtifactView(ArtifactView.ViewConfiguration) - Static method in class org.cyclonedx.gradle.utils.DependencyUtils

Configures an artifact view to only include external module dependencies.

createBom() - Method in class org.cyclonedx.gradle.CyclonedxDirectTask

Executes the main logic of the plugin by loading the dependency graph (SbomGraphProvider.get()) and providing the result to SbomBuilder

cyclonedxAggregateConfigurationName - Variable in class org.cyclonedx.gradle.CyclonedxPlugin

cyclonedxAggregateReportDir - Variable in class org.cyclonedx.gradle.CyclonedxPlugin

CyclonedxAggregateTask - Class in org.cyclonedx.gradle

CyclonedxAggregateTask() - Constructor for class org.cyclonedx.gradle.CyclonedxAggregateTask

cyclonedxAggregateTaskName - Variable in class org.cyclonedx.gradle.CyclonedxPlugin

cyclonedxDirectConfigurationName - Variable in class org.cyclonedx.gradle.CyclonedxPlugin

cyclonedxDirectReportDir - Variable in class org.cyclonedx.gradle.CyclonedxPlugin

CyclonedxDirectTask - Class in org.cyclonedx.gradle

This task mainly acts a container for the user configurations (includeConfigs, projectType, schemaVersion, ...) and orchestrating the calls between the core objects (SbomGraphProvider and SbomBuilder)

CyclonedxDirectTask() - Constructor for class org.cyclonedx.gradle.CyclonedxDirectTask

cyclonedxDirectTaskName - Variable in class org.cyclonedx.gradle.CyclonedxPlugin

CyclonedxPlugin - Class in org.cyclonedx.gradle

Entrypoint of the plugin which simply configures one task

CyclonedxPlugin() - Constructor for class org.cyclonedx.gradle.CyclonedxPlugin

CyclonedxPlugin(String, String, String, String, String, String) - Constructor for class org.cyclonedx.gradle.CyclonedxPlugin

CyclonedxUtils - Class in org.cyclonedx.gradle.utils

CyclonedxUtils() - Constructor for class org.cyclonedx.gradle.utils.CyclonedxUtils

D

DEFAULT_SCHEMA_VERSION - Static variable in class org.cyclonedx.gradle.utils.CyclonedxUtils

DependencyComparator - Class in org.cyclonedx.gradle.model

DependencyComparator() - Constructor for class org.cyclonedx.gradle.model.DependencyComparator

DependencyUtils - Class in org.cyclonedx.gradle.utils

DependencyUtils() - Constructor for class org.cyclonedx.gradle.utils.DependencyUtils

E

EnvironmentUtils - Class in org.cyclonedx.gradle.utils

Utility class for working with environment variables in common CI environments.

EnvironmentUtils() - Constructor for class org.cyclonedx.gradle.utils.EnvironmentUtils

equals(Object) - Method in class org.cyclonedx.gradle.model.SbomComponent

equals(Object) - Method in class org.cyclonedx.gradle.model.SbomComponentId

ExternalReference(String, String) - Constructor for class org.cyclonedx.gradle.model.SbomMetaData.ExternalReference

ExternalReferencesUtil - Class in org.cyclonedx.gradle.utils

F

fromComponent(Component) - Static method in class org.cyclonedx.gradle.model.SbomMetaData

G

generatePackageUrl(SbomComponentId) - Static method in class org.cyclonedx.gradle.utils.DependencyUtils

getAggregateConfigurationName() - Method in class org.cyclonedx.gradle.CyclonedxDirectTask

The name of the aggregate configuration to exclude from the BOM.

getArtifactFile() - Method in class org.cyclonedx.gradle.model.SbomComponent

getBuildSystemEnvironmentVariable() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The environment variable to use to determine the build system URL.

getBuildURI() - Static method in class org.cyclonedx.gradle.utils.EnvironmentUtils

Get the URI of the current build from the environment variables set on common build systems like GitHub Actions, GitLab CI, etc.

getBuildURI(String) - Static method in class org.cyclonedx.gradle.utils.EnvironmentUtils

Get the URI of the current build from the specified environment variable.

getComponentGroup() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The group of the component that will be used in the BOM.

getComponentName() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The name of the component that will be used in the BOM.

getComponentVersion() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The version of the component that will be used in the BOM.

getConfigName() - Method in class org.cyclonedx.gradle.model.ConfigurationScope

getDependencyComponents() - Method in class org.cyclonedx.gradle.model.SbomComponent

getDescription() - Method in class org.cyclonedx.gradle.model.SbomMetaData

getExternalReferences() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The external reference that will be used in the BOM.

getExternalReferences() - Method in class org.cyclonedx.gradle.model.SbomMetaData

getGitUrlFromEnvironmentVariable() - Static method in class org.cyclonedx.gradle.utils.GitUtils

getGitUrlFromGitRepo() - Static method in class org.cyclonedx.gradle.utils.GitUtils

getGradleProjectPath() - Method in class org.cyclonedx.gradle.model.SbomComponentId

getGraph() - Method in class org.cyclonedx.gradle.model.SbomGraph

getGroup() - Method in class org.cyclonedx.gradle.model.SbomComponentId

getId() - Method in class org.cyclonedx.gradle.model.SbomComponent

getIncludeBomSerialNumber() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

Whether to include the BOM serial number in the BOM.

getIncludeBuildEnvironment() - Method in class org.cyclonedx.gradle.CyclonedxDirectTask

Whether to include the build environment dependencies (e.g.

getIncludeBuildSystem() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

Whether to include the build system information in the BOM.

getIncludeConfigs() - Method in class org.cyclonedx.gradle.CyclonedxDirectTask

The list of configuration names to include in the BOM.

getIncludeLicenseText() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

Whether to include the license text in the BOM.

getIncludeMetadataResolution() - Method in class org.cyclonedx.gradle.CyclonedxDirectTask

Whether to include metadata resolution in the BOM.

getInScopeConfigurations() - Method in class org.cyclonedx.gradle.model.SbomComponent

getJsonOutput() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The output file for the JSON report.

getLicenseChoice() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The license choice that will be used in the BOM.

getLicenses() - Method in class org.cyclonedx.gradle.model.SbomComponent

getName() - Method in class org.cyclonedx.gradle.model.SbomComponentId

getOrganizationalEntity() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The organizational entity that will be used in the BOM.

getProjectName() - Method in class org.cyclonedx.gradle.model.ConfigurationScope

getProjectPath - Variable in class org.cyclonedx.gradle.CyclonedxAggregateTask

getProjectType() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The type of the project that will be used in the BOM.

getPublisher() - Method in class org.cyclonedx.gradle.model.SbomMetaData

getQualifiers() - Method in class org.cyclonedx.gradle.model.SbomComponentId

getResolvedDependencies() - Method in class org.cyclonedx.gradle.CyclonedxDirectTask

The resolved dependency files from all in-scope configurations.

getRootComponent() - Method in class org.cyclonedx.gradle.model.SbomGraph

getSbomMetaData() - Method in class org.cyclonedx.gradle.model.SbomComponent

getSchemaVersion() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The schema version of the BOM.

getSkipConfigs() - Method in class org.cyclonedx.gradle.CyclonedxDirectTask

The list of configuration names to skip in the BOM.

getType() - Method in class org.cyclonedx.gradle.model.SbomComponentId

getVersion() - Method in class org.cyclonedx.gradle.model.SbomComponentId

getXmlOutput() - Method in class org.cyclonedx.gradle.BaseCyclonedxTask

The output file for the XML report.

GitUtils - Class in org.cyclonedx.gradle.utils

GradleAssistedMavenModelResolverImpl - Class in org.cyclonedx.gradle

GradleAssistedMavenModelResolverImpl(Project) - Constructor for class org.cyclonedx.gradle.GradleAssistedMavenModelResolverImpl

H

hashCode() - Method in class org.cyclonedx.gradle.model.SbomComponent

hashCode() - Method in class org.cyclonedx.gradle.model.SbomComponentId

L

LOG_PREFIX - Static variable in class org.cyclonedx.gradle.CyclonedxPlugin

M

mergeGraphs(Map, Map) - Static method in class org.cyclonedx.gradle.utils.DependencyUtils

N

newCopy() - Method in class org.cyclonedx.gradle.GradleAssistedMavenModelResolverImpl

O

org.cyclonedx.gradle - package org.cyclonedx.gradle

org.cyclonedx.gradle.model - package org.cyclonedx.gradle.model

org.cyclonedx.gradle.utils - package org.cyclonedx.gradle.utils

R

resolveModel(String, String, String) - Method in class org.cyclonedx.gradle.GradleAssistedMavenModelResolverImpl

resolveModel(Dependency) - Method in class org.cyclonedx.gradle.GradleAssistedMavenModelResolverImpl

resolveModel(Parent) - Method in class org.cyclonedx.gradle.GradleAssistedMavenModelResolverImpl

S

sanitizeGitUrl(String) - Static method in class org.cyclonedx.gradle.utils.GitUtils

SbomComponent - Class in org.cyclonedx.gradle.model

SbomComponent.Builder - Class in org.cyclonedx.gradle.model

SbomComponentId - Class in org.cyclonedx.gradle.model

SbomComponentId(String, String, String, String, String) - Constructor for class org.cyclonedx.gradle.model.SbomComponentId

SbomGraph - Class in org.cyclonedx.gradle.model

Represents the aggregated dependency graph across all the configurations of the projects in scope.

SbomGraph(Map, SbomComponent) - Constructor for class org.cyclonedx.gradle.model.SbomGraph

SbomMetaData - Class in org.cyclonedx.gradle.model

SbomMetaData.ExternalReference - Class in org.cyclonedx.gradle.model

schemaVersion(String) - Static method in class org.cyclonedx.gradle.utils.CyclonedxUtils

Resolves the CycloneDX schema the mojo has been requested to use.

setDescription(String) - Method in class org.cyclonedx.gradle.model.SbomMetaData

setPublisher(String) - Method in class org.cyclonedx.gradle.model.SbomMetaData

T

toComponentId(ResolvedComponentResult, File) - Static method in class org.cyclonedx.gradle.utils.DependencyUtils

toString() - Method in class org.cyclonedx.gradle.model.SbomComponentId

W

withArtifactFile(File) - Method in class org.cyclonedx.gradle.model.SbomComponent.Builder

withDependencyComponents(Set) - Method in class org.cyclonedx.gradle.model.SbomComponent.Builder

withId(SbomComponentId) - Method in class org.cyclonedx.gradle.model.SbomComponent.Builder

withInScopeConfigurations(Set) - Method in class org.cyclonedx.gradle.model.SbomComponent.Builder

withLicenses(List) - Method in class org.cyclonedx.gradle.model.SbomComponent.Builder

withMetaData(SbomMetaData) - Method in class org.cyclonedx.gradle.model.SbomComponent.Builder

writeJsonBom(Version, Bom, File) - Static method in class org.cyclonedx.gradle.utils.CyclonedxUtils

writeXmlBom(Version, Bom, File) - Static method in class org.cyclonedx.gradle.utils.CyclonedxUtils

A B C D E F G H L M N O R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form