Package hudson.ivy

Class IvyBuildProxy.Filter<CORE extends IvyBuildProxy>

java.lang.Object

hudson.ivy.IvyBuildProxy.Filter<CORE>

All Implemented Interfaces:

IvyBuildProxy, Serializable

Direct Known Subclasses:

IvyBuildProxy2.Filter

Enclosing interface:

IvyBuildProxy

public abstract static class IvyBuildProxy.Filter<CORE extends IvyBuildProxy>
extends Object
implements IvyBuildProxy, Serializable

Filter for IvyBuildProxy.

Meant to be useful as the base class for other filters.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	IvyBuildProxy.Filter.AsyncInvoker	Callable for invoking IvyBuildProxy.BuildCallable asynchronously.

Nested classes/interfaces inherited from interface hudson.ivy.IvyBuildProxy

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final CORE	core

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Filter(CORE core)

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 IvyBuildProxy.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)

Methods inherited from class java.lang.Object

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

Field Details

core

protected final CORE extends IvyBuildProxy core

Constructor Details

Filter

protected Filter(CORE core)

Method Details

execute

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

Description copied from interface: IvyBuildProxy

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.

Specified by:

execute in interface IvyBuildProxy

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:

• IvyBuildProxy.executeAsync(BuildCallable)

executeAsync

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

Description copied from interface: IvyBuildProxy

Executes the given IvyBuildProxy.BuildCallable asynchronously on the master.

This method works like IvyBuildProxy.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.

Specified by:

executeAsync in interface IvyBuildProxy

Throws:

IOException

getRootDir

public FilePath getRootDir()

Description copied from interface: IvyBuildProxy

Root directory of the build.

Specified by:

getRootDir in interface IvyBuildProxy

See Also:

• Run.getRootDir()

getProjectRootDir

public FilePath getProjectRootDir()

Description copied from interface: IvyBuildProxy

Root directory of the parent of this build.

Specified by:

getProjectRootDir in interface IvyBuildProxy

getModuleSetRootDir

public FilePath getModuleSetRootDir()

Description copied from interface: IvyBuildProxy

Root directory of the owner IvyModuleSet

Specified by:

getModuleSetRootDir in interface IvyBuildProxy

getArtifactsDir

public FilePath getArtifactsDir()

Specified by:

getArtifactsDir in interface IvyBuildProxy

See Also:

• Run.getArtifactsDir()

setResult

public void setResult(Result result)

Specified by:

setResult in interface IvyBuildProxy

See Also:

• Run.setResult(Result)

getTimestamp

public Calendar getTimestamp()

Specified by:

getTimestamp in interface IvyBuildProxy

See Also:

• Run.getTimestamp()

getMilliSecsSinceBuildStart

public long getMilliSecsSinceBuildStart()

Description copied from interface: IvyBuildProxy

# of milliseconds elapsed since IvyBuildProxy.getTimestamp().

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

Specified by:

getMilliSecsSinceBuildStart in interface IvyBuildProxy

isArchivingDisabled

public boolean isArchivingDisabled()

Description copied from interface: IvyBuildProxy

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

Specified by:

isArchivingDisabled in interface IvyBuildProxy

registerAsProjectAction

public void registerAsProjectAction(IvyReporter reporter)

Description copied from interface: IvyBuildProxy

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.

Specified by:

registerAsProjectAction in interface IvyBuildProxy

registerAsAggregatedProjectAction

public void registerAsAggregatedProjectAction(IvyReporter reporter)

Description copied from interface: IvyBuildProxy

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.

Specified by:

registerAsAggregatedProjectAction in interface IvyBuildProxy