Package hudson.maven

Class MavenBuild.ProxyImpl2

java.lang.Object

hudson.maven.MavenBuild.ProxyImpl2

All Implemented Interfaces:

MavenBuildProxy, MavenBuildProxy2, Serializable

Enclosing class:

MavenBuild

public class MavenBuild.ProxyImpl2
extends Object
implements MavenBuildProxy2

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.maven.MavenBuildProxy

MavenBuildProxy.BuildCallable<V,T extends Throwable>, MavenBuildProxy.Filter<CORE extends MavenBuildProxy>

Nested classes/interfaces inherited from interface hudson.maven.MavenBuildProxy2

MavenBuildProxy2.Filter<CORE extends MavenBuildProxy2>

Method Summary

Modifier and Type	Method	Description
void	appendLastLog()	Sends the accumulated log in SplittableBuildListener to the log of this build.
protected void	close()	Performs final clean up.
void	end()	Notifies that the build has left a module.
<V,T extends Throwable> V	execute(MavenBuildProxy.BuildCallable<V,T> program)	Executes the given MavenBuildProxy.BuildCallable on the controller, where one has access to MavenBuild and all the other Hudson objects.
void	executeAsync(MavenBuildProxy.BuildCallable<?,?> program)	Deprecated. This helps IDE find coding mistakes when someone tries to call this method.
FilePath	getArtifactsDir()	Deprecated. Does not work with ArtifactManager.
MavenBuildInformation	getMavenBuildInformation()
long	getMilliSecsSinceBuildStart()	# of milliseconds elapsed since MavenBuildProxy.getTimestamp().
FilePath	getModuleSetRootDir()	Root directory of the owner MavenModuleSet
FilePath	getProjectRootDir()	Root directory of the parent of this build.
FilePath	getRootDir()	Root directory of the build.
Calendar	getTimestamp()
boolean	isArchivingDisabled()	If true, artifacts will not actually be archived to controller.
boolean	isSiteArchivingDisabled()	If true, artifacts will not actually be archived to controller during site deploy.
MavenBuild	owner()	Gets the build for which this proxy is created.
void	queueArchiving(String artifactPath, String artifact)
void	registerAsAggregatedProjectAction(MavenReporter reporter)	Nominates that the reporter will contribute a project action for this build by using MavenReporter.getAggregatedProjectAction(MavenModuleSet).
void	registerAsProjectAction(MavenProjectActionBuilder builder)	Nominates that the reporter will contribute a project action for this build by using MavenReporter.getProjectActions(MavenModule).
void	registerAsProjectAction(MavenReporter reporter)	Nominates that the reporter will contribute a project action for this build by using MavenReporter.getProjectActions(MavenModule).
protected void	setBlockBuildEvents(boolean blockBuildEvents)
void	setExecutedMojos(List<ExecutedMojo> executedMojos)	Called at the end of the build to record what mojos are executed.
void	setResult(Result result)
void	start()	Notifies that the build has entered a module.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.maven.MavenBuildProxy

execute, executeAsync, getArtifactsDir, getMavenBuildInformation, getMilliSecsSinceBuildStart, getModuleSetRootDir, getProjectRootDir, getRootDir, getTimestamp, isArchivingDisabled, isSiteArchivingDisabled, queueArchiving, registerAsAggregatedProjectAction, registerAsProjectAction, registerAsProjectAction, setExecutedMojos, setResult

Method Detail

start

public void start()

Description copied from interface: MavenBuildProxy2

Notifies that the build has entered a module. Jenkins has a somewhat simplified view of the sequence of events in a Maven build. Namely, a Maven build can be building a particular Maven module, and start and end marks that boundary. Note that Maven can be in a state that it's not building any module, for example when executing an aggregator mojo, and start/end cannot be nested (which right now means a forked lifecycle doesn't result in the event firing.)

Specified by:

start in interface MavenBuildProxy2

end

public void end()

Description copied from interface: MavenBuildProxy2

Notifies that the build has left a module.

Specified by:

end in interface MavenBuildProxy2

appendLastLog

public void appendLastLog()

Sends the accumulated log in SplittableBuildListener to the log of this build.

Specified by:

appendLastLog in interface MavenBuildProxy2

close

protected void close()

Performs final clean up. Invoked after the entire aggregator build is completed.

owner

public MavenBuild owner()

Gets the build for which this proxy is created.

setBlockBuildEvents

protected void setBlockBuildEvents(boolean blockBuildEvents)

execute

public <V,T extends Throwable> V execute(MavenBuildProxy.BuildCallable<V,T> program)
                                        throws T extends Throwable,
                                               IOException,
                                               InterruptedException

Description copied from interface: MavenBuildProxy

Executes the given MavenBuildProxy.BuildCallable on the controller, where one has access to MavenBuild and all the other Hudson objects.

The parameter, return value, and exception are all transfered by using Java serialization.

Specified by:

execute in interface MavenBuildProxy

Returns:

the value that MavenBuildProxy.BuildCallable returned.

Throws:

T - if MavenBuildProxy.BuildCallable throws this exception.

IOException - if the remoting failed.

InterruptedException - if the remote execution is aborted.

T extends Throwable

See Also:

MavenBuildProxy.executeAsync(BuildCallable)

executeAsync

public final void executeAsync(MavenBuildProxy.BuildCallable<?,?> program)
                        throws IOException

Deprecated.

This helps IDE find coding mistakes when someone tries to call this method.

This method is implemented by the remote proxy before the invocation gets to this. So correct code shouldn't be invoking this method on the controller ever.

Specified by:

executeAsync in interface MavenBuildProxy

Throws:

IOException

getRootDir

public FilePath getRootDir()

Description copied from interface: MavenBuildProxy

Root directory of the build.

Specified by:

getRootDir in interface MavenBuildProxy

See Also:

Run.getRootDir(), MavenReporterDescriptor.reportedFilePattern()

getProjectRootDir

public FilePath getProjectRootDir()

Description copied from interface: MavenBuildProxy

Root directory of the parent of this build.

Specified by:

getProjectRootDir in interface MavenBuildProxy

See Also:

MavenReporterDescriptor.reportedFilePattern()

getModuleSetRootDir

public FilePath getModuleSetRootDir()

Description copied from interface: MavenBuildProxy

Root directory of the owner MavenModuleSet

Specified by:

getModuleSetRootDir in interface MavenBuildProxy

See Also:

MavenReporterDescriptor.reportedFilePattern()

getArtifactsDir

@Deprecated
public FilePath getArtifactsDir()

Deprecated.

Does not work with ArtifactManager.

Specified by:

getArtifactsDir in interface MavenBuildProxy

queueArchiving

public void queueArchiving(String artifactPath,
                           String artifact)

Specified by:

queueArchiving in interface MavenBuildProxy

Parameters:

artifactPath - a relative /-separated path

artifact - absolute path name on the agent in the workspace

See Also:

ArtifactManager.archive(hudson.FilePath, hudson.Launcher, hudson.model.BuildListener, java.util.Map<java.lang.String, java.lang.String>)

setResult

public void setResult(Result result)

Specified by:

setResult in interface MavenBuildProxy

See Also:

Run.setResult(Result)

getTimestamp

public Calendar getTimestamp()

Specified by:

getTimestamp in interface MavenBuildProxy

See Also:

Run.getTimestamp()

getMilliSecsSinceBuildStart

public long getMilliSecsSinceBuildStart()

Description copied from interface: MavenBuildProxy

# of milliseconds elapsed since MavenBuildProxy.getTimestamp(). Where the clock skew is involved between the controller and the Maven JVM, comparing current time on Maven JVM with MavenBuildProxy.getTimestamp() could be problematic, but this value is more robust.

Specified by:

getMilliSecsSinceBuildStart in interface MavenBuildProxy

isArchivingDisabled

public boolean isArchivingDisabled()

Description copied from interface: MavenBuildProxy

If true, artifacts will not actually be archived to controller. Calls MavenModuleSet.isArchivingDisabled().

Specified by:

isArchivingDisabled in interface MavenBuildProxy

isSiteArchivingDisabled

public boolean isSiteArchivingDisabled()

Description copied from interface: MavenBuildProxy

If true, artifacts will not actually be archived to controller during site deploy. Calls MavenModuleSet.isSiteArchivingDisabled().

Specified by:

isSiteArchivingDisabled in interface MavenBuildProxy

registerAsProjectAction

public void registerAsProjectAction(MavenReporter reporter)

Description copied from interface: MavenBuildProxy

Nominates that the reporter will contribute a project action for this build by using MavenReporter.getProjectActions(MavenModule).

The specified MavenReporter object will be transfered to the controller and will become a persisted part of the MavenBuild.

Specified by:

registerAsProjectAction in interface MavenBuildProxy

registerAsProjectAction

public void registerAsProjectAction(MavenProjectActionBuilder builder)

Description copied from interface: MavenBuildProxy

Nominates that the reporter will contribute a project action for this build by using MavenReporter.getProjectActions(MavenModule).

The specified MavenReporter object will be transferred to the controller and will become a persisted part of the MavenBuild.

Specified by:

registerAsProjectAction in interface MavenBuildProxy

registerAsAggregatedProjectAction

public void registerAsAggregatedProjectAction(MavenReporter reporter)

Description copied from interface: MavenBuildProxy

Nominates that the reporter will contribute a project action for this build by using MavenReporter.getAggregatedProjectAction(MavenModuleSet).

The specified MavenReporter object will be transfered to the controller and will become a persisted part of the MavenModuleSetBuild.

Specified by:

registerAsAggregatedProjectAction in interface MavenBuildProxy

setExecutedMojos

public void setExecutedMojos(List<ExecutedMojo> executedMojos)

Description copied from interface: MavenBuildProxy

Called at the end of the build to record what mojos are executed.

Specified by:

setExecutedMojos in interface MavenBuildProxy

getMavenBuildInformation

public MavenBuildInformation getMavenBuildInformation()

Specified by:

getMavenBuildInformation in interface MavenBuildProxy