Class BaseCyclonedxTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.cyclonedx.gradle.BaseCyclonedxTask
All Implemented Interfaces:
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>
Direct Known Subclasses:
CyclonedxAggregateTask, CyclonedxDirectTask
@CacheableTask public abstract class BaseCyclonedxTask extends org.gradle.api.DefaultTask

  • Nested Class Summary

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

    org.gradle.api.Named.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
    Description
    BaseCyclonedxTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<String>
    getBuildSystemEnvironmentVariable()
    The environment variable to use to determine the build system URL.
    abstract org.gradle.api.provider.Property<String>
    getComponentGroup()
    The group of the component that will be used in the BOM.
    abstract org.gradle.api.provider.Property<String>
    getComponentName()
    The name of the component that will be used in the BOM.
    abstract org.gradle.api.provider.Property<String>
    getComponentVersion()
    The version of the component that will be used in the BOM.
    abstract org.gradle.api.provider.ListProperty<org.cyclonedx.model.ExternalReference>
    getExternalReferences()
    The external reference that will be used in the BOM.
    abstract org.gradle.api.provider.Property<Boolean>
    getIncludeBomSerialNumber()
    Whether to include the BOM serial number in the BOM.
    abstract org.gradle.api.provider.Property<Boolean>
    getIncludeBuildSystem()
    Whether to include the build system information in the BOM.
    abstract org.gradle.api.provider.Property<Boolean>
    getIncludeLicenseText()
    Whether to include the license text in the BOM.
    abstract org.gradle.api.file.RegularFileProperty
    getJsonOutput()
    The output file for the JSON report.
    abstract org.gradle.api.provider.Property<org.cyclonedx.model.LicenseChoice>
    getLicenseChoice()
    The license choice that will be used in the BOM.
    abstract org.gradle.api.provider.Property<org.cyclonedx.model.OrganizationalEntity>
    getOrganizationalEntity()
    The organizational entity that will be used in the BOM.
    abstract org.gradle.api.provider.Property<org.cyclonedx.model.Component.Type>
    getProjectType()
    The type of the project that will be used in the BOM.
    abstract org.gradle.api.provider.Property<org.cyclonedx.Version>
    getSchemaVersion()
    The schema version of the BOM.
    abstract org.gradle.api.file.RegularFileProperty
    getXmlOutput()
    The output file for the XML report.

    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, 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 Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • BaseCyclonedxTask

      public BaseCyclonedxTask()

  • Method Details

    • getComponentGroup

      @Input public abstract org.gradle.api.provider.Property<String> getComponentGroup()
      The group of the component that will be used in the BOM. This is typically the group of the project. If not set, the project group will be used.
      Returns:
      the group of the component
      See Also:
      • Project.getGroup()

    • getComponentName

      @Input public abstract org.gradle.api.provider.Property<String> getComponentName()
      The name of the component that will be used in the BOM. This is typically the name of the project. If not set, the project name will be used.
      Returns:
      the name of the component
      See Also:
      • Project.getName()

    • getComponentVersion

      @Input public abstract org.gradle.api.provider.Property<String> getComponentVersion()
      The version of the component that will be used in the BOM. This is typically the version of the project. If not set, the project version will be used.
      Returns:
      the version of the component
      See Also:
      • Project.getVersion()

    • getSchemaVersion

      @Input public abstract org.gradle.api.provider.Property<org.cyclonedx.Version> getSchemaVersion()
      The schema version of the BOM. It can be one of the supported versions, e.g., Version.VERSION_16. If not set, it defaults to Version.VERSION_16.
      Returns:
      the schema version of the BOM
      See Also:
      • Version

    • getXmlOutput

      @OutputFile @Optional public abstract org.gradle.api.file.RegularFileProperty getXmlOutput()

      The output file for the XML report.

      If not set, the default is "${project.buildDir}/reports/cyclonedx/bom.xml".

      To disable the XML output, you need to unset convention: xmlOutput.unsetConvention()

      Returns:
      the XML output file property
      See Also:

    • getJsonOutput

      @OutputFile @Optional public abstract org.gradle.api.file.RegularFileProperty getJsonOutput()

      The output file for the JSON report.

      If not set, the default is "${project.buildDir}/reports/cyclonedx/bom.json".

      To disable the JSON output, you need to unset convention: jsonOutput.unsetConvention()

      Returns:
      the JSON output file property
      See Also:

    • getIncludeBomSerialNumber

      @Input public abstract org.gradle.api.provider.Property<Boolean> getIncludeBomSerialNumber()
      Whether to include the BOM serial number in the BOM. If not set, it defaults to true.
      Returns:
      true if BOM serial number should be included, false otherwise

    • getProjectType

      @Input public abstract org.gradle.api.provider.Property<org.cyclonedx.model.Component.Type> getProjectType()
      The type of the project that will be used in the BOM. It can be one of the types defined in Component.Type. If not set, it defaults to Component.Type.LIBRARY.
      Returns:
      the type of the project

    • getIncludeBuildSystem

      @Input public abstract org.gradle.api.provider.Property<Boolean> getIncludeBuildSystem()
      Whether to include the build system information in the BOM. If not set, it defaults to true.
      Returns:
      true if build system information should be included, false otherwise

    • getBuildSystemEnvironmentVariable

      @Input @Optional public abstract org.gradle.api.provider.Property<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

    • getOrganizationalEntity

      @Internal public abstract org.gradle.api.provider.Property<org.cyclonedx.model.OrganizationalEntity> getOrganizationalEntity()
      The organizational entity that will be used in the BOM. This is typically the organization that owns the project. If not set, it defaults to an empty organizational entity.
      Returns:
      the organizational entity

    • getLicenseChoice

      @Internal public abstract org.gradle.api.provider.Property<org.cyclonedx.model.LicenseChoice> getLicenseChoice()
      The license choice that will be used in the BOM. This is typically the license choice of the project. If not set, it defaults to an empty license choice.
      Returns:
      the license choice

    • getExternalReferences

      @Internal public abstract org.gradle.api.provider.ListProperty<org.cyclonedx.model.ExternalReference> getExternalReferences()
      The external reference that will be used in the BOM. This can be used to link to external resources related to the project. If not set, it defaults to resolution of git remote URL, if available.
      Returns:
      the external reference

    • getIncludeLicenseText

      @Input public abstract org.gradle.api.provider.Property<Boolean> getIncludeLicenseText()
      Whether to include the license text in the BOM. If not set, it defaults to false.
      Returns:
      true if license text should be included, false otherwise