Package hudson.maven

Class MavenBuildProxy.Filter<CORE extends MavenBuildProxy>

java.lang.Object

hudson.maven.MavenBuildProxy.Filter<CORE>

All Implemented Interfaces:

MavenBuildProxy, Serializable

Direct Known Subclasses:

MavenBuildProxy2.Filter

Enclosing interface:

MavenBuildProxy

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

Filter for MavenBuildProxy. 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	MavenBuildProxy.Filter.AsyncInvoker	Callable for invoking MavenBuildProxy.BuildCallable asynchronously.

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

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

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(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)	Executes the given MavenBuildProxy.BuildCallable asynchronously on the controller.
FilePath	getArtifactsDir()
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.
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).
void	setExecutedMojos(List<ExecutedMojo> executedMojos)	Called at the end of the build to record what mojos are executed.
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 MavenBuildProxy core

Constructor Details

Filter

protected Filter(CORE core)

Method Details

execute

public <V,
T extends Throwable> V execute(MavenBuildProxy.BuildCallable<V,T> program)
                                  throws T,
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.

See Also:

• MavenBuildProxy.executeAsync(BuildCallable)

executeAsync

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

Description copied from interface: MavenBuildProxy

Executes the given MavenBuildProxy.BuildCallable asynchronously on the controller.

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

public FilePath getArtifactsDir()

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