org.jenkinsci.plugins.DependencyTrack

Class DependencyTrackPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.jenkinsci.plugins.DependencyTrack.DependencyTrackPublisher

All Implemented Interfaces:

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

public class DependencyTrackPublisher
extends hudson.tasks.Recorder
implements jenkins.tasks.SimpleBuildStep, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

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 inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
DependencyTrackPublisher(String artifact, String artifactType, boolean synchronous)

Method Summary

Modifier and Type	Method and Description
String	getArtifact() Retrieves the path and filename of the artifact.
String	getArtifactType() Retrieves the type of artifact (bom or scanResult).
DependencyTrackPublisher.DescriptorImpl	getDescriptor() A Descriptor Implementation.
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
String	getProjectId() Retrieves the project ID to upload to.
String	getProjectName() Retrieves the project name to upload to.
String	getProjectVersion() Retrieves the project version to upload to.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	isSynchronous() Retrieves is synchronous mode is enabled or not.
void	perform(hudson.model.Run<?,?> build, hudson.FilePath filePath, hudson.Launcher launcher, hudson.model.TaskListener listener) This method is called whenever the build step is executed.
void	setProjectId(String projectId) Sets the project ID to upload to.
void	setProjectName(String projectName) Sets the project name to upload to.
void	setProjectVersion(String projectVersion) Sets the project name to upload to.

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

getProjectActions, perform, prebuild

Constructor Detail

DependencyTrackPublisher

@DataBoundConstructor
public DependencyTrackPublisher(String artifact,
                                                      String artifactType,
                                                      boolean synchronous)

Method Detail

setProjectId

@DataBoundSetter
public void setProjectId(String projectId)

Sets the project ID to upload to. This is a per-build config item. This method must match the value in config.jelly.

setProjectName

@DataBoundSetter
public void setProjectName(String projectName)

Sets the project name to upload to. This is a per-build config item.

setProjectVersion

@DataBoundSetter
public void setProjectVersion(String projectVersion)

Sets the project name to upload to. This is a per-build config item.

getProjectId

public String getProjectId()

Retrieves the project ID to upload to. This is a per-build config item. This method must match the value in config.jelly.

getArtifact

public String getArtifact()

Retrieves the path and filename of the artifact. This is a per-build config item. This method must match the value in config.jelly.

getArtifactType

public String getArtifactType()

Retrieves the type of artifact (bom or scanResult). This is a per-build config item. This method must match the value in config.jelly.

getProjectName

public String getProjectName()

Retrieves the project name to upload to. This is a per-build config item. This method must match the value in config.jelly.

getProjectVersion

public String getProjectVersion()

Retrieves the project version to upload to. This is a per-build config item. This method must match the value in config.jelly.

isSynchronous

public boolean isSynchronous()

Retrieves is synchronous mode is enabled or not. This is a per-build config item. This method must match the value in config.jelly.

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> build,
                    @Nonnull
                    hudson.FilePath filePath,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

This method is called whenever the build step is executed.

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Parameters:

build - A Run object

filePath - A FilePath object

launcher - A Launcher object

listener - A BuildListener object

Throws:

InterruptedException

IOException

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

getDescriptor

public DependencyTrackPublisher.DescriptorImpl getDescriptor()

A Descriptor Implementation.

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Recorder

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep