net.praqma.jenkins.plugin.prqa.notifier
Class PRQANotifier

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          net.praqma.jenkins.plugin.prqa.notifier.PRQANotifier

All Implemented Interfaces:

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

public class PRQANotifier
extends hudson.tasks.Publisher

Nested Class Summary

static class

PRQANotifier.DescriptorImpl This class is used by Jenkins to define the plugin.

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

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

hudson.tasks.BuildStep.PublisherList

Field Summary

String	chosenServer
boolean	enableDataFlowAnalysis
boolean	enableDependencyMode
Double	fileComplianceIndex
boolean	generateReports
boolean	performCrossModuleAnalysis
String	product
Double	projectComplianceIndex
String	projectFile
boolean	publishToQAV
String	qaVerifyProjectName
String	settingFileCompliance
String	settingMaxMessages
String	settingProjectCompliance
boolean	singleSnapshotMode
PRQAReportSource	source
String	sourceOrigin
int	threshholdlevel
Boolean	totalBetter
Integer	totalMax
String	vcsConfigXml

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

PRQANotifier(String product, boolean totalBetter, String totalMax, String fileComplianceIndex, String projectComplianceIndex, String settingMaxMessages, String settingFileCompliance, String settingProjectCompliance, String projectFile, boolean performCrossModuleAnalysis, boolean publishToQAV, String qaVerifyProjectName, String vcsConfigXml, boolean singleSnapshotMode, String snapshotName, String chosenServer, boolean enableDependencyMode, String codeUploadSetting, String msgConfigFile, boolean generateReports, String sourceOrigin, EnumSet<net.praqma.prqa.PRQAContext.QARReportType> chosenReportTypes, boolean enableDataFlowAnalysis, int threshholdlevel, PRQAReportSource source)

Method Summary

EnumSet<net.praqma.prqa.PRQAContext.QARReportType>	getChosenReportTypes()
net.praqma.prqa.CodeUploadSetting	getCodeUploadSetting()
PRQAGraph	getGraph(Class clazz, List<PRQAGraph> graphs)
PRQAGraph	getGraph(String simpleClassName)
List<PRQAGraph>	getGraphTypes()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
List<PRQAGraph>	getSupportedGraphs()
Number	getThreshold(net.praqma.prqa.status.StatusCategory cat) Use this method to get the threshold values associated with the current build.
HashMap<net.praqma.prqa.status.StatusCategory,Number>	getThresholds()
Integer	getTotalMax()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
boolean	prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Pre-build for the plugin.
void	setChosenReportTypes(EnumSet<net.praqma.prqa.PRQAContext.QARReportType> chosenReportTypes)
void	setCodeUploadSetting(String codeUploadSetting)
void	setGraphTypes(List<PRQAGraph> graphTypes)

Methods inherited from class hudson.tasks.Publisher

all, getDescriptor, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectActions, perform

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

Field Detail

threshholdlevel

public final int threshholdlevel

totalBetter

public final Boolean totalBetter

totalMax

public final Integer totalMax

product

public final String product

chosenServer

public final String chosenServer

settingFileCompliance

public final String settingFileCompliance

settingMaxMessages

public final String settingMaxMessages

settingProjectCompliance

public final String settingProjectCompliance

fileComplianceIndex

public final Double fileComplianceIndex

projectComplianceIndex

public final Double projectComplianceIndex

projectFile

public final String projectFile

vcsConfigXml

public final String vcsConfigXml

performCrossModuleAnalysis

public final boolean performCrossModuleAnalysis

publishToQAV

public final boolean publishToQAV

singleSnapshotMode

public final boolean singleSnapshotMode

enableDependencyMode

public final boolean enableDependencyMode

enableDataFlowAnalysis

public final boolean enableDataFlowAnalysis

generateReports

public final boolean generateReports

sourceOrigin

public final String sourceOrigin

qaVerifyProjectName

public final String qaVerifyProjectName

source

public final PRQAReportSource source

Constructor Detail

PRQANotifier

@DataBoundConstructor
public PRQANotifier(String product,
                                         boolean totalBetter,
                                         String totalMax,
                                         String fileComplianceIndex,
                                         String projectComplianceIndex,
                                         String settingMaxMessages,
                                         String settingFileCompliance,
                                         String settingProjectCompliance,
                                         String projectFile,
                                         boolean performCrossModuleAnalysis,
                                         boolean publishToQAV,
                                         String qaVerifyProjectName,
                                         String vcsConfigXml,
                                         boolean singleSnapshotMode,
                                         String snapshotName,
                                         String chosenServer,
                                         boolean enableDependencyMode,
                                         String codeUploadSetting,
                                         String msgConfigFile,
                                         boolean generateReports,
                                         String sourceOrigin,
                                         EnumSet<net.praqma.prqa.PRQAContext.QARReportType> chosenReportTypes,
                                         boolean enableDataFlowAnalysis,
                                         int threshholdlevel,
                                         PRQAReportSource source)

Method Detail

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

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

getSupportedGraphs

public List<PRQAGraph> getSupportedGraphs()

getGraph

public PRQAGraph getGraph(String simpleClassName)

getThreshold

public Number getThreshold(net.praqma.prqa.status.StatusCategory cat)

Use this method to get the threshold values associated with the current build.

Parameters:

cat -

Returns:

the threshold for any given category.

getThresholds

public HashMap<net.praqma.prqa.status.StatusCategory,Number> getThresholds()

getGraph

public PRQAGraph getGraph(Class clazz,
                          List<PRQAGraph> graphs)

prebuild

public boolean prebuild(hudson.model.AbstractBuild<?,?> build,
                        hudson.model.BuildListener listener)

Pre-build for the plugin. We use this one to clean up old report files.

Specified by:

prebuild in interface hudson.tasks.BuildStep

Overrides:

prebuild in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build -

listener -

Returns:

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

getTotalMax

@Exported
public Integer getTotalMax()

setGraphTypes

@Exported
public void setGraphTypes(List<PRQAGraph> graphTypes)

getGraphTypes

@Exported
public List<PRQAGraph> getGraphTypes()

getCodeUploadSetting

public net.praqma.prqa.CodeUploadSetting getCodeUploadSetting()

Returns:

the codeUploadSetting

setCodeUploadSetting

public void setCodeUploadSetting(String codeUploadSetting)

Parameters:

codeUploadSetting - the codeUploadSetting to set

getChosenReportTypes

public EnumSet<net.praqma.prqa.PRQAContext.QARReportType> getChosenReportTypes()

Returns:

the optionalReportTypes

setChosenReportTypes

public void setChosenReportTypes(EnumSet<net.praqma.prqa.PRQAContext.QARReportType> chosenReportTypes)