Package jetbrains.buildServer.serverSide.discovery

Class BreadthFirstRunnerDiscoveryExtension

java.lang.Object

jetbrains.buildServer.serverSide.discovery.BreadthFirstRunnerDiscoveryExtension

All Implemented Interfaces:

BuildRunnerDiscoveryExtension, ServerExtension, TeamCityExtension

public abstract class BreadthFirstRunnerDiscoveryExtension
extends Object
implements BuildRunnerDiscoveryExtension

Breadth first scanner. Does not go deeper specified depth and stops processing if it found some runners at some level. By default depth limit is 2.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_DEPTH_LIMIT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BreadthFirstRunnerDiscoveryExtension()
protected	BreadthFirstRunnerDiscoveryExtension(int depthLimit)

Method Summary

Modifier and Type	Method	Description
protected List<DiscoveredObject>	breadthFirstScan(Element currentElement, int currentElementDepth)
List<DiscoveredObject>	discover(BuildTypeSettings settings, Browser browser)	Returns list of guessed build runners, or null if no runners were found.
protected abstract List<DiscoveredObject>	discoverRunnersInDirectory(Element dir, List<Element> filesAndDirs)	Called for each found directory
protected List<DiscoveredObject>	postProcessDiscoveredObjects(BuildTypeSettings settings, Browser browser, List<DiscoveredObject> discovered)	Called when discovery process finished.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEPTH_LIMIT

public static final int DEFAULT_DEPTH_LIMIT

Constructor Detail

BreadthFirstRunnerDiscoveryExtension

protected BreadthFirstRunnerDiscoveryExtension()

BreadthFirstRunnerDiscoveryExtension

protected BreadthFirstRunnerDiscoveryExtension(int depthLimit)

Method Detail

discover

@Nullable
public List<DiscoveredObject> discover(@NotNull
                                       BuildTypeSettings settings,
                                       @NotNull
                                       Browser browser)

Description copied from interface: BuildRunnerDiscoveryExtension

Returns list of guessed build runners, or null if no runners were found.

Specified by:

discover in interface BuildRunnerDiscoveryExtension

Parameters:

settings - build type settings

browser - project source code browser

Returns:

see above

breadthFirstScan

@NotNull
protected List<DiscoveredObject> breadthFirstScan(@NotNull
                                                  Element currentElement,
                                                  int currentElementDepth)

discoverRunnersInDirectory

@NotNull
protected abstract List<DiscoveredObject> discoverRunnersInDirectory(@NotNull
                                                                     Element dir,
                                                                     @NotNull
                                                                     List<Element> filesAndDirs)

Called for each found directory

Parameters:

dir - directory

filesAndDirs - directory content (both files and sub directories)

Returns:

found runners

postProcessDiscoveredObjects

@NotNull
protected List<DiscoveredObject> postProcessDiscoveredObjects(@NotNull
                                                              BuildTypeSettings settings,
                                                              @NotNull
                                                              Browser browser,
                                                              @NotNull
                                                              List<DiscoveredObject> discovered)

Called when discovery process finished. Allows to modify list of found objects. Usually used to filter out discovered objects that are already configured in provided settings.

Parameters:

settings - build configuration settings

browser - project source code browser

discovered - discovered objects

Returns:

new list of discovered objects