Package org.jenkinsci.plugins.aquadockerscannerbuildstep

Class AquaDockerScannerBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.aquadockerscannerbuildstep.AquaDockerScannerBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class AquaDockerScannerBuilder
extends Builder
implements SimpleBuildStep

This is the builder class.

When a build is performed, the perform(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) method will be invoked.

Author:

Oran Moshai

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AquaDockerScannerBuilder.DescriptorImpl	Descriptor for AquaDockerScannerBuilder.

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields

Modifier and Type	Field	Description
static int	DISALLOWED_CODE
static int	OK_CODE

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
AquaDockerScannerBuilder(String locationType, String registry, boolean register, String localImage, String hostedImage, String onDisallowed, String notCompliesCmd, boolean hideBase, boolean showNegligible, String policies, String localToken, String customFlags, String tarFilePath, String containerRuntime, String scannerPath, String runtimeDirectory)

Method Summary

Modifier and Type	Method	Description
String	getContainerRuntime()
String	getCustomFlags()
AquaDockerScannerBuilder.DescriptorImpl	getDescriptor()
boolean	getHideBase()
String	getHostedImage()
String	getLocalImage()
String	getLocalToken()
String	getLocationType()	Public access required by config.jelly to display current values in configuration screen.
String	getNotCompliesCmd()
String	getOnDisallowed()
String	getPolicies()
boolean	getRegister()
String	getRegistry()
String	getRuntimeDirectory()
String	getScannerPath()
boolean	getShowNegligible()
String	getTarFilePath()
String	isLocationType(String type)
String	isOnDisallowed(String state)
void	perform(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
void	setContainerRuntime(String containerRuntime)
void	setLocalToken(String localToken)
void	setRuntimeDirectory(String runtimeDirectory)
void	setScannerPath(String scannerPath)
void	setTarFilePath(String tarFilePath)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, 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, perform, prebuild

Field Detail

OK_CODE

public static final int OK_CODE

See Also:

Constant Field Values

DISALLOWED_CODE

public static final int DISALLOWED_CODE

See Also:

Constant Field Values

Constructor Detail

AquaDockerScannerBuilder

@DataBoundConstructor
public AquaDockerScannerBuilder(String locationType,
                                String registry,
                                boolean register,
                                String localImage,
                                String hostedImage,
                                String onDisallowed,
                                String notCompliesCmd,
                                boolean hideBase,
                                boolean showNegligible,
                                String policies,
                                String localToken,
                                String customFlags,
                                String tarFilePath,
                                String containerRuntime,
                                String scannerPath,
                                String runtimeDirectory)

Method Detail

getLocationType

public String getLocationType()

Public access required by config.jelly to display current values in configuration screen.

getContainerRuntime

@CheckForNull
public String getContainerRuntime()

getScannerPath

@CheckForNull
public String getScannerPath()

getRegistry

public String getRegistry()

getRegister

public boolean getRegister()

getLocalImage

public String getLocalImage()

getHostedImage

public String getHostedImage()

getOnDisallowed

public String getOnDisallowed()

getNotCompliesCmd

public String getNotCompliesCmd()

getPolicies

public String getPolicies()

getLocalToken

@CheckForNull
public String getLocalToken()

getCustomFlags

public String getCustomFlags()

getHideBase

public boolean getHideBase()

getShowNegligible

public boolean getShowNegligible()

getRuntimeDirectory

public String getRuntimeDirectory()

getTarFilePath

@CheckForNull
public String getTarFilePath()

isLocationType

public String isLocationType(String type)

isOnDisallowed

public String isOnDisallowed(String state)

setContainerRuntime

@DataBoundSetter
public void setContainerRuntime(@CheckForNull
                                String containerRuntime)

setScannerPath

@DataBoundSetter
public void setScannerPath(@CheckForNull
                           String scannerPath)

setTarFilePath

@DataBoundSetter
public void setTarFilePath(@CheckForNull
                           String tarFilePath)

setLocalToken

@DataBoundSetter
public void setLocalToken(@CheckForNull
                          String localToken)

setRuntimeDirectory

@DataBoundSetter
public void setRuntimeDirectory(@CheckForNull
                                String runtimeDirectory)

perform

public void perform(Run<?,?> build,
                    FilePath workspace,
                    Launcher launcher,
                    TaskListener listener)
             throws AbortException,
                    InterruptedException

Specified by:

perform in interface SimpleBuildStep

Throws:

AbortException

InterruptedException

getDescriptor

public AquaDockerScannerBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder