Package org.sonatype.gradle.plugins.scan.nexus.iq.scan

Class NexusIqScanTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.sonatype.gradle.plugins.scan.nexus.iq.scan.NexusIqScanTask
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>
@DisableCachingByDefault(because="Scanning submits the dependency list to a remote Nexus IQ Server, which creates a report and evaluates it against server-side policies that can change independently of this build, so the result is not reproducible from the task inputs") public class NexusIqScanTask extends org.gradle.api.DefaultTask
Gradle task for scanning and evaluating dependencies against Nexus IQ Server policies.

  • 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
    NexusIqScanTask()
    Constructs a new NexusIqScanTask.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApplicationId()
    Returns the application ID.
    String
    getDirExcludes()
    Returns the directory exclude patterns.
    String
    getDirIncludes()
    Returns the directory include patterns.
    Set<String>
    getModulesExcluded()
    Returns the set of excluded modules.
    String
    getOrganizationId()
    Returns the organization ID.
    String
    getPassword()
    Returns the password for authentication.
    String
    getScanFolderPath()
    Returns the scan folder path.
    String
    getServerUrl()
    Returns the server URL.
    String
    getStage()
    Returns the stage.
    String
    getUsername()
    Returns the username for authentication.
    boolean
    isAllConfigurations()
    Returns whether all configurations should be scanned.
    void
    scan()
    Executes the scan against Nexus IQ Server.

    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, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, 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, notCompatibleWithConfigurationCache

  • Constructor Details

    • NexusIqScanTask

      public NexusIqScanTask()
      Constructs a new NexusIqScanTask.

  • Method Details

    • scan

      public void scan()
      Executes the scan against Nexus IQ Server.

    • getScanFolderPath

      @Input public String getScanFolderPath()
      Returns the scan folder path.

    • getUsername

      @Input public String getUsername()
      Returns the username for authentication.

    • getPassword

      @Input public String getPassword()
      Returns the password for authentication.

    • getApplicationId

      @Input public String getApplicationId()
      Returns the application ID.

    • getOrganizationId

      @Input public String getOrganizationId()
      Returns the organization ID.

    • getServerUrl

      @Input public String getServerUrl()
      Returns the server URL.

    • getStage

      @Input public String getStage()
      Returns the stage.

    • isAllConfigurations

      @Input public boolean isAllConfigurations()
      Returns whether all configurations should be scanned.

    • getModulesExcluded

      @Input public Set<String> getModulesExcluded()
      Returns the set of excluded modules.

    • getDirIncludes

      @Input public String getDirIncludes()
      Returns the directory include patterns.

    • getDirExcludes

      @Input public String getDirExcludes()
      Returns the directory exclude patterns.