Package jenkins.scm.api

Class SCMFileSystem.Builder

java.lang.Object

jenkins.scm.api.SCMFileSystem.Builder

All Implemented Interfaces:

ExtensionPoint

Enclosing class:

SCMFileSystem

public abstract static class SCMFileSystem.Builder
extends Object
implements ExtensionPoint

Extension point that allows different plugins to implement SCMFileSystem classes for the same SCM or SCMSource and let Jenkins pick the most capable for any specific SCM implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SCMFileSystem	build(Item owner, SCM scm, SCMRevision rev)	Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
SCMFileSystem	build(Item owner, SCM scm, SCMRevision rev, Run<?,?> _build)	Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
SCMFileSystem	build(SCMSource source, SCMHead head, SCMRevision rev)	Given a SCMSource, a SCMHead and a SCMRevision this method should try to build a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision.
abstract boolean	supports(SCM source)	Checks if this SCMFileSystem.Builder supports the supplied SCM.
boolean	supports(SCMDescriptor<?> descriptor)	Checks if this SCMFileSystem.Builder supports the supplied SCMDescriptor.
abstract boolean	supports(SCMSource source)	Checks if this SCMFileSystem.Builder supports the supplied SCMSource.
boolean	supports(SCMSourceDescriptor descriptor)	Checks if this SCMFileSystem.Builder supports the supplied SCMSourceDescriptor.
protected abstract boolean	supportsDescriptor(SCMDescriptor descriptor)	Checks if this SCMFileSystem.Builder supports the supplied SCMDescriptor.
protected abstract boolean	supportsDescriptor(SCMSourceDescriptor descriptor)	Checks if this SCMFileSystem.Builder supports the supplied SCMSourceDescriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

supports

public abstract boolean supports(SCM source)

Checks if this SCMFileSystem.Builder supports the supplied SCM.

Parameters:

source - the SCM.

Returns:

true if and only if the supplied SCM is supported by this SCMFileSystem.Builder, false if build(Item, SCM, SCMRevision) will always return null.

supports

public abstract boolean supports(SCMSource source)

Checks if this SCMFileSystem.Builder supports the supplied SCMSource.

Parameters:

source - the SCMSource.

Returns:

true if and only if the supplied SCMSource is supported by this SCMFileSystem.Builder, false if build(SCMSource, SCMHead, SCMRevision) will always return null.

supports

public final boolean supports(SCMDescriptor<?> descriptor)

Checks if this SCMFileSystem.Builder supports the supplied SCMDescriptor.

Parameters:

descriptor - the SCMDescriptor

Returns:

the return value of supportsDescriptor(SCMDescriptor) if implemented, otherwise, it will return true if one of the following is true: the SCM for the descriptor is the enclosing class of this builder class, the builder and SCM are in the same package, or the builder is in a child package of the SCM.

Since:

2.3.0

supportsDescriptor

protected abstract boolean supportsDescriptor(SCMDescriptor descriptor)

Checks if this SCMFileSystem.Builder supports the supplied SCMDescriptor.

Parameters:

descriptor - the SCMDescriptor

Returns:

true if and only if the supplied SCMSourceDescriptor's SCMDescriptor class is supported by this SCMFileSystem.Builder.

Since:

2.3.0

supports

public final boolean supports(SCMSourceDescriptor descriptor)

Checks if this SCMFileSystem.Builder supports the supplied SCMSourceDescriptor.

Parameters:

descriptor - the SCMSourceDescriptor

Returns:

the return value of supportsDescriptor(SCMSourceDescriptor) if implemented, otherwise, it will return true if one of the following is true: the SCMSource for the descriptor is the enclosing class of this builder class, the builder and SCMSource are in the same package, or the builder is in a child package of the SCMSource.

Since:

2.3.0

supportsDescriptor

protected abstract boolean supportsDescriptor(SCMSourceDescriptor descriptor)

Checks if this SCMFileSystem.Builder supports the supplied SCMSourceDescriptor.

Parameters:

descriptor - the SCMSourceDescriptor

Returns:

true if and only if the supplied SCMSourceDescriptor's SCMSource class is supported by this SCMFileSystem.Builder, false if build(SCMSource, SCMHead, SCMRevision) will always return null, and false by default for compatibility.

Since:

2.3.0

build

@CheckForNull
public SCMFileSystem build(@NonNull
                           Item owner,
                           @NonNull
                           SCM scm,
                           @CheckForNull
                           SCMRevision rev)
                    throws IOException,
                           InterruptedException

Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision. If the SCM is supported but not for a fixed revision, best effort is acceptable as the most capable SCMFileSystem will be returned to the caller.

Parameters:

owner - the owner of the SCM

scm - the SCM.

rev - the specified SCMRevision.

Returns:

the corresponding SCMFileSystem or null if this builder cannot create a SCMFileSystem for the specified SCM.

Throws:

IOException - if the attempt to create a SCMFileSystem failed due to an IO error (such as the remote system being unavailable)

InterruptedException - if the attempt to create a SCMFileSystem was interrupted.

build

@CheckForNull
public SCMFileSystem build(@NonNull
                           SCMSource source,
                           @NonNull
                           SCMHead head,
                           @CheckForNull
                           SCMRevision rev)
                    throws IOException,
                           InterruptedException

Given a SCMSource, a SCMHead and a SCMRevision this method should try to build a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision. If the SCMSource is supported but not for a fixed revision, best effort is acceptable as the most capable SCMFileSystem will be returned to the caller.

Parameters:

source - the SCMSource.

head - the specified SCMHead.

rev - the specified SCMRevision.

Returns:

the corresponding SCMFileSystem or null if there is none.

Throws:

IOException - if the attempt to create a SCMFileSystem failed due to an IO error (such as the remote system being unavailable)

InterruptedException - if the attempt to create a SCMFileSystem was interrupted.

build

@CheckForNull
public SCMFileSystem build(@NonNull
                           Item owner,
                           @NonNull
                           SCM scm,
                           @CheckForNull
                           SCMRevision rev,
                           @CheckForNull
                           Run<?,?> _build)
                    throws IOException,
                           InterruptedException

Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision. If the SCM is supported but not for a fixed revision, best effort is acceptable as the most capable SCMFileSystem will be returned to the caller. If the Run is provided, it can be used to alter the behavior. For example, variables in the branch name can be expanded based on current build properties, etc.

Parameters:

owner - the owner of the SCM

scm - the SCM.

rev - the specified SCMRevision.

_build - the specified Run.

Returns:

the corresponding SCMFileSystem or null if this builder cannot create a SCMFileSystem for the specified SCM.

Throws:

IOException - if the attempt to create a SCMFileSystem failed due to an IO error (such as the remote system being unavailable)

InterruptedException - if the attempt to create a SCMFileSystem was interrupted.