com.blackducksoftware.integration.hub.jenkins.scan

Class BDCommonScanStep

java.lang.Object

com.blackducksoftware.integration.hub.jenkins.scan.BDCommonScanStep

public class BDCommonScanStep
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description

BDCommonScanStep(ScanJobs[] scans, java.lang.String hubProjectName, java.lang.String hubProjectVersion, java.lang.String phase, java.lang.String distribution, java.lang.String scanMemory, boolean projectLevelAdjustments, boolean shouldGenerateHubReport, java.lang.String bomUpdateMaximumWaitTime, boolean dryRun, boolean cleanupOnSuccessfulScan, java.lang.Boolean verbose, java.lang.String[] excludePatterns, java.lang.String codeLocationName, boolean unmapPreviousCodeLocations, boolean deletePreviousCodeLocations, boolean failureConditionsConfigured)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBomUpdateMaximumWaitTime()
BomUpToDateAction	getBomUpToDateAction()
java.lang.String	getCodeLocationName()
java.lang.String	getDistribution()
java.lang.String[]	getExcludePatterns()
java.lang.String	getHubProjectName()
java.lang.String	getHubProjectVersion()
HubServerInfo	getHubServerInfo()
java.lang.String	getPhase()
java.lang.String	getScanMemory()
int	getScanMemoryInteger()
ScanJobs[]	getScans()
java.util.List<java.lang.String>	getScanTargets(com.blackducksoftware.integration.log.IntLogger logger, hudson.model.Node builtOn, hudson.EnvVars variables, java.lang.String workingDirectory)
boolean	isCleanupOnSuccessfulScan()
boolean	isDeletePreviousCodeLocations()
boolean	isDryRun()
boolean	isFailureConditionsConfigured()
boolean	isProjectLevelAdjustments()
boolean	isShouldGenerateHubReport()
boolean	isUnmapPreviousCodeLocations()
java.lang.Boolean	isVerbose()
void	runScan(hudson.model.Run run, hudson.model.Node builtOn, hudson.EnvVars envVars, hudson.FilePath workspace, HubJenkinsLogger logger, hudson.Launcher launcher, hudson.model.TaskListener listener, java.lang.String buildDisplayName, java.lang.String buildIdentifier)
boolean	validateGlobalConfiguration() Validates that the Plugin is configured correctly.

Methods inherited from class java.lang.Object

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

Constructor Detail

BDCommonScanStep

public BDCommonScanStep(ScanJobs[] scans,
                        java.lang.String hubProjectName,
                        java.lang.String hubProjectVersion,
                        java.lang.String phase,
                        java.lang.String distribution,
                        java.lang.String scanMemory,
                        boolean projectLevelAdjustments,
                        boolean shouldGenerateHubReport,
                        java.lang.String bomUpdateMaximumWaitTime,
                        boolean dryRun,
                        boolean cleanupOnSuccessfulScan,
                        java.lang.Boolean verbose,
                        java.lang.String[] excludePatterns,
                        java.lang.String codeLocationName,
                        boolean unmapPreviousCodeLocations,
                        boolean deletePreviousCodeLocations,
                        boolean failureConditionsConfigured)

Method Detail

getCodeLocationName

public java.lang.String getCodeLocationName()

getScans

public ScanJobs[] getScans()

getExcludePatterns

public java.lang.String[] getExcludePatterns()

getHubProjectName

public java.lang.String getHubProjectName()

getHubProjectVersion

public java.lang.String getHubProjectVersion()

getPhase

public java.lang.String getPhase()

getDistribution

public java.lang.String getDistribution()

getScanMemory

public java.lang.String getScanMemory()

getScanMemoryInteger

public int getScanMemoryInteger()

isProjectLevelAdjustments

public boolean isProjectLevelAdjustments()

isShouldGenerateHubReport

public boolean isShouldGenerateHubReport()

getBomUpdateMaximumWaitTime

public java.lang.String getBomUpdateMaximumWaitTime()

isDryRun

public boolean isDryRun()

isVerbose

public java.lang.Boolean isVerbose()

isCleanupOnSuccessfulScan

public boolean isCleanupOnSuccessfulScan()

getBomUpToDateAction

public BomUpToDateAction getBomUpToDateAction()

isUnmapPreviousCodeLocations

public boolean isUnmapPreviousCodeLocations()

isDeletePreviousCodeLocations

public boolean isDeletePreviousCodeLocations()

isFailureConditionsConfigured

public boolean isFailureConditionsConfigured()

getHubServerInfo

public HubServerInfo getHubServerInfo()

runScan

public void runScan(hudson.model.Run run,
                    hudson.model.Node builtOn,
                    hudson.EnvVars envVars,
                    hudson.FilePath workspace,
                    HubJenkinsLogger logger,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener,
                    java.lang.String buildDisplayName,
                    java.lang.String buildIdentifier)

getScanTargets

public java.util.List<java.lang.String> getScanTargets(com.blackducksoftware.integration.log.IntLogger logger,
                                                       hudson.model.Node builtOn,
                                                       hudson.EnvVars variables,
                                                       java.lang.String workingDirectory)
                                                throws BDJenkinsHubPluginException,
                                                       java.lang.InterruptedException

Throws:

BDJenkinsHubPluginException

java.lang.InterruptedException

validateGlobalConfiguration

public boolean validateGlobalConfiguration()
                                    throws HubConfigurationException

Validates that the Plugin is configured correctly. Checks that the User has defined an iScan tool, a Hub server URL, a Credential, and that there are at least one scan Target/Job defined in the Build

Throws:

HubConfigurationException