Interface BuildDirectoryManager

All Known Implementing Classes:
DefaultBuildDirectoryManager, RemoteBuildDirectoryManager

@PublicApi public interface BuildDirectoryManager
Interface to retrieve various build locations
  • Method Details

    • 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