jetbrains.buildServer.serverSide
Class ServerPaths

java.lang.Object
  jetbrains.buildServer.serverSide.ServerPaths

public class ServerPaths
extends java.lang.Object

Provides information about TeamCity server working paths locations.

Field Summary

static java.lang.String	GLOBAL_ARTIFACTS_DIRECTORY_NAME
static java.lang.String	ourBackupFolderName
static java.lang.String	ourBuildLogSubfolderName Name of the folder with build logs, inside the system folder.
static java.lang.String	ourConfigFolderName
static java.lang.String	ourLibFolderName
static java.lang.String	ourPersonalChangesSubfolderName Name of the folder with personal changes, inside the system folder.
static java.lang.String	ourPluginsFolderName
static java.lang.String	ourSystemFolderName
static java.lang.String	PLUGIN_DATA_DIRECTORY_NAME

Constructor Summary

ServerPaths()

ServerPaths(java.lang.String rootDir)

ServerPaths(java.lang.String systemDir, java.lang.String configDir, java.lang.String backupDir)

Method Summary

java.io.File	getArtifactsDirectory()
java.lang.String	getBackupDir() Direcory for backup TeamCity data.
java.lang.String	getCachesDir() Returns path to the TeamCity caches directory.
java.lang.String	getConfigDir() Returns path to the TeamCity configuration directory.
java.io.File	getDataDirectory() Returns TeamCity data directory (root for all of the configuration directories).
java.lang.String	getLibDir()
java.io.File	getLogsPath()
java.io.File	getPluginDataDirectory()
java.lang.String	getPluginsDir()
java.lang.String	getSystemDir() Returns path to the TeamCity system directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GLOBAL_ARTIFACTS_DIRECTORY_NAME

public static final java.lang.String GLOBAL_ARTIFACTS_DIRECTORY_NAME

See Also:

Constant Field Values

PLUGIN_DATA_DIRECTORY_NAME

public static final java.lang.String PLUGIN_DATA_DIRECTORY_NAME

See Also:

Constant Field Values

ourSystemFolderName

public static final java.lang.String ourSystemFolderName

See Also:

Constant Field Values

ourConfigFolderName

public static final java.lang.String ourConfigFolderName

See Also:

Constant Field Values

ourBackupFolderName

public static final java.lang.String ourBackupFolderName

See Also:

Constant Field Values

ourLibFolderName

public static final java.lang.String ourLibFolderName

See Also:

Constant Field Values

ourPluginsFolderName

public static final java.lang.String ourPluginsFolderName

See Also:

Constant Field Values

ourBuildLogSubfolderName

public static final java.lang.String ourBuildLogSubfolderName

Name of the folder with build logs, inside the system folder.

See Also:

Constant Field Values

ourPersonalChangesSubfolderName

public static final java.lang.String ourPersonalChangesSubfolderName

Name of the folder with personal changes, inside the system folder.

See Also:

Constant Field Values

Constructor Detail

ServerPaths

public ServerPaths()

ServerPaths

public ServerPaths(java.lang.String systemDir,
                   java.lang.String configDir,
                   java.lang.String backupDir)

ServerPaths

public ServerPaths(java.lang.String rootDir)

Method Detail

getLogsPath

@NotNull
public java.io.File getLogsPath()

getSystemDir

public java.lang.String getSystemDir()

Returns path to the TeamCity system directory. This directory contains build logs, artifacts, HSQLDB database files, and other non-configuration stuff. Usually, this is TEAMCITY_DATA_PATH/system, where TEAMCITY_DATA_PATH is specified as system property teamcity.data.path or environment variable TEAMCITY_DATA_PATH or $HOME/.BuildServer

Returns:

TeamCity system directory

getCachesDir

public java.lang.String getCachesDir()

Returns path to the TeamCity caches directory. Could be used to store caches for plugins or core services.

Returns:

TeamCity caches directory

getConfigDir

public java.lang.String getConfigDir()

Returns path to the TeamCity configuration directory. This directory contains various settings of TeamCity, including description of projects, build configurations, and other settings. Usually, this is TEAMCITY_DATA_PATH/config, where TEAMCITY_DATA_PATH is specified as system property teamcity.data.path or environment variable TEAMCITY_DATA_PATH or $HOME/.BuildServer

Returns:

TeamCity configuration directory

getBackupDir

public java.lang.String getBackupDir()

Direcory for backup TeamCity data.

Returns:

TeamCity backup directory.

getArtifactsDirectory

@NotNull
public java.io.File getArtifactsDirectory()

getPluginDataDirectory

@NotNull
public java.io.File getPluginDataDirectory()

getDataDirectory

@NotNull
public java.io.File getDataDirectory()

Returns TeamCity data directory (root for all of the configuration directories).

Returns:

TeamCity data directory

getLibDir

public java.lang.String getLibDir()

getPluginsDir

public java.lang.String getPluginsDir()