com.atlassian.bamboo.utils
Class SystemProperty

java.lang.Object
  com.atlassian.bamboo.utils.SystemProperty

Direct Known Subclasses:

SystemProperty.BooleanSystemProperty, SystemProperty.IntegerSystemProperty

public class SystemProperty
extends Object

This class represents system properties as constants. The system / environmental constants resolution order goes:

1. System.getProperty (so any -Dproperty=hello will take precedent)
2. System.getenv() (works only on JDK 1.5)
3. Ant's Execute.getProcEnvironment() (should work for all JDKs)

Nested Class Summary

static class	SystemProperty.BooleanSystemProperty
static class	SystemProperty.IntegerSystemProperty

Field Summary

static SystemProperty.BooleanSystemProperty	AGENT_QUEUE_OFFLOADING_ENABLED Enables offloading of agent queue to disk.
static SystemProperty.BooleanSystemProperty	ALLOW_MUTATIVE_GET_IN_STRICT_XSRF_MODE
static SystemProperty	ALLOW_UNSUPPORTED_DB Whether the user can select an unsupported database or not.
static SystemProperty	ANT_HOME Location of ANT
static SystemProperty	ARTIFACT_COMPRESSION_DARK_FEATURE Makes artifacts and logs compression tied to the global compression configuration.
static SystemProperty	ARTIFACT_HANDLER_DARK_FEATURE Turns on the artifact handler UI.
static SystemProperty	ARTIFACT_SIZE_LIMIT_PER_BUILD
static SystemProperty	ATLASSIAN_DEV_MODE
static SystemProperty	BAMBOO_DELETION_ENABLED If this is set to 'false' then the background deletion service will not delete objects within Bamboo that are ImmutableDeletable.isMarkedForDeletion() This is only useful for support purposes
static SystemProperty	BAMBOO_FREEMARKER_DEBUG Unlocks different aspects of Freemarker debug output: - output template names as html comments (BAM-8006)
static SystemProperty	BAMBOO_HOME_FROM_ENV Location of Bamboo Home
static String	BAMBOO_HOME_PROPERTY_NAME
static SystemProperty	BAMBOO_HOSTED_MODE Executes Bamboo in hosted mode
static SystemProperty	BAMBOO_HOSTED_TEST_MODE Executes Bamboo in hosted mode for functional tests
static SystemProperty.BooleanSystemProperty	BAMBOO_IGNORE_SERVER_STATE_ON_RESTART
static SystemProperty	BAMBOO_MAX_AGENTS_LOADING Specifies the maximum amount of remote agents able to load at one time
static SystemProperty	BAMBOO_RELOAD_AGENT_CLASSPATH When set causes the classpath.zip of the Jar Remote class loader to be reset for each agent startup
static SystemProperty	BAMBOO_REQUEST_PROFILING
static SystemProperty	BUILD_FAILED_MARKER Text the builders will look for when checking for build failure, currently only used by ant builder
static SystemProperty	BUILD_PARENT_JAVA_IO_TMPDIR Parent directory for temporary directories created for builds.
static SystemProperty	BUILD_RESULTS_CACHE_SIZE Make the buildresults cache configurable
static SystemProperty	BUILD_SUCCESSFUL_MARKER Text the builders will look for when checking for build success.
static SystemProperty	BUILDING_DISABLED Disable building plans globally in Bamboo
static SystemProperty.BooleanSystemProperty	CREATE_BRANCHES_FOR_PULL_REQUESTS_ENABLED Is automatic creation of plan branches for Stash pull requests enabled.
static SystemProperty	CVS_CHECKOUT_FORMAT CVS checkout format, the default behavior is to checkout in BINARY format, although this can be overidden with either TEXT or NONE
static SystemProperty	CVS_FORCE_CHECKOUT_TO_LATEST A flag that forces Bamboo's CVS repository to checkout to the latest of that particular branch / HEAD, rather than using the -d flag, which seems to have compatibility issues in some cases.
static int	CVS_SOCKET_TIMEOUT_MS A socket level timeout in milli-seconds for all CVS connections.
static SystemProperty	CVS_TIME_DIFF The CVS Server's time offset in minutes if different to Bamboo Server
static SystemProperty	DEFAULT_CVS_ROOT Default CVS Root (CVS server!)
static SystemProperty	DEFAULT_P4_EXE Default Perforce p4 executable
static SystemProperty	DEFAULT_PERFORCE_CLIENT Default Perforce Client
static SystemProperty	DEFAULT_PERFORCE_PORT Default Perforce Port (Perforce server!)
static SystemProperty	DEFAULT_PERFORCE_USER Default Perforce User
static SystemProperty	DIRECTORY_SCANNING_PLUGIN_SCAN_DIR An optional directory to attempt to load additional plugins from.
static SystemProperty	DISABLE_AGENT_AUTO_CAPABILITY_DETECTION Prevents agents from automatically overriding remote agent capabilities on new startup
static SystemProperty	DISABLE_BRANCH_DETECTION
static SystemProperty	DISABLE_CLOSED_BRANCH_DETECTION
static SystemProperty.BooleanSystemProperty	DISABLE_STASH_BUILD_STATUS_UPDATES Globally disable sending build status updates to Stash after builds are executed.
static SystemProperty	EC2_AGENT_ENDPOINT You can override the EC2 agent endpoint here, it will be used instead of the base URL.
static SystemProperty.BooleanSystemProperty	EC2_HTTP_TUNNEL_ENABLED Whether to enable Tunnel for http traffic to and from the agents.
static SystemProperty	EC2_IGNORE_CERT_CHECK Allow EC2 agents to ignore invalid certificates, if not using the tunnel
static SystemProperty.BooleanSystemProperty	EC2_JMS_TUNNEL_ENABLED Whether to enable Tunnel for http and JMS traffic to and from the agents.
static SystemProperty	EC2_TUNNEL_ENABLED Deprecated. since 5.6 use EC2_HTTP_TUNNEL_ENABLED instead.
static SystemProperty	ELASTIC_AGENT_LOG_AWS_ID If it is set to a valid AWS id, it will be used to authenticate to S3 and copy logs there upon shutdown Default : empty Usage: env : bamboo.ec2.agentLogAwsId=XXXXXXX java: -Dbamboo.ec2.agentLogAwsId=XXXXXXX
static SystemProperty	ELASTIC_AGENT_LOG_AWS_SECRET If it is set to a valid AWS id, it will be used to authenticate to S3 and copy logs there upon shutdown Default : empty Usage: env : bamboo.ec2.agentLogSecret=XXXXXXX java: -Dbamboo.ec2.agentLogSecret=XXXXXXX
static SystemProperty	ELASTIC_IMAGE_AMI_ID Lets you over ride the default elastic images used
static SystemProperty.BooleanSystemProperty	ENABLE_JMS_OVER_HTTP
static SystemProperty.BooleanSystemProperty	ENABLE_REMOTE_AGENTS_SHELL When enabled, users with appropriate permissions can access agents through a terminal integrated with Bamboo.
static SystemProperty.BooleanSystemProperty	ENABLE_XML_FACTORY_OVERRIDE When enabled, enables applying the system XML parser workaround (BDEV-7924)
static SystemProperty.BooleanSystemProperty	ENFORCE_POLLING_BRANCH_DETECTION_EVEN_WHEN_REPO_CAN_PUSH_IT Enforce polling branches even for Repository that implements BranchInformationProvider and returns False from BranchInformationProvider.usePollingForBranchDetection()
static SystemProperty	EVENT_MANAGER_CORE_POOL_SIZE Optional property for tuning core pool size in Bamboo Event Manager
static SystemProperty	EVENT_MANAGER_MAXIMUM_POOL_SIZE Optional property for tuning maximum pool size in Bamboo Event Manager
static SystemProperty	EXPORT_WAIT_FOR_SERVER_PAUSE_SLEEP Period between checks of the Server state when export is waiting for the server to pause.
static SystemProperty	EXPORT_WAIT_FOR_SERVER_PAUSE_TIMEOUT Timeout period to wait for running jobs to all be paused before running an export.
static SystemProperty	FILE_UPLOAD_MAXIMUM_SIZE Maximum size of uploaded files in megabytes
static SystemProperty	FILTER_MAVEN_LOG_FOR_DOWNLOAD_STATUS Filter out Maven artifact download progress status message in build log.
static SystemProperty	FIND_SUCCESS_MESSAGE_IN_LAST Number of lines for builders to look back to guarantee build successful.
static SystemProperty	FIRE_INITAL_BUILD_FOR_MANUAL_STRATEGY Fire initial build automatically for manual build strategy on build creation
static SystemProperty.IntegerSystemProperty	FS_TIMESTAMP_RESOLUTION_MS Defines the worst case resolution of times stored on filesystem.
static SystemProperty.BooleanSystemProperty	FUSION_DEPLOYMENTS_SUPPORT_DISABLED Disable sending any Deployments data to Fusion plugin.
static SystemProperty	HG_CHANGE_SET_LIMIT
static SystemProperty	HG_COMMAND_FORCE_DEBUG Whether mercurial plans output more verbose logs from hg commands.
static SystemProperty.BooleanSystemProperty	LIMITED_TIME_QUARANTINE_ENABLED Enables limited time quarantine feature.
static SystemProperty.IntegerSystemProperty	LOG_LINES_FOR_NOTIFICATIONS Lets you control how much information is showed in notifications
static SystemProperty	MAVEN_HOME Location of MAVEN 1
static SystemProperty	MAVEN2_HOME Location of MAVEN 2
static SystemProperty	MAX_VCS_OPERATION_RETRIES Overrides the maximum number of retries for operations that fail.
static SystemProperty	PATH The system PATH variable.
static boolean	PATH_SET_ALLOWED Whenever arbitrary path for export and backup allowed
static SystemProperty	PDL_DARK_FEATURE Turns on the PDL and related stuff
static SystemProperty.BooleanSystemProperty	PERSIST_RUNTIME_STATE Whether Bamboo should persist/restore runtime operations: builds and deployments in progress.
static SystemProperty	PLAN_CONFIG_SIMPLIFIED Turns on new plan config UI (simplified)
static SystemProperty	PLAN_DIRECTORY_INFO_REST
static SystemProperty	PLAN_EXECUTION_DETECTION_THREADS Allows for the pool size for change detection to be modified.
static SystemProperty.BooleanSystemProperty	REMOVE_LABELS_AND_PLANS_FOR_NON_PLAN_ADMIN Disable sending any Deployments data to Fusion plugin.
static SystemProperty	ROTP_ADMIN_SHORTCUTS_DARK_FEATURE Turns on the ROTP admin shortcuts
static SystemProperty	ROTP_DARK_FEATURE Turns on the ROTP header and related stuff
static SystemProperty	ROTP_PROJECT_SHORTCUTS_DARK_FEATURE Turns on the ROTP project shortcuts
static SystemProperty	SEARCH_BUILD_SUCCESS_FAIL_MESSAGE_EVERYWHERE A workaround for BAM-4069, allows us to search for build successful/failed messages.
static SystemProperty	SEND_FILE_NAMES_TO_AGENT If your agent side plugins rely on presence of file names in BuildContext, set this property to true.
static SystemProperty.BooleanSystemProperty	SKIP_BOOT_DELEGATION_OVERRIDES When enabled, skips performing boot delegation workarounds on Bamboo startup
static SystemProperty.IntegerSystemProperty	STASH_REPOSITORY_TRIGGER_POLLING_INTERVAL Polling interval (in seconds) for Stash trigger type.
static SystemProperty.IntegerSystemProperty	STASH_SSH_PORT_NUMBER Default ssh port number for stash server.
static SystemProperty	SVN_CACHE_CREDENTIALS SVN authentication caching
static SystemProperty	SVN_SPOOL_TO_FILE SVN client to use temporary file for spooling repository files
static SystemProperty	SVN_WC_FORMAT Deprecated. since 4.2.1 use AdministrationConfiguration.getRepositorySettings() * * * Default : 1.6 * Usage: env : bamboo.svn.wc.format="String" * java: -Dbamboo.svn.wc.format="String" * *
static SystemProperty	TRIGGERS_ON_ENVIRONMENT_PAGES_DARK_FEATURE Turns on creating and showing triggers on Environment configuration pages

Constructor Summary

	SystemProperty(boolean mandatory, String... properties) Creates an instance containing the value of the given property - logs an error if it cannot be found
protected	SystemProperty(String property, boolean mandatory, org.apache.log4j.Logger log) Used in testing

Method Summary

boolean	exists()
protected static String	getEnvironmentVariable(String variable, boolean mandatory) Obtain the specified environment variable.
String	getKey() Obtain the key used to find this property
String	getValue() Obtain the value of this proprty
boolean	getValue(boolean defaultValue) Obtain the boolean property value
int	getValue(int defaultValue)
long	getValue(long defaultValue)
String	getValue(String defaultValue) Obtain the value of the property (returns the default value if the environment variable has not been defined.
void	setValue(String propertyValue) So the setting can be set by a test

Methods inherited from class java.lang.Object

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

Field Detail

BAMBOO_HOME_PROPERTY_NAME

public static final String BAMBOO_HOME_PROPERTY_NAME

See Also:

Constant Field Values

BAMBOO_HOME_FROM_ENV

public static final SystemProperty BAMBOO_HOME_FROM_ENV

Location of Bamboo Home

• Default :
• Usage:
  • env : BAMBOO_HOME=bamboo-home or bamboo.home=bamboo-home>
  • java: -DBAMBOO_HOME=bamboo-home, -Dbamboo.home=bamboo-home

MAVEN_HOME

public static final SystemProperty MAVEN_HOME

Location of MAVEN 1

• Default :
• Usage:
  • env : MAVEN_HOME=maven1-install
  • java: -DMAVEN_HOME=maven1-install

MAVEN2_HOME

public static final SystemProperty MAVEN2_HOME

Location of MAVEN 2

• Default :
• Usage:
  • env : M2_HOME=maven2-install, MAVEN2_HOME=maven2-install
  • java: -DM2_HOME=maven2-install, -DMAVEN2_HOME=maven2-install

ANT_HOME

public static final SystemProperty ANT_HOME

Location of ANT

• Default :
• Usage:
  • env : ANT_HOME=ant-install
  • java: -DANT_HOME=ant-install

DEFAULT_CVS_ROOT

public static final SystemProperty DEFAULT_CVS_ROOT

Default CVS Root (CVS server!)

• Default :
• Usage:
  • env : CVSROOT=/path/to/cvs-root
  • java: -DCVSROOT=/path/to/cvs-root

DEFAULT_PERFORCE_PORT

public static final SystemProperty DEFAULT_PERFORCE_PORT

Default Perforce Port (Perforce server!)

• Default :
• Usage:
  • env : P4PORT=p4host:port
  • java: -DP4PORT=p4host:port

DEFAULT_PERFORCE_CLIENT

public static final SystemProperty DEFAULT_PERFORCE_CLIENT

Default Perforce Client

• Default :
• Usage:
  • env : P4CLIENT=p4clientname
  • java: -DP4CLIENT=p4clientname

DEFAULT_PERFORCE_USER

public static final SystemProperty DEFAULT_PERFORCE_USER

Default Perforce User

• Default :
• Usage:
  • env : P4USER=p4username
  • java: -DP4USER=p4username

DEFAULT_P4_EXE

public static final SystemProperty DEFAULT_P4_EXE

Default Perforce p4 executable

• Default :
• Usage:
  • env : P4EXE=/path/to/p4exec
  • java: -DP4EXE=/path/to/p4exec

FIND_SUCCESS_MESSAGE_IN_LAST

public static final SystemProperty FIND_SUCCESS_MESSAGE_IN_LAST

Number of lines for builders to look back to guarantee build successful.

• Default : 250
• Usage:
  • env : SUCCESS_MESSAGE_LINES=number
  • java: -DSUCCESS_MESSAGE_LINES=number

BUILD_SUCCESSFUL_MARKER

public static final SystemProperty BUILD_SUCCESSFUL_MARKER

Text the builders will look for when checking for build success.

• Default : BUILD SUCCESS
• Usage:
  • env : atlassian.bamboo.builder.successMarker="String"
  • java: -atlassian.bamboo.builder.successMarker="String"

BUILD_FAILED_MARKER

public static final SystemProperty BUILD_FAILED_MARKER

Text the builders will look for when checking for build failure, currently only used by ant builder

• Default : BUILD FAILED
• Usage:
  • env : atlassian.bamboo.builder.failedMarker="String"
  • java: -Datlassian.bamboo.builder.failedMarker="String"

SEARCH_BUILD_SUCCESS_FAIL_MESSAGE_EVERYWHERE

public static final SystemProperty SEARCH_BUILD_SUCCESS_FAIL_MESSAGE_EVERYWHERE

A workaround for BAM-4069, allows us to search for build successful/failed messages.

• Default : false
• Usage:
  • env : bamboo.build.searchSuccessFailMessageEverywhere="true"
  • java: -Dbamboo.build.searchSuccessFailMessageEverywhere=true

DISABLE_AGENT_AUTO_CAPABILITY_DETECTION

public static final SystemProperty DISABLE_AGENT_AUTO_CAPABILITY_DETECTION

Prevents agents from automatically overriding remote agent capabilities on new startup

• Default : false
• Usage:
  • env : DISABLE_AGENT_AUTO_CAPABILITY_DETECTION="true"
  • java: -DDISABLE_AGENT_AUTO_CAPABILITY_DETECTION=true

SVN_SPOOL_TO_FILE

public static final SystemProperty SVN_SPOOL_TO_FILE

SVN client to use temporary file for spooling repository files

• Default : true
• Usage:
  • env : SVN_SPOOL_TO_FILE="false"
  • java: -DSVN_SPOOL_TO_FILE=false

BUILDING_DISABLED

public static final SystemProperty BUILDING_DISABLED

Disable building plans globally in Bamboo

• Default : false
• Usage:
  • env : atlassian.bamboo.build.disable="true"
  • java: -Datlassian.bamboo.build.disable=true

PATH

public static final SystemProperty PATH

The system PATH variable. Needed so we can append to it

• Default : "" (empty)
• Usage:
  • env : PATH=<$PATH>, Path="String", path="String"
  • java: -DPATH=<$PATH>, -DPath="String", -Dpath="String"

CVS_TIME_DIFF

public static final SystemProperty CVS_TIME_DIFF

The CVS Server's time offset in minutes if different to Bamboo Server

• Default : 0
• Usage:
  • env : atlassian.bamboo.cvsTimeDiff=number
  • java: -Datlassian.bamboo.cvsTimeDiff=number

CVS_CHECKOUT_FORMAT

public static final SystemProperty CVS_CHECKOUT_FORMAT

CVS checkout format, the default behavior is to checkout in BINARY format, although this can be overidden with either TEXT or NONE

See Also:

Issues with CVS

• Default : BINARY
• Usage :
  • env : CVS_CHECKOUT_FORMAT=[TEXT|BINARY|NONE]
  • java: -DCVS_CHECKOUT_FORMAT=[TEXT|BINARY|NONE]

CVS_FORCE_CHECKOUT_TO_LATEST

public static final SystemProperty CVS_FORCE_CHECKOUT_TO_LATEST

A flag that forces Bamboo's CVS repository to checkout to the latest of that particular branch / HEAD, rather than using the -d flag, which seems to have compatibility issues in some cases.

See Also:

BAM-2542

• Default : false
• Usage :
  • env : CVS_FORCE_CHECKOUT_TO_LATEST="true"
  • java: -DCVS_FORCE_CHECKOUT_TO_LATEST="true"

CVS_SOCKET_TIMEOUT_MS

public static final int CVS_SOCKET_TIMEOUT_MS

A socket level timeout in milli-seconds for all CVS connections. The specified value will be set on all Socket.setSoTimeout(int)

• Default : 60000 (1 minute)
• Usage:
  • env : CVS_SOCKET_TIMEOUT_MS=number
  • java: -DCVS_SOCKET_TIMEOUT_MS=number

BUILD_RESULTS_CACHE_SIZE

public static final SystemProperty BUILD_RESULTS_CACHE_SIZE

Make the buildresults cache configurable

• Default : 100
• Usage:
  • env : BUILD_RESULTS_CACHE_SIZE=number
  • java: -DBUILD_RESULTS_CACHE_SIZE=number

FILTER_MAVEN_LOG_FOR_DOWNLOAD_STATUS

public static final SystemProperty FILTER_MAVEN_LOG_FOR_DOWNLOAD_STATUS

Filter out Maven artifact download progress status message in build log.
If set to false all messages from maven are displayed.

• Default : true
• Usage:
  • env : FILTER_MAVEN_LOG_FOR_DOWNLOAD_STATUS="false"
  • java: -DFILTER_MAVEN_LOG_FOR_DOWNLOAD_STATUS=false

SVN_WC_FORMAT

@Deprecated
public static final SystemProperty SVN_WC_FORMAT

Deprecated. since 4.2.1 use AdministrationConfiguration.getRepositorySettings() *

*

*
• Default : 1.6 *
• Usage:
  • env : bamboo.svn.wc.format="String" *
  • java: -Dbamboo.svn.wc.format="String" *
  *

* Default format of SVN workspaces

SVN_CACHE_CREDENTIALS

public static final SystemProperty SVN_CACHE_CREDENTIALS

SVN authentication caching

• Default : 1.5
• Usage:
  • env : bamboo.svn.cache.credentials=true
  • java: -Dbamboo.svn.cache.credentials=true

LOG_LINES_FOR_NOTIFICATIONS

public static final SystemProperty.IntegerSystemProperty LOG_LINES_FOR_NOTIFICATIONS

Lets you control how much information is showed in notifications

• for build completed emails the last x number of error lines will be included
• for build errored emails the first x number of lines of the stack trace will be included
• Default : 100
• Usage:
  • env : bamboo.notifications.logLinesToInclude=number
  • java: -Dbamboo.notifications.logLinesToInclude=number

FS_TIMESTAMP_RESOLUTION_MS

public static final SystemProperty.IntegerSystemProperty FS_TIMESTAMP_RESOLUTION_MS

Defines the worst case resolution of times stored on filesystem. Java provides accesse only to the modification time.

SEND_FILE_NAMES_TO_AGENT

public static final SystemProperty SEND_FILE_NAMES_TO_AGENT

If your agent side plugins rely on presence of file names in BuildContext, set this property to true. Default: false.

ELASTIC_IMAGE_AMI_ID

public static final SystemProperty ELASTIC_IMAGE_AMI_ID

Lets you over ride the default elastic images used

• Default : null
• Usage:
  • env : bamboo.aws.amiId="String"
  • java: -Dbamboo.aws.amiId="String"

EC2_HTTP_TUNNEL_ENABLED

public static final SystemProperty.BooleanSystemProperty EC2_HTTP_TUNNEL_ENABLED

Whether to enable Tunnel for http traffic to and from the agents. Defaults to true

• Default : true
• Usage:
  • env : bamboo.ec2.tunnel.enabled=false
  • java: -Dbamboo.ec2.tunnel.enabled="false"

EC2_TUNNEL_ENABLED

@Deprecated
public static final SystemProperty EC2_TUNNEL_ENABLED

Deprecated. since 5.6 use EC2_HTTP_TUNNEL_ENABLED instead.

EC2_JMS_TUNNEL_ENABLED

public static final SystemProperty.BooleanSystemProperty EC2_JMS_TUNNEL_ENABLED

Whether to enable Tunnel for http and JMS traffic to and from the agents. Defaults to true.

• Default : true
• Usage:
  • env : bamboo.ec2.tunnel.jms.enabled=false
  • java: -Dbamboo.ec2.tunnel.jms.enabled="false"

EC2_IGNORE_CERT_CHECK

public static final SystemProperty EC2_IGNORE_CERT_CHECK

Allow EC2 agents to ignore invalid certificates, if not using the tunnel

• Default : false
• Usage:
  • env : bamboo.ec2.ignoreCertCheck="true"
  • java: -Dbamboo.ec2.ignoreCertCheck=true

FIRE_INITAL_BUILD_FOR_MANUAL_STRATEGY

public static final SystemProperty FIRE_INITAL_BUILD_FOR_MANUAL_STRATEGY

Fire initial build automatically for manual build strategy on build creation

• Default : false
• Usage:
  • env : fire.initial.build.for.manual.strategy=true
  • java: -Dfire.initial.build.for.manual.strategy="true"

ALLOW_UNSUPPORTED_DB

public static final SystemProperty ALLOW_UNSUPPORTED_DB

Whether the user can select an unsupported database or not.

• Default : false
• Usage:
  • env : bamboo.enable.unsupported.db=true
  • java: -Dbamboo.enable.unsupported.db="true"

PATH_SET_ALLOWED

public static final boolean PATH_SET_ALLOWED

Whenever arbitrary path for export and backup allowed

• Default : false (export and backup files created only in Bamboo home)
• Usage:
  • env : bamboo.paths.set.allowed=true
  • java: -Dbamboo.paths.set.allowed=true

BUILD_PARENT_JAVA_IO_TMPDIR

public static final SystemProperty BUILD_PARENT_JAVA_IO_TMPDIR

Parent directory for temporary directories created for builds. Defaults to System.getProperty("java.io.tmpdir")

• Default : empty
• Usage:
  • env : bamboo.build.parent.java.io.tmpdir=String or java.io.tmpdir=String
  • java: -Dbamboo.build.parent.java.io.tmpdir=String or -Djava.io.tmpdir=String

EVENT_MANAGER_CORE_POOL_SIZE

public static final SystemProperty EVENT_MANAGER_CORE_POOL_SIZE

Optional property for tuning core pool size in Bamboo Event Manager

• Default : System - ThreadPoolExecutor.getCorePoolSize()
• Usage:
  • env : bamboo.event.bambooEventManager.corePoolSize=number
  • java: -Dbamboo.event.bambooEventManager.corePoolSize=number

EVENT_MANAGER_MAXIMUM_POOL_SIZE

public static final SystemProperty EVENT_MANAGER_MAXIMUM_POOL_SIZE

Optional property for tuning maximum pool size in Bamboo Event Manager

• Default : System - ThreadPoolExecutor.getMaximumPoolSize()
• Usage:
  • env : bamboo.event.bambooEventManager.maximumPoolSize=number
  • java: -Dbamboo.event.bambooEventManager.maximumPoolSize=number

HG_COMMAND_FORCE_DEBUG

public static final SystemProperty HG_COMMAND_FORCE_DEBUG

Whether mercurial plans output more verbose logs from hg commands.

• Default : false
• Usage:
  • env : bamboo.hg.debug=true
  • java: -Dbamboo.hg.debug="true"

DIRECTORY_SCANNING_PLUGIN_SCAN_DIR

public static final SystemProperty DIRECTORY_SCANNING_PLUGIN_SCAN_DIR

An optional directory to attempt to load additional plugins from. Must be a directory readable to the process.

• Default :
• Usage:
  • env : atlassian.bamboo.pluginScanDirectory=/path/to/plugin/directory
  • java: -Datlassian.bamboo.pluginScanDirectory="/path/to/plugin/directory"

ELASTIC_AGENT_LOG_AWS_ID

public static final SystemProperty ELASTIC_AGENT_LOG_AWS_ID

If it is set to a valid AWS id, it will be used to authenticate to S3 and copy logs there upon shutdown

• Default : empty
• Usage:
  • env : bamboo.ec2.agentLogAwsId=XXXXXXX
  • java: -Dbamboo.ec2.agentLogAwsId=XXXXXXX

ELASTIC_AGENT_LOG_AWS_SECRET

public static final SystemProperty ELASTIC_AGENT_LOG_AWS_SECRET

If it is set to a valid AWS id, it will be used to authenticate to S3 and copy logs there upon shutdown

• Default : empty
• Usage:
  • env : bamboo.ec2.agentLogSecret=XXXXXXX
  • java: -Dbamboo.ec2.agentLogSecret=XXXXXXX

BAMBOO_DELETION_ENABLED

public static final SystemProperty BAMBOO_DELETION_ENABLED

If this is set to 'false' then the background deletion service will not delete objects within Bamboo that are ImmutableDeletable.isMarkedForDeletion() This is only useful for support purposes

BAMBOO_RELOAD_AGENT_CLASSPATH

public static final SystemProperty BAMBOO_RELOAD_AGENT_CLASSPATH

When set causes the classpath.zip of the Jar Remote class loader to be reset for each agent startup

BAMBOO_MAX_AGENTS_LOADING

public static final SystemProperty BAMBOO_MAX_AGENTS_LOADING

Specifies the maximum amount of remote agents able to load at one time

BAMBOO_FREEMARKER_DEBUG

public static final SystemProperty BAMBOO_FREEMARKER_DEBUG

Unlocks different aspects of Freemarker debug output: - output template names as html comments (BAM-8006)

MAX_VCS_OPERATION_RETRIES

public static final SystemProperty MAX_VCS_OPERATION_RETRIES

Overrides the maximum number of retries for operations that fail. bamboo.vcs.retries

PLAN_EXECUTION_DETECTION_THREADS

public static final SystemProperty PLAN_EXECUTION_DETECTION_THREADS

Allows for the pool size for change detection to be modified.

ARTIFACT_HANDLER_DARK_FEATURE

public static final SystemProperty ARTIFACT_HANDLER_DARK_FEATURE

Turns on the artifact handler UI.

ARTIFACT_COMPRESSION_DARK_FEATURE

public static final SystemProperty ARTIFACT_COMPRESSION_DARK_FEATURE

Makes artifacts and logs compression tied to the global compression configuration.

ROTP_DARK_FEATURE

public static final SystemProperty ROTP_DARK_FEATURE

Turns on the ROTP header and related stuff

ROTP_PROJECT_SHORTCUTS_DARK_FEATURE

public static final SystemProperty ROTP_PROJECT_SHORTCUTS_DARK_FEATURE

Turns on the ROTP project shortcuts

ROTP_ADMIN_SHORTCUTS_DARK_FEATURE

public static final SystemProperty ROTP_ADMIN_SHORTCUTS_DARK_FEATURE

Turns on the ROTP admin shortcuts

PDL_DARK_FEATURE

public static final SystemProperty PDL_DARK_FEATURE

Turns on the PDL and related stuff

TRIGGERS_ON_ENVIRONMENT_PAGES_DARK_FEATURE

public static final SystemProperty TRIGGERS_ON_ENVIRONMENT_PAGES_DARK_FEATURE

Turns on creating and showing triggers on Environment configuration pages

BAMBOO_HOSTED_MODE

public static final SystemProperty BAMBOO_HOSTED_MODE

Executes Bamboo in hosted mode

PLAN_CONFIG_SIMPLIFIED

public static final SystemProperty PLAN_CONFIG_SIMPLIFIED

Turns on new plan config UI (simplified)

BAMBOO_HOSTED_TEST_MODE

public static final SystemProperty BAMBOO_HOSTED_TEST_MODE

Executes Bamboo in hosted mode for functional tests

HG_CHANGE_SET_LIMIT

public static final SystemProperty HG_CHANGE_SET_LIMIT

ARTIFACT_SIZE_LIMIT_PER_BUILD

public static final SystemProperty ARTIFACT_SIZE_LIMIT_PER_BUILD

DISABLE_BRANCH_DETECTION

public static final SystemProperty DISABLE_BRANCH_DETECTION

DISABLE_CLOSED_BRANCH_DETECTION

public static final SystemProperty DISABLE_CLOSED_BRANCH_DETECTION

ATLASSIAN_DEV_MODE

public static final SystemProperty ATLASSIAN_DEV_MODE

BAMBOO_REQUEST_PROFILING

public static final SystemProperty BAMBOO_REQUEST_PROFILING

ALLOW_MUTATIVE_GET_IN_STRICT_XSRF_MODE

public static final SystemProperty.BooleanSystemProperty ALLOW_MUTATIVE_GET_IN_STRICT_XSRF_MODE

EXPORT_WAIT_FOR_SERVER_PAUSE_SLEEP

public static final SystemProperty EXPORT_WAIT_FOR_SERVER_PAUSE_SLEEP

Period between checks of the Server state when export is waiting for the server to pause.

• Default : true
• Usage:
  • env : bamboo.export.wait.for.server.pause.sleep=60000
  • java: -Dbamboo.export.wait.for.server.pause.sleep=60000

EXPORT_WAIT_FOR_SERVER_PAUSE_TIMEOUT

public static final SystemProperty EXPORT_WAIT_FOR_SERVER_PAUSE_TIMEOUT

Timeout period to wait for running jobs to all be paused before running an export.

• Default : true
• Usage:
  • env : bamboo.export.wait.for.server.pause.timeout=3600000
  • java: -Dbamboo.export.wait.for.server.pause.timeout=3600000

EC2_AGENT_ENDPOINT

public static final SystemProperty EC2_AGENT_ENDPOINT

You can override the EC2 agent endpoint here, it will be used instead of the base URL. Unless you know what you're doing, you should use a localhost address of your Bamboo instance. Examples: http://localhost:8085, https://localhost:8085/bamboo, https://127.0.0.1:8085

FILE_UPLOAD_MAXIMUM_SIZE

public static final SystemProperty FILE_UPLOAD_MAXIMUM_SIZE

Maximum size of uploaded files in megabytes

• Default : true
• env : bamboo.file.upload.max.size=50
• java: -Dbamboo.file.upload.max.size=50

BAMBOO_IGNORE_SERVER_STATE_ON_RESTART

public static final SystemProperty.BooleanSystemProperty BAMBOO_IGNORE_SERVER_STATE_ON_RESTART

ENABLE_JMS_OVER_HTTP

public static SystemProperty.BooleanSystemProperty ENABLE_JMS_OVER_HTTP

FUSION_DEPLOYMENTS_SUPPORT_DISABLED

public static SystemProperty.BooleanSystemProperty FUSION_DEPLOYMENTS_SUPPORT_DISABLED

Disable sending any Deployments data to Fusion plugin. Do not use that property directly, use FeatureManager.isFusionDeploymentsSupportEnabled() to check it's value.

STASH_SSH_PORT_NUMBER

public static final SystemProperty.IntegerSystemProperty STASH_SSH_PORT_NUMBER

Default ssh port number for stash server. Temporary, should be exposed by stash

REMOVE_LABELS_AND_PLANS_FOR_NON_PLAN_ADMIN

public static SystemProperty.BooleanSystemProperty REMOVE_LABELS_AND_PLANS_FOR_NON_PLAN_ADMIN

Disable sending any Deployments data to Fusion plugin. Do not use that property directly, use FeatureManager.isFusionDeploymentsSupportEnabled() to check it's value.

DISABLE_STASH_BUILD_STATUS_UPDATES

public static SystemProperty.BooleanSystemProperty DISABLE_STASH_BUILD_STATUS_UPDATES

Globally disable sending build status updates to Stash after builds are executed. Do not use that property directly, use FeatureManager.isUpdatingStashWithBuildStatusEnabled() to check it's value.

ENFORCE_POLLING_BRANCH_DETECTION_EVEN_WHEN_REPO_CAN_PUSH_IT

public static SystemProperty.BooleanSystemProperty ENFORCE_POLLING_BRANCH_DETECTION_EVEN_WHEN_REPO_CAN_PUSH_IT

Enforce polling branches even for Repository that implements BranchInformationProvider and returns False from BranchInformationProvider.usePollingForBranchDetection()

CREATE_BRANCHES_FOR_PULL_REQUESTS_ENABLED

public static SystemProperty.BooleanSystemProperty CREATE_BRANCHES_FOR_PULL_REQUESTS_ENABLED

Is automatic creation of plan branches for Stash pull requests enabled.

STASH_REPOSITORY_TRIGGER_POLLING_INTERVAL

public static SystemProperty.IntegerSystemProperty STASH_REPOSITORY_TRIGGER_POLLING_INTERVAL

Polling interval (in seconds) for Stash trigger type.

If this value is set to greater than 0 Stash triggers will poll the repository for changes in addition to listening for Stash events.

AGENT_QUEUE_OFFLOADING_ENABLED

public static final SystemProperty.BooleanSystemProperty AGENT_QUEUE_OFFLOADING_ENABLED

Enables offloading of agent queue to disk. Use when agents OOM due to the amount of logging/slow link.

ENABLE_REMOTE_AGENTS_SHELL

public static SystemProperty.BooleanSystemProperty ENABLE_REMOTE_AGENTS_SHELL

When enabled, users with appropriate permissions can access agents through a terminal integrated with Bamboo.

LIMITED_TIME_QUARANTINE_ENABLED

public static final SystemProperty.BooleanSystemProperty LIMITED_TIME_QUARANTINE_ENABLED

Enables limited time quarantine feature.

SKIP_BOOT_DELEGATION_OVERRIDES

public static SystemProperty.BooleanSystemProperty SKIP_BOOT_DELEGATION_OVERRIDES

When enabled, skips performing boot delegation workarounds on Bamboo startup

ENABLE_XML_FACTORY_OVERRIDE

public static SystemProperty.BooleanSystemProperty ENABLE_XML_FACTORY_OVERRIDE

When enabled, enables applying the system XML parser workaround (BDEV-7924)

PERSIST_RUNTIME_STATE

public static final SystemProperty.BooleanSystemProperty PERSIST_RUNTIME_STATE

Whether Bamboo should persist/restore runtime operations: builds and deployments in progress. Use this flag to turn seamless restart feature.

• Default : false
• Usage:
  • env : bamboo.darkfeature.persist.runtime.state=true
  • java: -Dbamboo.darkfeature.persist.runtime.state="true"

PLAN_DIRECTORY_INFO_REST

public static final SystemProperty PLAN_DIRECTORY_INFO_REST

Constructor Detail

SystemProperty

public SystemProperty(boolean mandatory,
                      String... properties)

Creates an instance containing the value of the given property - logs an error if it cannot be found

Parameters:

mandatory - Is the property mandatory or optional?

properties - The property we're loading from the environment (first name found will be loaded)

SystemProperty

protected SystemProperty(String property,
                         boolean mandatory,
                         org.apache.log4j.Logger log)

Used in testing

Parameters:

property - The property we're loading from the environment

mandatory - Is the property mandatory or optional?

log - The logger we're logging errors to

Method Detail

getValue

@Nullable
public String getValue()

Obtain the value of this proprty

Returns:

The value (null if the environment variable has not been defined)

getKey

public String getKey()

Obtain the key used to find this property

Returns:

The key (null if environment variable has not been defined)

getValue

@NotNull
public String getValue(@NotNull
                               String defaultValue)

Obtain the value of the property (returns the default value if the environment variable has not been defined.

Parameters:

defaultValue - The default value, if the environment variable has not been defined

Returns:

The value of the property

getValue

public boolean getValue(boolean defaultValue)

Obtain the boolean property value

Parameters:

defaultValue - The default value, if the environment variable has not been defined

Returns:

The value of the property

getEnvironmentVariable

@Nullable
protected static String getEnvironmentVariable(@NotNull
                                                        String variable,
                                                        boolean mandatory)

Obtain the specified environment variable. An error is logged if a mandatory value does not exist.

Parameters:

variable - The variable we require

mandatory - Is this a mandatory property?

Returns:

The value of the variable, null if not found

setValue

public void setValue(String propertyValue)

So the setting can be set by a test

Parameters:

propertyValue - The value required by the test

exists

public boolean exists()

getValue

public int getValue(int defaultValue)

getValue

public long getValue(long defaultValue)