Package hudson.plugins.promoted_builds

Class Promotion

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.Run<P,R>

hudson.model.AbstractBuild<PromotionProcess,Promotion>

hudson.plugins.promoted_builds.Promotion

All Implemented Interfaces:

ExtensionPoint, DescriptorByNameOwner, ModelObject, PersistenceRoot, Queue.Executable, Saveable, SearchableModelObject, SearchItem, AccessControlled, Comparable<Promotion>, Runnable, WithConsoleUrl, HistoricalBuild, LazyBuildMixIn.LazyLoadingRun<PromotionProcess,Promotion>, ModelObjectWithContextMenu, RunWithSCM<PromotionProcess,Promotion>, OnMaster, org.kohsuke.stapler.StaplerProxy

public class Promotion
extends AbstractBuild<PromotionProcess,Promotion>

Records a promotion process.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Promotion.PromotionParametersAction	Action, which stores promotion parameters.
protected class	Promotion.RunnerImpl

Nested classes/interfaces inherited from class hudson.model.AbstractBuild

AbstractBuild.AbstractBuildExecution, AbstractBuild.AbstractRunner, AbstractBuild.DependencyChange

Nested classes/interfaces inherited from class hudson.model.Run

Run.Artifact, Run.ArtifactList, Run.KeepLogBuildBadge, Run.RedirectUp, Run.RunExecution, Run.Runner, Run.RunnerAbortedException, Run.StatusSummarizer, Run.Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields

Modifier and Type	Field	Description
static final PermissionGroup	PERMISSIONS
static final Permission	PROMOTE

Fields inherited from class hudson.model.AbstractBuild

buildEnvironments

Fields inherited from class hudson.model.Run

ARTIFACTS, charset, DELETE, description, duration, FEED_ADAPTER, FEED_ADAPTER_LATEST, LIST_CUTOFF, nextBuild, number, ORDER_BY_DATE, previousBuild, project, QUEUE_ID_UNKNOWN, result, SKIP_PERMISSION_CHECK, timestamp, UPDATE, XSTREAM, XSTREAM2

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
Promotion(PromotionProcess job)
Promotion(PromotionProcess project, File buildDir)
Promotion(PromotionProcess job, Calendar timestamp)

Method Summary

Modifier and Type	Method	Description
static void	buildParametersAction(List<Action> actions, AbstractBuild<?,?> build, List<ParameterValue> promotionParams)	Deprecated. Use Promotion.PromotionParametersAction with constructor instead.
static ParametersAction	createParametersAction(List<ParameterValue> parameters)	Factory method for creating ParametersAction
void	doRebuild(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
boolean	equals(Object obj)
EnvVars	getEnvironment(TaskListener listener)
List<ParameterDefinition>	getParameterDefinitionsWithValue()	Gets parameter definitions from the ManualCondition.
static ParametersAction	getParametersActions(Promotion build)
List<ParameterValue>	getParameterValues()
AbstractBuild<?,?>	getRootBuild()
Status	getStatus()	Gets the Status object that keeps track of what Promotions are performed for a build, including this Promotion.
AbstractBuild<?,?>	getTargetBuild()	Gets the build that this promotion promoted.
AbstractBuild<?,?>	getTargetBuildOrFail()	Gets the build that this promotion promoted.
String	getUrl()
String	getUserId()	Gets ID of the User, who triggered the promotion.
String	getUserName()	Get a user name of the person, who triggered the promotion.
int	hashCode()
static void	registerPermissions()
void	run()

Methods inherited from class hudson.model.AbstractBuild

addAction, calculateCulprits, createReference, doStop, doStop, dropLinks, due, getAggregatedTestResultAction, getBuildVariableResolver, getBuildVariables, getBuiltOn, getBuiltOnStr, getChangeSet, getChangeSets, getCulpritIds, getCulprits, getDependencyChanges, getDownstreamBuilds, getDownstreamBuilds, getDownstreamRelationship, getEnvironments, getHudsonVersion, getModuleRoot, getModuleRoots, getNextBuild, getParentExecutable, getPersistentActions, getPreviousBuild, getProject, getRunMixIn, getSensitiveBuildVariables, getTestResultAction, getTransitiveUpstreamBuilds, getUpstreamBuilds, getUpstreamRelationship, getUpstreamRelationshipBuild, getUpUrl, getWhyKeepLog, getWorkspace, hasChangeSetComputed, setBuiltOnStr, setWorkspace, shouldCalculateCulprits

Methods inherited from class hudson.model.Run

_this, canToggleLogKeep, compareTo, delete, deleteArtifacts, doArtifact, doBuildNumber, doBuildStatus, doBuildTimestamp, doConfigSubmit, doConsoleText, doConsoleText, doDoDelete, doDoDelete, doProgressiveLog, doSubmitDescription, doToggleLogKeep, execute, fromExternalizableId, getAbsoluteUrl, getACL, getApi, getArtifactManager, getArtifacts, getArtifactsDir, getArtifactsUpTo, getBadgeActions, getBuildFingerprints, getBuildsOverThreshold, getBuildStatusSummary, getCause, getCauses, getCharacteristicEnvVars, getCharset, getConsoleUrl, getDescription, getDisplayName, getDuration, getDurationString, getDynamic, getDynamic, getEnvironment, getEnvVars, getEstimatedDuration, getExecutor, getExternalizableId, getFullDisplayName, getHasArtifacts, getIconColor, getId, getLog, getLog, getLogFile, getLogInputStream, getLogReader, getLogText, getNumber, getOneOffExecutor, getParent, getPreviousBuildInProgress, getPreviousBuildsOverThreshold, getPreviousBuiltBuild, getPreviousCompletedBuild, getPreviousFailedBuild, getPreviousNotFailedBuild, getPreviousSuccessfulBuild, getQueueId, getResult, getRootDir, getSearchUrl, getStartTimeInMillis, getTarget, getTime, getTimeInMillis, getTimestamp, getTimestampString, getTimestampString2, getTransientActions, hasCustomDisplayName, hasntStartedYet, isBuilding, isInProgress, isKeepLog, isLogUpdated, keepLog, keepLog, makeSearchIndex, onEndBuilding, onLoad, onStartBuilding, pickArtifactManager, reload, run, save, setDescription, setDisplayName, setQueueId, setResult, submit, toString, updateSymlinks, writeLogTo, writeReplace, writeWholeLogTo

Methods inherited from class hudson.model.Actionable

addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface jenkins.model.HistoricalBuild

getBuildStatusIconClassName, getBuildStatusUrl, getTruncatedDescription

Methods inherited from interface hudson.model.Queue.Executable

getConsoleUrl, getEstimatedDuration, getParent, toString

Methods inherited from interface jenkins.scm.RunWithSCM

hasParticipant

Field Details

PERMISSIONS

public static final PermissionGroup PERMISSIONS

PROMOTE

public static final Permission PROMOTE

Constructor Details

Promotion

public Promotion(PromotionProcess job)
          throws IOException

Throws:

IOException

Promotion

public Promotion(PromotionProcess job,
 Calendar timestamp)

Promotion

public Promotion(PromotionProcess project,
 File buildDir)
          throws IOException

Throws:

IOException

Method Details

getTargetBuild

@CheckForNull
public AbstractBuild<?,?> getTargetBuild()

Gets the build that this promotion promoted.

Returns:

null if there's no such object. For example, if the build has already garbage collected.

Since:

3.4

getTargetBuildOrFail

@NonNull
public AbstractBuild<?,?> getTargetBuildOrFail()

Gets the build that this promotion promoted.

Returns:

Target build

Throws:

IllegalStateException - There is no target build

Since:

3.5

getRootBuild

public AbstractBuild<?,?> getRootBuild()

Overrides:

getRootBuild in class AbstractBuild<PromotionProcess,Promotion>

getUrl

public String getUrl()

Specified by:

getUrl in interface HistoricalBuild

Overrides:

getUrl in class Run<PromotionProcess,Promotion>

getStatus

public Status getStatus()

Gets the Status object that keeps track of what Promotions are performed for a build, including this Promotion.

getEnvironment

public EnvVars getEnvironment(TaskListener listener)
                       throws IOException,
InterruptedException

Overrides:

getEnvironment in class AbstractBuild<PromotionProcess,Promotion>

Throws:

IOException

InterruptedException

getUserName

@NonNull
public String getUserName()

Get a user name of the person, who triggered the promotion. The method tries various sources like Cause.UserIdCause or ManualCondition.Badge.

Returns:

user's name who triggered the promotion, or 'anonymous' if the search fails

getUserId

@NonNull
public String getUserId()

Gets ID of the User, who triggered the promotion. The method tries various sources like Cause.UserIdCause or ManualCondition.Badge.

Returns:

ID of the user who triggered the promotion. If the search fails, returns ID of User.getUnknown().

Since:

2.22

getParameterValues

public List<ParameterValue> getParameterValues()

Specified by:

getParameterValues in interface HistoricalBuild

Overrides:

getParameterValues in class Run<PromotionProcess,Promotion>

getParameterDefinitionsWithValue

@NonNull
public List<ParameterDefinition> getParameterDefinitionsWithValue()

Gets parameter definitions from the ManualCondition.

Returns:

List of parameter definitions to be presented. May be empty if there is no ManualCondition.

doRebuild

public void doRebuild(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
               throws IOException

Throws:

IOException

run

public void run()

Specified by:

run in interface Queue.Executable

Specified by:

run in interface Runnable

Specified by:

run in class AbstractBuild<PromotionProcess,Promotion>

registerPermissions

@Initializer(before=SYSTEM_CONFIG_LOADED)
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public static void registerPermissions()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

createParametersAction

public static ParametersAction createParametersAction(List<ParameterValue> parameters)

Factory method for creating ParametersAction

Parameters:

parameters -

Returns:

getParametersActions

public static ParametersAction getParametersActions(Promotion build)

buildParametersAction

@Deprecated
public static void buildParametersAction(@NonNull
 List<Action> actions,
 @NonNull
 AbstractBuild<?,?> build,
 @CheckForNull
 List<ParameterValue> promotionParams)

Deprecated.

Use Promotion.PromotionParametersAction with constructor instead.

Combine the target build parameters with the promotion build parameters

Parameters:

actions -

build -

promotionParams -