jenkins.scm

Class SCMDecisionHandler

java.lang.Object

jenkins.scm.SCMDecisionHandler

All Implemented Interfaces:

ExtensionPoint

public abstract class SCMDecisionHandler
extends Object
implements ExtensionPoint

Extension point for various decisions about SCM operations for Item instances.

Since:

2.11

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SCMDecisionHandler()

Method Summary

Modifier and Type	Method and Description
static ExtensionList<SCMDecisionHandler>	all() All registered SCMDecisionHandlers
static SCMDecisionHandler	firstShouldPollVeto(Item item) Returns the first SCMDecisionHandler that returns false from shouldPoll(Item)
static List<SCMDecisionHandler>	listShouldPollVetos(Item item) Returns the SCMDecisionHandler instances that return false from shouldPoll(Item)
abstract boolean	shouldPoll(Item item) This handler is consulted every time someone tries to run a polling of an Item.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMDecisionHandler

public SCMDecisionHandler()

Method Detail

shouldPoll

public abstract boolean shouldPoll(@NonNull
                                   Item item)

This handler is consulted every time someone tries to run a polling of an Item. If any of the registered handlers returns false, the Item will not be polled.

Parameters:

item - The item.

all

@NonNull
public static ExtensionList<SCMDecisionHandler> all()

All registered SCMDecisionHandlers

firstShouldPollVeto

@CheckForNull
public static SCMDecisionHandler firstShouldPollVeto(@NonNull
                                                                   Item item)

Returns the first SCMDecisionHandler that returns false from shouldPoll(Item)

Parameters:

item - the item

Returns:

the first veto or null if there are no vetos

listShouldPollVetos

@NonNull
public static List<SCMDecisionHandler> listShouldPollVetos(@NonNull
                                                                    Item item)

Returns the SCMDecisionHandler instances that return false from shouldPoll(Item)

Parameters:

item - the item

Returns:

the SCMDecisionHandler instances vetoing the polling of the specified item.