jenkins.scm.api.trait

Class SCMSourceRequest

java.lang.Object

jenkins.scm.api.trait.SCMSourceRequest

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class SCMSourceRequest
extends Object
implements Closeable

Represents the context of an individual request for a call to SCMSource.retrieve(SCMSourceCriteria, SCMHeadObserver, SCMHeadEvent, TaskListener) or an equivalent method.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SCMSourceRequest.IntermediateLambda<I> A lambda that produces an intermediate summary used to drive creation of the SCMSourceCriteria.Probe and SCMRevision instances.
static interface	SCMSourceRequest.LazyRevisionLambda<H extends SCMHead,R extends SCMRevision,I> A lambda that will create the SCMRevision instance for a specific SCMHead using the intermediate value produced by a SCMSourceRequest.IntermediateLambda.
static interface	SCMSourceRequest.ProbeLambda<H extends SCMHead,I> A lambda that will create a SCMSourceCriteria.Probe (ideally a SCMProbe but for legacy code migration we use SCMSourceCriteria.Probe) for a specified SCMHead and either a SCMRevision or some other type created by a SCMSourceRequest.IntermediateLambda.
static interface	SCMSourceRequest.RevisionLambda<H extends SCMHead,R extends SCMRevision> A lambda that will create the SCMRevision instance for a specific SCMHead.
static interface	SCMSourceRequest.Witness<H extends SCMHead,R extends SCMRevision> Callback lambda to track the results of process(SCMHead, IntermediateLambda, ProbeLambda, LazyRevisionLambda, Witness[])

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SCMSourceRequest(SCMSource source, SCMSourceContext<?,?> context, TaskListener listener) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
List<SCMSourceCriteria>	getCriteria() Returns the SCMSourceCriteria being used for this request.
boolean	isComplete() Checks if this request has been completed, that is if its SCMHeadObserver has stopped SCMHeadObserver.isObserving().
boolean	isExcluded(SCMHead head) Tests if the SCMHead is excluded from the request.
boolean	isTrusted(SCMHead head) Tests if the SCMHead is trusted.
TaskListener	listener() Returns the TaskListener to use for this request.
void	manage(Closeable closeable) Adds managing a Closeable into the scope of the SCMSourceRequest
<H extends SCMHead,R extends SCMRevision> boolean	process(H head, R revision, SCMSourceRequest.ProbeLambda<H,R> probeFactory, SCMSourceRequest.Witness... witnesses) Processes a head in the context of the current request.
<H extends SCMHead,I,R extends SCMRevision> boolean	process(H head, SCMSourceRequest.IntermediateLambda<I> intermediateFactory, SCMSourceRequest.ProbeLambda<H,I> probeFactory, SCMSourceRequest.LazyRevisionLambda<H,R,I> revisionFactory, SCMSourceRequest.Witness... witnesses) Processes a head in the context of the current request where an intermediary operation is required before the SCMRevision can be instantiated.
<H extends SCMHead,R extends SCMRevision> boolean	process(H head, SCMSourceRequest.RevisionLambda<H,R> revisionFactory, SCMSourceRequest.ProbeLambda<H,R> probeFactory, SCMSourceRequest.Witness... witnesses) Processes a head in the context of the current request.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMSourceRequest

protected SCMSourceRequest(@NonNull
                           SCMSource source,
                           @NonNull
                           SCMSourceContext<?,?> context,
                           @CheckForNull
                           TaskListener listener)

Constructor.

Parameters:

source - the source.

context - the context.

listener - the (optional) TaskListener.

Method Detail

isExcluded

public final boolean isExcluded(@NonNull
                                SCMHead head)
                         throws IOException,
                                InterruptedException

Tests if the SCMHead is excluded from the request.

Parameters:

head - the SCMHead.

Returns:

true if the SCMHead is excluded.

Throws:

IOException - if there is an I/O error.

InterruptedException - if the operation was interrupted.

isTrusted

public final boolean isTrusted(@NonNull
                               SCMHead head)
                        throws IOException,
                               InterruptedException

Tests if the SCMHead is trusted.

Parameters:

head - the SCMHead.

Returns:

true if the SCMHead is trusted.

Throws:

IOException - if there is an I/O error.

InterruptedException - if the operation was interrupted.

getCriteria

@NonNull
public final List<SCMSourceCriteria> getCriteria()

Returns the SCMSourceCriteria being used for this request.

Returns:

the SCMSourceCriteria being used for this request.

process

public final <H extends SCMHead,R extends SCMRevision> boolean process(@NonNull
                                                                       H head,
                                                                       @NonNull
                                                                       R revision,
                                                                       @NonNull
                                                                       SCMSourceRequest.ProbeLambda<H,R> probeFactory,
                                                                       @NonNull
                                                                       SCMSourceRequest.Witness... witnesses)
                                                                throws IOException,
                                                                       InterruptedException

Processes a head in the context of the current request.

Type Parameters:

H - the type of SCMHead.

R - the type of SCMRevision.

Parameters:

head - the SCMHead to process.

revision - the SCMRevision (assuming revision creation is very cheap).

probeFactory - factory method that creates the SCMProbe.

witnesses - any SCMSourceRequest.Witness instances to be informed of the observation result.

Returns:

true if the SCMHeadObserver for this request has completed observing, false to continue processing.

Throws:

IOException - if there was an I/O error.

InterruptedException - if the processing was interrupted.

process

public final <H extends SCMHead,R extends SCMRevision> boolean process(@NonNull
                                                                       H head,
                                                                       @NonNull
                                                                       SCMSourceRequest.RevisionLambda<H,R> revisionFactory,
                                                                       @NonNull
                                                                       SCMSourceRequest.ProbeLambda<H,R> probeFactory,
                                                                       @NonNull
                                                                       SCMSourceRequest.Witness... witnesses)
                                                                throws IOException,
                                                                       InterruptedException

Processes a head in the context of the current request.

Type Parameters:

H - the type of SCMHead.

R - the type of SCMRevision.

Parameters:

head - the SCMHead to process.

revisionFactory - factory method that creates the SCMRevision (assuming creation is cheap).

probeFactory - factory method that creates the SCMProbe.

witnesses - any SCMSourceRequest.Witness instances to be informed of the observation result.

Returns:

true if the SCMHeadObserver for this request has completed observing, false to continue processing.

Throws:

IOException - if there was an I/O error.

InterruptedException - if the processing was interrupted.

process

public final <H extends SCMHead,I,R extends SCMRevision> boolean process(@NonNull
                                                                         H head,
                                                                         @CheckForNull
                                                                         SCMSourceRequest.IntermediateLambda<I> intermediateFactory,
                                                                         @NonNull
                                                                         SCMSourceRequest.ProbeLambda<H,I> probeFactory,
                                                                         @NonNull
                                                                         SCMSourceRequest.LazyRevisionLambda<H,R,I> revisionFactory,
                                                                         @NonNull
                                                                         SCMSourceRequest.Witness... witnesses)
                                                                  throws IOException,
                                                                         InterruptedException

Processes a head in the context of the current request where an intermediary operation is required before the SCMRevision can be instantiated.

Type Parameters:

H - the type of SCMHead.

I - the type of the intermediary operation result.

R - the type of SCMRevision.

Parameters:

head - the SCMHead to process.

intermediateFactory - factory method that provides the seed information for both the SCMSourceRequest.ProbeLambda and the SCMSourceRequest.LazyRevisionLambda.

probeFactory - factory method that creates the SCMProbe.

revisionFactory - factory method that creates the SCMRevision.

witnesses - any SCMSourceRequest.Witness instances to be informed of the observation result.

Returns:

true if the SCMHeadObserver for this request has completed observing, false to continue processing.

Throws:

IOException - if there was an I/O error.

InterruptedException - if the processing was interrupted.

isComplete

public boolean isComplete()

Checks if this request has been completed, that is if its SCMHeadObserver has stopped SCMHeadObserver.isObserving().

Returns:

true if and only if the request is completed.

listener

@NonNull
public TaskListener listener()

Returns the TaskListener to use for this request.

Returns:

the TaskListener to use for this request.

manage

public void manage(@CheckForNull
                   Closeable closeable)

Adds managing a Closeable into the scope of the SCMSourceRequest

Parameters:

closeable - the Closeable to manage.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException