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:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class CodeDxPublisher
extends hudson.tasks.Recorder

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 and Description
static class	CodeDxPublisher.DescriptorImpl Descriptor for CodeDxPublisher.

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
CodeDxPublisher(String url, String key, String projectId, String sourceAndBinaryFiles, String toolOutputFiles, String excludedSourceAndBinaryFiles, AnalysisResultConfiguration analysisResultConfiguration)

Method Summary

Methods

Modifier and Type	Method and Description
AnalysisResultConfiguration	getAnalysisResultConfiguration()
CodeDxPublisher.DescriptorImpl	getDescriptor()
String	getExcludedSourceAndBinaryFiles()
String	getKey()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
String	getProjectId()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getSourceAndBinaryFiles()
String	getToolOutputFiles()
String	getUrl()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

getProjectActions, prebuild

Constructor Detail

CodeDxPublisher

@DataBoundConstructor
public CodeDxPublisher(String url,
                                    String key,
                                    String projectId,
                                    String sourceAndBinaryFiles,
                                    String toolOutputFiles,
                                    String excludedSourceAndBinaryFiles,
                                    AnalysisResultConfiguration analysisResultConfiguration)

Parameters:

url - URL of the Code Dx server

key - API key of the Code Dx server

projectId - Code Dx project ID

sourceAndBinaryFiles - Comma separated list of source/binary file Ant GLOB patterns

toolOutputFiles - List of paths to tool output files

excludedSourceAndBinaryFiles - Comma separated list of source/binary file Ant GLOB patterns to exclude

analysisResultConfiguration - Contains the fields applicable when the user chooses to have Jenkins wait for analysis runs to complete.

Method Detail

getAnalysisResultConfiguration

public AnalysisResultConfiguration getAnalysisResultConfiguration()

getProjectId

public String getProjectId()

getUrl

public String getUrl()

getKey

public String getKey()

getSourceAndBinaryFiles

public String getSourceAndBinaryFiles()

getToolOutputFiles

public String getToolOutputFiles()

getExcludedSourceAndBinaryFiles

public String getExcludedSourceAndBinaryFiles()

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

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

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

getDescriptor

public CodeDxPublisher.DescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Recorder