com.starteam
Class ConfigFiles

java.lang.Object
  com.starteam.ConfigFiles

public final class ConfigFiles
extends java.lang.Object

All client stored configuration file locations for StarTeam can be found using this class.

Method Summary

static java.io.File	getConnectionManagerPath() Gets the full path to the ConnectionManager file.
static java.io.File	getDefaultCentralStatusDirectory() Returns the default location of the client's local directory for storing centralized status information.
static java.io.File	getNonWindowsConfig() Returns the default location of the client's configuration settings for non-Windows platforms.
static java.io.File	getServerList() Gets the default location of the client's "StarTeam-Servers.xml" file.
static java.io.File	getStarTeamXML() Returns the default location of the client's "StarTeam.xml" file.
static java.io.File	getViewCompareMergeRootDir() Gets the full path to the View Compare/Merge root folder.

Methods inherited from class java.lang.Object

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

Method Detail

getServerList

public static java.io.File getServerList()
                                  throws java.io.IOException

Gets the default location of the client's "StarTeam-Servers.xml" file. This file contains a list of StarTeam Server names, with connection information for each server.

On Windows platforms, the file is located in a user-specific application folder: for example, "C:\Documents and Settings\UserName\Application Data\Borland\StarTeam".

On non-windows platforms, the file is located in the ".starteam-client" sub-directory of the user's home directory. (Older installations use the ".starbase" sub-directory.)

Returns:

The default location of the client's "starteam-servers.xml" file.

Throws:

java.io.IOException

getStarTeamXML

public static java.io.File getStarTeamXML()
                                   throws java.io.IOException

Returns the default location of the client's "StarTeam.xml" file. This file contains GUI settings and view and folder working directory overrides.

On Windows platforms, the file is located in a user-specific application folder: for example, "C:\Documents and Settings\UserName\Application Data\Borland\StarTeam".

On non-windows platforms, the file is located in the ".starteam-client" subdirectory of the user's home directory. (Older installations use the ".starbase" subdirectory.)

Returns:

The default location of the client's "StarTeam.xml" file.

Throws:

java.io.IOException

getDefaultCentralStatusDirectory

public static java.io.File getDefaultCentralStatusDirectory()
                                                     throws java.io.IOException

Returns the default location of the client's local directory for storing centralized status information.

On Windows platforms, the file is located in a user-specific application folder: for example, "C:\Documents and Settings\UserName\Local Settings\Application Data\Borland\StarTeam\syncdb". (Older installations use "...\Application Data\Starbase\syncdb".)

On non-windows platforms, the file is located in the ".starteam-client/syncdb" subdirectory of the user's home directory. (Older installations use the ".starbase/syncdb" subdirectory.)

Returns:

The default location of the client's centralized status directory

Throws:

java.io.IOException

getConnectionManagerPath

public static java.io.File getConnectionManagerPath()

Gets the full path to the ConnectionManager file.

On Windows platforms, the file is located in a global application folder: for example, "C:\Documents and Settings\All Users\Application Data\Borland\StarTeam".

On non-windows platforms, the ConnectionManager file is unused. In this case, getConnectionManager() returns null.

Returns:

The full path to ConnectionManager, or null on non-Windows platforms.

See Also:

Platform.isWin32()

getNonWindowsConfig

public static java.io.File getNonWindowsConfig()
                                        throws java.io.IOException

Returns the default location of the client's configuration settings for non-Windows platforms. (This file is not used by the SDK on Windows.)

The name of the configuration file is "platform.ini", located in the ".starteam-client" subdirectory of the user's home directory. (Older installations use the ".starteam" file in ".starbase" subdirectory. Calling this method will copy the new platform.ini from the old location if the new one does not already exist.)

Throws:

java.io.IOException

getViewCompareMergeRootDir

public static java.io.File getViewCompareMergeRootDir()
                                               throws java.io.IOException

Gets the full path to the View Compare/Merge root folder. This is where View Compare/Merge stores its intermediate files.

Returns:

the full path to the View Compare/Merge root folder.

Throws:

java.io.IOException