Package com.atlassian.bamboo.variable

Class BuiltInVariableHelper

java.lang.Object

com.atlassian.bamboo.variable.BuiltInVariableHelper

public class BuiltInVariableHelper
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGENT_ID
static final String	AGENT_WORKING_DIRECTORY
static final String	BUILD_KEY
static final String	BUILD_NUMBER
static final String	BUILD_PLAN_NAME
static final String	BUILD_RESULT_KEY
static final String	BUILD_RESULTS_URL
static final String	BUILD_STATE
static final String	DEPLOY_PREFIX
static final String	DEPLOYMENT_PREVIOUS_RELEASE
static final String	DEPLOYMENT_PREVIOUS_VERSION	Deprecated. since 5.1
static final String	DEPLOYMENT_PROJECT
static final String	DEPLOYMENT_PROJECT_ID
static final String	DEPLOYMENT_RELEASE
static final String	DEPLOYMENT_RESULT_ID
static final String	DEPLOYMENT_VERSION	Deprecated. since 5.1
static final String	DEPLOYMENT_VERSION_ID
static final String	DEPLOYMENT_VERSION_NAME	Deprecated. since 5.1
static final String	ENVIRONMENT
static final String	ENVIRONMENT_ID
static final String	ENVIRONMENT_NAME
static final String	FINISHED_DATE
static final String	INTEGRATION_BRANCH
static final String	IS_ROLLBACK
static final String	MERGED_REVISION
static final String	NAMESPACE_BAMBOO
static final String	NAMESPACE_SYSTEM
static final String	PLAN_KEY
static final String	PLAN_NAME
static final String	PLAN_RESULT_KEY
static final String	PR_KEY
static final String	PR_SOURCE_BRANCH
static final String	PR_SOURCE_FORK_OWNER
static final String	PR_SOURCE_FORK_REPOSITORY
static final String	PR_TARGET_BRANCH
static final String	QUEUED_DATE
static final String	REPOSITORY_BRANCH_DISPLAY_NAME
static final String	REPOSITORY_BRANCH_NAME
static final String	REPOSITORY_NAME
static final String	REPOSITORY_PREVIOUS_REVISION
static final String	REPOSITORY_REVISION
static final String	REPOSITORY_TYPE
static final String	REPOSITORY_VAR_PREFIX
static final String	RESULTS_URL
static final String	SHORT_JOB_KEY
static final String	SHORT_JOB_NAME
static final String	SHORT_PLAN_BRANCH_NAME
static final String	SHORT_PLAN_KEY
static final String	SHORT_PLAN_NAME
static final String	SIMPLE_BUILD_TIMESTAMP
static final String	STARTED_DATE
static final String	TRIGGER_REASON
static final String	TRIGGER_SENTENCE
static final String	WEBHOOK_NOTIFICATION_DESCRIPTION
static final String	WEBHOOK_TEMPLATE_ID
static final String	WEBHOOK_TEMPLATE_NAME
static final String	WEBHOOK_TIMESTAMP
static final String	WEBHOOK_UUID

Method Summary

Modifier and Type	Method	Description
static void	addVariableContext(@NotNull Map<String,VariableDefinitionContext> variables, @NotNull String key, @Nullable String value, @NotNull VariableType variableType)	Helper function adding VariableDefinitionContext to a map that can later be used during variable substitution.
static void	createRepositoryVariables(@NotNull Map<String,VariableDefinitionContext> variables, @NotNull ResultsSummary resultsSummary, @NotNull VariableType variableType, @NotNull RepositoryDefinitionManager repositoryDefinitionManager, @NotNull VcsRepositoryManager vcsRepositoryManager)
static void	createRepositoryVariables(@NotNull Map<String,VariableDefinitionContext> variables, @NotNull List<PlanRepositoryDefinition> repositoryDefinitions, @NotNull BuildChanges buildChanges, @NotNull VariableType variableType, @NotNull VcsRepositoryManager vcsRepositoryManager)

Methods inherited from class java.lang.Object

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

Field Details

NAMESPACE_BAMBOO

public static final String NAMESPACE_BAMBOO

See Also:

• Constant Field Values

NAMESPACE_SYSTEM

public static final String NAMESPACE_SYSTEM

See Also:

• Constant Field Values

PLAN_KEY

public static final String PLAN_KEY

See Also:

• Constant Field Values

PLAN_NAME

public static final String PLAN_NAME

See Also:

• Constant Field Values

SHORT_PLAN_KEY

public static final String SHORT_PLAN_KEY

See Also:

• Constant Field Values

SHORT_PLAN_NAME

public static final String SHORT_PLAN_NAME

See Also:

• Constant Field Values

SHORT_PLAN_BRANCH_NAME

public static final String SHORT_PLAN_BRANCH_NAME

See Also:

• Constant Field Values

BUILD_NUMBER

public static final String BUILD_NUMBER

See Also:

• Constant Field Values

PLAN_RESULT_KEY

public static final String PLAN_RESULT_KEY

See Also:

• Constant Field Values

BUILD_RESULT_KEY

public static final String BUILD_RESULT_KEY

See Also:

• Constant Field Values

SHORT_JOB_KEY

public static final String SHORT_JOB_KEY

See Also:

• Constant Field Values

SHORT_JOB_NAME

public static final String SHORT_JOB_NAME

See Also:

• Constant Field Values

BUILD_RESULTS_URL

public static final String BUILD_RESULTS_URL

See Also:

• Constant Field Values

RESULTS_URL

public static final String RESULTS_URL

See Also:

• Constant Field Values

BUILD_KEY

public static final String BUILD_KEY

See Also:

• Constant Field Values

BUILD_PLAN_NAME

public static final String BUILD_PLAN_NAME

See Also:

• Constant Field Values

BUILD_STATE

public static final String BUILD_STATE

See Also:

• Constant Field Values

AGENT_ID

public static final String AGENT_ID

See Also:

• Constant Field Values

AGENT_WORKING_DIRECTORY

public static final String AGENT_WORKING_DIRECTORY

See Also:

• Constant Field Values

REPOSITORY_VAR_PREFIX

public static final String REPOSITORY_VAR_PREFIX

See Also:

• Constant Field Values

REPOSITORY_NAME

public static final String REPOSITORY_NAME

See Also:

• Constant Field Values

REPOSITORY_REVISION

public static final String REPOSITORY_REVISION

See Also:

• Constant Field Values

REPOSITORY_PREVIOUS_REVISION

public static final String REPOSITORY_PREVIOUS_REVISION

See Also:

• Constant Field Values

REPOSITORY_TYPE

public static final String REPOSITORY_TYPE

See Also:

• Constant Field Values

REPOSITORY_BRANCH_NAME

public static final String REPOSITORY_BRANCH_NAME

See Also:

• Constant Field Values

REPOSITORY_BRANCH_DISPLAY_NAME

public static final String REPOSITORY_BRANCH_DISPLAY_NAME

See Also:

• Constant Field Values

INTEGRATION_BRANCH

public static final String INTEGRATION_BRANCH

See Also:

• Constant Field Values

MERGED_REVISION

public static final String MERGED_REVISION

See Also:

• Constant Field Values

PR_KEY

public static final String PR_KEY

See Also:

• Constant Field Values

PR_SOURCE_BRANCH

public static final String PR_SOURCE_BRANCH

See Also:

• Constant Field Values

PR_TARGET_BRANCH

public static final String PR_TARGET_BRANCH

See Also:

• Constant Field Values

PR_SOURCE_FORK_OWNER

public static final String PR_SOURCE_FORK_OWNER

See Also:

• Constant Field Values

PR_SOURCE_FORK_REPOSITORY

public static final String PR_SOURCE_FORK_REPOSITORY

See Also:

• Constant Field Values

DEPLOY_PREFIX

public static final String DEPLOY_PREFIX

See Also:

• Constant Field Values

DEPLOYMENT_PROJECT

public static final String DEPLOYMENT_PROJECT

See Also:

• Constant Field Values

ENVIRONMENT

public static final String ENVIRONMENT

See Also:

• Constant Field Values

DEPLOYMENT_RELEASE

public static final String DEPLOYMENT_RELEASE

See Also:

• Constant Field Values

DEPLOYMENT_PREVIOUS_RELEASE

public static final String DEPLOYMENT_PREVIOUS_RELEASE

See Also:

• Constant Field Values

WEBHOOK_TEMPLATE_ID

public static final String WEBHOOK_TEMPLATE_ID

See Also:

• Constant Field Values

WEBHOOK_TEMPLATE_NAME

public static final String WEBHOOK_TEMPLATE_NAME

See Also:

• Constant Field Values

WEBHOOK_TIMESTAMP

public static final String WEBHOOK_TIMESTAMP

See Also:

• Constant Field Values

WEBHOOK_NOTIFICATION_DESCRIPTION

public static final String WEBHOOK_NOTIFICATION_DESCRIPTION

See Also:

• Constant Field Values

WEBHOOK_UUID

public static final String WEBHOOK_UUID

See Also:

• Constant Field Values

ENVIRONMENT_ID

public static final String ENVIRONMENT_ID

See Also:

• Constant Field Values

ENVIRONMENT_NAME

public static final String ENVIRONMENT_NAME

See Also:

• Constant Field Values

DEPLOYMENT_PROJECT_ID

public static final String DEPLOYMENT_PROJECT_ID

See Also:

• Constant Field Values

DEPLOYMENT_VERSION_ID

public static final String DEPLOYMENT_VERSION_ID

See Also:

• Constant Field Values

DEPLOYMENT_RESULT_ID

public static final String DEPLOYMENT_RESULT_ID

See Also:

• Constant Field Values

STARTED_DATE

public static final String STARTED_DATE

See Also:

• Constant Field Values

QUEUED_DATE

public static final String QUEUED_DATE

See Also:

• Constant Field Values

FINISHED_DATE

public static final String FINISHED_DATE

See Also:

• Constant Field Values

TRIGGER_REASON

public static final String TRIGGER_REASON

See Also:

• Constant Field Values

TRIGGER_SENTENCE

public static final String TRIGGER_SENTENCE

See Also:

• Constant Field Values

DEPLOYMENT_VERSION

@Deprecated
public static final String DEPLOYMENT_VERSION

Deprecated.

since 5.1

See Also:

• Constant Field Values

DEPLOYMENT_VERSION_NAME

@Deprecated
public static final String DEPLOYMENT_VERSION_NAME

Deprecated.

since 5.1

See Also:

• Constant Field Values

DEPLOYMENT_PREVIOUS_VERSION

@Deprecated
public static final String DEPLOYMENT_PREVIOUS_VERSION

Deprecated.

since 5.1

See Also:

• Constant Field Values

IS_ROLLBACK

public static final String IS_ROLLBACK

See Also:

• Constant Field Values

SIMPLE_BUILD_TIMESTAMP

public static final String SIMPLE_BUILD_TIMESTAMP

See Also:

• Constant Field Values

Method Details

addVariableContext

public static void addVariableContext(@NotNull
 @NotNull Map<String,VariableDefinitionContext> variables,
 @NotNull
 @NotNull String key,
 @Nullable
 @Nullable String value,
 @NotNull
 @NotNull VariableType variableType)

Helper function adding VariableDefinitionContext to a map that can later be used during variable substitution.

Parameters:

variables -

key -

value -

variableType -

createRepositoryVariables

public static void createRepositoryVariables(@NotNull
 @NotNull Map<String,VariableDefinitionContext> variables,
 @NotNull
 @NotNull ResultsSummary resultsSummary,
 @NotNull
 @NotNull VariableType variableType,
 @NotNull
 @NotNull RepositoryDefinitionManager repositoryDefinitionManager,
 @NotNull
 @NotNull VcsRepositoryManager vcsRepositoryManager)

createRepositoryVariables

public static void createRepositoryVariables(@NotNull
 @NotNull Map<String,VariableDefinitionContext> variables,
 @NotNull
 @NotNull List<PlanRepositoryDefinition> repositoryDefinitions,
 @NotNull
 @NotNull BuildChanges buildChanges,
 @NotNull
 @NotNull VariableType variableType,
 @NotNull
 @NotNull VcsRepositoryManager vcsRepositoryManager)