Package pl.project13.core.cibuild

Class BuildServerDataProvider

java.lang.Object

pl.project13.core.cibuild.BuildServerDataProvider

Direct Known Subclasses:

AwsCodeBuildBuildServerData, AzureDevOpsBuildServerData, BambooBuildServerData, BitbucketBuildServerData, CircleCiBuildServerData, GitHubBuildServerData, GitlabBuildServerData, HudsonJenkinsBuildServerData, TeamCityBuildServerData, TravisBuildServerData, UnknownBuildServerData

public abstract class BuildServerDataProvider
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BRANCH_REF_PREFIX
protected static final String	PULL_REQUEST_REF_PREFIX
protected static final String	TAG_REF_PREFIX

Method Summary

Modifier and Type	Method	Description
abstract String	getBuildBranch()
static BuildServerDataProvider	getBuildServerProvider(@NonNull Map<String,String> env, @NonNull LogInterface log)	Get the BuildServerDataProvider implementation for the running environment
void	loadBuildData(@NonNull Properties properties, @Nullable Date reproducibleBuildOutputTimestamp)
protected void	maybePut(@NonNull Properties properties, @NonNull String key, Supplier<String> supplier)
BuildServerDataProvider	setAdditionalProperties(Map<String,Supplier<String>> additionalProperties)
BuildServerDataProvider	setDateFormat(@NonNull String dateFormat)
BuildServerDataProvider	setDateFormatTimeZone(@NonNull String dateFormatTimeZone)
BuildServerDataProvider	setExcludeProperties(List<String> excludeProperties)
BuildServerDataProvider	setIncludeOnlyProperties(List<String> includeOnlyProperties)
BuildServerDataProvider	setPrefixDot(@NonNull String prefixDot)

Methods inherited from class java.lang.Object

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

Field Details

BRANCH_REF_PREFIX

protected static final String BRANCH_REF_PREFIX

See Also:

• Constant Field Values

PULL_REQUEST_REF_PREFIX

protected static final String PULL_REQUEST_REF_PREFIX

See Also:

• Constant Field Values

TAG_REF_PREFIX

protected static final String TAG_REF_PREFIX

See Also:

• Constant Field Values

Method Details

setDateFormat

public BuildServerDataProvider setDateFormat(@NonNull String dateFormat)

setDateFormatTimeZone

public BuildServerDataProvider setDateFormatTimeZone(@NonNull String dateFormatTimeZone)

setPrefixDot

public BuildServerDataProvider setPrefixDot(@NonNull String prefixDot)

setExcludeProperties

public BuildServerDataProvider setExcludeProperties(List<String> excludeProperties)

setIncludeOnlyProperties

public BuildServerDataProvider setIncludeOnlyProperties(List<String> includeOnlyProperties)

setAdditionalProperties

public BuildServerDataProvider setAdditionalProperties(Map<String,Supplier<String>> additionalProperties)

getBuildServerProvider

public static BuildServerDataProvider getBuildServerProvider(@NonNull Map<String,String> env,
 @NonNull LogInterface log)

Get the BuildServerDataProvider implementation for the running environment

Parameters:

env - environment variables which get used to identify the environment

log - logging provider which will be used to log events

Returns:

the corresponding BuildServerDataProvider for your environment or UnknownBuildServerData

loadBuildData

public void loadBuildData(@NonNull Properties properties,
 @Nullable Date reproducibleBuildOutputTimestamp)

getBuildBranch

public abstract String getBuildBranch()

Returns:

the branch name provided by the server or an empty string

maybePut

protected void maybePut(@NonNull Properties properties,
 @NonNull String key,
 Supplier<String> supplier)