io.jenkins.plugins

Class ReqtifyGenerateReport

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

io.jenkins.plugins.ReqtifyGenerateReport

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

@Extension
public class ReqtifyGenerateReport
extends Builder
implements SimpleBuildStep

This class allow us to generate a reqtify report with Jenkins.

Version:

1.0

Author:

3DS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReqtifyGenerateReport.DescriptorImpl Descriptor of the class ReqtifyGenerateReport.

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ReqtifyGenerateReport()
ReqtifyGenerateReport(String nameReport, String modelReport, String templateReport, String lang) Constructor with DataBoundConstructor.

Method Summary

Modifier and Type	Method and Description
ReqtifyGenerateReport.DescriptorImpl	getDescriptor()
String	getLang()
String	getModelReport()
String	getNameReport()
String	getTemplateReport()
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener) Creation and running of the command to generate a Reqtify report.
static String	readAll(InputStream is) Read all the char of an inputStream before -1.
void	setModelReport(String modelReport) Set a new model for the report.
void	setNameReport(String nameReport) Set a new name for the report.
void	setTemplateReport(String templateReport) Set a new template for the report.

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, 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

Constructor Detail

ReqtifyGenerateReport

public ReqtifyGenerateReport()

Since:

1.0

ReqtifyGenerateReport

@DataBoundConstructor
public ReqtifyGenerateReport(String nameReport,
                                                    String modelReport,
                                                    String templateReport,
                                                    String lang)

Constructor with DataBoundConstructor.

Parameters:

nameReport - stored name of the report

modelReport - stored model of the report

templateReport - stored template of the report

lang - stored language of the report

Since:

1.0

Method Detail

getNameReport

@Nonnull
public String getNameReport()

Returns:

stored name of the report

Since:

1.0

getModelReport

public String getModelReport()

Returns:

stored model of the report

Since:

1.0

getTemplateReport

public String getTemplateReport()

Returns:

stored template of the report

Since:

1.0

getLang

public String getLang()

Returns:

stored language of the report

Since:

1.0

setNameReport

@DataBoundSetter
public void setNameReport(@Nonnull
                                            String nameReport)

Set a new name for the report.

Parameters:

nameReport - New name for the report

Since:

1.0

setModelReport

@DataBoundSetter
public void setModelReport(String modelReport)

Set a new model for the report.

Parameters:

modelReport - New model for the report

Since:

1.0

setTemplateReport

@DataBoundSetter
public void setTemplateReport(String templateReport)

Set a new template for the report.

Parameters:

templateReport - New template for the report

Since:

1.0

getDescriptor

public ReqtifyGenerateReport.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder

Returns:

Return the descriptor

Since:

1.0

readAll

public static String readAll(InputStream is)
                      throws IOException

Read all the char of an inputStream before -1.

Parameters:

is - InputStream we want to read

Returns:

Return the string of readed chars

Throws:

IOException

Since:

1.0

perform

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

Creation and running of the command to generate a Reqtify report.

Specified by:

perform in interface SimpleBuildStep

Parameters:

run -

workspace - Path of the worskspace of the project

launcher -

listener -

Throws:

InterruptedException

IOException

Since:

1.0