com.microsoft.tfs.core.config
Class EnvironmentVariables

java.lang.Object
  extended by com.microsoft.tfs.core.config.EnvironmentVariables

public abstract class EnvironmentVariables
extends java.lang.Object

A collection of all the environment variables that control configuration in classes in the com.microsoft.tfs.core.config package.

Thread-safety:
immutable
Since:
TEE-SDK-10.1

Field Summary
static java.lang.String ACCEPT_UNTRUSTED_CERTIFICATES
          When set to any value untrusted SSL certificates will be accepted.
static java.lang.String DISABLE_APPLY_EXECUTABLE_PROP
          When set to any value, files with the property PropertyConstants.EXECUTABLE_KEY will not have the Unix execute bit set when they are written to working folders during operations like get, pend, undo, or unshelve.
static java.lang.String DISABLE_DETECT_EXECUTABLE_PROP
          When set to any value, the automatic pend of property PropertyConstants.EXECUTABLE_KEY for files with the Unix execute bit is skipped when local workspaces are scanned.
static java.lang.String MAX_CHUNK_RETRY_ATTEMPTS
          When set to an integer positive value defines the maximum number of attempts to upload a chunk of a file before we attempt to retry the entire file.
static java.lang.String MAX_FILE_RETRY_ATTEMPTS
          When set to an integer positive value defines the maximum number of attempts to upload a file before an error is reported to the user.
static java.lang.String OFFLINE_METADATA_ROOT_DIRECTORY
          Overrides the standard calculation used to compute the local workspace metadata root directory ( Workstation#getOfflineMetadataFileRoot()).
static java.lang.String TF_PROXY
          When set to any value, the value of this variable is used as the URL to the Team Foundation Proxy (not the general HTTP proxy).
static java.lang.String UPLOAD_BUFFER_SIZE
          When set to an integer positive value defines the size of a I/O buffer used to read a file during upload.
static java.lang.String UPLOAD_CHUNK_SIZE
          When set to an integer positive value defines the maximum size of a file portion during chunked file upload.
static java.lang.String WORKSTATION_CACHE_DIRECTORY
          Overrides the standard cache file storage directory the Workstation class uses.
static java.lang.String WORKSTATION_CONFIGURATION_DIRECTORY
          Overrides the standard cache file storage directory the Workstation class uses.
 
Constructor Summary
EnvironmentVariables()
           
 
Method Summary
static int getInt(java.lang.String variableName, int defaultValue)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACCEPT_UNTRUSTED_CERTIFICATES

public static final java.lang.String ACCEPT_UNTRUSTED_CERTIFICATES
When set to any value untrusted SSL certificates will be accepted.

Setting this variable reduces security and should only be used if the user understands the risks in disabling server certificate validation.

See Also:
Constant Field Values
Constant Field Value:
"TF_ACCEPT_UNTRUSTED_CERTIFICATES"

UPLOAD_CHUNK_SIZE

public static final java.lang.String UPLOAD_CHUNK_SIZE
When set to an integer positive value defines the maximum size of a file portion during chunked file upload. The value may be specified either - in bytes (e.g 12345678), or - in kilobytes (e.g. 1234K or 1234k), or - in megabytes (e.g. 12M or 12m)

Setting this variable to a value less than 2 disables chunked upload. Files are uploaded with a single HTTP request.

See Also:
Constant Field Values
Constant Field Value:
"TF_UPLOAD_CHUNK_SIZE"

UPLOAD_BUFFER_SIZE

public static final java.lang.String UPLOAD_BUFFER_SIZE
When set to an integer positive value defines the size of a I/O buffer used to read a file during upload. The value may be specified either - in bytes (e.g 12345678), or - in kilobytes (e.g. 1234K or 1234k), or - in megabytes (e.g. 12M or 12m)

See Also:
Constant Field Values
Constant Field Value:
"TF_UPLOAD_BUFFER_SIZE"

MAX_FILE_RETRY_ATTEMPTS

public static final java.lang.String MAX_FILE_RETRY_ATTEMPTS
When set to an integer positive value defines the maximum number of attempts to upload a file before an error is reported to the user.

See Also:
Constant Field Values
Constant Field Value:
"TF_MAX_FILE_RETRY_ATTEMPTS"

MAX_CHUNK_RETRY_ATTEMPTS

public static final java.lang.String MAX_CHUNK_RETRY_ATTEMPTS
When set to an integer positive value defines the maximum number of attempts to upload a chunk of a file before we attempt to retry the entire file.

See Also:
Constant Field Values
Constant Field Value:
"TF_MAX_CHUNK_RETRY_ATTEMPTS"

DISABLE_DETECT_EXECUTABLE_PROP

public static final java.lang.String DISABLE_DETECT_EXECUTABLE_PROP
When set to any value, the automatic pend of property PropertyConstants.EXECUTABLE_KEY for files with the Unix execute bit is skipped when local workspaces are scanned.

Has no affect on non-Unix platforms.

See Also:
Constant Field Values
Constant Field Value:
"TF_DISABLE_DETECT_EXECUTABLE_PROP"

DISABLE_APPLY_EXECUTABLE_PROP

public static final java.lang.String DISABLE_APPLY_EXECUTABLE_PROP
When set to any value, files with the property PropertyConstants.EXECUTABLE_KEY will not have the Unix execute bit set when they are written to working folders during operations like get, pend, undo, or unshelve.

This variable does not prevent the application of the execute bit when specified in a .tpattributes file.

Has no affect on non-Unix platforms.

See Also:
Constant Field Values
Constant Field Value:
"TF_DISABLE_APPLY_EXECUTABLE_PROP"

TF_PROXY

public static final java.lang.String TF_PROXY
When set to any value, the value of this variable is used as the URL to the Team Foundation Proxy (not the general HTTP proxy).

Visual Studio uses the same environment variable for this purpose.

See Also:
Constant Field Values
Constant Field Value:
"TFSPROXY"

WORKSTATION_CACHE_DIRECTORY

public static final java.lang.String WORKSTATION_CACHE_DIRECTORY
Overrides the standard cache file storage directory the Workstation class uses. Does not affect where non- Workstation cache files are placed (see PersistenceStoreProvider).

The Workstation cache directory contains the version control workspace cache file.

Visual Studio uses the same environment variable for this purpose.

See Also:
Constant Field Values
Constant Field Value:
"TFSVC_CACHE_DIR"

WORKSTATION_CONFIGURATION_DIRECTORY

public static final java.lang.String WORKSTATION_CONFIGURATION_DIRECTORY
Overrides the standard cache file storage directory the Workstation class uses. Does not affect where non- Workstation cache files are placed (see PersistenceStoreProvider).

The Workstation configuration directory contains the version control exclusion patterns file.

Visual Studio uses the same environment variable for this purpose.

See Also:
Constant Field Values
Constant Field Value:
"TFSVC_CONFIG_DIR"

OFFLINE_METADATA_ROOT_DIRECTORY

public static final java.lang.String OFFLINE_METADATA_ROOT_DIRECTORY
Overrides the standard calculation used to compute the local workspace metadata root directory ( Workstation#getOfflineMetadataFileRoot()).

Visual Studio uses the same environment variable for this purpose.

See Also:
Constant Field Values
Constant Field Value:
"TFS_OFFLINE_METADATA_ROOT"
Constructor Detail

EnvironmentVariables

public EnvironmentVariables()
Method Detail

getInt

public static int getInt(java.lang.String variableName,
                         int defaultValue)


© 2012 Microsoft. All rights reserved.