Package hudson.plugins.build_timeout

Class BuildTimeoutWrapper

java.lang.Object

hudson.tasks.BuildWrapper

hudson.plugins.build_timeout.BuildTimeoutWrapper

All Implemented Interfaces:

ExtensionPoint, Describable<BuildWrapper>

public class BuildTimeoutWrapper
extends BuildWrapper

BuildWrapper that terminates a build if it's taking too long.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BuildTimeoutWrapper.DescriptorImpl
class	BuildTimeoutWrapper.EnvironmentImpl

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

BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final BuildTimeoutWrapper.DescriptorImpl	DESCRIPTOR
boolean	failBuild	Deprecated. use FailOperation instead.
static long	MINIMUM_TIMEOUT_MILLISECONDS
int	timeoutMinutes
Integer	timeoutMinutesElasticDefault
int	timeoutPercentage
String	timeoutType
boolean	writingDescription	Deprecated. use WriteDescriptionOperation instead.

Constructor Summary

Constructors

Constructor	Description
BuildTimeoutWrapper(BuildTimeOutStrategy strategy, boolean failBuild, boolean writingDescription)	Deprecated.
BuildTimeoutWrapper(BuildTimeOutStrategy strategy, List<BuildTimeOutOperation> operationList)	Deprecated.
BuildTimeoutWrapper(BuildTimeOutStrategy strategy, List<BuildTimeOutOperation> operationList, String timeoutEnvVar)	ctor.

Method Summary

Modifier and Type	Method	Description
OutputStream	decorateLogger(AbstractBuild build, OutputStream logger)
Descriptor<BuildWrapper>	getDescriptor()
List<BuildTimeOutOperation>	getOperationList()
BuildTimeOutStrategy	getStrategy()
String	getTimeoutEnvVar()
protected Object	readResolve()
BuildWrapper.Environment	setUp(AbstractBuild build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.tasks.BuildWrapper

all, decorateLauncher, getProjectAction, getProjectActions, makeBuildVariables, makeSensitiveBuildVariables, preCheckout, setUp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MINIMUM_TIMEOUT_MILLISECONDS

public static long MINIMUM_TIMEOUT_MILLISECONDS

failBuild

@Deprecated
public transient boolean failBuild

Deprecated.

use FailOperation instead.

Fail the build rather than aborting it

writingDescription

@Deprecated
public transient boolean writingDescription

Deprecated.

use WriteDescriptionOperation instead.

Writing the build description when timeout occurred.

DESCRIPTOR

@Extension
public static final BuildTimeoutWrapper.DescriptorImpl DESCRIPTOR

timeoutMinutes

public transient int timeoutMinutes

timeoutPercentage

public transient int timeoutPercentage

timeoutType

public transient String timeoutType

timeoutMinutesElasticDefault

public transient Integer timeoutMinutesElasticDefault

Constructor Details

BuildTimeoutWrapper

@Deprecated
public BuildTimeoutWrapper(BuildTimeOutStrategy strategy,
 boolean failBuild,
 boolean writingDescription)

Deprecated.

BuildTimeoutWrapper

@Deprecated
public BuildTimeoutWrapper(BuildTimeOutStrategy strategy,
 List<BuildTimeOutOperation> operationList)

Deprecated.

BuildTimeoutWrapper

@DataBoundConstructor
public BuildTimeoutWrapper(BuildTimeOutStrategy strategy,
 List<BuildTimeOutOperation> operationList,
 String timeoutEnvVar)

ctor. Don't forget to update BuildTimeoutWrapper.DescriptorImpl.newInstance(StaplerRequest2, JSONObject) when you add new arguments.

Method Details

getOperationList

public List<BuildTimeOutOperation> getOperationList()

Returns:

operations to perform at timeout.

setUp

public BuildWrapper.Environment setUp(AbstractBuild build,
 Launcher launcher,
 BuildListener listener)
                               throws IOException,
InterruptedException

Overrides:

setUp in class BuildWrapper

Throws:

IOException

InterruptedException

readResolve

protected Object readResolve()

getDescriptor

public Descriptor<BuildWrapper> getDescriptor()

getStrategy

public BuildTimeOutStrategy getStrategy()

getTimeoutEnvVar

public String getTimeoutEnvVar()

decorateLogger

public OutputStream decorateLogger(AbstractBuild build,
 OutputStream logger)
                            throws IOException,
InterruptedException,
Run.RunnerAbortedException

Overrides:

decorateLogger in class BuildWrapper

Throws:

IOException

InterruptedException

Run.RunnerAbortedException