Attribute

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> derby >> iapi >> [ reference overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.derby.iapi.reference.Attribute

SOURCE |

Download org.apache.derby.iapi.reference.Attribute

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.derby.iapi.reference
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

static java.lang.String BOOT_PASSWORD
          If dataEncryption is true, use this attribute to pass in the secret key.

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_EXTERNAL_KEY_VERIFY_FILE
          One can encrypt the database with an encryption key at create time.

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 DRDAID_ATTR
          The attribute that is used to set the connection's DRDA ID.

static 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 Cloudscape supports.

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 jdbc

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

public static final java.lang.String PROTOCOL

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

See Also:: Constant Field Values

SQLJ_NESTED

public static final java.lang.String SQLJ_NESTED

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

See Also:: Constant Field Values

DATA_ENCRYPTION

public 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

public 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

DBNAME_ATTR

public 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

public static final java.lang.String SHUTDOWN_ATTR

The attribute that is used to request a shutdown.

See Also:: Constant Field Values

CREATE_ATTR

public static final java.lang.String CREATE_ATTR

The attribute that is used to request a database create.

See Also:: Constant Field Values

USERNAME_ATTR

public static final java.lang.String USERNAME_ATTR

The attribute that is used to set the user name.

See Also:: Constant Field Values

PASSWORD_ATTR

public static final java.lang.String PASSWORD_ATTR

The attribute that is used to set the user password.

See Also:: Constant Field Values

DRDAID_ATTR

public 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

public static final java.lang.String UPGRADE_ATTR

The attribute that is used to allow upgrade.

See Also:: Constant Field Values

LOG_DEVICE

public static final java.lang.String LOG_DEVICE

Put the log on a different device.

See Also:: Constant Field Values

TERRITORY

public static final java.lang.String TERRITORY

Set the territory for the database.

See Also:: Constant Field Values

COLLATE

public 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

public static final java.lang.String CRYPTO_PROVIDER

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

See Also:: Constant Field Values

CRYPTO_ALGORITHM

public static final java.lang.String CRYPTO_ALGORITHM

Attribute for encrypting a database. Specifies the cryptographic algorithm.

See Also:: Constant Field Values

CRYPTO_KEY_LENGTH

public 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

public 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

CRYPTO_EXTERNAL_KEY_VERIFY_FILE

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

See Also:: Constant Field Values

CREATE_FROM

public 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

public 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

public 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