jenkins.scm.api

Interface SCMSourceOwner

All Superinterfaces:

hudson.security.AccessControlled, hudson.model.Item, hudson.model.ModelObject, hudson.model.PersistenceRoot, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem

public interface SCMSourceOwner
extends hudson.model.Item

An Item that owns SCMSource instances.

Author:

Stephen Connolly

Field Summary

Fields inherited from interface hudson.model.Item

BUILD, CANCEL, CONFIGURE, CREATE, DELETE, DISCOVER, EXTENDED_READ, PERMISSIONS, READ, WIPEOUT, WORKSPACE

Fields inherited from interface hudson.model.Saveable

NOOP

Method Summary

Methods

Modifier and Type	Method and Description
SCMSource	getSCMSource(String sourceId) Gets the source with the specified SCMSource.getId().
SCMSourceCriteria	getSCMSourceCriteria(SCMSource source) Returns the criteria for determining if a candidate head is relevant for consumption.
List<SCMSource>	getSCMSources() Returns the SCMSource instances that this item is consuming.
void	onSCMSourceUpdated(SCMSource source) Called when a source has received notification of an update.

Methods inherited from interface hudson.model.Item

delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch, onLoad, save

Methods inherited from interface hudson.model.PersistenceRoot

getRootDir

Methods inherited from interface hudson.search.SearchableModelObject

getSearch

Methods inherited from interface hudson.search.SearchItem

getSearchIndex, getSearchName, getSearchUrl

Methods inherited from interface hudson.security.AccessControlled

checkPermission, getACL, hasPermission

Method Detail

getSCMSources

@NonNull
List<SCMSource> getSCMSources()

Returns the SCMSource instances that this item is consuming.

Returns:

the SCMSource instances that this item is consuming.

getSCMSource

@CheckForNull
SCMSource getSCMSource(@CheckForNull
                                  String sourceId)

Gets the source with the specified SCMSource.getId().

Parameters:

sourceId - the SCMSource.getId()

Returns:

the corresponding SCMSource or null if no matching source.

onSCMSourceUpdated

void onSCMSourceUpdated(@NonNull
                      SCMSource source)

Called when a source has received notification of an update.

Parameters:

source - the source

getSCMSourceCriteria

@CheckForNull
SCMSourceCriteria getSCMSourceCriteria(@NonNull
                                                  SCMSource source)

Returns the criteria for determining if a candidate head is relevant for consumption.

Parameters:

source - the source to get the criteria for.

Returns:

the criteria for determining if a candidate head is relevant for consumption.