Package com.veracode.jenkins.plugin.args

Class UploadAndScanArgs

java.lang.Object

com.veracode.jenkins.plugin.args.AbstractArgs

com.veracode.jenkins.plugin.args.UploadAndScanArgs

public final class UploadAndScanArgs
extends AbstractArgs

The UploadAndScanArgs class builds the command line argument passed to the Veracode API wrapper that causes it to upload binaries, start the pre-scan, and if the pre-scan is successful, start the scan.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CUSTOM_PROJECT_NAME_VAR

Fields inherited from class com.veracode.jenkins.plugin.args.AbstractArgs

ACTION, list, PHOST, PPASSWORD, PPORT, PUSER, SWITCH, USERAGENT, VID, VKEY

Method Summary

Modifier and Type	Method	Description
protected void	addUserAgent(String userAgent)	Adds user agent details got through API.
static String	getDeleteIncompleteScan(String deleteIncompleteScan)	This method will handle the backward compatibility of deleteIncompleteScan.
static UploadAndScanArgs	newUploadAndScanArgs(boolean bRemoteScan, boolean autoApplicationName, boolean autoDescription, boolean autoScanName, boolean createSandbox, boolean createProfile, String teams, boolean useProxy, String vId, String vKey, String buildNumber, String projectName, String applicationName, String sandboxName, String scanName, String criticality, String scanIncludesPattern, String scanExcludesPattern, String fileNamePattern, String replacementPattern, String pHost, String pPort, String pUser, String pCredential, FilePath workspace, EnvVars envVars, String timeOut, String deleteIncompleteScan, boolean debug, boolean scanallnonfataltoplevelmodules, boolean includenewmodules, String[] filePaths)	Returns an UploadAndScanArgs object initialized with the specified arguments.
static UploadAndScanArgs	newUploadAndScanArgs(VeracodeNotifier notifier, AbstractBuild<?,?> build, EnvVars envVars, String[] filePaths, boolean bRemoteScan)	Returns an UploadAndScanArgs object initialized with the specified arguments.
static UploadAndScanArgs	newUploadAndScanArgs(VeracodePipelineRecorder vpr, Run<?,?> run, FilePath workspace, EnvVars envVars, String[] filePaths, boolean bRemoteScan, boolean autoApplicationName, boolean autoScanName, boolean createAutoApplicationDescription)	Returns an UploadAndScanArgs object initialized with the specified arguments.
static void	setEnvVars(EnvVars envVars, String buildNumber, String projectName)	Sets our custom environment variables.

Methods inherited from class com.veracode.jenkins.plugin.args.AbstractArgs

addAction, addApiCredentials, addProxyConfiguration, addProxyConfiguration, addProxyCredentials, getArguments, getMaskedArguments

Methods inherited from class java.lang.Object

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

Field Detail

CUSTOM_PROJECT_NAME_VAR

public static final String CUSTOM_PROJECT_NAME_VAR

See Also:

Constant Field Values

Method Detail

addUserAgent

protected void addUserAgent(String userAgent)

Adds user agent details got through API.

Parameters:

userAgent - a String object.

newUploadAndScanArgs

public static UploadAndScanArgs newUploadAndScanArgs(VeracodeNotifier notifier,
                                                     AbstractBuild<?,?> build,
                                                     EnvVars envVars,
                                                     String[] filePaths,
                                                     boolean bRemoteScan)

Returns an UploadAndScanArgs object initialized with the specified arguments. Used by the VeracodeNotifier.

Parameters:

notifier - a VeracodeNotifier object.

build - a AbstractBuild object.

envVars - a EnvVars object.

filePaths - an array of String objects.

bRemoteScan - a boolean.

Returns:

a UploadAndScanArgs object.

newUploadAndScanArgs

public static UploadAndScanArgs newUploadAndScanArgs(VeracodePipelineRecorder vpr,
                                                     Run<?,?> run,
                                                     FilePath workspace,
                                                     EnvVars envVars,
                                                     String[] filePaths,
                                                     boolean bRemoteScan,
                                                     boolean autoApplicationName,
                                                     boolean autoScanName,
                                                     boolean createAutoApplicationDescription)

Returns an UploadAndScanArgs object initialized with the specified arguments. Used by the VeracodePipelineRecorder.

Parameters:

vpr - a VeracodePipelineRecorder object.

run - a Run object.

workspace - a FilePath object.

envVars - a EnvVars object.

filePaths - an array of String objects.

bRemoteScan - a boolean.

autoApplicationName - a boolean.

autoScanName - a boolean.

createAutoApplicationDescription - a boolean.

Returns:

a UploadAndScanArgs object.

newUploadAndScanArgs

public static UploadAndScanArgs newUploadAndScanArgs(boolean bRemoteScan,
                                                     boolean autoApplicationName,
                                                     boolean autoDescription,
                                                     boolean autoScanName,
                                                     boolean createSandbox,
                                                     boolean createProfile,
                                                     String teams,
                                                     boolean useProxy,
                                                     String vId,
                                                     String vKey,
                                                     String buildNumber,
                                                     String projectName,
                                                     String applicationName,
                                                     String sandboxName,
                                                     String scanName,
                                                     String criticality,
                                                     String scanIncludesPattern,
                                                     String scanExcludesPattern,
                                                     String fileNamePattern,
                                                     String replacementPattern,
                                                     String pHost,
                                                     String pPort,
                                                     String pUser,
                                                     String pCredential,
                                                     FilePath workspace,
                                                     EnvVars envVars,
                                                     String timeOut,
                                                     String deleteIncompleteScan,
                                                     boolean debug,
                                                     boolean scanallnonfataltoplevelmodules,
                                                     boolean includenewmodules,
                                                     String[] filePaths)

Returns an UploadAndScanArgs object initialized with the specified arguments.

Parameters:

bRemoteScan - a boolean.

autoApplicationName - a boolean.

autoDescription - a boolean.

autoScanName - a boolean.

createSandbox - a boolean.

createProfile - a boolean.

teams - a String object.

useProxy - a boolean.

vId - a String object.

vKey - a String object.

buildNumber - a String object.

projectName - a String object.

applicationName - a String object.

sandboxName - a String object.

scanName - a String object.

criticality - a String object.

scanIncludesPattern - a String object.

scanExcludesPattern - a String object.

fileNamePattern - a String object.

replacementPattern - a String object.

pHost - a String object.

pPort - a String object.

pUser - a String object.

pCredential - a String object.

workspace - a FilePath object.

envVars - a EnvVars object.

debug - a boolean.

scanallnonfataltoplevelmodules - a boolean

includenewmodules - a boolean

timeOut - a String object.

deleteIncompleteScan - a String object.

filePaths - an array of String objects.

Returns:

a UploadAndScanArgs object.

setEnvVars

public static void setEnvVars(EnvVars envVars,
                              String buildNumber,
                              String projectName)

Sets our custom environment variables.

Parameters:

envVars - a EnvVars object - environment of the build/run.

buildNumber - a String object.

projectName - a String object.

getDeleteIncompleteScan

public static String getDeleteIncompleteScan(String deleteIncompleteScan)

This method will handle the backward compatibility of deleteIncompleteScan. If deleteIncompleteScan is false then return "0". If deleteIncompleteScan is true then return "1".

Parameters:

deleteIncompleteScan - a String object.

Returns:

a String object.