Package org.jenkinsci.plugins.workflow.libs

Class LibraryRetriever

java.lang.Object

hudson.model.AbstractDescribableImpl<LibraryRetriever>

org.jenkinsci.plugins.workflow.libs.LibraryRetriever

All Implemented Interfaces:

ExtensionPoint, Describable<LibraryRetriever>

Direct Known Subclasses:

SCMBasedRetriever

public abstract class LibraryRetriever
extends AbstractDescribableImpl<LibraryRetriever>
implements ExtensionPoint

A way in which a library can be physically obtained for use in a build.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
LibraryRetriever()

Method Summary

Modifier and Type	Method	Description
LibraryRetrieverDescriptor	getDescriptor()
void	retrieve(String name, String version, boolean changelog, FilePath target, Run<?,?> run, TaskListener listener)	Deprecated. Override retrieve3(org.jenkinsci.plugins.workflow.libs.LibraryRecord, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener) instead.
void	retrieve(String name, String version, FilePath target, Run<?,?> run, TaskListener listener)	Deprecated. Override retrieve3(org.jenkinsci.plugins.workflow.libs.LibraryRecord, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener) instead.
protected void	retrieve3(LibraryRecord record, boolean changelog, FilePath target, Run<?,?> run, TaskListener listener)	Obtains library sources.
FormValidation	validateVersion(String name, String version)	Deprecated.
FormValidation	validateVersion(String name, String version, Item context)	Offer to validate a proposed version for retrieve(java.lang.String, java.lang.String, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener).

Methods inherited from class java.lang.Object

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

Constructor Details

LibraryRetriever

public LibraryRetriever()

Method Details

retrieve

@Deprecated
public void retrieve(@NonNull
 String name,
 @NonNull
 String version,
 boolean changelog,
 @NonNull
 FilePath target,
 @NonNull
 Run<?,?> run,
 @NonNull
 TaskListener listener)
              throws Exception

Deprecated.

Override retrieve3(org.jenkinsci.plugins.workflow.libs.LibraryRecord, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener) instead.

Throws:

Exception

retrieve

@Deprecated
public void retrieve(@NonNull
 String name,
 @NonNull
 String version,
 @NonNull
 FilePath target,
 @NonNull
 Run<?,?> run,
 @NonNull
 TaskListener listener)
              throws Exception

Deprecated.

Override retrieve3(org.jenkinsci.plugins.workflow.libs.LibraryRecord, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener) instead.

Throws:

Exception

retrieve3

protected void retrieve3(@NonNull
 LibraryRecord record,
 boolean changelog,
 @NonNull
 FilePath target,
 @NonNull
 Run<?,?> run,
 @NonNull
 TaskListener listener)
                  throws Exception

Obtains library sources. New implementations should override this method; the default delegates to retrieve(String, String, boolean, FilePath, Run, TaskListener) for backward compatibility with third-party retrievers that have not yet been updated.

Parameters:

record - full record of this library's configuration for this build; use LibraryRecord.getName() and LibraryRecord.getVersion() in place of the former name and version parameters

changelog - whether to include changesets in the library in jobs using it from LibraryConfiguration.getIncludeInChangesets()

target - a directory in which to check out sources; should create src/**/*.groovy and/or vars/*.groovy, and optionally also resources/

run - a build which will use the library

listener - a way to report progress

Throws:

Exception - if there is any problem (use AbortException for user errors)

validateVersion

@Deprecated
public FormValidation validateVersion(@NonNull
 String name,
 @NonNull
 String version)

Deprecated.

validateVersion

public FormValidation validateVersion(@NonNull
 String name,
 @NonNull
 String version,
 @CheckForNull
 Item context)

Offer to validate a proposed version for retrieve(java.lang.String, java.lang.String, boolean, hudson.FilePath, hudson.model.Run<?, ?>, hudson.model.TaskListener).

Parameters:

name - the proposed library name

version - a proposed version

context - optional context in which this runs

Returns:

by default, OK

getDescriptor

public LibraryRetrieverDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<LibraryRetriever>