org.cyclonedx.gradle

Class CycloneDxTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.cyclonedx.gradle.CycloneDxTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public abstract class CycloneDxTask
extends org.gradle.api.DefaultTask

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
CycloneDxTask()

Method Summary

Modifier and Type	Method and Description
void	createBom() Executes the main logic of the plugin by loading the dependency graph (SbomGraphProvider.get()) and providing the result to SbomBuilder
org.gradle.api.provider.Property<java.lang.String>	getBuildSystemEnvironmentVariable() The environment variable to use to determine the build system URL.
org.gradle.api.provider.Property<java.lang.String>	getComponentName()
org.gradle.api.provider.Property<java.lang.String>	getComponentVersion()
org.gradle.api.provider.Property<java.io.File>	getDestination()
org.gradle.api.provider.Property<java.lang.Boolean>	getIncludeBomSerialNumber()
org.gradle.api.provider.Property<java.lang.Boolean>	getIncludeBuildSystem()
org.gradle.api.provider.ListProperty<java.lang.String>	getIncludeConfigs()
org.gradle.api.provider.Property<java.lang.Boolean>	getIncludeLicenseText()
org.gradle.api.provider.Property<java.lang.Boolean>	getIncludeMetadataResolution()
org.gradle.api.provider.Property<java.lang.String>	getOutputFormat()
org.gradle.api.provider.Property<java.lang.String>	getOutputName()
org.gradle.api.provider.Property<java.lang.String>	getProjectType()
org.gradle.api.provider.Property<java.lang.String>	getSchemaVersion()
org.gradle.api.provider.ListProperty<java.lang.String>	getSkipConfigs()
org.gradle.api.provider.ListProperty<java.lang.String>	getSkipProjects()
void	setBuildSystemEnvironmentVariable(java.lang.String buildSystemEnvironmentVariable)
void	setComponentName(java.lang.String componentName)
void	setComponentVersion(java.lang.String componentVersion)
void	setDestination(java.io.File destination)
void	setIncludeBomSerialNumber(boolean includeBomSerialNumber)
void	setIncludeBuildSystem(boolean includeBuildSystem)
void	setIncludeConfigs(java.util.Collection<java.lang.String> includeConfigs)
void	setIncludeLicenseText(boolean includeLicenseText)
void	setIncludeMetadataResolution(boolean includeMetadataResolution)
void	setLicenseChoice(java.util.function.Consumer<org.cyclonedx.model.LicenseChoice> customizer)
void	setOrganizationalEntity(java.util.function.Consumer<org.cyclonedx.model.OrganizationalEntity> customizer)
void	setOutputFormat(java.lang.String format)
void	setOutputName(java.lang.String output)
void	setProjectType(java.lang.String projectType)
void	setSchemaVersion(java.lang.String schemaVersion)
void	setSkipConfigs(java.util.Collection<java.lang.String> skipConfigs)
void	setSkipProjects(java.util.Collection<java.lang.String> skipProjects)
void	setVCSGit(java.util.function.Consumer<org.cyclonedx.model.ExternalReference> customizer)

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Constructor Detail

CycloneDxTask

public CycloneDxTask()

Method Detail

getOutputName

@Input
public org.gradle.api.provider.Property<java.lang.String> getOutputName()

setOutputName

public void setOutputName(java.lang.String output)

getSchemaVersion

@Input
public org.gradle.api.provider.Property<java.lang.String> getSchemaVersion()

setSchemaVersion

public void setSchemaVersion(java.lang.String schemaVersion)

getComponentName

@Input
public org.gradle.api.provider.Property<java.lang.String> getComponentName()

setComponentName

public void setComponentName(java.lang.String componentName)

getComponentVersion

@Input
public org.gradle.api.provider.Property<java.lang.String> getComponentVersion()

setComponentVersion

public void setComponentVersion(java.lang.String componentVersion)

getOutputFormat

@Input
public org.gradle.api.provider.Property<java.lang.String> getOutputFormat()

setOutputFormat

public void setOutputFormat(java.lang.String format)

getIncludeBomSerialNumber

@Input
public org.gradle.api.provider.Property<java.lang.Boolean> getIncludeBomSerialNumber()

setIncludeBomSerialNumber

public void setIncludeBomSerialNumber(boolean includeBomSerialNumber)

getSkipConfigs

@Input
public org.gradle.api.provider.ListProperty<java.lang.String> getSkipConfigs()

setSkipConfigs

public void setSkipConfigs(java.util.Collection<java.lang.String> skipConfigs)

getIncludeConfigs

@Input
public org.gradle.api.provider.ListProperty<java.lang.String> getIncludeConfigs()

setIncludeConfigs

public void setIncludeConfigs(java.util.Collection<java.lang.String> includeConfigs)

getIncludeMetadataResolution

@Input
public org.gradle.api.provider.Property<java.lang.Boolean> getIncludeMetadataResolution()

setIncludeMetadataResolution

public void setIncludeMetadataResolution(boolean includeMetadataResolution)

getIncludeLicenseText

@Input
public org.gradle.api.provider.Property<java.lang.Boolean> getIncludeLicenseText()

setIncludeLicenseText

public void setIncludeLicenseText(boolean includeLicenseText)

getProjectType

@Input
public org.gradle.api.provider.Property<java.lang.String> getProjectType()

setProjectType

public void setProjectType(java.lang.String projectType)

getSkipProjects

@Input
public org.gradle.api.provider.ListProperty<java.lang.String> getSkipProjects()

setSkipProjects

public void setSkipProjects(java.util.Collection<java.lang.String> skipProjects)

getIncludeBuildSystem

@Input
public org.gradle.api.provider.Property<java.lang.Boolean> getIncludeBuildSystem()

setIncludeBuildSystem

public void setIncludeBuildSystem(boolean includeBuildSystem)

getBuildSystemEnvironmentVariable

@Input
 @Optional
public org.gradle.api.provider.Property<java.lang.String> getBuildSystemEnvironmentVariable()

The environment variable to use to determine the build system URL. If the build system URL needs to be constructed from multiple environment variables a pattern can be set using `buildSystemEnvironmentVariable = '${SERVER}/jobs/${JOB_ID}'`. Note, that when configuring in kotlin or groovy single quotes must be used to prevent the build itself from interpolating that variables.

Returns:

the environment variable to use to determine the build system

setBuildSystemEnvironmentVariable

public void setBuildSystemEnvironmentVariable(java.lang.String buildSystemEnvironmentVariable)

getDestination

@OutputDirectory
public org.gradle.api.provider.Property<java.io.File> getDestination()

setDestination

public void setDestination(java.io.File destination)

createBom

public void createBom()

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

setOrganizationalEntity

public void setOrganizationalEntity(java.util.function.Consumer<org.cyclonedx.model.OrganizationalEntity> customizer)

setLicenseChoice

public void setLicenseChoice(java.util.function.Consumer<org.cyclonedx.model.LicenseChoice> customizer)

setVCSGit

public void setVCSGit(java.util.function.Consumer<org.cyclonedx.model.ExternalReference> customizer)