jenkins.scm.api

Class SCMNavigator

java.lang.Object

hudson.model.AbstractDescribableImpl<SCMNavigator>

jenkins.scm.api.SCMNavigator

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<SCMNavigator>

Direct Known Subclasses:

SingleSCMNavigator

public abstract class SCMNavigator
extends hudson.model.AbstractDescribableImpl<SCMNavigator>
implements hudson.ExtensionPoint

An API for discovering new and navigating already discovered SCMSources within an organization. An implementation does not need to cache existing discoveries, but some form of caching is strongly recommended where the backing provider of repositories has a rate limiter on API calls.

Since:

0.3-beta-1

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SCMNavigator()

Method Summary

Methods

Modifier and Type	Method and Description
SCMNavigatorDescriptor	getDescriptor()
abstract void	visitSources(SCMSourceObserver observer) Looks for SCM sources in a configured place.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMNavigator

protected SCMNavigator()

Method Detail

visitSources

public abstract void visitSources(@Nonnull
                SCMSourceObserver observer)
                           throws IOException,
                                  InterruptedException

Looks for SCM sources in a configured place. After this method completes, no further calls may be made to the observer or its child callbacks.

Parameters:

observer - a recipient of progress notifications and a source of contextual information

Throws:

IOException - if scanning fails

InterruptedException - if scanning is interrupted

getDescriptor

public SCMNavigatorDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<SCMNavigator>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<SCMNavigator>