net.nemerosa.ontrack.extension.git.model

Interface BuildGitCommitLink<T>

Type Parameters:

T - Type of configuration data

All Known Subinterfaces:

IndexableBuildGitCommitLink<T>

All Known Implementing Classes:

CommitBuildNameGitCommitLink, GitCommitPropertyCommitLink, TagBuildNameGitCommitLink, TagPatternBuildNameGitCommitLink

public interface BuildGitCommitLink<T>

Defines the way to link builds to Git commits, in order to manage the change logs, the Git searches and synchronisations.

Method Summary

Modifier and Type	Method and Description
T	clone(T data, java.util.function.Function<java.lang.String,java.lang.String> replacementFunction) Clones the configuration.
java.util.stream.Stream<java.lang.String>	getBuildCandidateReferences(java.lang.String commit, net.nemerosa.ontrack.model.structure.Branch branch, net.nemerosa.ontrack.git.GitRepositoryClient gitClient, GitBranchConfiguration branchConfiguration, T data) Gets the list of build names from Git reference candidates
java.lang.String	getCommitFromBuild(net.nemerosa.ontrack.model.structure.Build build, T data) For the given build, returns the corresponding Git commit
net.nemerosa.ontrack.model.form.Form	getForm() Creates a form for the edition of the link configuration.
java.lang.String	getId() ID of the link
java.lang.String	getName() Display name for the link
boolean	isBuildEligible(net.nemerosa.ontrack.model.structure.Build build, T data) Checks if a build is eligible after it has been loaded from a getBuildCandidateReferences(String, Branch, net.nemerosa.ontrack.git.GitRepositoryClient, GitBranchConfiguration, Object)
boolean	isBuildNameValid(java.lang.String name, T data) Checks if a build name is valid for this configuration.
T	parseData(com.fasterxml.jackson.databind.JsonNode node) Parses the configuration from a JSON node
com.fasterxml.jackson.databind.JsonNode	toJson(T data) Formats the configuration data as JSON

Method Detail

getId

java.lang.String getId()

ID of the link

getName

java.lang.String getName()

Display name for the link

clone

T clone(T data,
        java.util.function.Function<java.lang.String,java.lang.String> replacementFunction)

Clones the configuration.

getCommitFromBuild

java.lang.String getCommitFromBuild(net.nemerosa.ontrack.model.structure.Build build,
                                    T data)

For the given build, returns the corresponding Git commit

Parameters:

build - Build to get the commit for

data - Configuration of the link

Returns:

Committish (short or long SHA, tag, head, etc.)

parseData

T parseData(com.fasterxml.jackson.databind.JsonNode node)

Parses the configuration from a JSON node

toJson

com.fasterxml.jackson.databind.JsonNode toJson(T data)

Formats the configuration data as JSON

getForm

net.nemerosa.ontrack.model.form.Form getForm()

Creates a form for the edition of the link configuration.

getBuildCandidateReferences

java.util.stream.Stream<java.lang.String> getBuildCandidateReferences(java.lang.String commit,
                                                                      net.nemerosa.ontrack.model.structure.Branch branch,
                                                                      net.nemerosa.ontrack.git.GitRepositoryClient gitClient,
                                                                      GitBranchConfiguration branchConfiguration,
                                                                      T data)

Gets the list of build names from Git reference candidates

Parameters:

commit - The commit to start from

branch - Branch where to look the build into

gitClient - The Git client to use for the connection

branchConfiguration - Git branch configuration

data - Configuration data

Returns:

Candidate build names

isBuildEligible

boolean isBuildEligible(net.nemerosa.ontrack.model.structure.Build build,
                        T data)

Checks if a build is eligible after it has been loaded from a getBuildCandidateReferences(String, Branch, net.nemerosa.ontrack.git.GitRepositoryClient, GitBranchConfiguration, Object)

Parameters:

build - Build to check

data - Configuration data

Returns:

true if the build is linked to the configuration

isBuildNameValid

boolean isBuildNameValid(java.lang.String name,
                         T data)

Checks if a build name is valid for this configuration.