Package jenkins.scm.api

The public API contract of the SCM API plugin.

Interface Summary

Interface	Description
FormTagLib
SCMNavigatorOwner	An Item that owns SCMNavigator instances.
SCMSourceCriteria	Filter that selects heads picked up by SCMSource out of all the branches and other heads found in the repository.
SCMSourceOwner	An Item that owns SCMSource instances.

Class Summary

Class	Description
Messages	Generated localization support class.
SCM2	Extended functionality base class for SCM implementations that only want to handle one event system and are consolidating on the SCM API event system.
SCMCategory<T>	Base class for categories of SCM things.
SCMEvent<P>	Base class for all events from a SCM system.
SCMEvent.Dispatcher<E extends SCMEvent<?>>
SCMEvent.EventQueueMetrics
SCMEventListener	Base class for listeners to SCMEvents
SCMFile	A file/directory inspected by SCMFileSystem.
SCMFileSystem	A virtual file system for a specific SCM potentially pinned to a specific SCMRevision.
SCMFileSystem.Builder	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.
SCMHead	Represents a named SCM branch, change request, tag or mainline.
SCMHead.HeadByItem	Means of locating a head given an item.
SCMHeadCategory	Base class for categories of SCMHead, for example: branches, tags, change requests, mainlines, features, etc.
SCMHeadEvent<P>	Base class for events relating to SCMHead instances.
SCMHeadMigration<S extends SCMSource,H extends SCMHead,R extends SCMRevision>	If a SCMSource plugin needs to migrate the implementation classes for SCMHead this extension point allows the plugin to register type migrations.
SCMHeadObserver	Something that observes SCMHead and corresponding SCMRevision details.
SCMHeadObserver.AllFinished	An observer that wraps multiple observers and keeps observing as long as one of the wrapped observers wants to.
SCMHeadObserver.Any	An observer that picks the first revision it can find.
SCMHeadObserver.Collector	An observer that collects the observed SCMHeads and SCMRevisions.
SCMHeadObserver.Filter<O extends SCMHeadObserver>	A SCMHeadObserver that filters the SCMHead instances that will be observed by the wrapped SCMHeadObserver.
SCMHeadObserver.Named	An observer that collects the SCMRevision of a named SCMHead and then stops observing.
SCMHeadObserver.None	An observer that is already finished.
SCMHeadObserver.OneFinished	An observer that wraps multiple observers and keeps observing until one of the wrapped observers stops observing.
SCMHeadObserver.Selector	An observer that collects the SCMRevision of a specific SCMHead and then stops observing.
SCMHeadObserver.Wrapped<O extends SCMHeadObserver>	Base class for an SCMHeadObserver that wraps another SCMHeadObserver while allowing access to the original observer via SCMHeadObserver.Wrapped.unwrap().
SCMHeadOrigin	Represents the origin of a SCMHead.
SCMHeadOrigin.Default	The default origin.
SCMHeadOrigin.Fork	A named fork.
SCMName	Utility class to help with naming SCM related things.
SCMNavigator	An API for discovering new and navigating already discovered SCMSources within an organization.
SCMNavigatorDescriptor	Definition of a kind of SCMNavigator.
SCMNavigatorEvent<P>	Base class for events relating to SCMNavigator instances.
SCMNavigatorOwners	Provides a means to lookup the SCMNavigatorOwners that own SCMNavigatorOwner instances.
SCMNavigatorOwners.Enumerator	Extension point to allow for access to embedded SCMSourceOwner instances that SCMNavigatorOwners.JenkinsItemEnumerator will not find.
SCMNavigatorOwners.JenkinsItemEnumerator	Provide all the Jenkins items that are SCMNavigatorOwners.
SCMProbe	An unmanaged SCMSourceCriteria.Probe that has its lifecycle managed outside of SCMSource.fetch(TaskListener).
SCMProbeStat	Represents the result of an existence check which may optionally include details of an alternative name for the object being checked for existence.
SCMRevision	Base class that represents a specific (or not so specific) revision of a SCMHead.
SCMRevisionAction	Action added to AbstractBuild to remember which revision is built in the given build.
SCMSource	A SCMSource is responsible for fetching SCMHead and corresponding SCMRevision instances from which it can build SCM instances that are configured to check out the specific SCMHead at the specified SCMRevision.
SCMSource.SourceByItem	Means of locating a head given an item.
SCMSourceCategory	Base class for categories of SCMSource, for example: repository, depot, VOB, etc.
SCMSourceCriteria.Probe	A probe for a branch candidate.
SCMSourceDescriptor	A Descriptor for SCMSources.
SCMSourceEvent<P>	Base class for events relating to SCMSource instances.
SCMSourceObserver	Callback used by SCMNavigator.
SCMSourceObserver.Filter<O extends SCMSourceObserver>	An observer that filters the observed sources to a subset of named instances.
SCMSourceObserver.ProjectObserver	Nested callback produced by SCMSourceObserver.observe(java.lang.String).
SCMSourceObserver.Wrapped<O extends SCMSourceObserver>	Base class for an observer that wraps another observer.
SCMSourceOwners	Provides a means to lookup the SCMSourceOwners that own SCMSource instances.
SCMSourceOwners.Enumerator	Extension point to allow for access to embedded SCMSourceOwner instances that SCMSourceOwners.JenkinsItemEnumerator will not find.
SCMSourceOwners.JenkinsItemEnumerator	Provide all the Jenkins items that are SCMSourceOwners.
SCMUri	Utility class to help with SCM URI related things.

Enum Summary

Enum	Description
SCMEvent.Type	The type of event.
SCMFile.Type	Represents the type of a SCMFile.