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

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)

Method Summary

EnumSet<net.praqma.prqa.PRQAContext.QARReportType>	getChosenReportTypes()
String	getChosenServer()
net.praqma.prqa.CodeUploadSetting	getCodeUploadSetting()
Double	getFileComplianceIndex()
PRQAGraph	getGraph(Class clazz, List<PRQAGraph> graphs)
PRQAGraph	getGraph(String simpleClassName)
List<PRQAGraph>	getGraphTypes()
String	getProduct()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
Double	getProjectComplianceIndex()
String	getProjectFile()
String	getQaVerifyProjectName()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getSettingFileCompliance()
String	getSettingMaxMessages()
String	getSettingProjectCompliance()
String	getSourceOrigin()
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()
Boolean	getTotalBetter()
Integer	getTotalMax()
String	getVcsConfigXml()
boolean	isEnableDataFlowAnalysis()
boolean	isEnableDependencyMode()
boolean	isGenerateReports()
boolean	isPerformCrossModuleAnalysis()
boolean	isPublishToQAV()
boolean	isSingleSnapshotMode()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	setChosenReportTypes(EnumSet<net.praqma.prqa.PRQAContext.QARReportType> chosenReportTypes)
void	setChosenServer(String chosenServer)
void	setCodeUploadSetting(String codeUploadSetting)
void	setEnableDataFlowAnalysis(boolean enableDataFlowAnalysis)
void	setEnableDependencyMode(boolean enableDependencyMode)
void	setFileComplianceIndex(Double fileCompliance)
void	setGenerateReports(boolean generateReports)
void	setGraphTypes(List<PRQAGraph> graphTypes)
void	setPerformCrossModuleAnalysis(boolean performCrossModuleAnalysis)
void	setProduct(String product)
void	setProjectComplianceIndex(Double index)
void	setProjectFile(String projectFile)
void	setPublishToQAV(boolean publishToQAV)
void	setQaVerifyProjectName(String qaVerifyProjectName)
void	setSettingFileCompliance(String settingFileCompliance)
void	setSettingMaxMessages(String settingMaxMessages)
void	setSettingProjectCompliance(String settingProjectCompliance)
void	setSingleSnapshotMode(boolean singleSnapshotMode)
void	setSourceOrigin(String sourceOrigin)
void	setTotalBetter(Boolean totalBetter)
void	setTotalMax(Integer totalMax)
void	setVcsConfigXml(String vcsConfigXml)

Methods inherited from class hudson.tasks.Publisher

all, getDescriptor, 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

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)

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)

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()

setTotalMax

@Exported
public void setTotalMax(Integer totalMax)

setGraphTypes

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

getGraphTypes

@Exported
public List<PRQAGraph> getGraphTypes()

getProduct

@Exported
public String getProduct()

setProduct

@Exported
public void setProduct(String product)

getTotalBetter

@Exported
public Boolean getTotalBetter()

setTotalBetter

@Exported
public void setTotalBetter(Boolean totalBetter)

setFileComplianceIndex

@Exported
public void setFileComplianceIndex(Double fileCompliance)

getFileComplianceIndex

@Exported
public Double getFileComplianceIndex()

getProjectComplianceIndex

@Exported
public Double getProjectComplianceIndex()

setProjectComplianceIndex

@Exported
public void setProjectComplianceIndex(Double index)

setSettingFileCompliance

@Exported
public void setSettingFileCompliance(String settingFileCompliance)

getSettingFileCompliance

@Exported
public String getSettingFileCompliance()

setSettingProjectCompliance

@Exported
public void setSettingProjectCompliance(String settingProjectCompliance)

getSettingProjectCompliance

@Exported
public String getSettingProjectCompliance()

getSettingMaxMessages

@Exported
public String getSettingMaxMessages()

setSettingMaxMessages

@Exported
public void setSettingMaxMessages(String settingMaxMessages)

setProjectFile

@Exported
public void setProjectFile(String projectFile)

getProjectFile

@Exported
public String getProjectFile()

isPerformCrossModuleAnalysis

@Exported
public boolean isPerformCrossModuleAnalysis()

Returns:

the performCrossModuleAnalysis

setPerformCrossModuleAnalysis

@Exported
public void setPerformCrossModuleAnalysis(boolean performCrossModuleAnalysis)

Parameters:

performCrossModuleAnalysis - the performCrossModuleAnalysis to set

isPublishToQAV

@Exported
public boolean isPublishToQAV()

Returns:

the publishToQAV

setPublishToQAV

@Exported
public void setPublishToQAV(boolean publishToQAV)

getQaVerifyProjectName

public String getQaVerifyProjectName()

Returns:

the qaVerifyProjectName

setQaVerifyProjectName

public void setQaVerifyProjectName(String qaVerifyProjectName)

Parameters:

qaVerifyProjectName - the qaVerifyProjectName to set

getVcsConfigXml

public String getVcsConfigXml()

Returns:

the vcsConfigXml

setVcsConfigXml

public void setVcsConfigXml(String vcsConfigXml)

Parameters:

vcsConfigXml - the vcsConfigXml to set

isSingleSnapshotMode

public boolean isSingleSnapshotMode()

Returns:

the singleSnapshotMode

setSingleSnapshotMode

public void setSingleSnapshotMode(boolean singleSnapshotMode)

Parameters:

singleSnapshotMode - the singleSnapshotMode to set

isEnableDependencyMode

public boolean isEnableDependencyMode()

Returns:

the enableDependencyMode

setEnableDependencyMode

public void setEnableDependencyMode(boolean enableDependencyMode)

Parameters:

enableDependencyMode - the enableDependencyMode to set

getCodeUploadSetting

public net.praqma.prqa.CodeUploadSetting getCodeUploadSetting()

Returns:

the codeUploadSetting

setCodeUploadSetting

public void setCodeUploadSetting(String codeUploadSetting)

Parameters:

codeUploadSetting - the codeUploadSetting to set

isGenerateReports

public boolean isGenerateReports()

Returns:

the generateReports

setGenerateReports

public void setGenerateReports(boolean generateReports)

Parameters:

generateReports - the generateReports to set

getChosenServer

public String getChosenServer()

Returns:

the chosenServer

setChosenServer

public void setChosenServer(String chosenServer)

Parameters:

chosenServer - the chosenServer to set

getSourceOrigin

public String getSourceOrigin()

Returns:

the sourceOrigin

setSourceOrigin

public void setSourceOrigin(String sourceOrigin)

Parameters:

sourceOrigin - the sourceOrigin 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)

isEnableDataFlowAnalysis

public boolean isEnableDataFlowAnalysis()

Returns:

the enableDataFlowAnalysis

setEnableDataFlowAnalysis

public void setEnableDataFlowAnalysis(boolean enableDataFlowAnalysis)

Parameters:

enableDataFlowAnalysis - the enableDataFlowAnalysis to set