hudson.maven
Class MavenBuild

java.lang.Object
  hudson.model.AbstractModelObject
      hudson.model.Actionable
          hudson.model.Run<P,R>
              hudson.model.AbstractBuild<P,B>
                  hudson.maven.AbstractMavenBuild<MavenModule,MavenBuild>
                      hudson.maven.MavenBuild

All Implemented Interfaces:

ExtensionPoint, DescriptorByNameOwner, ModelObject, PersistenceRoot, Queue.Executable, Saveable, SearchableModelObject, SearchItem, AccessControlled, Comparable<MavenBuild>, Runnable, ModelObjectWithContextMenu, OnMaster

public class MavenBuild
extends AbstractMavenBuild<MavenModule,MavenBuild>

Run for MavenModule.

Author:

Kohsuke Kawaguchi

Nested Class Summary

class

MavenBuild.ProxyImpl2

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.Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.MenuItem

Field Summary

static boolean	debug Set true to produce debug output.
protected static ProcessCache	mavenProcessCache

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, ID_FORMATTER, LIST_CUTOFF, number, ORDER_BY_DATE, PERMISSIONS, project, result, state, timestamp, TREE_CUTOFF, UPDATE, XSTREAM, XSTREAM2

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

MavenBuild(MavenModule job)

MavenBuild(MavenModule job, Calendar timestamp)

MavenBuild(MavenModule project, File buildDir)

Method Summary

static ExecutedMojo.Cache	createExecutedMojoCache()
ChangeLogSet<? extends ChangeLogSet.Entry>	getChangeSet() Gets the changes incorporated into this build.
String	getDisplayName()
EnvVars	getEnvironment(TaskListener log) Exposes MAVEN_OPTS to forked processes.
List<ExecutedMojo>	getExecutedMojos()
MavenArtifactRecord	getMavenArtifacts() Information about artifacts produced by Maven.
String	getMavenOpts(TaskListener listener, EnvVars envVars) Obtains the fully resolved MAVEN_OPTS with all the tokens and variables expanded.
MavenModuleSetBuild	getModuleSetBuild() Gets the "governing" MavenModuleSet that has set the workspace for this build.
MavenModule	getParent() The project this build is for.
MavenModuleSetBuild	getParentBuild() Gets the MavenModuleSetBuild that has the same build number.
List<MavenProjectActionBuilder>	getProjectActionBuilders()
AbstractBuild<?,?>	getRootBuild() The same as getParentBuild().
String	getUpUrl() Used to render the side panel "Back to project" link.
String	getWhyKeepLog() If the parent MavenModuleSetBuild is kept, keep this record, too.
boolean	hasChangeSetComputed() We always get the changeset from MavenModuleSetBuild.
void	registerAsProjectAction(MavenProjectActionBuilder builder)
void	registerAsProjectAction(MavenReporter reporter)
void	run() Invoked by Executor to performs a build.
protected void	setBuiltOnStr(String builtOn) Allows subtypes to set the value of AbstractBuild.builtOn.
protected void	setWorkspace(FilePath path) Backdoor for MavenModuleSetBuild to assign workspaces for modules.

Methods inherited from class hudson.maven.AbstractMavenBuild

expandTokens

Methods inherited from class hudson.model.AbstractBuild

doStop, doStop, due, getAggregatedTestResultAction, getBuildFingerprints, getBuildVariableResolver, getBuildVariables, getBuiltOn, getBuiltOnStr, getCulprits, getDependencyChanges, getDownstreamBuilds, getDownstreamBuilds, getDownstreamRelationship, getEnvironments, getHudsonVersion, getModuleRoot, getModuleRoots, getNextBuild, getPersistentActions, getPreviousBuild, getProject, getSensitiveBuildVariables, getTestResultAction, getTransitiveUpstreamBuilds, getUpstreamBuilds, getUpstreamRelationship, getUpstreamRelationshipBuild, getWorkspace, hasParticipant

Methods inherited from class hudson.model.Run

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

Methods inherited from class hudson.model.Actionable

doContextMenu, getAction, getAction, getActions, getActions

Methods inherited from class hudson.model.AbstractModelObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Queue.Executable

getEstimatedDuration, toString

Field Detail

mavenProcessCache

protected static final ProcessCache mavenProcessCache

debug

public static boolean debug

Set true to produce debug output.

Constructor Detail

MavenBuild

public MavenBuild(MavenModule job)
           throws IOException

Throws:

IOException

MavenBuild

public MavenBuild(MavenModule job,
                  Calendar timestamp)

MavenBuild

public MavenBuild(MavenModule project,
                  File buildDir)
           throws IOException

Throws:

IOException

Method Detail

getUpUrl

public String getUpUrl()

Description copied from class: AbstractBuild

Used to render the side panel "Back to project" link.

In a rare situation where a build can be reached from multiple paths, returning different URLs from this method based on situations might be desirable.

If you override this method, you'll most likely also want to override Run.getDisplayName().

Overrides:

getUpUrl in class AbstractBuild<MavenModule,MavenBuild>

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class Run<MavenModule,MavenBuild>

getParentBuild

@CheckForNull
public MavenModuleSetBuild getParentBuild()

Gets the MavenModuleSetBuild that has the same build number.

Returns:

null if no such build exists, which happens when the module build is manually triggered.

See Also:

getModuleSetBuild()

getRootBuild

public AbstractBuild<?,?> getRootBuild()

The same as getParentBuild().

Overrides:

getRootBuild in class AbstractBuild<MavenModule,MavenBuild>

Returns:

never null. In the worst case the build dominates itself.

See Also:

AbstractProject.getRootProject()

getModuleSetBuild

@CheckForNull
public MavenModuleSetBuild getModuleSetBuild()

Gets the "governing" MavenModuleSet that has set the workspace for this build.

Returns:

null if no such build exists, which happens if the build is manually removed.

See Also:

getParentBuild()

getChangeSet

public ChangeLogSet<? extends ChangeLogSet.Entry> getChangeSet()

Description copied from class: AbstractBuild

Gets the changes incorporated into this build.

Overrides:

getChangeSet in class AbstractBuild<MavenModule,MavenBuild>

Returns:

never null.

hasChangeSetComputed

public boolean hasChangeSetComputed()

We always get the changeset from MavenModuleSetBuild.

Overrides:

hasChangeSetComputed in class AbstractBuild<MavenModule,MavenBuild>

getMavenArtifacts

@Exported
public MavenArtifactRecord getMavenArtifacts()

Information about artifacts produced by Maven.

getEnvironment

public EnvVars getEnvironment(TaskListener log)
                       throws IOException,
                              InterruptedException

Exposes MAVEN_OPTS to forked processes.

See MavenModuleSetBuild.getEnvironment(TaskListener) for discussion.

Overrides:

getEnvironment in class AbstractMavenBuild<MavenModule,MavenBuild>

Returns:

the map with the environmental variables. Never null.

Throws:

IOException

InterruptedException

registerAsProjectAction

public void registerAsProjectAction(MavenReporter reporter)

registerAsProjectAction

public void registerAsProjectAction(MavenProjectActionBuilder builder)

getProjectActionBuilders

public List<MavenProjectActionBuilder> getProjectActionBuilders()

getExecutedMojos

public List<ExecutedMojo> getExecutedMojos()

run

public void run()

Description copied from class: AbstractBuild

Invoked by Executor to performs a build.

Specified by:

run in interface Queue.Executable

Specified by:

run in interface Runnable

Specified by:

run in class AbstractBuild<MavenModule,MavenBuild>

getWhyKeepLog

public String getWhyKeepLog()

If the parent MavenModuleSetBuild is kept, keep this record, too.

Overrides:

getWhyKeepLog in class AbstractBuild<MavenModule,MavenBuild>

createExecutedMojoCache

public static ExecutedMojo.Cache createExecutedMojoCache()

setWorkspace

protected void setWorkspace(FilePath path)

Backdoor for MavenModuleSetBuild to assign workspaces for modules.

Overrides:

setWorkspace in class AbstractBuild<MavenModule,MavenBuild>

getParent

public MavenModule getParent()

Description copied from class: Run

The project this build is for.

Specified by:

getParent in interface Queue.Executable

Overrides:

getParent in class Run<MavenModule,MavenBuild>

setBuiltOnStr

protected void setBuiltOnStr(String builtOn)

Description copied from class: AbstractBuild

Allows subtypes to set the value of AbstractBuild.builtOn. This is used for those implementations where an AbstractBuild is made 'built' without actually running its AbstractBuild.run() method.

Overrides:

setBuiltOnStr in class AbstractBuild<MavenModule,MavenBuild>

getMavenOpts

public String getMavenOpts(TaskListener listener,
                           EnvVars envVars)

Description copied from class: AbstractMavenBuild

Obtains the fully resolved MAVEN_OPTS with all the tokens and variables expanded.

Specified by:

getMavenOpts in class AbstractMavenBuild<MavenModule,MavenBuild>

envVars - Caller must pass in the environment variables obtained from AbstractMavenBuild.getEnvironment(TaskListener) This method takes this as a parameter as opposed to recomputing it since the caller always have this handy.

See Also:

MavenModuleSet.getMavenOpts()