com.atlassian.bamboo.utils
Class SystemProperty

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

public class SystemProperty
extends java.lang.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)

Field Summary

static SystemProperty	ALLOW_UNSUPPORTED_DB Whether the user can select an unsupported database or not.
static SystemProperty	ANT_HOME Location of ANT
static SystemProperty	BAMBOO_HOME_FROM_ENV Location of Bamboo Home
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	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	DISABLE_AGENT_AUTO_CAPABILITY_DETECTION Prevents agents from automatically overriding remote agent capabilities on new startup
static SystemProperty	EC2_IGNORE_CERT_CHECK Allow EC2 agents to ignore invalid certificates, if not using the tunnel
static SystemProperty	EC2_TUNNEL_ENABLED Whether to enable Tunnel for http traffic two and from the agents.
static SystemProperty	ELASTIC_IMAGE_AMI_ID Lets you over ride the default elastic images used
static SystemProperty	ENABLE_CHAINS Whether chains functionality should be shown in the app
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	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_FORM_MANUAL_STRATEGY Fire initial build automatically for manual build strategy on build creation
static SystemProperty	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 int	NUMBER_OF_CONCURRENT_BUILDS Whenever concurrent builds should be enabled and number of concurrent builds allowed
static SystemProperty	PATH The system PATH variable.
static boolean	PATH_SET_ALLOWED Whenever arbitrary path for export and backup allowed
static SystemProperty	SEARCH_BUILD_SUCCESS_FAIL_MESSAGE_EVERYWHERE A workaround for BAM-4069, allows us to search for build successful/failed messages.
static SystemProperty	SVN_14_COMPATIBLE Deprecated. Use SVN_WC_FORMAT instead default : false
static SystemProperty	SVN_SPOOL_TO_FILE SVN client to use temporary file for spooling repository files
static SystemProperty	SVN_WC_FORMAT Default format of SVN workspaces

Constructor Summary

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

Method Summary

boolean	exists()
protected static java.lang.String	getEnvironmentVariable(java.lang.String variable, boolean mandatory) Obtain the specified environment variable.
java.lang.String	getKey() Obtain the key used to find this property
java.lang.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)
java.lang.String	getValue(java.lang.String defaultValue) Obtain the value of the property (returns the default value if the enviroment variable has not been defined.
void	setValue(java.lang.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_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_14_COMPATIBLE

public static final SystemProperty SVN_14_COMPATIBLE

Deprecated. Use SVN_WC_FORMAT instead default : false

Bamboo will check out subversion code in 1.4 format rather than 1.5

SVN_WC_FORMAT

public static final SystemProperty SVN_WC_FORMAT

Default format of SVN workspaces

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

LOG_LINES_FOR_NOTIFICATIONS

public static final SystemProperty 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

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_TUNNEL_ENABLED

public static final SystemProperty EC2_TUNNEL_ENABLED

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

• Default : true
• Usage:
  • env : bamboo.ec2.tunnel.enabled=false
  • java: -Dbamboo.ec2.tunnel.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_FORM_MANUAL_STRATEGY

public static final SystemProperty FIRE_INITAL_BUILD_FORM_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"

ENABLE_CHAINS

public static final SystemProperty ENABLE_CHAINS

Whether chains functionality should be shown in the app

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

NUMBER_OF_CONCURRENT_BUILDS

public static final int NUMBER_OF_CONCURRENT_BUILDS

Whenever concurrent builds should be enabled and number of concurrent builds allowed

• Default : 1 (concurrent builds disabled)
• Usage:
  • env : bamboo.concurrent.builds.number=number
  • java: -Dbamboo.concurrent.builds.number=number

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

Constructor Detail

SystemProperty

public SystemProperty(boolean mandatory,
                      java.lang.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(java.lang.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

public java.lang.String getValue()

Obtain the value of this proprty

Returns:

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

getKey

public java.lang.String getKey()

Obtain the key used to find this property

Returns:

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

getValue

public java.lang.String getValue(java.lang.String defaultValue)

Obtain the value of the property (returns the default value if the enviroment 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 java.lang.String getEnvironmentVariable(@NotNull
                                                                  java.lang.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(java.lang.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)