com.atlassian.bamboo.fileserver
Class SystemDirectory

java.lang.Object
  extended by com.atlassian.bamboo.fileserver.SystemDirectory

public class SystemDirectory
extends java.lang.Object

This class provides key system directory info


Field Summary
static java.lang.String BUILD_LOGS_DIRECTORY
           
static java.lang.String BUILD_NUMBER_PREFIX
           
static java.lang.String CACHE_SUB_DIR
           
static java.lang.String DOWNLOAD_DIRECTORY
           
static java.lang.String GLOBAL_STORAGE
           
static java.lang.String LOG_FILENAME
           
static java.lang.String LOGS_DIRECTORY
           
static java.lang.String PLUGINS_SUB_DIR
           
 
Method Summary
static java.io.File getApplicationHome()
           
static java.io.File getArtifactDestinationDirectory(PlanKey planKey, java.lang.String version, ArtifactDefinitionContext artifact)
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static java.io.File getArtifactDestinationDirectory(PlanResultKey planResultKey, ArtifactDefinitionContext artifact)
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static java.io.File getArtifactDirectory(Plan plan)
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static java.io.File getArtifactDirectory(Plan plan, int buildNumber)
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static java.io.File getArtifactDirectory(PlanKey planKey)
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static java.io.File getArtifactDirectory(PlanResultKey planResultKey)
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static java.lang.String getArtifactPathSuffix(PlanResultKey planResultKey, ArtifactDefinitionContext artifact)
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static java.io.File getArtifactRootStorageDirectory()
          Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()
static ArtifactStorage getArtifactStorage()
           
static java.io.File getBaseBuildWorkingDirectory()
          This method returns the root directory underneath which the build directories or agent directories are located.
static java.io.File getBuildDataDirectory()
           
static java.io.File getBuildDataDirectory(Key key)
           
static java.io.File getBuildDataDirectory(java.lang.String buildKey)
          Provide a specific builds data directory
static java.lang.String getBuildDirectoryName(int buildNumber)
           
static java.io.File getBuildDownloadDataDirectory(Key key)
          Build a specific plan's download data directory.
static java.io.File getBuildDownloadDataDirectory(java.lang.String buildKey)
          Build a specific build's download data directory.
static java.io.File getBuildLogsDirectory(Key key)
           
static java.io.File getBuildLogsDirectory(java.lang.String buildKey)
           
static java.io.File getBuildResultsDirectory(java.lang.String buildKey)
           
static java.io.File getCacheDirectory()
           
static java.io.File getConfigDirectory()
           
static java.io.File getLogFile()
           
static java.lang.String getLogRelativePath()
           
static java.io.File getPluginCacheDirectory()
           
static java.io.File getPluginDirectory()
           
static void setBuildDirectoryManager(BuildDirectoryManager buildDirectoryManager)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOWNLOAD_DIRECTORY

public static final java.lang.String DOWNLOAD_DIRECTORY
See Also:
Constant Field Values

BUILD_LOGS_DIRECTORY

public static final java.lang.String BUILD_LOGS_DIRECTORY
See Also:
Constant Field Values

BUILD_NUMBER_PREFIX

public static final java.lang.String BUILD_NUMBER_PREFIX
See Also:
Constant Field Values

LOGS_DIRECTORY

public static final java.lang.String LOGS_DIRECTORY
See Also:
Constant Field Values

LOG_FILENAME

public static final java.lang.String LOG_FILENAME
See Also:
Constant Field Values

GLOBAL_STORAGE

public static final java.lang.String GLOBAL_STORAGE
See Also:
Constant Field Values

PLUGINS_SUB_DIR

public static final java.lang.String PLUGINS_SUB_DIR
See Also:
Constant Field Values

CACHE_SUB_DIR

public static final java.lang.String CACHE_SUB_DIR
See Also:
Constant Field Values
Method Detail

getBuildDownloadDataDirectory

public static java.io.File getBuildDownloadDataDirectory(java.lang.String buildKey)
Build a specific build's download data directory.

Parameters:
buildKey - The build's unique key
Returns:
The build's download directory

getBuildDownloadDataDirectory

public static java.io.File getBuildDownloadDataDirectory(Key key)
Build a specific plan's download data directory.

Parameters:
key - The plan's or environments unique key
Returns:
The plan's download directory

getBuildDataDirectory

public static java.io.File getBuildDataDirectory(java.lang.String buildKey)
Provide a specific builds data directory

Parameters:
buildKey - The build's unique key
Returns:
The build's root data directory

getBuildDataDirectory

public static java.io.File getBuildDataDirectory(Key key)

getBuildDataDirectory

public static java.io.File getBuildDataDirectory()

getApplicationHome

public static java.io.File getApplicationHome()

getConfigDirectory

public static java.io.File getConfigDirectory()

getLogRelativePath

public static java.lang.String getLogRelativePath()

getLogFile

public static java.io.File getLogFile()

getPluginDirectory

public static java.io.File getPluginDirectory()

getCacheDirectory

public static java.io.File getCacheDirectory()

getPluginCacheDirectory

public static java.io.File getPluginCacheDirectory()

getBuildResultsDirectory

public static java.io.File getBuildResultsDirectory(java.lang.String buildKey)

getBaseBuildWorkingDirectory

public static java.io.File getBaseBuildWorkingDirectory()
This method returns the root directory underneath which the build directories or agent 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.


getBuildDirectoryName

public static java.lang.String getBuildDirectoryName(int buildNumber)

getBuildLogsDirectory

public static java.io.File getBuildLogsDirectory(java.lang.String buildKey)

getBuildLogsDirectory

public static java.io.File getBuildLogsDirectory(Key key)

getArtifactStorage

@NotNull
public static ArtifactStorage getArtifactStorage()

getArtifactRootStorageDirectory

@Deprecated
public static java.io.File getArtifactRootStorageDirectory()
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


getArtifactDirectory

@Deprecated
public static java.io.File getArtifactDirectory(PlanKey planKey)
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


getArtifactDirectory

@Deprecated
public static java.io.File getArtifactDirectory(Plan plan)
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


getArtifactDirectory

@Deprecated
public static java.io.File getArtifactDirectory(Plan plan,
                                                           int buildNumber)
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


getArtifactDirectory

@Deprecated
public static java.io.File getArtifactDirectory(PlanResultKey planResultKey)
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


getArtifactDestinationDirectory

@Deprecated
public static java.io.File getArtifactDestinationDirectory(PlanResultKey planResultKey,
                                                                      @Nullable
                                                                      ArtifactDefinitionContext artifact)
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


getArtifactDestinationDirectory

@Deprecated
public static java.io.File getArtifactDestinationDirectory(PlanKey planKey,
                                                                      java.lang.String version,
                                                                      @Nullable
                                                                      ArtifactDefinitionContext artifact)
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


getArtifactPathSuffix

@Deprecated
public static java.lang.String getArtifactPathSuffix(PlanResultKey planResultKey,
                                                                @Nullable
                                                                ArtifactDefinitionContext artifact)
Deprecated. since 4.2 use an appropriate method on $SystemDirectory.getArtifactStorage()


setBuildDirectoryManager

public static void setBuildDirectoryManager(BuildDirectoryManager buildDirectoryManager)


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.