Interface Attribute
-
public interface Attribute
List of all connection (JDBC) attributes by the system.This class exists for two reasons
- To act as the internal documentation for the attributes.
- 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
Fields Modifier and Type Field Description static java.lang.String
BOOT_PASSWORD
If dataEncryption is true, use this attribute to pass in the secret key.static java.lang.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.static java.lang.String
CLIENT_RETIEVE_MESSAGE_TEXT
retrieveMessageText.static java.lang.String
CLIENT_SECURITY_MECHANISM
securityMechanism sets the mechanism for transmitting the user name and password from the client.static java.lang.String
CLIENT_TRACE_APPEND
traceFileAppend.static java.lang.String
CLIENT_TRACE_DIRECTORY
traceDirectory sets the client side trace directory.static java.lang.String
CLIENT_TRACE_FILE
traceFile sets the client side trace file.static java.lang.String
CLIENT_TRACE_LEVEL
traceLevel.static java.lang.String
COLLATE
Set the collation sequence of the database, currently on IDENTITY will be supported (strings will sort according to binary comparison).static java.lang.String
CREATE_ATTR
The attribute that is used to request a database create.static java.lang.String
CREATE_FROM
This attribute is used to request to create a database from backup.static java.lang.String
CRYPTO_ALGORITHM
Attribute for encrypting a database.static java.lang.String
CRYPTO_EXTERNAL_KEY
Attribute for encrypting a database.static java.lang.String
CRYPTO_KEY_LENGTH
Attribute for encrypting a database.static java.lang.String
CRYPTO_PROVIDER
Attribute for encrypting a database.static java.lang.String
DATA_ENCRYPTION
Attribute name to encrypt the database on disk.static java.lang.String
DBNAME_ATTR
The attribute that is used for the database name, from the JDBC notion of jdbc:: static java.lang.String
DNC_PROTOCOL
The protocol for Derby Network Clientstatic java.lang.String
DRDAID_ATTR
The attribute that is used to set the connection's DRDA ID.static java.lang.String
JCC_PROTOCOL
The protocol for the IBM Universal JDBC Driverstatic java.lang.String
LOG_DEVICE
Put the log on a different device.static java.lang.String
PASSWORD_ATTR
The attribute that is used to set the user password.static java.lang.String
PROTOCOL
Not an attribute but the root for the JDBC URL that Derby supports.static java.lang.String
REPLICATION_FAILOVER
Attribute name to start failover for a given database..static java.lang.String
REPLICATION_INTERNAL_SHUTDOWN_SLAVE
Attribute name to stop replication slave mode for a database.static java.lang.String
REPLICATION_SLAVE_HOST
If startMaster is true, this attribute is used to specify the host name the master should connect to.static java.lang.String
REPLICATION_SLAVE_PORT
If startMaster is true, this attribute is used to specify the port the master should connect to.static java.lang.String
REPLICATION_START_MASTER
Attribute name to start replication master mode for a database.static java.lang.String
REPLICATION_START_SLAVE
Attribute name to start replication slave mode for a database.static java.lang.String
REPLICATION_STOP_MASTER
Attribute name to stop replication master mode for a database.static java.lang.String
REPLICATION_STOP_SLAVE
Attribute name to stop replication slave mode for a database.static java.lang.String
RESTORE_FROM
This attribute is used to request a database restore from backup.static java.lang.String
ROLL_FORWARD_RECOVERY_FROM
The attribute that is used to request a roll-forward recovery of the database.static java.lang.String
SHUTDOWN_ATTR
The attribute that is used to request a shutdown.static java.lang.String
SQLJ_NESTED
The SQLJ protocol for getting the default connection for server side jdbcstatic java.lang.String
SSL_ATTR
The attribute that is used to set client SSL mode.static java.lang.String
TERRITORY
Set the territory for the database.static java.lang.String
UPGRADE_ATTR
The attribute that is used to allow upgrade.static java.lang.String
USERNAME_ATTR
The attribute that is used to set the user name.
-
-
-
Field Detail
-
PROTOCOL
static final java.lang.String PROTOCOL
Not an attribute but the root for the JDBC URL that Derby supports.- See Also:
- Constant Field Values
-
SQLJ_NESTED
static final java.lang.String SQLJ_NESTED
The SQLJ protocol for getting the default connection for server side jdbc- See Also:
- Constant Field Values
-
DNC_PROTOCOL
static final java.lang.String DNC_PROTOCOL
The protocol for Derby Network Client- See Also:
- Constant Field Values
-
JCC_PROTOCOL
static final java.lang.String JCC_PROTOCOL
The protocol for the IBM Universal JDBC Driver- See Also:
- Constant Field Values
-
CLIENT_JVM_PROPERTY_PREFIX
static final java.lang.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- See Also:
- Constant Field Values
-
DATA_ENCRYPTION
static final java.lang.String DATA_ENCRYPTION
Attribute name to encrypt the database on disk. If set to true, all user data is stored encrypted on disk.- See Also:
- Constant Field Values
-
BOOT_PASSWORD
static final java.lang.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.- See Also:
- Constant Field Values
-
REPLICATION_START_MASTER
static final java.lang.String REPLICATION_START_MASTER
Attribute name to start replication master mode for a database. If used, REPLICATION_SLAVE_HOST is a required attribute.- See Also:
- Constant Field Values
-
REPLICATION_STOP_MASTER
static final java.lang.String REPLICATION_STOP_MASTER
Attribute name to stop replication master mode for a database.- See Also:
- Constant Field Values
-
REPLICATION_START_SLAVE
static final java.lang.String REPLICATION_START_SLAVE
Attribute name to start replication slave mode for a database.- See Also:
- Constant Field Values
-
REPLICATION_STOP_SLAVE
static final java.lang.String REPLICATION_STOP_SLAVE
Attribute name to stop replication slave mode for a database.- See Also:
- Constant Field Values
-
REPLICATION_INTERNAL_SHUTDOWN_SLAVE
static final java.lang.String REPLICATION_INTERNAL_SHUTDOWN_SLAVE
Attribute name to stop replication slave mode for a database. Internal use only- See Also:
- Constant Field Values
-
REPLICATION_SLAVE_HOST
static final java.lang.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.- See Also:
- Constant Field Values
-
REPLICATION_FAILOVER
static final java.lang.String REPLICATION_FAILOVER
Attribute name to start failover for a given database..- See Also:
- Constant Field Values
-
REPLICATION_SLAVE_PORT
static final java.lang.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.- See Also:
- Constant Field Values
-
DBNAME_ATTR
static final java.lang.String DBNAME_ATTR
The attribute that is used for the database name, from the JDBC notion of jdbc:: - See Also:
- Constant Field Values
-
SHUTDOWN_ATTR
static final java.lang.String SHUTDOWN_ATTR
The attribute that is used to request a shutdown.- See Also:
- Constant Field Values
-
CREATE_ATTR
static final java.lang.String CREATE_ATTR
The attribute that is used to request a database create.- See Also:
- Constant Field Values
-
USERNAME_ATTR
static final java.lang.String USERNAME_ATTR
The attribute that is used to set the user name.- See Also:
- Constant Field Values
-
PASSWORD_ATTR
static final java.lang.String PASSWORD_ATTR
The attribute that is used to set the user password.- See Also:
- Constant Field Values
-
DRDAID_ATTR
static final java.lang.String DRDAID_ATTR
The attribute that is used to set the connection's DRDA ID.- See Also:
- Constant Field Values
-
UPGRADE_ATTR
static final java.lang.String UPGRADE_ATTR
The attribute that is used to allow upgrade.- See Also:
- Constant Field Values
-
LOG_DEVICE
static final java.lang.String LOG_DEVICE
Put the log on a different device.- See Also:
- Constant Field Values
-
TERRITORY
static final java.lang.String TERRITORY
Set the territory for the database.- See Also:
- Constant Field Values
-
COLLATE
static final java.lang.String COLLATE
Set the collation sequence of the database, currently on IDENTITY will be supported (strings will sort according to binary comparison).- See Also:
- Constant Field Values
-
CRYPTO_PROVIDER
static final java.lang.String CRYPTO_PROVIDER
Attribute for encrypting a database. Specifies the cryptographic services provider.- See Also:
- Constant Field Values
-
CRYPTO_ALGORITHM
static final java.lang.String CRYPTO_ALGORITHM
Attribute for encrypting a database. Specifies the cryptographic algorithm.- See Also:
- Constant Field Values
-
CRYPTO_KEY_LENGTH
static final java.lang.String CRYPTO_KEY_LENGTH
Attribute for encrypting a database. Specifies the key length in bytes for the specified cryptographic algorithm.- See Also:
- Constant Field Values
-
CRYPTO_EXTERNAL_KEY
static final java.lang.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.- See Also:
- Constant Field Values
-
CREATE_FROM
static final java.lang.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.- See Also:
- Constant Field Values
-
RESTORE_FROM
static final java.lang.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.- See Also:
- Constant Field Values
-
ROLL_FORWARD_RECOVERY_FROM
static final java.lang.String ROLL_FORWARD_RECOVERY_FROM
The attribute that is used to request a roll-forward recovery of the database.- See Also:
- Constant Field Values
-
CLIENT_SECURITY_MECHANISM
static final java.lang.String CLIENT_SECURITY_MECHANISM
securityMechanism sets the mechanism for transmitting the user name and password from the client. Client driver attribute.- See Also:
- Constant Field Values
-
CLIENT_TRACE_FILE
static final java.lang.String CLIENT_TRACE_FILE
traceFile sets the client side trace file. Client driver attribute.- See Also:
- Constant Field Values
-
CLIENT_TRACE_DIRECTORY
static final java.lang.String CLIENT_TRACE_DIRECTORY
traceDirectory sets the client side trace directory. Client driver attribute.- See Also:
- Constant Field Values
-
CLIENT_TRACE_APPEND
static final java.lang.String CLIENT_TRACE_APPEND
traceFileAppend. Client driver attribute.- See Also:
- Constant Field Values
-
CLIENT_TRACE_LEVEL
static final java.lang.String CLIENT_TRACE_LEVEL
traceLevel. Client driver attribute.- See Also:
- Constant Field Values
-
CLIENT_RETIEVE_MESSAGE_TEXT
static final java.lang.String CLIENT_RETIEVE_MESSAGE_TEXT
retrieveMessageText. Client driver attribute.- See Also:
- Constant Field Values
-
SSL_ATTR
static final java.lang.String SSL_ATTR
The attribute that is used to set client SSL mode.- See Also:
- Constant Field Values
-
-