Interface BuildDirectoryManager
- All Known Implementing Classes:
DefaultBuildDirectoryManager
,RemoteBuildDirectoryManager
@PublicApi
public interface BuildDirectoryManager
Interface to retrieve various build locations
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetAgentPathPrefix
(ExecutableBuildAgent buildAgent) Returns application's/agent's home directory.@NotNull File
getBuildWorkingDirectory
(@NotNull Key key) Returns the working directory for the plan.@NotNull Path
getServerSideTaskWorkingDirectory
(@NotNull BuildDirectoryManager.ServerSideTaskType taskType) Returns the directory used by server-side tasks of specific type.@NotNull File
getServerSideTaskWorkingDirectory
(@NotNull ResultKey resultKey) Returns the directory used by server-side tasks, e.g.@Nullable File
-
Method Details
-
getBuildWorkingDirectory
Returns the working directory for the plan.- Parameters:
key
-- Returns:
-
getWorkingDirectoryOfCurrentAgent
-
getApplicationHome
File getApplicationHome()Returns application's/agent's home directory.- Returns:
- Application's/agent's home directory
-
getBaseBuildWorkingDirectory
File getBaseBuildWorkingDirectory() -
getAgentPathPrefix
-
getServerSideTaskWorkingDirectory
Returns the directory used by server-side tasks, e.g. pre/post build merge and commit- Parameters:
resultKey
-- Returns:
- Throws:
UnsupportedOperationException
- if called on remote agent- Since:
- 4.0
-
getServerSideTaskWorkingDirectory
@NotNull @NotNull Path getServerSideTaskWorkingDirectory(@NotNull @NotNull BuildDirectoryManager.ServerSideTaskType taskType) Returns the directory used by server-side tasks of specific type.- Parameters:
taskType
-- Returns:
- Throws:
UnsupportedOperationException
- if called on remote agent
-