All Methods Instance Methods Concrete Methods Modifier and Type Method Description
id()Generates the ID of the thing being navigated from the configuration of this
visitSources(SCMSourceObserver observer)Looks for SCM sources in a configured place.
Methods inherited from class jenkins.scm.api.SCMNavigator
afterSave, checkInterrupt, defaultListener, fetchActions, getCategories, getDescriptor, getId, getPronoun, getTraits, isCategoryEnabled, resetId, retrieveActions, setTraits, visitSource, visitSources, visitSources
public String getName()
@NonNull protected String id()Description copied from class:
SCMNavigatorGenerates the ID of the thing being navigated from the configuration of this
The ID will typically be a composite of things like the server and the project/organization that the navigator is scoped to.
For example, a GitHub navigator that is navigating repositories in a GitHub organization could construct its ID as being the URL of the GitHub Server (to allow for GitHub Enterprise servers) and the name of the organization.
The key criteria is that if two navigators have the same ID and they are both in the same
SCMNavigatorOwnerthen the results from
SCMNavigator.fetchActions(SCMNavigatorOwner, SCMNavigatorEvent, TaskListener)should be not just equivalent but
If the results could be non-equal for navigators with the same ID then more detail needs to be encoded in the ID.
public void visitSources(SCMSourceObserver observer) throws IOException, InterruptedExceptionDescription copied from class:
SCMNavigatorLooks for SCM sources in a configured place. After this method completes, no further calls may be made to the
observeror its child callbacks. It is vitally important that implementations must periodically call
SCMNavigator.checkInterrupt()otherwise it will be impossible for users to interrupt the operation.