hudson.plugins.helpers
Interface Ghostwriter.MasterGhostwriter

All Superinterfaces:

Ghostwriter, java.io.Serializable

All Known Implementing Classes:

CppNCSSGhostwriter

Enclosing interface:

Ghostwriter

public static interface Ghostwriter.MasterGhostwriter
extends Ghostwriter

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.plugins.helpers.Ghostwriter

Ghostwriter.MasterGhostwriter, Ghostwriter.SlaveGhostwriter

Method Summary

boolean

performFromMaster(hudson.model.AbstractBuild<?,?> build, hudson.FilePath executionRoot, hudson.model.BuildListener listener) Runs (on the master) the step over the given build and reports the progress to the listener.

Method Detail

performFromMaster

boolean performFromMaster(hudson.model.AbstractBuild<?,?> build,
                          hudson.FilePath executionRoot,
                          hudson.model.BuildListener listener)
                          throws java.lang.InterruptedException,
                                 java.io.IOException

Runs (on the master) the step over the given build and reports the progress to the listener.

Parameters:

build - The the build.

executionRoot - The module root on which the build executed.

listener - The buildListener.

Returns:

true if the build can continue, false if there was an error and the build needs to be aborted.

Throws:

java.lang.InterruptedException - If the build is interrupted by the user (in an attempt to abort the build.) Normally the BuildStep implementations may simply forward the exception it got from its lower-level functions.

java.io.IOException - If the implementation wants to abort the processing when an IOException happens, it can simply propagate the exception to the caller. This will cause the build to fail, with the default error message. Implementations are encouraged to catch IOException on its own to provide a better error message, if it can do so, so that users have better understanding on why it failed.