Package org.ow2.clif.jenkins

Class ClifPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.ow2.clif.jenkins.ClifPublisher

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep

public class ClifPublisher
extends Recorder

The publisher creates the results we want from the Clif execution. =======

An extension point to execute a post build report generation for Clif result.

It defines ClifProjectAction as Project Action and ClifBuildAction as an action for each build.

This publisher is not executed when the build status is ABORTED or FAILURE.

Author:

Julien Coste, Bruno Dillenseger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClifPublisher.DescriptorImpl

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ClifPublisher.DescriptorImpl	DESCRIPTOR	Descriptor should be singleton.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
ClifPublisher(String clifReportDirectory)
ClifPublisher(String clifReportDirectory, boolean dateFiltering, String minTimestamp, String maxTimestamp, int chartWidth, int chartHeight, int distributionSliceSize, int distributionSliceNumber, int statisticalPeriod)

Method Summary

Modifier and Type	Method	Description
protected boolean	canContinue(Result result)	Clif publisher doesn't need to continue if the build's status is ABORTED or FAILURE.
List<ClifAlias>	getAlias()
int	getChartHeight()
int	getChartWidth()
String	getClifReportDirectory()
ClifDataCleanup	getDataCleanupConfig()
boolean	getDateFiltering()
ClifPublisher.DescriptorImpl	getDescriptor()
int	getDistributionSliceNumber()
int	getDistributionSliceSize()
protected static double	getDouble(String value)
protected static long	getLong(String value)
String	getMaxTimestamp()
String	getMinTimestamp()
Action	getProjectAction(AbstractProject<?,?> project)
BuildStepMonitor	getRequiredMonitorService()
int	getStatisticalPeriod()
List<ClifResultConfig>	getSuccessPatterns()
boolean	isDateFiltering()
protected static boolean	isDouble(String value)
protected static boolean	isLong(String value)
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, 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

Field Details

DESCRIPTOR

@Extension
public static final ClifPublisher.DescriptorImpl DESCRIPTOR

Descriptor should be singleton.

Constructor Details

ClifPublisher

public ClifPublisher(String clifReportDirectory)

ClifPublisher

@DataBoundConstructor
public ClifPublisher(String clifReportDirectory,
 boolean dateFiltering,
 String minTimestamp,
 String maxTimestamp,
 int chartWidth,
 int chartHeight,
 int distributionSliceSize,
 int distributionSliceNumber,
 int statisticalPeriod)

Method Details

perform

public boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 BuildListener listener)
                throws InterruptedException,
IOException

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

getProjectAction

public Action getProjectAction(AbstractProject<?,?> project)

Specified by:

getProjectAction in interface BuildStep

Overrides:

getProjectAction in class BuildStepCompatibilityLayer

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

canContinue

protected boolean canContinue(Result result)

Clif publisher doesn't need to continue if the build's status is ABORTED or FAILURE.

Parameters:

result - build status object

Returns:

true if build status is not ABORTED or FAILURE.

getDescriptor

public ClifPublisher.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Recorder

isLong

protected static boolean isLong(String value)

getLong

protected static long getLong(String value)

isDouble

protected static boolean isDouble(String value)

getDouble

protected static double getDouble(String value)

getDateFiltering

public boolean getDateFiltering()

getMinTimestamp

public String getMinTimestamp()

getMaxTimestamp

public String getMaxTimestamp()

getClifReportDirectory

public String getClifReportDirectory()

getAlias

public List<ClifAlias> getAlias()

getSuccessPatterns

public List<ClifResultConfig> getSuccessPatterns()

getDataCleanupConfig

public ClifDataCleanup getDataCleanupConfig()

getChartWidth

public int getChartWidth()

getChartHeight

public int getChartHeight()

getDistributionSliceNumber

public int getDistributionSliceNumber()

getDistributionSliceSize

public int getDistributionSliceSize()

isDateFiltering

public boolean isDateFiltering()

getStatisticalPeriod

public int getStatisticalPeriod()