com.perforce.p4java
Class PropertyDefs

java.lang.Object
  com.perforce.p4java.PropertyDefs

public class PropertyDefs
extends java.lang.Object

Defines keys and default values for common and useful P4Java-wide properties. Particularly useful for initial properties passed in through the server factory to define things like calling-program name and version, but note that (as individually noted below) some properties defined here must be defined at load time through the system properties or they will have no effect.

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.

Field Summary

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_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	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	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	TICKET_PATH_KEY What is the location of the p4tickets file?
static java.lang.String	TICKET_PATH_KEY_SHORT_FORM What is the location of the p4tickets file?
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.

Constructor Summary

PropertyDefs()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

P4JAVA_PROP_KEY_PREFIX

public static final java.lang.String P4JAVA_PROP_KEY_PREFIX

The standard default P4Java server properties key prefix.

See Also:

Constant Field Values

PROG_NAME_KEY_SHORTFORM

public static final java.lang.String PROG_NAME_KEY_SHORTFORM

Short form program name key.

See Also:

Constant Field Values

PROG_VERSION_KEY_SHORTFORM

public static final java.lang.String PROG_VERSION_KEY_SHORTFORM

Short form program version key.

See Also:

Constant Field Values

PROG_VERSION_KEY

public static final java.lang.String PROG_VERSION_KEY

Properties key for the calling-program version. Usage is intended to be similar to the p4 command lines -zversion flag. If no corresponding property is given, the value defined by PROG_VERSION_DEFAULT below is used.

See Also:

Constant Field Values

PROG_VERSION_DEFAULT

public static final 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.

PROG_NAME_KEY

public static final java.lang.String PROG_NAME_KEY

Properties key for the calling-program name. Usage is intended to be similar to the p4 command lines -zprog flag. If no corresponding property is given, the value defined by PROG_NAME_DEFAULT below is used.

See Also:

Constant Field Values

PROG_NAME_DEFAULT

public static final 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.

See Also:

Constant Field Values

CLIENT_UNSET_NAME_KEY

public static final 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. If no such property is given, the value used defaults to CLIENT_UNSET_NAME_DEFAULT, below.

See Also:

Constant Field Values

CLIENT_UNSET_NAME_DEFAULT

public static final 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.

See Also:

Constant Field Values

P4JAVA_TMP_DIR_KEY

public static final java.lang.String P4JAVA_TMP_DIR_KEY

Property name key for the P4Java API's temporary directory. Unless otherwise noted, this directory will be used for temporary files, and, unless set by this property, it will default to whatever's in the system java.io.tmpdir property.

See Also:

Constant Field Values

USER_NAME_KEY_SHORTFORM

public static final java.lang.String USER_NAME_KEY_SHORTFORM

Short form user name key.

See Also:

Constant Field Values

USER_NAME_KEY

public static final java.lang.String USER_NAME_KEY

Property key for a Perforce user name set though the P4Java properties mechanism. If set, an IServer returned from the server factory will have its user name set to this value.

See Also:

Constant Field Values

PASSWORD_KEY_SHORTFORM

public static final java.lang.String PASSWORD_KEY_SHORTFORM

Short form password key.

See Also:

Constant Field Values

PASSWORD_KEY

public static final java.lang.String PASSWORD_KEY

Property key for a Perforce password set though the P4Java properties mechanism. If set, an IServer returned from the server factory will have its password set to this value.

See Also:

Constant Field Values

CLIENT_NAME_KEY_SHORTFORM

public static final java.lang.String CLIENT_NAME_KEY_SHORTFORM

Short form client name key.

See Also:

Constant Field Values

CLIENT_NAME_KEY

public static final java.lang.String CLIENT_NAME_KEY

Property key for a Perforce client name set though the P4Java properties mechanism. If set, an IServer returned from the server factory will have its client name set to this value.

See Also:

Constant Field Values

AUTO_CONNECT_KEY_SHORTFORM

public static final java.lang.String AUTO_CONNECT_KEY_SHORTFORM

Short form autoconnect key.

See Also:

Constant Field Values

AUTO_CONNECT_KEY

public static final 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. Will be done after any auto logins (see below).

See Also:

Constant Field Values

AUTO_LOGIN_KEY_SHORTFORM

public static final java.lang.String AUTO_LOGIN_KEY_SHORTFORM

Short form auto login key.

See Also:

Constant Field Values

AUTO_LOGIN_KEY

public static final java.lang.String AUTO_LOGIN_KEY

If AUTO_LOGIN_KEY (or its short form) is set, attempt to perform a login on connect(). Will only actually try the login if userName and password are also set through the properties menachnism.

See Also:

Constant Field Values

TICKET_PATH_KEY_SHORT_FORM

public static final java.lang.String TICKET_PATH_KEY_SHORT_FORM

What is the location of the p4tickets file?

See Also:

Constant Field Values

TICKET_PATH_KEY

public static final java.lang.String TICKET_PATH_KEY

What is the location of the p4tickets file?

See Also:

Constant Field Values

DEFAULT_CHARSET_KEY

public static final 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. Note that this property is fundamental and must be set early on, i.e. in the System properties at P4Java startup / load time.

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.

See Also:

Constant Field Values

Constructor Detail

PropertyDefs

public PropertyDefs()