Package io.github.rschnitk.buildprocess

Class UploadBomTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.rschnitk.buildprocess.UploadBomTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public abstract class UploadBomTask extends org.gradle.api.DefaultTask
UploadBom task class

Usage: 

    tasks.register("uploadBom", com.ceyoniq.gradle.buildprocess.UploadBomTask) {
       uri         = "http://001linuxserver01.ct.com:8888/api/v1/bom"
       bomFile     = new File(cyclonedxBom.destination.get(), 'bom.json')

       apiKey      = providers.gradleProperty('dtrack.api.key').get();
       projectUUID = providers.gradleProperty('dtrack.project.id').get()
       
       dependsOn cyclonedxBom
    }

  • 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
    Description
    UploadBomTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<String>
    getApiKey()
    Get Dependency Track API key
    abstract org.gradle.api.file.RegularFileProperty
    getBomFile()
    Get BOM file as regular file property
    abstract org.gradle.api.provider.Property<String>
    getProjectUUID()
    Get Dependency Track project UUID
    abstract org.gradle.api.provider.Property<Boolean>
    getTrustAll()
    Trust all certificates?
    abstract org.gradle.api.provider.Property<String>
    getUri()
    Get the URI of Dependency Track server
    void
    uploadBom()
    task action for UploadBomTask

    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 Details

    • UploadBomTask

      public UploadBomTask()

  • Method Details

    • getBomFile

      @InputFile public abstract org.gradle.api.file.RegularFileProperty getBomFile()
      Get BOM file as regular file property
      Returns:
      BOM as RegularFileProperty

    • getUri

      @Input public abstract org.gradle.api.provider.Property<String> getUri()
      Get the URI of Dependency Track server
      Returns:
      the URI for BOM upload (e.g. "http://001linuxserver01.ct.com:8888/api/v1/bom" )

    • getApiKey

      @Input public abstract org.gradle.api.provider.Property<String> getApiKey()
      Get Dependency Track API key
      Returns:
      Dependency Track API key

    • getProjectUUID

      @Input public abstract org.gradle.api.provider.Property<String> getProjectUUID()
      Get Dependency Track project UUID
      Returns:
      Dependency Track project UUID

    • getTrustAll

      @Input public abstract org.gradle.api.provider.Property<Boolean> getTrustAll()
      Trust all certificates?
      Returns:
      true if check should be skipped

    • uploadBom

      public void uploadBom() throws InterruptedException, GeneralSecurityException
      task action for UploadBomTask
      Throws:
      InterruptedException - on error
      GeneralSecurityException