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 java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	BRANCH_REF_PREFIX
protected static java.lang.String	PULL_REQUEST_REF_PREFIX
protected static java.lang.String	TAG_REF_PREFIX

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

BRANCH_REF_PREFIX

protected static final java.lang.String BRANCH_REF_PREFIX

See Also:

Constant Field Values

PULL_REQUEST_REF_PREFIX

protected static final java.lang.String PULL_REQUEST_REF_PREFIX

See Also:

Constant Field Values

TAG_REF_PREFIX

protected static final java.lang.String TAG_REF_PREFIX

See Also:

Constant Field Values

Method Detail

setDateFormat

public BuildServerDataProvider setDateFormat(@Nonnull
                                             java.lang.String dateFormat)

setDateFormatTimeZone

public BuildServerDataProvider setDateFormatTimeZone(@Nonnull
                                                     java.lang.String dateFormatTimeZone)

setPrefixDot

public BuildServerDataProvider setPrefixDot(@Nonnull
                                            java.lang.String prefixDot)

setExcludeProperties

public BuildServerDataProvider setExcludeProperties(java.util.List<java.lang.String> excludeProperties)

setIncludeOnlyProperties

public BuildServerDataProvider setIncludeOnlyProperties(java.util.List<java.lang.String> includeOnlyProperties)

setAdditionalProperties

public BuildServerDataProvider setAdditionalProperties(java.util.Map<java.lang.String,java.util.function.Supplier<java.lang.String>> additionalProperties)

getBuildServerProvider

public static BuildServerDataProvider getBuildServerProvider(@Nonnull
                                                             java.util.Map<java.lang.String,java.lang.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
                          java.util.Properties properties,
                          @Nullable
                          java.util.Date reproducibleBuildOutputTimestamp)

getBuildBranch

public abstract java.lang.String getBuildBranch()

Returns:

the branch name provided by the server or an empty string

maybePut

protected void maybePut(@Nonnull
                        java.util.Properties properties,
                        @Nonnull
                        java.lang.String key,
                        java.util.function.Supplier<java.lang.String> supplier)