Top Description Fields
org.apache.derby.shared.common.reference

public Interface Attribute


List of all connection (JDBC) attributes by the system.

This class exists for two reasons

  1. To act as the internal documentation for the attributes.
  2. To remove the need to declare a java static field for the attributes name in the protocol/implementation class. This reduces the footprint as the string is final and thus can be included simply as a String constant pool entry.

This class should not be shipped with the product.

This class has no methods, all it contains are String's which by are public, static and final since they are declared in an interface.

Field Summary

Modifier and TypeField and Description
public static final String
BOOT_PASSWORD

If dataEncryption is true, use this attribute to pass in the secret key.

public static final String
CLIENT_JVM_PROPERTY_PREFIX

User should use this prefix for the client attributes traceLevel and traceDirectory when they are sending those attributes as JVM properties.

public static final String
CLIENT_RETIEVE_MESSAGE_TEXT

retrieveMessageText.

public static final String
CLIENT_SECURITY_MECHANISM

securityMechanism sets the DRDA mechanism in-use for the client.

public static final String
CLIENT_TRACE_APPEND

traceFileAppend.

public static final String
CLIENT_TRACE_DIRECTORY

traceDirectory sets the client side trace directory.

public static final String
CLIENT_TRACE_FILE

traceFile sets the client side trace file.

public static final String
CLIENT_TRACE_LEVEL

traceLevel.

public static final String
COLLATION

Optional JDBC url attribute (at the database create time only) It can be set to one of the following 2 values 1) UCS_BASIC (This means codepoint based collation.

public static final String
CREATE_ATTR

The attribute that is used to request a database create.

public static final String
CREATE_FROM

This attribute is used to request to create a database from backup.

public static final String
CRYPTO_ALGORITHM

Attribute for encrypting a database.

public static final String
CRYPTO_EXTERNAL_KEY

Attribute for encrypting a database.

public static final String
CRYPTO_EXTERNAL_KEY_VERIFY_FILE

One can encrypt the database with an encryption key at create time.

public static final String
CRYPTO_KEY_LENGTH

Attribute for encrypting a database.

public static final String
CRYPTO_PROVIDER

Attribute for encrypting a database.

public static final String
DATA_ENCRYPTION

Attribute name to encrypt the database on disk.

public static final String
DBNAME_ATTR

The attribute that is used for the database name, from the JDBC notion of jdbc:$subprotocol:$subname

public static final String
DECRYPT_DATABASE

Attribute name for decrypting an encrypted database.

public static final String
DEREGISTER_ATTR

The attribute that is to keep autoloading idiom for driver

public static final String
DNC_PROTOCOL

The protocol for Derby Network Client

public static final String
DRDA_SECMEC

Internal attribute which holds the value of the securityMechanism attribute specified by the client.

public static final String
DRDA_SECTKN_IN

Internal attributes.

public static final String
public static final String
DRDAID_ATTR

The attribute that is used to set the connection's DRDA ID.

public static final String
DROP_ATTR

The attribute that is used to request a drop database.

public static final String
JCC_PROTOCOL

The protocol for the IBM Universal JDBC Driver

public static final String
LOG_DEVICE

Put the log on a different device.

public static final String
NEW_BOOT_PASSWORD

The attribute that is used to chage the secret key of an encrypted database.

public static final String
NEW_CRYPTO_EXTERNAL_KEY

The attribute that is used to chage the encryption key of an encrypted database.

public static final String
PASSWORD_ATTR

The attribute that is used to set the user password.

public static final String
PROTOCOL

Not an attribute but the root for the JDBC URL that Derby supports.

public static final String
REPLICATION_FAILOVER

Attribute name to start failover for a given database..

public static final String
REPLICATION_INTERNAL_SHUTDOWN_SLAVE

Attribute name to stop replication slave mode for a database.

public static final String
REPLICATION_SLAVE_HOST

If startMaster is true, this attribute is used to specify the host name the master should connect to.

public static final String
REPLICATION_SLAVE_PORT

If startMaster is true, this attribute is used to specify the port the master should connect to.

public static final String
REPLICATION_START_MASTER

Attribute name to start replication master mode for a database.

public static final String
REPLICATION_START_SLAVE

Attribute name to start replication slave mode for a database.

public static final String
REPLICATION_STOP_MASTER

Attribute name to stop replication master mode for a database.

public static final String
REPLICATION_STOP_SLAVE

Attribute name to stop replication slave mode for a database.

public static final String
RESTORE_FROM

This attribute is used to request a database restore from backup.

public static final String
ROLL_FORWARD_RECOVERY_FROM

The attribute that is used to request a roll-forward recovery of the database.

public static final String
SHUTDOWN_ATTR

The attribute that is used to request a shutdown.

public static final String
SOFT_UPGRADE_NO_FEATURE_CHECK

Internal attribute.

public static final String
SQLJ_NESTED

The SQLJ protocol for getting the default connection for server side jdbc

public static final String
SSL_ATTR

The attribute that is used to set client SSL mode.

public static final String
TERRITORY

Set the territory for the database.

public static final String
UPGRADE_ATTR

The attribute that is used to allow upgrade.

public static final String
USERNAME_ATTR

The attribute that is used to set the user name.

Field Detail

BOOT_PASSWORDback to summary
public static final String BOOT_PASSWORD

If dataEncryption is true, use this attribute to pass in the secret key. The secret key must be at least 8 characters long. This key must not be stored persistently in cleartext anywhere.

CLIENT_JVM_PROPERTY_PREFIXback to summary
public static final String CLIENT_JVM_PROPERTY_PREFIX

User should use this prefix for the client attributes traceLevel and traceDirectory when they are sending those attributes as JVM properties. These 2 attributes can be sent through jdbc url directly (supported way) or as JVM properties with the following prefix (undocumented way). DERBY-1275

CLIENT_RETIEVE_MESSAGE_TEXTback to summary
public static final String CLIENT_RETIEVE_MESSAGE_TEXT

retrieveMessageText. Client driver attribute.

CLIENT_SECURITY_MECHANISMback to summary
public static final String CLIENT_SECURITY_MECHANISM

securityMechanism sets the DRDA mechanism in-use for the client. Internal only.

CLIENT_TRACE_APPENDback to summary
public static final String CLIENT_TRACE_APPEND

traceFileAppend. Client driver attribute.

CLIENT_TRACE_DIRECTORYback to summary
public static final String CLIENT_TRACE_DIRECTORY

traceDirectory sets the client side trace directory. Client driver attribute.

CLIENT_TRACE_FILEback to summary
public static final String CLIENT_TRACE_FILE

traceFile sets the client side trace file. Client driver attribute.

CLIENT_TRACE_LEVELback to summary
public static final String CLIENT_TRACE_LEVEL

traceLevel. Client driver attribute.

COLLATIONback to summary
public static final String COLLATION

Optional JDBC url attribute (at the database create time only) It can be set to one of the following 2 values 1) UCS_BASIC (This means codepoint based collation. This will also be the default collation used by Derby if no collation attribute is specified on the JDBC url at the database create time. This collation is what Derby 10.2 and prior have supported) 2)TERRITORY_BASED (the collation will be based on language region specified by the existing Derby attribute called territory. If the territory attribute is not specified at the database create time, Derby will use java.util.Locale.getDefault to determine the territory for the newly created database.

CREATE_ATTRback to summary
public static final String CREATE_ATTR

The attribute that is used to request a database create.

CREATE_FROMback to summary
public static final String CREATE_FROM

This attribute is used to request to create a database from backup. This will throw error if a database with same already exists at the location where we tring to create.

CRYPTO_ALGORITHMback to summary
public static final String CRYPTO_ALGORITHM

Attribute for encrypting a database. Specifies the cryptographic algorithm.

CRYPTO_EXTERNAL_KEYback to summary
public static final String CRYPTO_EXTERNAL_KEY

Attribute for encrypting a database. Specifies the actual key. When this is specified all the supplied crypto information is stored external to the database, ie by the application.

CRYPTO_EXTERNAL_KEY_VERIFY_FILEback to summary
public static final String CRYPTO_EXTERNAL_KEY_VERIFY_FILE

One can encrypt the database with an encryption key at create time. For security reasons, this key is not made persistent in the database. But it is necessary to verify the encryption key whenever booting the database before we access the data/logs to avoid the risk of corrupting the database because of a wrong encryption key. This attribute refers to the name of the file where encrypted data is stored for verification of encryption key.

CRYPTO_KEY_LENGTHback to summary
public static final String CRYPTO_KEY_LENGTH

Attribute for encrypting a database. Specifies the key length in bytes for the specified cryptographic algorithm.

CRYPTO_PROVIDERback to summary
public static final String CRYPTO_PROVIDER

Attribute for encrypting a database. Specifies the cryptographic services provider.

DATA_ENCRYPTIONback to summary
public static final String DATA_ENCRYPTION

Attribute name to encrypt the database on disk. If set to true, all user data is stored encrypted on disk.

DBNAME_ATTRback to summary
public static final String DBNAME_ATTR

The attribute that is used for the database name, from the JDBC notion of jdbc:$subprotocol:$subname

DECRYPT_DATABASEback to summary
public static final String DECRYPT_DATABASE

Attribute name for decrypting an encrypted database.

DEREGISTER_ATTRback to summary
public static final String DEREGISTER_ATTR

The attribute that is to keep autoloading idiom for driver

DNC_PROTOCOLback to summary
public static final String DNC_PROTOCOL

The protocol for Derby Network Client

DRDA_SECMECback to summary
public static final String DRDA_SECMEC

Internal attribute which holds the value of the securityMechanism attribute specified by the client. Used for passing information about which security mechanism to use from the network server to the embedded driver. Use another name than "securityMechanism" in order to prevent confusion if an attempt is made to establish an embedded connection with securityMechanism specified (see DERBY-3025).

DRDA_SECTKN_INback to summary
public static final String DRDA_SECTKN_IN

Internal attributes. Mainly used by DRDA and Derby BUILTIN authentication provider in some security mechanism context (SECMEC_USRSSBPWD). DRDA_SECTKN_IN is the random client seed (RDs) DRDA_SECTKN_OUT is the random server seed (RDr)

DRDA_SECTKN_OUTback to summary
public static final String DRDA_SECTKN_OUT
DRDAID_ATTRback to summary
public static final String DRDAID_ATTR

The attribute that is used to set the connection's DRDA ID.

DROP_ATTRback to summary
public static final String DROP_ATTR

The attribute that is used to request a drop database.

JCC_PROTOCOLback to summary
public static final String JCC_PROTOCOL

The protocol for the IBM Universal JDBC Driver

LOG_DEVICEback to summary
public static final String LOG_DEVICE

Put the log on a different device.

NEW_BOOT_PASSWORDback to summary
public static final String NEW_BOOT_PASSWORD

The attribute that is used to chage the secret key of an encrypted database. The secret key must be at least 8 characters long. This key must not be stored persistently in cleartext anywhere.

NEW_CRYPTO_EXTERNAL_KEYback to summary
public static final String NEW_CRYPTO_EXTERNAL_KEY

The attribute that is used to chage the encryption key of an encrypted database. When this is specified all the supplied crypto information is stored external to the database, ie by the application.

PASSWORD_ATTRback to summary
public static final String PASSWORD_ATTR

The attribute that is used to set the user password.

PROTOCOLback to summary
public static final String PROTOCOL

Not an attribute but the root for the JDBC URL that Derby supports.

REPLICATION_FAILOVERback to summary
public static final String REPLICATION_FAILOVER

Attribute name to start failover for a given database..

REPLICATION_INTERNAL_SHUTDOWN_SLAVEback to summary
public static final String REPLICATION_INTERNAL_SHUTDOWN_SLAVE

Attribute name to stop replication slave mode for a database. Internal use only

REPLICATION_SLAVE_HOSTback to summary
public static final String REPLICATION_SLAVE_HOST

If startMaster is true, this attribute is used to specify the host name the master should connect to. This is a required attribute.

REPLICATION_SLAVE_PORTback to summary
public static final String REPLICATION_SLAVE_PORT

If startMaster is true, this attribute is used to specify the port the master should connect to. This is an optional attribute

REPLICATION_START_MASTERback to summary
public static final String REPLICATION_START_MASTER

Attribute name to start replication master mode for a database. If used, REPLICATION_SLAVE_HOST is a required attribute.

REPLICATION_START_SLAVEback to summary
public static final String REPLICATION_START_SLAVE

Attribute name to start replication slave mode for a database.

REPLICATION_STOP_MASTERback to summary
public static final String REPLICATION_STOP_MASTER

Attribute name to stop replication master mode for a database.

REPLICATION_STOP_SLAVEback to summary
public static final String REPLICATION_STOP_SLAVE

Attribute name to stop replication slave mode for a database.

RESTORE_FROMback to summary
public static final String RESTORE_FROM

This attribute is used to request a database restore from backup. It must be used only when the active database is corrupted, because it will cleanup the existing database and replace it from the backup.

ROLL_FORWARD_RECOVERY_FROMback to summary
public static final String ROLL_FORWARD_RECOVERY_FROM

The attribute that is used to request a roll-forward recovery of the database.

SHUTDOWN_ATTRback to summary
public static final String SHUTDOWN_ATTR

The attribute that is used to request a shutdown.

SOFT_UPGRADE_NO_FEATURE_CHECKback to summary
public static final String SOFT_UPGRADE_NO_FEATURE_CHECK

Internal attribute. Used to always allow soft upgrade for authentication purposes in a two phase hard upgrade (to check database owner power before proceeding. The purpose is to avoid failing soft upgrade due to a feature being set but not supported until after hard upgrade has taken place (e.g. during hard upgrade from 10.1 -> 10.3 or higher if derby.database.sqlAuthorization is set, cf. DD_Version#checkVersion).

SQLJ_NESTEDback to summary
public static final String SQLJ_NESTED

The SQLJ protocol for getting the default connection for server side jdbc

SSL_ATTRback to summary
public static final String SSL_ATTR

The attribute that is used to set client SSL mode.

TERRITORYback to summary
public static final String TERRITORY

Set the territory for the database.

UPGRADE_ATTRback to summary
public static final String UPGRADE_ATTR

The attribute that is used to allow upgrade.

USERNAME_ATTRback to summary
public static final String USERNAME_ATTR

The attribute that is used to set the user name.