com.synopsys.protecode.sc.jenkins

Class ProtecodeScPlugin

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.synopsys.protecode.sc.jenkins.ProtecodeScPlugin

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class ProtecodeScPlugin
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

TODO: There are much too many variables stored on the object level. Maybe we could perhaps store them in a configuration object or much more preferably as temp variables being moved in the methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtecodeScPlugin.DescriptorImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_ERROR

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ProtecodeScPlugin(String credentialsId, String protecodeScGroup)

Method Summary

Modifier and Type	Method and Description
boolean	doPerform(hudson.model.Run<?,?> run, hudson.FilePath workspace)
boolean	getConvertToSummary()
String	getCredentialsId()
String	getCustomHeader()
ProtecodeScPlugin.DescriptorImpl	getDescriptor()
String	getDirectoryToScan()
boolean	getDontZipFiles()
boolean	getEndAfterSendingFiles()
boolean	getFailIfVulns()
boolean	getIncludeSubdirectories()
String	getPattern()
String	getProtecodeScanName()
String	getProtecodeScGroup()
boolean	getScanOnlyArtifacts()
int	getScanTimeout()
String	getTask()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
Object	readResolve() For backward compatibility.
void	setConvertToSummary(boolean convertToSummary)
void	setCredentialsId(String credentialsId)
void	setCustomHeader(String customHeader)
void	setDirectoryToScan(String directoryToScan)
void	setDontZipFiles(boolean dontZipFiles)
void	setEndAfterSendingFiles(boolean endAfterSendingFiles)
void	setFailIfVulns(boolean failIfVulns)
void	setIncludeSubdirectories(boolean includeSubdirectories)
void	setPattern(String pattern)
void	setProtecodeScanName(String protecodeScanName)
void	setProtecodeScGroup(String protecodeScGroup)
void	setScanOnlyArtifacts(boolean onlyArtifacts)
void	setScanTimeout(int scanTimeout)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, prebuild

Field Detail

NO_ERROR

public static final String NO_ERROR

See Also:

Constant Field Values

Constructor Detail

ProtecodeScPlugin

@DataBoundConstructor
public ProtecodeScPlugin(String credentialsId,
                                               String protecodeScGroup)

Method Detail

readResolve

public Object readResolve()

For backward compatibility. The XML persistence will build the instance in memory with out much logic and since some values are empty, they will default to null. This method is called right after the "resurrection" of the object and checks all non-trivial values.

Returns:

a ProtecodeScPlugin object with values which might be null.

perform

public void perform(hudson.model.Run<?,?> run,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

doPerform

public boolean doPerform(hudson.model.Run<?,?> run,
                         hudson.FilePath workspace)
                  throws IOException,
                         InterruptedException

Throws:

IOException

InterruptedException

getDescriptor

public ProtecodeScPlugin.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder

getTask

public String getTask()

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

setProtecodeScGroup

@DataBoundSetter
public void setProtecodeScGroup(String protecodeScGroup)

setDirectoryToScan

@DataBoundSetter
public void setDirectoryToScan(String directoryToScan)

setIncludeSubdirectories

@DataBoundSetter
public void setIncludeSubdirectories(boolean includeSubdirectories)

setPattern

@DataBoundSetter
public void setPattern(String pattern)

setConvertToSummary

@DataBoundSetter
public void setConvertToSummary(boolean convertToSummary)

setFailIfVulns

@DataBoundSetter
public void setFailIfVulns(boolean failIfVulns)

setScanTimeout

@DataBoundSetter
public void setScanTimeout(int scanTimeout)

setScanOnlyArtifacts

@DataBoundSetter
public void setScanOnlyArtifacts(boolean onlyArtifacts)

setCustomHeader

@DataBoundSetter
public void setCustomHeader(String customHeader)

setProtecodeScanName

@DataBoundSetter
public void setProtecodeScanName(String protecodeScanName)

setEndAfterSendingFiles

@DataBoundSetter
public void setEndAfterSendingFiles(boolean endAfterSendingFiles)

setDontZipFiles

@DataBoundSetter
public void setDontZipFiles(boolean dontZipFiles)

getConvertToSummary

@CheckForNull
public boolean getConvertToSummary()

getCredentialsId

@CheckForNull
public String getCredentialsId()

getDirectoryToScan

@CheckForNull
public String getDirectoryToScan()

getIncludeSubdirectories

@CheckForNull
public boolean getIncludeSubdirectories()

getPattern

@CheckForNull
public String getPattern()

getProtecodeScGroup

@CheckForNull
public String getProtecodeScGroup()

getFailIfVulns

@CheckForNull
public boolean getFailIfVulns()

getScanTimeout

@CheckForNull
public int getScanTimeout()

getScanOnlyArtifacts

@CheckForNull
public boolean getScanOnlyArtifacts()

getCustomHeader

@CheckForNull
public String getCustomHeader()

getProtecodeScanName

@CheckForNull
public String getProtecodeScanName()

getEndAfterSendingFiles

@CheckForNull
public boolean getEndAfterSendingFiles()

getDontZipFiles

@CheckForNull
public boolean getDontZipFiles()