Package hudson.ivy

Interface IvyBuildProxy

All Known Subinterfaces:

IvyBuildProxy2

All Known Implementing Classes:

IvyBuildProxy.Filter, IvyBuildProxy2.Filter

public interface IvyBuildProxy

Remoting proxy interface for IvyReporters to talk to IvyBuild during the build.

Author:

Timothy Bingaman

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IvyBuildProxy.BuildCallable<V,T extends Throwable>
static class	IvyBuildProxy.Filter<CORE extends IvyBuildProxy>	Filter for IvyBuildProxy.

Method Summary

Modifier and Type	Method	Description
<V, T extends Throwable> V	execute(IvyBuildProxy.BuildCallable<V,T> program)	Executes the given IvyBuildProxy.BuildCallable on the master, where one has access to IvyBuild and all the other Jenkins objects.
void	executeAsync(IvyBuildProxy.BuildCallable<?,?> program)	Executes the given IvyBuildProxy.BuildCallable asynchronously on the master.
FilePath	getArtifactsDir()
long	getMilliSecsSinceBuildStart()	# of milliseconds elapsed since getTimestamp().
FilePath	getModuleSetRootDir()	Root directory of the owner IvyModuleSet
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 master.
void	registerAsAggregatedProjectAction(IvyReporter reporter)	Nominates that the reporter will contribute a project action for this build by using IvyReporter.getAggregatedProjectAction(IvyModuleSet).
void	registerAsProjectAction(IvyReporter reporter)	Nominates that the reporter will contribute a project action for this build by using IvyReporter.getProjectAction(IvyModule).
void	setResult(Result result)

Method Details

execute

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

Executes the given IvyBuildProxy.BuildCallable on the master, where one has access to IvyBuild and all the other Jenkins objects.

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

Returns:

the value that IvyBuildProxy.BuildCallable returned.

Throws:

T - if IvyBuildProxy.BuildCallable throws this exception.

IOException - if the remoting failed.

InterruptedException - if the remote execution is aborted.

See Also:

• executeAsync(BuildCallable)

executeAsync

void executeAsync(IvyBuildProxy.BuildCallable<?,?> program)
           throws IOException

Executes the given IvyBuildProxy.BuildCallable asynchronously on the master.

This method works like execute(BuildCallable) except that the method returns immediately and doesn't wait for the completion of the program.

The completions of asynchronous executions are accounted for before the build completes. If they throw exceptions, they'll be reported and the build will be marked as a failure.

Throws:

IOException

getRootDir

FilePath getRootDir()

Root directory of the build.

See Also:

• Run.getRootDir()

getProjectRootDir

FilePath getProjectRootDir()

Root directory of the parent of this build.

getModuleSetRootDir

FilePath getModuleSetRootDir()

Root directory of the owner IvyModuleSet

getArtifactsDir

FilePath getArtifactsDir()

See Also:

• Run.getArtifactsDir()

setResult

void setResult(Result result)

See Also:

• Run.setResult(Result)

getTimestamp

Calendar getTimestamp()

See Also:

• Run.getTimestamp()

getMilliSecsSinceBuildStart

long getMilliSecsSinceBuildStart()

# of milliseconds elapsed since getTimestamp().

Where the clock skew is involved between the master and the Ivy JVM, comparing current time on Ivy JVM with getTimestamp() could be problematic, but this value is more robust.

isArchivingDisabled

boolean isArchivingDisabled()

If true, artifacts will not actually be archived to master. Calls IvyModuleSet.isArchivingDisabled().

registerAsProjectAction

void registerAsProjectAction(IvyReporter reporter)

Nominates that the reporter will contribute a project action for this build by using IvyReporter.getProjectAction(IvyModule).

The specified IvyReporter object will be transferred to the master and will become a persisted part of the IvyBuild.

registerAsAggregatedProjectAction

void registerAsAggregatedProjectAction(IvyReporter reporter)

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

The specified IvyReporter object will be transferred to the master and will become a persisted part of the IvyModuleSetBuild.