public class PropertyDefs
extends java.lang.Object
Unless otherwise noted in the individual definitions below, properties defined here apply to all protocol implementations.
Unless noted otherwise below, most properties can have an optional short form which is typically just the full form without the cumbersome com.perforce.p4java (etc.) prefix; use of the short form is particularly convenient for passing in properties through the server factory url mechanism, but you have to be careful that there are no system or environment properties with a conflicting name.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AUTH_FILE_LOCK_DELAY_KEY
If this property is set, attempt to use this value as the number of milliseconds
delay for deciding if the auth lock file is new or old based on file time stamp.
|
static java.lang.String |
AUTH_FILE_LOCK_DELAY_KEY_SHORT_FORM
If this property is set, attempt to use this value as the number of milliseconds
delay for deciding if the auth lock file is new or old based on file time stamp.
|
static java.lang.String |
AUTH_FILE_LOCK_TRY_KEY
If this property is set, attempt to use this value as the number of tries
for creating a auth lock file.
|
static java.lang.String |
AUTH_FILE_LOCK_TRY_KEY_SHORT_FORM
If this property is set, attempt to use this value as the number of tries
for creating a auth lock file.
|
static java.lang.String |
AUTH_FILE_LOCK_WAIT_KEY
If this property is set, attempt to use this value as the number of milliseconds
the current thread should wait (pause execution) for the other thread/process
to finish handling the auth lock file.
|
static java.lang.String |
AUTH_FILE_LOCK_WAIT_KEY_SHORT_FORM
If this property is set, attempt to use this value as the number of milliseconds
the current thread should wait (pause execution) for the other thread/process
to finish handling the auth lock file.
|
static java.lang.String |
AUTO_CONNECT_KEY
If AUTO_CONNECT_KEY (or its short form) is set, attempt to
connect with the client name, if the clientName is also set.
|
static java.lang.String |
AUTO_CONNECT_KEY_SHORTFORM
Short form autoconnect key.
|
static java.lang.String |
AUTO_LOGIN_KEY
If AUTO_LOGIN_KEY (or its short form) is set, attempt to perform
a login on connect().
|
static java.lang.String |
AUTO_LOGIN_KEY_SHORTFORM
Short form auto login key.
|
static java.lang.String |
CLIENT_NAME_KEY
Property key for a Perforce client name set though the P4Java properties
mechanism.
|
static java.lang.String |
CLIENT_NAME_KEY_SHORTFORM
Short form client name key.
|
static java.lang.String |
CLIENT_PATH_KEY
Property key for a Perforce client path set though the P4Java properties
mechanism.
|
static java.lang.String |
CLIENT_PATH_KEY_SHORTFORM
Short form client path key.
|
static java.lang.String |
CLIENT_UNSET_NAME_DEFAULT
Default value to be used for the unset client name (see the comments for
CLIENT_UNSET_NAME_KEY, above) when no associated property is set.
|
static java.lang.String |
CLIENT_UNSET_NAME_KEY
Property key for passing in a suitable client name to be used when we
don't actually have (or want) a Perforce client associated with a Perforce
server connection.
|
static java.lang.String |
CUSTOM_SPEC_KEY
If this property is set, allows the configuration of custom specs (undoc).
|
static java.lang.String |
CUSTOM_SPEC_KEY_SHORT_FORM
If this property is set, allows the configuration of custom specs (undoc).
|
static java.lang.String |
DEFAULT_CHARSET_KEY
If DEFAULT_CHARSET_KEY is set in the Java system properties, it defines the
name of the charset used to convert strings to and from the Perforce server
if that server is NOT in Unicode mode.
|
static java.lang.String |
ENABLE_ANDMAPS
If the ENABLE_ANDMAPS property is set (to any value), the server
expands and maps.
|
static java.lang.String |
ENABLE_ANDMAPS_SHORT_FORM
Short form of the ENABLE_ANDMAPS property (below).
|
static java.lang.String |
ENABLE_GRAPH
If the ENABLE_GRAPH property is set (to any value), the server
will reply with graph data as required.
|
static java.lang.String |
ENABLE_GRAPH_SHORT_FORM
Short form of the ENABLE_GRAPH property (below).
|
static java.lang.String |
ENABLE_PROGRESS
If the ENABLE_PROGRESS property is set (to any value), a variable
"progress" will be set to 1 to indicate that the server should send
progress messages to the client if they are available for that command.
|
static java.lang.String |
ENABLE_PROGRESS_SHORT_FORM
Short form of the ENABLE_PROGRESS property (below).
|
static java.lang.String |
ENABLE_STREAMS
If the ENABLE_STREAMS property is set (to any value), the server
enable streams commands.
|
static java.lang.String |
ENABLE_STREAMS_SHORT_FORM
Short form of the ENABLE_STREAMS property (below).
|
static java.lang.String |
ENABLE_TRACKING
If the ENABLE_TRACKING property is set (to any value), the server
performance tracking information will be returned as part of the result
for applicable commands.
|
static java.lang.String |
ENABLE_TRACKING_SHORT_FORM
Short form of the ENABLE_TRACKING property (below).
|
static java.lang.String |
FILESYS_RESTRICTSYMLINKS
FILESYS_UTF8BOM Set to 0 to prevent writing utf8 files BOM, Set to 1 to
write utf8 files with a BOM, Set to 2 to write utf8 BOM only on Windows.
|
static java.lang.String |
FILESYS_RESTRICTSYMLINKS_SHORT_FORM
Short form of the FILESYS_RESTRICTSYMLINKS property (below).
|
static java.lang.String |
FILESYS_UTF8BOM
FILESYS_UTF8BOM Set to 0 to prevent writing utf8 files BOM, Set to 1 to
write utf8 files with a BOM, Set to 2 to write utf8 BOM only on Windows.
|
static java.lang.String |
FILESYS_UTF8BOM_SHORT_FORM
Short form of the FILESYS_UTF8BOM property (below).
|
static java.lang.String |
IGNORE_FILE_NAME_KEY
If this property is set, attempt to use this ignore file name.
|
static java.lang.String |
IGNORE_FILE_NAME_KEY_SHORT_FORM
If this property is set, attempt to use this ignore file name.
|
static java.lang.String |
NON_CHECKED_SYNC
If the NON_CHECKED_SYNC property is set (to any value), syncs and certain
other operations (see below) against 2010.2 or later Perforce servers will not
have integrity checks performed during the operations.
|
static java.lang.String |
NON_CHECKED_SYNC_SHORT_FORM
Short form of the NON_CHECKED_SYNC property (below).
|
static java.lang.String |
P4JAVA_PROP_KEY_PREFIX
The standard default P4Java server properties key prefix.
|
static java.lang.String |
P4JAVA_TMP_DIR_KEY
Property name key for the P4Java API's temporary directory.
|
static java.lang.String |
PASSWORD_KEY
Property key for a Perforce password set though the P4Java properties
mechanism.
|
static java.lang.String |
PASSWORD_KEY_SHORTFORM
Short form password key.
|
static java.lang.String |
PROG_NAME_DEFAULT
Default calling-program name to use if no calling program property is
set with the PROG_NAME_KEY key, above.
|
static java.lang.String |
PROG_NAME_KEY
Properties key for the calling-program name.
|
static java.lang.String |
PROG_NAME_KEY_SHORTFORM
Short form program name key.
|
static java.lang.String |
PROG_VERSION_DEFAULT
Default calling-program version to use if no calling program property is
set with the PROG_VERSION_KEY key, above.
|
static java.lang.String |
PROG_VERSION_KEY
Properties key for the calling-program version.
|
static java.lang.String |
PROG_VERSION_KEY_SHORTFORM
Short form program version key.
|
static java.lang.String |
QUIET_MODE
If the QUIET_MODE property is set (to any value), suppress ALL info-level
output.
|
static java.lang.String |
QUIET_MODE_SHORT_FORM
Short form of the QUIET_MODE property (below).
|
static java.lang.String |
TICKET_PATH_KEY
If this property is set, attempt to use this path as the p4tickets file.
|
static java.lang.String |
TICKET_PATH_KEY_SHORT_FORM
If this property is set, attempt to use this path as the p4tickets file.
|
static java.lang.String |
TRUST_PATH_KEY
If this property is set, attempt to use this path as the p4trust file.
|
static java.lang.String |
TRUST_PATH_KEY_SHORT_FORM
If this property is set, attempt to use this path as the p4trust file.
|
static java.lang.String |
UNICODE_MAPPING
If the UNICODE_MAPPING property is set (to any value), attempt to apply
Perforce specific updates to character mappings in the P4ShiftJIS charset
implementation.
|
static java.lang.String |
UNICODE_MAPPING_SHORT_FORM
Short form of the UNICODE_MAPPING property (below).
|
static java.lang.String |
USE_AUTH_MEMORY_STORE_KEY
If this property is set (to any value), attempt to use memory instead of
file to store auth tickets and fingerprints.
|
static java.lang.String |
USE_AUTH_MEMORY_STORE_KEY_SHORT_FORM
If this property is set (to any value), attempt to use memory instead of
file to store auth tickets and fingerprints.
|
static java.lang.String |
USER_NAME_KEY
Property key for a Perforce user name set though the P4Java properties
mechanism.
|
static java.lang.String |
USER_NAME_KEY_SHORTFORM
Short form user name key.
|
static java.lang.String |
USER_UNSET_NAME_DEFAULT
Default value to be used for the unset user name (see the comments for
USER_UNSET_NAME_KEY, above) when no associated property is set.
|
static java.lang.String |
USER_UNSET_NAME_KEY
Property key for passing in a suitable user name to be used when we
don't actually have (or want) a Perforce user associated with a Perforce
server connection.
|
static java.lang.String |
WRITE_IN_PLACE_KEY
If WRITE_IN_PLACE_KEY is true, certain operations listed below may
write file contents from the Perforce server directly to the target
client file rather than to a temporary file (which is then renamed to
the target file).
|
static java.lang.String |
WRITE_IN_PLACE_SHORT_FORM
Short form of the WRITE_IN_PLACE_KEY, below.
|
Constructor and Description |
---|
PropertyDefs() |
public static final java.lang.String P4JAVA_PROP_KEY_PREFIX
public static final java.lang.String PROG_NAME_KEY_SHORTFORM
public static final java.lang.String PROG_VERSION_KEY_SHORTFORM
public static final java.lang.String PROG_VERSION_KEY
public static final java.lang.String PROG_VERSION_DEFAULT
public static final java.lang.String PROG_NAME_KEY
public static final java.lang.String PROG_NAME_DEFAULT
public static final java.lang.String CLIENT_UNSET_NAME_KEY
public static final java.lang.String CLIENT_UNSET_NAME_DEFAULT
public static final java.lang.String USER_UNSET_NAME_KEY
public static final java.lang.String USER_UNSET_NAME_DEFAULT
public static final java.lang.String P4JAVA_TMP_DIR_KEY
Note that sync operations will sync to temporary files in the enclosing directory of the target file rather than to the default tmp directory if this property is not set; this is so that cross-device copies are not needed at the end of each file sync from tmp to target. If set, however, this property's value will be used for sync ops as well.
public static final java.lang.String USER_NAME_KEY_SHORTFORM
public static final java.lang.String USER_NAME_KEY
public static final java.lang.String PASSWORD_KEY_SHORTFORM
public static final java.lang.String PASSWORD_KEY
public static final java.lang.String CLIENT_NAME_KEY_SHORTFORM
public static final java.lang.String CLIENT_NAME_KEY
public static final java.lang.String CLIENT_PATH_KEY_SHORTFORM
public static final java.lang.String CLIENT_PATH_KEY
public static final java.lang.String AUTO_CONNECT_KEY_SHORTFORM
public static final java.lang.String AUTO_CONNECT_KEY
public static final java.lang.String AUTO_LOGIN_KEY_SHORTFORM
public static final java.lang.String AUTO_LOGIN_KEY
public static final java.lang.String TICKET_PATH_KEY_SHORT_FORM
public static final java.lang.String TICKET_PATH_KEY
public static final java.lang.String DEFAULT_CHARSET_KEY
If this property is not set at P4Java load time, the default charset name is the current JVM default charset name if not null.
Note that this value has no effect whatever when running against a non-Unicode Perforce server.
Note also that this property has no short form.
public static final java.lang.String WRITE_IN_PLACE_SHORT_FORM
public static final java.lang.String WRITE_IN_PLACE_KEY
In general, this property should not be used unless you're on a Windows box and seeing performance issues with sync operations; even then it's probably best to consult with a Perforce support person before trying it, as this property has been introduced as a workaround to a known Java bug with file renaming on JDK 6 and earlier VMs on Windows boxes, and may not be an optimal solution for everyone. Known side-effects (besides performance) may include partial file content syncs in cases where network errors occur, but this is very rare and will not result in server-side data loss or corruption (in fact it's yet to be observed at all within Perforce).
Currently only the sync command honors this property.
public static final java.lang.String NON_CHECKED_SYNC_SHORT_FORM
public static final java.lang.String NON_CHECKED_SYNC
By default, for 2010.2 and later servers, the integrity checks are performed on the client for sync, revert, unshelve, and integ operations, and on the server for submit and shelve. Note that this feature can also be disabled on the server side (see the Perforce admin command for details).
public static final java.lang.String ENABLE_TRACKING_SHORT_FORM
public static final java.lang.String ENABLE_TRACKING
Note that using "-Ztrack" users will have to handle tracking information return from the lower level "raw" IServer.exec* methods.
public static final java.lang.String ENABLE_STREAMS_SHORT_FORM
public static final java.lang.String ENABLE_STREAMS
public static final java.lang.String ENABLE_ANDMAPS_SHORT_FORM
public static final java.lang.String ENABLE_ANDMAPS
public static final java.lang.String ENABLE_GRAPH_SHORT_FORM
public static final java.lang.String ENABLE_GRAPH
public static final java.lang.String FILESYS_RESTRICTSYMLINKS_SHORT_FORM
public static final java.lang.String FILESYS_RESTRICTSYMLINKS
public static final java.lang.String FILESYS_UTF8BOM_SHORT_FORM
public static final java.lang.String FILESYS_UTF8BOM
public static final java.lang.String ENABLE_PROGRESS_SHORT_FORM
public static final java.lang.String ENABLE_PROGRESS
Note that the progress indicator (p4 -I <command>)
flag makes sense to be
used with P4Java's lower level "raw" IServer.execStreamingMapCommand()
method. This streaming method takes a callback handler and continuously
report progress (in a result map) during the lifetime of a command.
public static final java.lang.String QUIET_MODE_SHORT_FORM
public static final java.lang.String QUIET_MODE
public static final java.lang.String IGNORE_FILE_NAME_KEY_SHORT_FORM
public static final java.lang.String IGNORE_FILE_NAME_KEY
public static final java.lang.String TRUST_PATH_KEY_SHORT_FORM
public static final java.lang.String TRUST_PATH_KEY
public static final java.lang.String USE_AUTH_MEMORY_STORE_KEY_SHORT_FORM
public static final java.lang.String USE_AUTH_MEMORY_STORE_KEY
public static final java.lang.String UNICODE_MAPPING_SHORT_FORM
public static final java.lang.String UNICODE_MAPPING
public static final java.lang.String AUTH_FILE_LOCK_TRY_KEY_SHORT_FORM
public static final java.lang.String AUTH_FILE_LOCK_TRY_KEY
public static final java.lang.String AUTH_FILE_LOCK_DELAY_KEY_SHORT_FORM
public static final java.lang.String AUTH_FILE_LOCK_DELAY_KEY
public static final java.lang.String AUTH_FILE_LOCK_WAIT_KEY_SHORT_FORM
public static final java.lang.String AUTH_FILE_LOCK_WAIT_KEY
public static final java.lang.String CUSTOM_SPEC_KEY_SHORT_FORM
public static final java.lang.String CUSTOM_SPEC_KEY