Package jenkins.model

Class ArtifactManager

java.lang.Object

jenkins.model.ArtifactManager

Direct Known Subclasses:

StandardArtifactManager

public abstract class ArtifactManager
extends Object

Manager of artifacts for one build.

Since:

1.532

See Also:

• ArtifactManagerFactory

Constructor Summary

Constructors

Constructor	Description
ArtifactManager()

Method Summary

Modifier and Type	Method	Description
abstract void	archive(FilePath workspace, Launcher launcher, BuildListener listener, Map<String,String> artifacts)	Archive all configured artifacts from a build.
abstract boolean	delete()	Delete all artifacts associated with an earlier build (if any).
abstract void	onLoad(Run<?,?> build)	Called when this manager is loaded from disk.
abstract VirtualFile	root()	Returns a representation of the root directory of archived artifacts.

Methods inherited from class java.lang.Object

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

Constructor Details

ArtifactManager

public ArtifactManager()

Method Details

onLoad

public abstract void onLoad(@NonNull
 Run<?,?> build)

Called when this manager is loaded from disk. The selected manager will be persisted inside a build, so the build reference should be transient (quasi-final) and restored here.

Parameters:

build - a historical build with which this manager was associated

archive

public abstract void archive(FilePath workspace,
 Launcher launcher,
 BuildListener listener,
 Map<String,String> artifacts)
                      throws IOException,
InterruptedException

Archive all configured artifacts from a build.

If called multiple times for the same build, do not delete the old artifacts but keep them all, unless overwritten. For example, the XVNC plugin could use this to save screenshot.jpg if so configured.

This method is typically invoked on a running build, though e.g. in the case of Maven module builds, the build may actually be Run.State.COMPLETED when this is called (since it is the parent build which is still running and performing archiving).

Parameters:

workspace - the root directory from which to copy files (typically AbstractBuild.getWorkspace() but not necessarily)

launcher - a launcher to use if external processes need to be forked

listener - a way to print messages about progress or problems

artifacts - map from paths in the archive area to paths relative to workspace (all paths /-separated)

Throws:

IOException - if transfer or copying failed in any way

InterruptedException - if transfer was interrupted

See Also:

• SimpleBuildStep.perform(Run, FilePath, Launcher, TaskListener)

delete

public abstract boolean delete()
                        throws IOException,
InterruptedException

Delete all artifacts associated with an earlier build (if any).

Returns:

true if there was actually anything to delete

Throws:

IOException - if deletion could not be completed

InterruptedException - if deletion was interrupted

root

public abstract VirtualFile root()

Returns a representation of the root directory of archived artifacts.

Returns:

the archive root