Package org.jvnet.hudson.plugins.m2release

Class M2ReleaseBuildWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<BuildWrapper>

hudson.tasks.BuildWrapper

org.jvnet.hudson.plugins.m2release.M2ReleaseBuildWrapper

All Implemented Interfaces:

ExtensionPoint, Describable<BuildWrapper>

public class M2ReleaseBuildWrapper
extends BuildWrapper

Wraps a MavenBuild to be able to run the maven release plugin on demand, with the ability to auto close a Nexus Pro Staging Repo

Since:

0.1

Version:

0.3

Author:

James Nord, Dominik Bartholdi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	M2ReleaseBuildWrapper.DescriptorImpl

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
boolean	defaultVersioningMode	Deprecated.
int	numberOfReleaseBuildsToKeep
boolean	selectAppendHudsonUsername
boolean	selectCustomScmCommentPrefix
boolean	selectScmCredentials

Constructor Summary

Constructors

Constructor	Description
M2ReleaseBuildWrapper(String releaseGoals, String dryRunGoals, boolean selectCustomScmCommentPrefix, boolean selectAppendHudsonUsername, boolean selectScmCredentials, String releaseEnvVar, String scmUserEnvVar, String scmPasswordEnvVar, int numberOfReleaseBuildsToKeep)

Method Summary

Modifier and Type	Method	Description
static void	checkReleasePermission(AbstractProject job)
M2ReleaseBuildWrapper.DescriptorImpl	getDescriptor()	Jenkins defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object.
String	getDryRunGoals()
int	getNumberOfReleaseBuildsToKeep()
Action	getProjectAction(AbstractProject job)
String	getReleaseEnvVar()
String	getReleaseGoals()
String	getScmPasswordEnvVar()
String	getScmUserEnvVar()
static boolean	hasReleasePermission(AbstractProject job)
boolean	isSelectAppendHudsonUsername()
boolean	isSelectCustomScmCommentPrefix()
void	setNumberOfReleaseBuildsToKeep(int numberOfReleaseBuildsToKeep)
void	setSelectAppendHudsonUsername(boolean selectAppendHudsonUsername)
void	setSelectCustomScmCommentPrefix(boolean selectCustomScmCommentPrefix)
BuildWrapper.Environment	setUp(AbstractBuild build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.tasks.BuildWrapper

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

Methods inherited from class java.lang.Object

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

Field Detail

defaultVersioningMode

@Deprecated
public transient boolean defaultVersioningMode

Deprecated.

For backwards compatibility with older configurations. @deprecated

selectCustomScmCommentPrefix

public boolean selectCustomScmCommentPrefix

selectAppendHudsonUsername

public boolean selectAppendHudsonUsername

selectScmCredentials

public boolean selectScmCredentials

numberOfReleaseBuildsToKeep

public int numberOfReleaseBuildsToKeep

Constructor Detail

M2ReleaseBuildWrapper

@DataBoundConstructor
public M2ReleaseBuildWrapper(String releaseGoals,
                             String dryRunGoals,
                             boolean selectCustomScmCommentPrefix,
                             boolean selectAppendHudsonUsername,
                             boolean selectScmCredentials,
                             String releaseEnvVar,
                             String scmUserEnvVar,
                             String scmPasswordEnvVar,
                             int numberOfReleaseBuildsToKeep)

Method Detail

setUp

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

Overrides:

setUp in class BuildWrapper

Throws:

IOException

InterruptedException

isSelectCustomScmCommentPrefix

public boolean isSelectCustomScmCommentPrefix()

setSelectCustomScmCommentPrefix

public void setSelectCustomScmCommentPrefix(boolean selectCustomScmCommentPrefix)

isSelectAppendHudsonUsername

public boolean isSelectAppendHudsonUsername()

setSelectAppendHudsonUsername

public void setSelectAppendHudsonUsername(boolean selectAppendHudsonUsername)

getNumberOfReleaseBuildsToKeep

public int getNumberOfReleaseBuildsToKeep()

setNumberOfReleaseBuildsToKeep

public void setNumberOfReleaseBuildsToKeep(int numberOfReleaseBuildsToKeep)

hasReleasePermission

public static boolean hasReleasePermission(AbstractProject job)

checkReleasePermission

public static void checkReleasePermission(AbstractProject job)

getReleaseEnvVar

public String getReleaseEnvVar()

getScmUserEnvVar

public String getScmUserEnvVar()

getScmPasswordEnvVar

public String getScmPasswordEnvVar()

getReleaseGoals

public String getReleaseGoals()

getDryRunGoals

public String getDryRunGoals()

getProjectAction

public Action getProjectAction(AbstractProject job)

Overrides:

getProjectAction in class BuildWrapper

getDescriptor

public M2ReleaseBuildWrapper.DescriptorImpl getDescriptor()

Jenkins defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object. Since we know that it's actually M2ReleaseBuildWrapper.DescriptorImpl, override the method and give a better return type, so that we can access M2ReleaseBuildWrapper.DescriptorImpl methods more easily. This is not necessary, but just a coding style preference.

Specified by:

getDescriptor in interface Describable<BuildWrapper>

Overrides:

getDescriptor in class AbstractDescribableImpl<BuildWrapper>