Package io.github.rschnitk.buildprocess

Class UploadBomTask

  • 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>
    @DisableCachingByDefault(because="Uploads to an external service; output is not cacheable")
public abstract class UploadBomTask
extends org.gradle.api.DefaultTask
    UploadBom task class

    Usage: 

        tasks.register("uploadBom", com.ceyoniq.gradle.buildprocess.UploadBomTask) {
       uri         = "https://dependency-track-server/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

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract org.gradle.api.provider.Property<java.lang.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<java.lang.Boolean> getIgnoreFailures()
      Ignore upload error
      abstract org.gradle.api.provider.Property<java.lang.String> getProjectUUID()
      Get Dependency Track project UUID
      abstract org.gradle.api.provider.Property<java.lang.Boolean> getTrustAll()
      Trust all certificates?
      abstract org.gradle.api.provider.Property<java.lang.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 Detail

      • UploadBomTask

        public UploadBomTask()

    • Method Detail

      • getBomFile

        @InputFile
@PathSensitive(NONE)
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<java.lang.String> getUri()
        Get the URI of Dependency Track server
        Returns:
        the URI for BOM upload (e.g. "https://dependency-track-server/api/v1/bom" )

      • getApiKey

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

      • getProjectUUID

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

      • getTrustAll

        @Input
@Optional
public abstract org.gradle.api.provider.Property<java.lang.Boolean> getTrustAll()
        Trust all certificates?
        Returns:
        Boolean-Property to trust all certificates

      • getIgnoreFailures

        @Input
@Optional
public abstract org.gradle.api.provider.Property<java.lang.Boolean> getIgnoreFailures()
        Ignore upload error
        Returns:
        Boolean-Property to ignore failures

      • uploadBom

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