Package io.jenkins.plugins.finitestate

Class FiniteStateSBOMImportRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

io.jenkins.plugins.finitestate.BaseFiniteStateRecorder

io.jenkins.plugins.finitestate.FiniteStateSBOMImportRecorder

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class FiniteStateSBOMImportRecorder
extends BaseFiniteStateRecorder

Refactored SBOM Import Recorder that extends the base class to reduce code duplication. This demonstrates how the new base classes can be used to eliminate repetitive code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FiniteStateSBOMImportRecorder.DescriptorImpl

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

Publisher.DescriptorExtensionListImpl

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 inherited from class io.jenkins.plugins.finitestate.BaseFiniteStateRecorder

apiTokenCredentialsId, externalizableId, preRelease, projectName, projectVersion, subdomain

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
FiniteStateSBOMImportRecorder(String subdomain, String apiTokenCredentialsId, String sbomFilePath, String projectName)

Method Summary

Modifier and Type	Method	Description
protected int	executeAnalysis(FilePath cltPath, FilePath filePath, String projectName, String projectVersion, FilePath workspace, Launcher launcher, TaskListener listener)	Abstract method for executing the specific analysis
protected String	getAnalysisType()	Get the analysis type name for logging and results
protected String	getFilePathFieldName()	Get the file path field name for validation
protected String	getFilePathValue()	Get the file path value
String	getSbomFilePath()
void	setSbomFilePath(String sbomFilePath)

Methods inherited from class io.jenkins.plugins.finitestate.BaseFiniteStateRecorder

addConsolidatedResult, getApiTokenCredentialsId, getCLTPath, getExternalizableId, getFileFromWorkspace, getPreRelease, getProjectName, getProjectVersion, getSecretTextValue, getSubdomain, logCommonInfo, parseVersion, perform, setApiTokenCredentialsId, setExternalizableId, setPreRelease, setProjectName, setProjectVersion, setSubdomain, validateCommonFields

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

FiniteStateSBOMImportRecorder

@DataBoundConstructor
public FiniteStateSBOMImportRecorder(String subdomain,
 String apiTokenCredentialsId,
 String sbomFilePath,
 String projectName)

Method Details

getSbomFilePath

public String getSbomFilePath()

setSbomFilePath

@DataBoundSetter
public void setSbomFilePath(String sbomFilePath)

executeAnalysis

protected int executeAnalysis(FilePath cltPath,
 FilePath filePath,
 String projectName,
 String projectVersion,
 FilePath workspace,
 Launcher launcher,
 TaskListener listener)
                       throws IOException,
InterruptedException

Description copied from class: BaseFiniteStateRecorder

Abstract method for executing the specific analysis

Specified by:

executeAnalysis in class BaseFiniteStateRecorder

Throws:

IOException

InterruptedException

getAnalysisType

protected String getAnalysisType()

Description copied from class: BaseFiniteStateRecorder

Get the analysis type name for logging and results

Specified by:

getAnalysisType in class BaseFiniteStateRecorder

getFilePathFieldName

protected String getFilePathFieldName()

Description copied from class: BaseFiniteStateRecorder

Get the file path field name for validation

Specified by:

getFilePathFieldName in class BaseFiniteStateRecorder

getFilePathValue

protected String getFilePathValue()

Description copied from class: BaseFiniteStateRecorder

Get the file path value

Specified by:

getFilePathValue in class BaseFiniteStateRecorder