net.nemerosa.ontrack.extension.git.support

Class CommitBuildNameGitCommitLink

java.lang.Object

net.nemerosa.ontrack.extension.git.support.CommitBuildNameGitCommitLink

All Implemented Interfaces:

BuildGitCommitLink<CommitLinkConfig>

@Component
public class CommitBuildNameGitCommitLink
extends java.lang.Object
implements BuildGitCommitLink<CommitLinkConfig>

Constructor Summary

Constructors

Constructor and Description
CommitBuildNameGitCommitLink()

Method Summary

Modifier and Type	Method and Description
CommitLinkConfig	clone(CommitLinkConfig 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, CommitLinkConfig data) Gets the list of build names from Git reference candidates
java.lang.String	getCommitFromBuild(net.nemerosa.ontrack.model.structure.Build build, CommitLinkConfig 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, CommitLinkConfig data) Checks if a build is eligible after it has been loaded from a BuildGitCommitLink.getBuildCandidateReferences(String, Branch, net.nemerosa.ontrack.git.GitRepositoryClient, GitBranchConfiguration, Object)
boolean	isBuildNameValid(java.lang.String name, CommitLinkConfig data) Checks if a build name is valid for this configuration.
CommitLinkConfig	parseData(com.fasterxml.jackson.databind.JsonNode node) Parses the configuration from a JSON node
com.fasterxml.jackson.databind.JsonNode	toJson(CommitLinkConfig data) Formats the configuration data as JSON

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitBuildNameGitCommitLink

public CommitBuildNameGitCommitLink()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: BuildGitCommitLink

ID of the link

Specified by:

getId in interface BuildGitCommitLink<CommitLinkConfig>

getName

public java.lang.String getName()

Description copied from interface: BuildGitCommitLink

Display name for the link

Specified by:

getName in interface BuildGitCommitLink<CommitLinkConfig>

clone

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

Description copied from interface: BuildGitCommitLink

Clones the configuration.

Specified by:

clone in interface BuildGitCommitLink<CommitLinkConfig>

getCommitFromBuild

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

Description copied from interface: BuildGitCommitLink

For the given build, returns the corresponding Git commit

Specified by:

getCommitFromBuild in interface BuildGitCommitLink<CommitLinkConfig>

Parameters:

build - Build to get the commit for

data - Configuration of the link

Returns:

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

parseData

public CommitLinkConfig parseData(com.fasterxml.jackson.databind.JsonNode node)

Description copied from interface: BuildGitCommitLink

Parses the configuration from a JSON node

Specified by:

parseData in interface BuildGitCommitLink<CommitLinkConfig>

toJson

public com.fasterxml.jackson.databind.JsonNode toJson(CommitLinkConfig data)

Description copied from interface: BuildGitCommitLink

Formats the configuration data as JSON

Specified by:

toJson in interface BuildGitCommitLink<CommitLinkConfig>

getForm

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

Description copied from interface: BuildGitCommitLink

Creates a form for the edition of the link configuration.

Specified by:

getForm in interface BuildGitCommitLink<CommitLinkConfig>

getBuildCandidateReferences

public 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,
                                                                             CommitLinkConfig data)

Description copied from interface: BuildGitCommitLink

Gets the list of build names from Git reference candidates

Specified by:

getBuildCandidateReferences in interface BuildGitCommitLink<CommitLinkConfig>

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

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

Description copied from interface: BuildGitCommitLink

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

Specified by:

isBuildEligible in interface BuildGitCommitLink<CommitLinkConfig>

Parameters:

build - Build to check

data - Configuration data

Returns:

true if the build is linked to the configuration

isBuildNameValid

public boolean isBuildNameValid(java.lang.String name,
                                CommitLinkConfig data)

Description copied from interface: BuildGitCommitLink

Checks if a build name is valid for this configuration.

Specified by:

isBuildNameValid in interface BuildGitCommitLink<CommitLinkConfig>