Package org.jenkinsci.plugins.codedx

Class CodeDxPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.jenkinsci.plugins.codedx.CodeDxPublisher

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class CodeDxPublisher
extends Recorder
implements SimpleBuildStep

Jenkins publisher that publishes project source, binaries, and analysis tool output files to a CodeDx server.

Author:

anthonyd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CodeDxPublisher.DescriptorImpl	Descriptor for CodeDxPublisher.
static class	CodeDxPublisher.NamedProject
static class	CodeDxPublisher.ProjectSelection
static class	CodeDxPublisher.ProjectSelectionDescriptor
static class	CodeDxPublisher.SpecificProject

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

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
CodeDxPublisher(String url, String keyCredentialId, String analysisName)

Method Summary

Modifier and Type	Method	Description
static CodeDxClient	buildClient(String url, String key, String fingerprint)
String	getAnalysisName()
AnalysisResultConfiguration	getAnalysisResultConfiguration()
String	getBaseBranchName()
CodeDxPublisher.DescriptorImpl	getDescriptor()
BuildErrorBehavior	getErrorHandlingBehavior()
String	getExcludedSourceAndBinaryFiles()
GitFetchConfiguration	getGitFetchConfiguration()
String	getKeyCredentialId()
CodeDxPublisher.ProjectSelection	getProject()
DescriptorExtensionList<CodeDxPublisher.ProjectSelection,Descriptor<CodeDxPublisher.ProjectSelection>>	getProjectDescriptors()
String	getProjectId()	Deprecated.
BuildStepMonitor	getRequiredMonitorService()
String	getSelfSignedCertificateFingerprint()
String	getSourceAndBinaryFiles()
String	getTargetBranchName()
String	getToolOutputFiles()
String	getUrl()
void	perform(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
protected Object	readResolve()
void	setAnalysisResultConfiguration(AnalysisResultConfiguration analysisResultConfiguration)
void	setBaseBranchName(String baseBranchName)
void	setErrorHandlingBehavior(BuildErrorBehavior behavior)
void	setExcludedSourceAndBinaryFiles(String excludedSourceAndBinaryFiles)
void	setGitFetchConfiguration(GitFetchConfiguration config)
void	setProject(CodeDxPublisher.ProjectSelection project)
void	setProjectId(String projectId)	Deprecated.
void	setSelfSignedCertificateFingerprint(String selfSignedCertificateFingerprint)
void	setSourceAndBinaryFiles(String sourceAndBinaryFiles)
void	setTargetBranchName(String targetBranchName)
void	setToolOutputFiles(String toolOutputFiles)

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

Constructor Detail

CodeDxPublisher

@DataBoundConstructor
public CodeDxPublisher(String url,
                       String keyCredentialId,
                       String analysisName)

Parameters:

url - URL of the Code Dx server

keyCredentialId - ID of a Secret Text Credential containing the API key of the Code Dx server

analysisName - The name to use for the analysis

Method Detail

readResolve

protected Object readResolve()

getAnalysisResultConfiguration

public AnalysisResultConfiguration getAnalysisResultConfiguration()

setAnalysisResultConfiguration

@DataBoundSetter
public void setAnalysisResultConfiguration(AnalysisResultConfiguration analysisResultConfiguration)

getProject

public CodeDxPublisher.ProjectSelection getProject()

setProject

@DataBoundSetter
public void setProject(CodeDxPublisher.ProjectSelection project)

getProjectDescriptors

public DescriptorExtensionList<CodeDxPublisher.ProjectSelection,Descriptor<CodeDxPublisher.ProjectSelection>> getProjectDescriptors()

getProjectId

@Deprecated
public String getProjectId()

Deprecated.

setProjectId

@Deprecated
@DataBoundSetter
public void setProjectId(String projectId)

Deprecated.

getUrl

public String getUrl()

getKeyCredentialId

public String getKeyCredentialId()

getSourceAndBinaryFiles

public String getSourceAndBinaryFiles()

setSourceAndBinaryFiles

@DataBoundSetter
public void setSourceAndBinaryFiles(String sourceAndBinaryFiles)

getToolOutputFiles

public String getToolOutputFiles()

setToolOutputFiles

@DataBoundSetter
public void setToolOutputFiles(String toolOutputFiles)

getExcludedSourceAndBinaryFiles

public String getExcludedSourceAndBinaryFiles()

setExcludedSourceAndBinaryFiles

@DataBoundSetter
public void setExcludedSourceAndBinaryFiles(String excludedSourceAndBinaryFiles)

getSelfSignedCertificateFingerprint

public String getSelfSignedCertificateFingerprint()

setSelfSignedCertificateFingerprint

@DataBoundSetter
public void setSelfSignedCertificateFingerprint(String selfSignedCertificateFingerprint)

getAnalysisName

public String getAnalysisName()

getTargetBranchName

public String getTargetBranchName()

setTargetBranchName

@DataBoundSetter
public void setTargetBranchName(String targetBranchName)

getBaseBranchName

public String getBaseBranchName()

setBaseBranchName

@DataBoundSetter
public void setBaseBranchName(String baseBranchName)

getErrorHandlingBehavior

public BuildErrorBehavior getErrorHandlingBehavior()

setErrorHandlingBehavior

@DataBoundSetter
public void setErrorHandlingBehavior(BuildErrorBehavior behavior)

getGitFetchConfiguration

public GitFetchConfiguration getGitFetchConfiguration()

setGitFetchConfiguration

@DataBoundSetter
public void setGitFetchConfiguration(GitFetchConfiguration config)

perform

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

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

buildClient

public static CodeDxClient buildClient(String url,
                                       String key,
                                       String fingerprint)

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

getDescriptor

public CodeDxPublisher.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Recorder