jenkins.scm.api.trait

Class SCMSourceFilter

java.lang.Object

jenkins.scm.api.trait.SCMSourceFilter

public abstract class SCMSourceFilter
extends Object

A SCMNavigatorRequest dependent filter of project names. Typically these filters may need to make remote requests in order to determine exclusion. If multiple filters are used, if any exclude then the project name is excluded.

Since:

3.4.0

See Also:

for {@link SCMSourceRequest} independent filters / filters that can perform completely off-line.

Constructor Summary

Constructors

Constructor and Description
SCMSourceFilter()

Method Summary

Modifier and Type	Method and Description
abstract boolean	isExcluded(SCMNavigatorRequest request, String projectName) Checks if the supplied project name is excluded from the specified SCMNavigatorRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMSourceFilter

public SCMSourceFilter()

Method Detail

isExcluded

public abstract boolean isExcluded(@NonNull
                                   SCMNavigatorRequest request,
                                   @NonNull
                                   String projectName)
                            throws IOException,
                                   InterruptedException

Checks if the supplied project name is excluded from the specified SCMNavigatorRequest.

Parameters:

request - the SCMNavigatorRequest.

projectName - the project name.

Returns:

true if and only if the project name is excluded from the request.

Throws:

IOException - if there was an I/O error when determining exclusion.

InterruptedException - if interrupted while determining exclusion.