Package com.synopsys.integration.blackduck.codelocation.signaturescanner

Class ScanBatch

java.lang.Object

com.synopsys.integration.util.Stringable

com.synopsys.integration.blackduck.codelocation.signaturescanner.ScanBatch

All Implemented Interfaces:

com.synopsys.integration.builder.Buildable

public class ScanBatch
extends com.synopsys.integration.util.Stringable
implements com.synopsys.integration.builder.Buildable

Constructor Summary

Constructors

Constructor

Description

ScanBatch(java.io.File signatureScannerInstallDirectory, java.io.File outputDirectory, boolean cleanupOutput, int scanMemoryInMegabytes, boolean dryRun, boolean debug, boolean verbose, java.lang.String scanCliOpts, java.lang.String additionalScanArguments, BlackDuckOnlineProperties blackDuckOnlineProperties, IndividualFileMatching individualFileMatching, com.synopsys.integration.rest.HttpUrl blackDuckUrl, java.lang.String blackDuckUsername, java.lang.String blackDuckPassword, java.lang.String blackDuckApiToken, com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo, boolean runInsecure, java.lang.String projectName, java.lang.String projectVersionName, java.util.List<ScanTarget> scanTargets)

Method Summary

Modifier and Type	Method	Description
java.util.List<ScanCommand>	createScanCommands(java.io.File defaultInstallDirectory, ScanPathsUtility scanPathsUtility, com.synopsys.integration.util.IntEnvironmentVariables intEnvironmentVariables)	The default install directory will be used if the batch does not already have an install directory.
java.lang.String	getAdditionalScanArguments()
java.lang.String	getBlackDuckApiToken()
java.lang.String	getBlackDuckPassword()
com.synopsys.integration.rest.HttpUrl	getBlackDuckUrl()
java.lang.String	getBlackDuckUsername()
IndividualFileMatching	getIndividualFileMatching()
java.io.File	getOutputDirectory()
java.lang.String	getProjectName()
java.lang.String	getProjectVersionName()
com.synopsys.integration.rest.proxy.ProxyInfo	getProxyInfo()
java.lang.String	getScanCliOpts()
int	getScanMemoryInMegabytes()
java.util.List<ScanTarget>	getScanTargets()
java.io.File	getSignatureScannerInstallDirectory()
SnippetMatching	getSnippetMatchingMode()
boolean	isCleanupOutput()
boolean	isDebug()
boolean	isDryRun()
boolean	isLicenseSearch()
boolean	isRunInsecure()
boolean	isUploadSource()
boolean	isVerbose()
static ScanBatchBuilder	newBuilder()

Methods inherited from class com.synopsys.integration.util.Stringable

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScanBatch

public ScanBatch(java.io.File signatureScannerInstallDirectory,
                 java.io.File outputDirectory,
                 boolean cleanupOutput,
                 int scanMemoryInMegabytes,
                 boolean dryRun,
                 boolean debug,
                 boolean verbose,
                 java.lang.String scanCliOpts,
                 java.lang.String additionalScanArguments,
                 BlackDuckOnlineProperties blackDuckOnlineProperties,
                 IndividualFileMatching individualFileMatching,
                 com.synopsys.integration.rest.HttpUrl blackDuckUrl,
                 java.lang.String blackDuckUsername,
                 java.lang.String blackDuckPassword,
                 java.lang.String blackDuckApiToken,
                 com.synopsys.integration.rest.proxy.ProxyInfo proxyInfo,
                 boolean runInsecure,
                 java.lang.String projectName,
                 java.lang.String projectVersionName,
                 java.util.List<ScanTarget> scanTargets)

Method Detail

newBuilder

public static ScanBatchBuilder newBuilder()

createScanCommands

public java.util.List<ScanCommand> createScanCommands(java.io.File defaultInstallDirectory,
                                                      ScanPathsUtility scanPathsUtility,
                                                      com.synopsys.integration.util.IntEnvironmentVariables intEnvironmentVariables)
                                               throws BlackDuckIntegrationException

The default install directory will be used if the batch does not already have an install directory.

Throws:

BlackDuckIntegrationException

getSignatureScannerInstallDirectory

public java.io.File getSignatureScannerInstallDirectory()

getOutputDirectory

public java.io.File getOutputDirectory()

isCleanupOutput

public boolean isCleanupOutput()

getScanMemoryInMegabytes

public int getScanMemoryInMegabytes()

isDryRun

public boolean isDryRun()

isDebug

public boolean isDebug()

isVerbose

public boolean isVerbose()

getScanCliOpts

public java.lang.String getScanCliOpts()

getAdditionalScanArguments

public java.lang.String getAdditionalScanArguments()

getSnippetMatchingMode

public SnippetMatching getSnippetMatchingMode()

isUploadSource

public boolean isUploadSource()

isLicenseSearch

public boolean isLicenseSearch()

getIndividualFileMatching

public IndividualFileMatching getIndividualFileMatching()

getBlackDuckUrl

public com.synopsys.integration.rest.HttpUrl getBlackDuckUrl()

getBlackDuckUsername

public java.lang.String getBlackDuckUsername()

getBlackDuckPassword

public java.lang.String getBlackDuckPassword()

getBlackDuckApiToken

public java.lang.String getBlackDuckApiToken()

getProxyInfo

public com.synopsys.integration.rest.proxy.ProxyInfo getProxyInfo()

isRunInsecure

public boolean isRunInsecure()

getProjectName

public java.lang.String getProjectName()

getProjectVersionName

public java.lang.String getProjectVersionName()

getScanTargets

public java.util.List<ScanTarget> getScanTargets()