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 Description static class
BuildDirectoryManager.ServerSideTaskType
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAgentPathPrefix(ExecutableBuildAgent buildAgent)
File
getApplicationHome()
Returns application's/agent's home directory.File
getBaseBuildWorkingDirectory()
@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
getWorkingDirectoryOfCurrentAgent()
-
-
-
Method Detail
-
getBuildWorkingDirectory
@NotNull @NotNull File getBuildWorkingDirectory(@NotNull @NotNull Key key)
Returns the working directory for the plan.- Parameters:
key
-- Returns:
-
getWorkingDirectoryOfCurrentAgent
@Nullable @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 @NotNull File getServerSideTaskWorkingDirectory(@NotNull @NotNull ResultKey resultKey)
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
-
-