Package com.atlassian.bamboo.setup

Interface BootstrapManager

All Superinterfaces:

com.atlassian.config.bootstrap.AtlassianBootstrapManager

All Known Implementing Classes:

DefaultBootstrapManager, MockBootstrapManager, TestBootstrapManager

public interface BootstrapManager
extends com.atlassian.config.bootstrap.AtlassianBootstrapManager

A Bamboo specialisation of the generic AtlassianBootstrapManager.

Field Summary

Fields

Modifier and Type	Field	Description
static String	INSTANCE_FINGERPRINT_PARAM
static String	SERVER_FINGERPRINT_PARAM

Method Summary

Modifier and Type	Method	Description
String	getArtifactsDirectory()	This method returns the root directory underneath which the artifacts are stored.
BambooSharedProperties	getBambooSharedProperties()	Shared home properties (bamboo-shared.cfg.xml)
URI	getBrokerClientURI()
URI	getBrokerURI()
String	getBuildDirectory()	Gets the directory where Bamboo's build files sit.
String	getBuildWorkingDirectory()	This method returns the root directory underneath which the build directories are located.
String	getConfigDirectory()	Gets the directory where Bamboo's administration.xml file sits
@NotNull ServerFingerprint	getFingerprint()
String	getH2VersionFromConfig()
default @Nullable File	getIndexDirectory()	Deprecated. since 8.2 there's no index, returns null
String	getLocalHomePath()	Local home directory;
String	getRepositoryLogsDirectory()
String	getServerID()
int	getServerKey()	Returns server key used for BambooEntityOids of this Bamboo instance.
String	getSharedHomePath()	Shared home directory;
boolean	initializeBuildNumberIfRequired()
boolean	initializeServerKey()	Initializes server key used for BambooEntityOids of this Bamboo instance based on server ID.
boolean	resetH2Version()
void	setArtifactsDirectory(String artifactsDir)
void	setBrokerClientURI(URI brokerURI)
void	setBrokerURI(URI brokerUrl)
void	setBuildDirectory(String buildDirectory)
void	setBuildWorkingDirectory(String buildWorkingDirectory)
void	setConfigDirectory(String configurationDirectory)
void	setH2Version(String h2Version)
void	setRepositoryLogsDirectory(String repositoryLogsDirectory)
void	setServerID(String serverId)
void	setServerKey(int serverKey)	Set server key used for BambooEntityOids for this Bamboo instance.

Methods inherited from interface com.atlassian.config.bootstrap.AtlassianBootstrapManager

bootstrapDatabase, bootstrapDatasource, databaseContainsExistingData, getApplicationConfig, getApplicationHome, getBootstrapFailureReason, getBuildNumber, getConfiguredApplicationHome, getFilePathProperty, getHibernateConfig, getHibernateConfigurator, getHibernateProperties, getOperation, getPropertiesWithPrefix, getProperty, getPropertyKeys, getSetupPersister, getString, getTestDatabaseConnection, getTestDatasourceConnection, init, isApplicationHomeValid, isBootstrapped, isPropertyTrue, isSetupComplete, publishConfiguration, removeProperty, save, setBuildNumber, setHibernateConfigurator, setOperation, setProperty, setSetupComplete

Field Detail

SERVER_FINGERPRINT_PARAM

static final String SERVER_FINGERPRINT_PARAM

See Also:

Constant Field Values

INSTANCE_FINGERPRINT_PARAM

static final String INSTANCE_FINGERPRINT_PARAM

See Also:

Constant Field Values

Method Detail

initializeBuildNumberIfRequired

boolean initializeBuildNumberIfRequired()
                                 throws com.atlassian.config.ConfigurationException

Throws:

com.atlassian.config.ConfigurationException

getConfigDirectory

String getConfigDirectory()

Gets the directory where Bamboo's administration.xml file sits

Returns:

String representing the path to the folder. Null if not configured

setConfigDirectory

void setConfigDirectory(String configurationDirectory)

getBuildDirectory

String getBuildDirectory()

Gets the directory where Bamboo's build files sit. This includes artifacts and the like

Returns:

String representing the path to the folder. Null if not configured

setBuildDirectory

void setBuildDirectory(String buildDirectory)

getBuildWorkingDirectory

String getBuildWorkingDirectory()

This method returns the root directory underneath which the build directories are located. The structure below this directory is not documented - you most likely do not want to use this method, consider using DefaultBuildDirectoryManager methods instead.

setBuildWorkingDirectory

void setBuildWorkingDirectory(String buildWorkingDirectory)

getArtifactsDirectory

String getArtifactsDirectory()

This method returns the root directory underneath which the artifacts are stored. The structure below this directory is not documented - you most likely do not want to use this method, consider using com.atlassian.bamboo.fileserver.SystemDirectory methods instead.

setArtifactsDirectory

void setArtifactsDirectory(String artifactsDir)

getRepositoryLogsDirectory

String getRepositoryLogsDirectory()

Returns:

the root directory underneath which the repositories logs directories are located.

setRepositoryLogsDirectory

void setRepositoryLogsDirectory(String repositoryLogsDirectory)

getIndexDirectory

@Deprecated
@Nullable
default @Nullable File getIndexDirectory()

Deprecated.

since 8.2 there's no index, returns null

getServerID

String getServerID()

setServerID

void setServerID(String serverId)

initializeServerKey

boolean initializeServerKey()

Initializes server key used for BambooEntityOids of this Bamboo instance based on server ID. Does nothing if the server key is already configured. This method should be externally synchronized.

Returns:

true if server key has been initialized, false otherwise

Throws:

IllegalStateException - if the value is not configured and can't be generated, e.g. the server ID has not been set yet.

getServerKey

int getServerKey()

Returns server key used for BambooEntityOids of this Bamboo instance.

Throws:

IllegalStateException - if the value is not configured for this Bamboo instance or is invalid

setServerKey

void setServerKey(int serverKey)

Set server key used for BambooEntityOids for this Bamboo instance.

Parameters:

serverKey - server key of this instance

Throws:

IllegalArgumentException - if the value is incorrect (e.g. is negative)

getBrokerURI

URI getBrokerURI()
          throws URISyntaxException

Throws:

URISyntaxException

setBrokerURI

void setBrokerURI(URI brokerUrl)

getBrokerClientURI

URI getBrokerClientURI()
                throws URISyntaxException

Throws:

URISyntaxException

setBrokerClientURI

void setBrokerClientURI(URI brokerURI)

getFingerprint

@NotNull
@NotNull ServerFingerprint getFingerprint()

Returns:

a unique identifier for this startup

getH2VersionFromConfig

String getH2VersionFromConfig()

resetH2Version

boolean resetH2Version()

setH2Version

void setH2Version(String h2Version)
           throws com.atlassian.config.ConfigurationException

Throws:

com.atlassian.config.ConfigurationException

getLocalHomePath

String getLocalHomePath()

Local home directory;

getSharedHomePath

String getSharedHomePath()

Shared home directory;

getBambooSharedProperties

BambooSharedProperties getBambooSharedProperties()

Shared home properties (bamboo-shared.cfg.xml)

Returns:

BambooSharedProperties