hudson.plugins.checkstyle.util
Class HealthAwarePublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.plugins.checkstyle.util.HealthAwarePublisher

All Implemented Interfaces:

hudson.model.Describable<hudson.tasks.Publisher>, HealthDescriptor, hudson.tasks.BuildStep, java.io.Serializable

Direct Known Subclasses:

CheckStylePublisher

public abstract class HealthAwarePublisher
extends hudson.tasks.Publisher
implements HealthDescriptor

A base class for publishers with the following two characteristics:

• It provides a unstable threshold, that could be enabled and set in the configuration screen. If the number of annotations in a build exceeds this value then the build is considered as UNSTABLE.
• It provides thresholds for the build health, that could be adjusted in the configuration screen. These values are used by the HealthReportBuilder to compute the health and the health trend graph.

Author:

Ulli Hafner

See Also:

Serialized Form

Nested Class Summary

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

HealthAwarePublisher(java.lang.String threshold, java.lang.String newThreshold, java.lang.String failureThreshold, java.lang.String newFailureThreshold, java.lang.String healthy, java.lang.String unHealthy, java.lang.String thresholdLimit, java.lang.String defaultEncoding, java.lang.String pluginName)
Creates a new instance of HealthAwarePublisher.

Method Summary

protected boolean	canContinue(hudson.model.Result result) Returns whether the publisher can continue processing.
java.lang.String	getDefaultEncoding() Returns the defined default encoding.
java.lang.String	getFailureThreshold() Returns the annotation threshold to be reached if a build should be considered as failure.
java.lang.String	getHealthy() Returns the healthy threshold, i.e.
Priority	getMinimumPriority() Returns the minimum priority that should be considered when computing build health and stability.
java.lang.String	getNewFailureThreshold() Returns the threshold of new annotations to be reached if a build should be considered as failure.
java.lang.String	getNewThreshold() Returns the threshold of new annotations to be reached if a build should be considered as unstable.
java.lang.String	getThreshold() Returns the annotation threshold to be reached if a build should be considered as unstable.
java.lang.String	getThresholdLimit() Returns the threshold limit.
java.lang.String	getUnHealthy() Returns the unhealthy threshold, i.e.
protected boolean	isAntBuild(hudson.model.AbstractBuild<?,?> build) Returns whether the current build uses ant.
protected boolean	isMavenBuild(hudson.model.AbstractBuild<?,?> build) Returns whether the current build uses maven.
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
protected abstract BuildResult	perform(hudson.model.AbstractBuild<?,?> build, PluginLogger logger) Performs the publishing of the results of this plug-in.
protected java.lang.Object	readResolve() Initializes new fields that are not serialized yet.

Methods inherited from class hudson.tasks.Publisher

all, getDescriptor, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

Constructor Detail

HealthAwarePublisher

public HealthAwarePublisher(java.lang.String threshold,
                            java.lang.String newThreshold,
                            java.lang.String failureThreshold,
                            java.lang.String newFailureThreshold,
                            java.lang.String healthy,
                            java.lang.String unHealthy,
                            java.lang.String thresholdLimit,
                            java.lang.String defaultEncoding,
                            java.lang.String pluginName)

Creates a new instance of HealthAwarePublisher.

Parameters:

threshold - Annotations threshold to be reached if a build should be considered as unstable.

newThreshold - New annotations threshold to be reached if a build should be considered as unstable.

failureThreshold - Annotation threshold to be reached if a build should be considered as failure.

newFailureThreshold - New annotations threshold to be reached if a build should be considered as failure.

healthy - Report health as 100% when the number of open tasks is less than this value

unHealthy - Report health as 0% when the number of open tasks is greater than this value

thresholdLimit - determines which warning priorities should be considered when evaluating the build stability and health

pluginName - the name of the plug-in

defaultEncoding - the default encoding to be used when reading and parsing files

Method Detail

readResolve

protected java.lang.Object readResolve()

Initializes new fields that are not serialized yet.

Returns:

the object

perform

public final boolean perform(hudson.model.AbstractBuild<?,?> build,
                             hudson.Launcher launcher,
                             hudson.model.BuildListener listener)
                      throws java.lang.InterruptedException,
                             java.io.IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

java.lang.InterruptedException

java.io.IOException

canContinue

protected boolean canContinue(hudson.model.Result result)

Returns whether the publisher can continue processing. This default implementation returns true if the build is not aborted or failed.

Parameters:

result - build result

Returns:

true if the build can continue

perform

protected abstract BuildResult perform(hudson.model.AbstractBuild<?,?> build,
                                       PluginLogger logger)
                                throws java.lang.InterruptedException,
                                       java.io.IOException

Performs the publishing of the results of this plug-in.

Parameters:

build - the build

logger - the logger to report the progress to

Returns:

the java project containing the found annotations

Throws:

java.lang.InterruptedException - If the build is interrupted by the user (in an attempt to abort the build.) Normally the BuildStep implementations may simply forward the exception it got from its lower-level functions.

java.io.IOException - If the implementation wants to abort the processing when an IOException happens, it can simply propagate the exception to the caller. This will cause the build to fail, with the default error message. Implementations are encouraged to catch IOException on its own to provide a better error message, if it can do so, so that users have better understanding on why it failed.

getThreshold

public java.lang.String getThreshold()

Returns the annotation threshold to be reached if a build should be considered as unstable.

Specified by:

getThreshold in interface HealthDescriptor

Returns:

the annotation threshold to be reached if a build should be considered as unstable.

getNewThreshold

public java.lang.String getNewThreshold()

Returns the threshold of new annotations to be reached if a build should be considered as unstable.

Specified by:

getNewThreshold in interface HealthDescriptor

Returns:

the threshold of new annotations to be reached if a build should be considered as unstable.

getFailureThreshold

public java.lang.String getFailureThreshold()

Returns the annotation threshold to be reached if a build should be considered as failure.

Specified by:

getFailureThreshold in interface HealthDescriptor

Returns:

the annotation threshold to be reached if a build should be considered as failure.

getNewFailureThreshold

public java.lang.String getNewFailureThreshold()

Returns the threshold of new annotations to be reached if a build should be considered as failure.

Specified by:

getNewFailureThreshold in interface HealthDescriptor

Returns:

the threshold of new annotations to be reached if a build should be considered as failure.

getHealthy

public java.lang.String getHealthy()

Returns the healthy threshold, i.e. when health is reported as 100%.

Specified by:

getHealthy in interface HealthDescriptor

Returns:

the 100% healthiness

getUnHealthy

public java.lang.String getUnHealthy()

Returns the unhealthy threshold, i.e. when health is reported as 0%.

Specified by:

getUnHealthy in interface HealthDescriptor

Returns:

the 0% unhealthiness

getDefaultEncoding

public java.lang.String getDefaultEncoding()

Returns the defined default encoding.

Returns:

the default encoding

isMavenBuild

protected boolean isMavenBuild(hudson.model.AbstractBuild<?,?> build)

Returns whether the current build uses maven.

Parameters:

build - the current build

Returns:

true if the current build uses maven, false otherwise

isAntBuild

protected boolean isAntBuild(hudson.model.AbstractBuild<?,?> build)

Returns whether the current build uses ant.

Parameters:

build - the current build

Returns:

true if the current build uses ant, false otherwise

getMinimumPriority

public Priority getMinimumPriority()

Returns the minimum priority that should be considered when computing build health and stability. E.g., if Priority.NORMAL is returned, then annotations with priority Priority.LOW are ignored.

Specified by:

getMinimumPriority in interface HealthDescriptor

Returns:

the minimum priority to consider

getThresholdLimit

public java.lang.String getThresholdLimit()

Returns the threshold limit.

Returns:

the threshold limit