com.atlassian.bamboo.build.fileserver

Interface BuildDirectoryManager

All Known Implementing Classes:

DefaultBuildDirectoryManager, RemoteBuildDirectoryManager

@PublicApi
public interface BuildDirectoryManager

Interface to retrieve various build locations

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BuildDirectoryManager.ServerSideTaskType

Method Summary

Modifier and Type	Method and Description
String	getAgentPathPrefix(ExecutableBuildAgent buildAgent)
File	getApplicationHome() Returns application's/agent's home directory.
File	getBaseBuildWorkingDirectory()
File	getBuildWorkingDirectory(Key key) Returns the working directory for the plan.
Path	getServerSideTaskWorkingDirectory(BuildDirectoryManager.ServerSideTaskType taskType) Returns the directory used by server-side tasks of specific type.
File	getServerSideTaskWorkingDirectory(ResultKey resultKey) Returns the directory used by server-side tasks, e.g.
File	getWorkingDirectoryOfCurrentAgent()

Method Detail

getBuildWorkingDirectory

@NotNull
File getBuildWorkingDirectory(@NotNull
                                       Key key)

Returns the working directory for the plan.

Parameters:

key@return -

getWorkingDirectoryOfCurrentAgent

@Nullable
File getWorkingDirectoryOfCurrentAgent()

getApplicationHome

File getApplicationHome()

Returns application's/agent's home directory.

Returns:

Application's/agent's home directory

getBaseBuildWorkingDirectory

File getBaseBuildWorkingDirectory()

getAgentPathPrefix

String getAgentPathPrefix(ExecutableBuildAgent buildAgent)

getServerSideTaskWorkingDirectory

@NotNull
File getServerSideTaskWorkingDirectory(@NotNull
                                                ResultKey resultKey)

Returns the directory used by server-side tasks, e.g. pre/post build merge and commit

Parameters:

resultKey@return -

Throws:

UnsupportedOperationException - if called on remote agent

Since:

4.0

getServerSideTaskWorkingDirectory

@NotNull
Path getServerSideTaskWorkingDirectory(@NotNull
                                                BuildDirectoryManager.ServerSideTaskType taskType)

Returns the directory used by server-side tasks of specific type.

Parameters:

taskType - @return

Throws:

UnsupportedOperationException - if called on remote agent