Package hudson.plugins.release

Class ReleaseWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<BuildWrapper>

hudson.tasks.BuildWrapper

hudson.plugins.release.ReleaseWrapper

All Implemented Interfaces:

ExtensionPoint, hudson.matrix.MatrixAggregatable, Describable<BuildWrapper>

public class ReleaseWrapper
extends BuildWrapper
implements hudson.matrix.MatrixAggregatable

Wraps a build with pre and post build steps. These steps can take any action as part of the special release build.

Since:

1.0

Author:

Peter Hayes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReleaseWrapper.DescriptorImpl
class	ReleaseWrapper.ReleaseAction
static class	ReleaseWrapper.ReleaseAggregator	Aggregates releases in matrix projects.
static class	ReleaseWrapper.ReleaseBuildBadgeAction

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 PermissionGroup	PERMISSIONS
static List<PermalinkProjectAction.Permalink>	RELEASE	List of PermalinkProjectAction.Permalinks for release builds.
static Permission	RELEASE_PERMISSION	Permission to trigger release builds.

Constructor Summary

Constructors

Constructor	Description
ReleaseWrapper()

Method Summary

Modifier and Type	Method	Description
static void	checkReleasePermission(AbstractProject job)
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, Launcher launcher, BuildListener listener)
List<ParameterDefinition>	getParameterDefinitions()
List<BuildStep>	getPostBuildSteps()
List<BuildStep>	getPostFailedBuildSteps()
List<BuildStep>	getPostFailedMatrixBuildSteps()
List<BuildStep>	getPostMatrixBuildSteps()
List<BuildStep>	getPostSuccessfulBuildSteps()
List<BuildStep>	getPostSuccessfulMatrixBuildSteps()
List<BuildStep>	getPreBuildSteps()
List<BuildStep>	getPreMatrixBuildSteps()
Collection<? extends Action>	getProjectActions(AbstractProject job)
String	getReleaseVersionTemplate()
static boolean	hasReleasePermission(AbstractProject job)
boolean	isDoNotKeepLog()
boolean	isOverrideBuildParameters()
void	setDoNotKeepLog(boolean doNotKeepLog)
void	setOverrideBuildParameters(boolean overrideBuildParameters)
void	setParameterDefinitions(List<ParameterDefinition> parameterDefinitions)
void	setPostBuildSteps(List<BuildStep> postSuccessBuildSteps)
void	setPostFailedBuildSteps(List<BuildStep> postFailedBuildSteps)
void	setPostFailedMatrixBuildSteps(List<BuildStep> postFailedMatrixBuildSteps)
void	setPostMatrixBuildSteps(List<BuildStep> postMatrixBuildSteps)
void	setPostSuccessfulBuildSteps(List<BuildStep> postSuccessfulBuildSteps)
void	setPostSuccessfulMatrixBuildSteps(List<BuildStep> postSuccessfulMatrixBuildSteps)
void	setPreBuildSteps(List<BuildStep> preBuildSteps)
void	setPreMatrixBuildSteps(List<BuildStep> preMatrixBuildSteps)
void	setReleaseVersionTemplate(String releaseVersionTemplate)
BuildWrapper.Environment	setUp(AbstractBuild build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.tasks.BuildWrapper

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

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSIONS

public static final PermissionGroup PERMISSIONS

RELEASE_PERMISSION

public static final Permission RELEASE_PERMISSION

Permission to trigger release builds.

RELEASE

public static final List<PermalinkProjectAction.Permalink> RELEASE

List of PermalinkProjectAction.Permalinks for release builds.

Constructor Detail

ReleaseWrapper

public ReleaseWrapper()

Method Detail

getReleaseVersionTemplate

public String getReleaseVersionTemplate()

setReleaseVersionTemplate

public void setReleaseVersionTemplate(String releaseVersionTemplate)

isDoNotKeepLog

public boolean isDoNotKeepLog()

setDoNotKeepLog

public void setDoNotKeepLog(boolean doNotKeepLog)

isOverrideBuildParameters

public boolean isOverrideBuildParameters()

setOverrideBuildParameters

public void setOverrideBuildParameters(boolean overrideBuildParameters)

getParameterDefinitions

public List<ParameterDefinition> getParameterDefinitions()

setParameterDefinitions

public void setParameterDefinitions(List<ParameterDefinition> parameterDefinitions)

getPreBuildSteps

public List<BuildStep> getPreBuildSteps()

Returns:

Returns the preBuildSteps.

setPreBuildSteps

public void setPreBuildSteps(List<BuildStep> preBuildSteps)

Parameters:

preBuildSteps - The preBuildSteps to set.

getPreMatrixBuildSteps

public List<BuildStep> getPreMatrixBuildSteps()

Returns:

Returns the preMatrixBuildSteps.

setPreMatrixBuildSteps

public void setPreMatrixBuildSteps(List<BuildStep> preMatrixBuildSteps)

getPostBuildSteps

public List<BuildStep> getPostBuildSteps()

Returns:

Returns the postBuildSteps.

setPostBuildSteps

public void setPostBuildSteps(List<BuildStep> postSuccessBuildSteps)

getPostMatrixBuildSteps

public List<BuildStep> getPostMatrixBuildSteps()

Returns:

Returns the postMatrixBuildSteps.

setPostMatrixBuildSteps

public void setPostMatrixBuildSteps(List<BuildStep> postMatrixBuildSteps)

Parameters:

postMatrixBuildSteps - The postMatrixBuildSteps to set.

getPostSuccessfulBuildSteps

public List<BuildStep> getPostSuccessfulBuildSteps()

setPostSuccessfulBuildSteps

public void setPostSuccessfulBuildSteps(List<BuildStep> postSuccessfulBuildSteps)

getPostFailedBuildSteps

public List<BuildStep> getPostFailedBuildSteps()

setPostFailedBuildSteps

public void setPostFailedBuildSteps(List<BuildStep> postFailedBuildSteps)

getPostSuccessfulMatrixBuildSteps

public List<BuildStep> getPostSuccessfulMatrixBuildSteps()

setPostSuccessfulMatrixBuildSteps

public void setPostSuccessfulMatrixBuildSteps(List<BuildStep> postSuccessfulMatrixBuildSteps)

getPostFailedMatrixBuildSteps

public List<BuildStep> getPostFailedMatrixBuildSteps()

setPostFailedMatrixBuildSteps

public void setPostFailedMatrixBuildSteps(List<BuildStep> postFailedMatrixBuildSteps)

getProjectActions

public Collection<? extends Action> getProjectActions(AbstractProject job)

Overrides:

getProjectActions in class BuildWrapper

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build,
                                                       Launcher launcher,
                                                       BuildListener listener)

Specified by:

createAggregator in interface hudson.matrix.MatrixAggregatable

setUp

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

Overrides:

setUp in class BuildWrapper

Throws:

IOException

InterruptedException

hasReleasePermission

public static boolean hasReleasePermission(AbstractProject job)

checkReleasePermission

public static void checkReleasePermission(AbstractProject job)