oracle.toplink.sessions
Class DatabaseLogin

java.lang.Object
oracle.toplink.sessions.DatabaseLogin

All Implemented Interfaces:

java.lang.Cloneable, Login, java.io.Serializable

Direct Known Subclasses:

SDKLogin

public class DatabaseLogin

extends java.lang.Object

implements Login, java.io.Serializable, java.lang.Cloneable

Purpose: Hold the configuration information necessary to connect to a JDBC driver.

Description: A JDBCLogin is used by a TopLink database session to connect to a JDBC server.

Responsibilities:

• Hold the driver class name and URL header
• Hold the database URL
• Hold any driver-specific database connection properties (e.g. "user", "database")
• Build the JDBC driver connect string
• Hold the database platform (e.g. Oracle, DB2)
• Hold the message logging stream
• Hold other assorted configuration settings

See Also:

Serialized Form

Field Summary

static int	CONCURRENT_READ_WRITE Reads and unit of work merges can occur concurrently.
static java.lang.String	licenseFile Deprecated. since 4.6. No direct replacement API.
static java.lang.String	licensePath Deprecated. since 4.6. No direct replacement API.
static java.lang.String	studioLicenseFile Deprecated. since 4.6. No direct replacement API.
static int	SYNCHRONIZED_READ_ON_WRITE Reads and unit of work merges will be serialized.
static int	SYNCHRONIZED_WRITE Reads can occur concurrently but unit of work merges will be serialized.
static int	TRANSACTION_NONE Transactions are not supported.
static int	TRANSACTION_READ_COMMITTED Dirty reads are prevented; non-repeatable reads and phantom reads can occur.
static int	TRANSACTION_READ_UNCOMMITTED Dirty reads, non-repeatable reads and phantom reads can occur.
static int	TRANSACTION_REPEATABLE_READ Dirty reads and non-repeatable reads are prevented; phantom reads can occur.
static int	TRANSACTION_SERIALIZABLE Dirty reads, non-repeatable reads and phantom reads are prevented.
static java.lang.String	versionString
static java.lang.String[]	xmlParserJARFileNames The names of the TopLink SDK XML Support JAR files

Constructor Summary

DatabaseLogin()
PUBLIC: Create a new login.

DatabaseLogin(DatabasePlatform databasePlatform)
ADVANCED: Create a new login for the given platform.

Method Summary

void	addProperty(java.lang.String propertyName, java.lang.Object propertyValue) Deprecated. - replaced by setProperty
void	bindAllParameters() PUBLIC: Bind all arguments to any SQL statement.
void	cacheAllStatements() PUBLIC: Cache all prepared statements, this requires full parameter binding as well.
void	dontBindAllParameters() PUBLIC: Do not bind all arguments to any SQL statement.
void	dontCacheAllStatements() PUBLIC: Do not cache all prepared statements.
void	dontOptimizeDataConversion() PUBLIC: Disable driver level data conversion optimization.
void	dontUseBatchWriting() PUBLIC: TopLink can be configured to use batch writing.
void	dontUseBinding() Deprecated. replaced by dontUseByteArrayBinding()
void	dontUseByteArrayBinding() PUBLIC: TopLink can be configured to use parameter binding for large binary data.
void	dontUseExternalConnectionPooling() PUBLIC: Do not use external connection pooling.
void	dontUseExternalTransactionController() PUBLIC: Let TopLink control transactions instead of some external transaction service such as JTS.
void	dontUseJDBCBatchWriting() PUBLIC: Indicate to TopLink that the JDBC driver does not support batch writing.
void	dontUseNativeSequencing() PUBLIC: TopLink can be configured to use a sequence table or native sequencing to generate unique object IDs.
void	dontUseNativeSQL() PUBLIC: TopLink can be configured to use database-specific SQL grammar, as opposed to the JDBC standard grammar.
void	dontUseStreamsForBinding() PUBLIC: TopLink can be configured to use streams to store large binary data.
void	dontUseStringBinding() PUBLIC: Do not bind strings of any size.
static DatabaseLogin	forAccess() Deprecated.
static DatabaseLogin	forDB2() Deprecated.
static DatabaseLogin	forDBase() Deprecated.
static DatabaseLogin	forInformix() Deprecated.
static DatabaseLogin	forJDBC() Deprecated.
static DatabaseLogin	forOracle() Deprecated.
static DatabaseLogin	forSQLServer() Deprecated.
static DatabaseLogin	forSybase() Deprecated.
int	getCacheTransactionIsolation() ADVANCED: By default concurrency is optimized and the cache is not locked more than required during reads or writes, This allows for virtual concurrent reading and writing and should never cause any problems.
java.lang.String	getConnectionString() PUBLIC: Return the JDBC connection string.
Connector	getConnector() PUBLIC: Return the connector that will instantiate the java.sql.Connection.
int	getCursorCode() ADVANCED: Return the code for preparing cursored output parameters in a stored procedure
java.lang.String	getDatabaseName() PUBLIC: The database name is required when connecting to databases that support multiple databases within a single server instance (e.g.
java.lang.String	getDatabaseURL() PUBLIC: The database URL is the JDBC URL for the database server.
java.lang.String	getDataSourceName() PUBLIC: The data source name is required if connecting through ODBC (JDBC-ODBC, etc.).
java.lang.String	getDriverClassName() PUBLIC: The driver class is the name of the Java class for the JDBC driver being used (e.g.
java.lang.String	getDriverURLHeader() PUBLIC: The driver URL header is the string predetermined by the JDBC driver to be part of the URL connection string, (e.g.
static java.lang.String	getKey() Deprecated. replaced by getLicensePath License keys are no longer used and have been replaced with license files.
static java.lang.String	getLicenseFile() Deprecated. since 4.6. No direct replacement API.
static java.lang.String	getLicensePath() Deprecated. since 4.6. No direct replacement API.
int	getMaxBatchWritingSize() PUBLIC: Allow for the max batch writing size to be set.
java.lang.String	getPassword() Return the password.
java.lang.Object	getProperty(java.lang.String name) PUBLIC: The properties are additional, driver-specific, connection information to be passed to the JDBC driver.
java.lang.String	getQualifiedSequenceTableName() PUBLIC: Return the the qualified name of the TOPLink sequence table.
java.lang.String	getSequenceCounterFieldName() PUBLIC: Return the name of the column in the TopLink sequence table that holds the current value for a given sequence (e.g.
java.lang.String	getSequenceCounterName() Deprecated. replaced by getSequenceCounterFieldName()
java.lang.String	getSequenceFieldName() Deprecated. replaced by getSequenceNameFieldName()
java.lang.String	getSequenceNameFieldName() PUBLIC: Return the name of the column in the TopLink sequence table that holds the name for a given sequence (e.g.
int	getSequencePreallocationSize() PUBLIC: TopLink supports sequence number preallocation.
java.lang.String	getSequenceTableName() PUBLIC: Return the name of the TopLink sequence table.
java.lang.String	getServerName() PUBLIC: The server name is the name of the database instance.
boolean	getShouldBindAllParameters() PUBLIC: Used to help bean introspection.
boolean	getShouldCacheAllStatements() PUBLIC: Used to help bean introspection.
boolean	getShouldOptimizeDataConversion() PUBLIC: Used to help bean introspection.
boolean	getShouldTrimStrings() PUBLIC: Used to help bean introspection.
int	getStatementCacheSize() PUBLIC: If prepared statement caching is used, return the cache size.
int	getStringBindingSize() PUBLIC: Used to help bean introspection.
static java.lang.String	getStudioLicenseFile() Deprecated. since 4.6. No direct replacement API.
java.lang.String	getTableQualifier() PUBLIC: Return the qualifier for the all of the tables referenced by TopLink.
int	getTransactionIsolation() PUBLIC: Return the transaction isolation setting for the connection.
java.lang.String	getUserName() PUBLIC: The user name is the database login name.
boolean	getUsesBinding() PUBLIC: Used to help bean introspection.
boolean	getUsesNativeSequencing() PUBLIC: Used to help bean introspection.
boolean	getUsesNativeSQL() PUBLIC: Used to help bean introspection.
boolean	getUsesStreamsForBinding() PUBLIC: Used to help bean introspection.
boolean	getUsesStringBinding() PUBLIC: Used to help bean introspection.
static java.lang.String	getVersion() PUBLIC: Return the TopLink version.
static java.lang.String[]	getXMLParserJARFileNames() ADVANCED: Return the names of the TopLink SDK XML Support JAR files
void	handleTransactionsManuallyForSybaseJConnect() PUBLIC: Force TopLink to manually begin transactions instead of using autoCommit.
boolean	isAnyOracleJDBCBridge() Deprecated.
boolean	isAnyOracleJDBCDriver() PUBLIC: Return whether an Oracle JDBC driver is being used.
boolean	isCloudscapeJDBCDriver() PUBLIC: Return whether a Cloudscape JDBC driver is being used.
boolean	isDB2JDBCBridge() Deprecated.
boolean	isDB2JDBCDriver() PUBLIC: Return whether an IBM DB2 native client JDBC driver is being used.
boolean	isIntersolvSequeLinkBridge() Deprecated.
boolean	isIntersolvSequeLinkDriver() PUBLIC: Return whether an Intersolv SeqeLink JDBC driver is being used.
boolean	isJConnectBridge() Deprecated.
boolean	isJConnectDriver() PUBLIC: Return whether a Sybase JConnect JDBC driver is being used.
boolean	isJDBCConnectBridge() Deprecated.
boolean	isJDBCConnectDriver() PUBLIC: Return whether a Borland JDBCConnect JDBC driver is being used.
boolean	isJDBCConnectRemoteBridge() Deprecated.
boolean	isJDBCConnectRemoteDriver() PUBLIC: Return whether a Borland JDBCConnect JDBC driver is being used.
boolean	isJDBCODBCBridge() PUBLIC: Return whether a Sun/Merant JDBC-ODBC bridge driver is being used.
boolean	isOracle7JDBCBridge() Deprecated.
boolean	isOracle7JDBCDriver() PUBLIC: Return whether an Oracle native 7.x OCI JDBC driver is being used.
boolean	isOracleJDBCBridge() Deprecated.
boolean	isOracleJDBCDriver() PUBLIC: Return whether an Oracle 8.x native OCI JDBC driver is being used.
boolean	isOracleServerJDBCBridge() Deprecated.
boolean	isOracleServerJDBCDriver() PUBLIC: Return whether an Oracle thin JDBC driver is being used.
boolean	isOracleThinJDBCBridge() Deprecated.
boolean	isOracleThinJDBCDriver() PUBLIC: Return whether an Oracle thin JDBC driver is being used.
boolean	isWebLogicOracleOCIBridge() Deprecated.
boolean	isWebLogicOracleOCIDriver() PUBLIC: Return whether a WebLogic Oracle OCI JDBC driver is being used.
boolean	isWebLogicSQLServerBridge() Deprecated.
boolean	isWebLogicSQLServerDBLibBridge() Deprecated.
boolean	isWebLogicSQLServerDBLibDriver() PUBLIC: Return whether a WebLogic SQL Server dblib JDBC driver is being used.
boolean	isWebLogicSQLServerDriver() PUBLIC: Return whether a WebLogic SQL Server JDBC driver is being used.
boolean	isWebLogicSybaseDBLibBridge() Deprecated.
boolean	isWebLogicSybaseDBLibDriver() PUBLIC: Return whether a WebLogic Sybase dblib JDBC driver is being used.
boolean	isWebLogicThinBridge() Deprecated.
boolean	isWebLogicThinClientBridge() Deprecated.
boolean	isWebLogicThinClientDriver() PUBLIC: Return whether a WebLogic thin client JDBC driver is being used.
boolean	isWebLogicThinDriver() PUBLIC: Return whether a WebLogic thin JDBC driver is being used.
void	optimizeDataConversion() PUBLIC: Enable driver level data conversion optimization.
void	removeProperty(java.lang.String propertyName) PUBLIC: Some JDBC drivers don't like the "user" and "password" properties.
void	setCacheTransactionIsolation(int cacheTransactionIsolation) ADVANCED: By default concurrency is optimized and the cache is not locked more than required during reads or writes, This allows for virtual concurrent reading and writing and should never cause any problems.
void	setConnectionString(java.lang.String url) PUBLIC: Set the JDBC connection string.
void	setConnector(Connector connector) PUBLIC: Set the connector that will instantiate the java.sql.Connection.
void	setCursorCode(int cursorCode) ADVANCED: Set the code for preparing cursored output parameters in a stored procedure
void	setDatabaseName(java.lang.String databaseName) PUBLIC: The database name is required when connecting to databases that support multiple databases within a single server instance (e.g.
void	setDatabaseURL(java.lang.String databaseURL) PUBLIC: The database URL is the JDBC URL for the database server.
void	setDataSourceName(java.lang.String dataSourceName) PUBLIC: The data source name is required if connecting through ODBC (JDBC-ODBC, etc.).
void	setDefaultNullValue(java.lang.Class type, java.lang.Object value) PUBLIC: The default value to substitute for database NULLs can be configured on a per-class basis.
void	setDriverClass(java.lang.Class driverClass) PUBLIC: The driver class is the Java class for the JDBC driver to be used (e.g. sun.jdbc.odbc.JdbcOdbcDriver.class).
void	setDriverClassName(java.lang.String driverClassName) PUBLIC: The name of the JDBC driver class to be used (e.g.
void	setDriverURLHeader(java.lang.String driverURLHeader) PUBLIC: The driver URL header is the string predetermined by the JDBC driver to be part of the URL connection string, (e.g.
void	setEncryptedPassword(java.lang.String password) Set the encrypted password.
void	setEncryptionClassName(java.lang.String encryptionClassName) Sets the encryption class name
static void	setKey(java.lang.String key) Deprecated. replaced by setLicensePath License keys are no longer used and have been replaced with license files.
static void	setKey(java.lang.String resourceName, java.lang.String keyName) Deprecated. replaced by setLicensePath License keys are no longer used and have been replaced with license files.
static void	setLicensePath(java.lang.String path) Deprecated. since 4.6. No direct replacement API.
void	setMaxBatchWritingSize(int maxBatchWritingSize) PUBLIC: Allow for the max batch writing size to be set.
void	setPassword(java.lang.String password) Set the password.
void	setProperties(java.util.Properties properties) PUBLIC: The properties are additional, driver-specific, connection information to be passed to the JDBC driver.
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) PUBLIC: Some JDBC drivers require additional, driver-specific, properties.
void	setSelectSequenceNumberQuery(ValueReadQuery selectSequenceNumberQuery) PUBLIC: Override the default query for reading the sequence numbers.
void	setSequenceCounterFieldName(java.lang.String name) PUBLIC: Set the name of the column in the TopLink sequence table that holds the current value for a given sequence (e.g.
void	setSequenceCounterName(java.lang.String name) Deprecated. replaced by setSequenceCounterFieldName()
void	setSequenceFieldName(java.lang.String name) Deprecated. replaced by setSequenceNameFieldName()
void	setSequenceNameFieldName(java.lang.String name) PUBLIC: Set the name of the column in the TopLink sequence table that holds the name for a given sequence (e.g.
void	setSequencePreallocationSize(int size) PUBLIC: TopLink supports sequence number preallocation.
void	setSequenceTableName(java.lang.String name) PUBLIC: Set the name of the TopLink sequence table.
void	setServerName(java.lang.String name) PUBLIC: The server name is the name of the database instance.
void	setShouldBindAllParameters(boolean shouldBindAllParameters) PUBLIC: Set whether to bind all arguments to any SQL statement.
void	setShouldCacheAllStatements(boolean shouldCacheAllStatements) PUBLIC: Set whether prepared statements should be cached.
void	setShouldForceFieldNamesToUpperCase(boolean shouldForceFieldNamesToUpperCase) ADVANCED: This setting can be used if the application expects upper case but the database does not return consistent case (e.g. different databases).
static void	setShouldIgnoreCaseOnFieldComparisons(boolean shouldIgnoreCaseOnFieldComparisons) ADVANCED: Allow for case in field names to be ignored as some databases are not case sensitive.
void	setShouldOptimizeDataConversion(boolean value) PUBLIC: Set whether driver level data conversion optimization is enabled.
void	setShouldTrimStrings(boolean shouldTrimStrings) PUBLIC: By default CHAR field values have trailing blanks trimmed, this can be configured.
void	setStatementCacheSize(int size) PUBLIC: If prepared statement caching is used this configures the cache size.
void	setStringBindingSize(int stringBindingSize) PUBLIC: Used to help bean introspection.
void	setTableQualifier(java.lang.String qualifier) PUBLIC: Set the default qualifier for all tables.
void	setTimestampQuery(ValueReadQuery timestampQuery) PUBLIC: Override the default query for returning a timestamp from the server.
void	setTransactionIsolation(int isolationLevel) PUBLIC: Set the transaction isolation setting for the connection.
void	setUpdateSequenceQuery(DataModifyQuery updateSequenceNumberQuery) PUBLIC: Override the default query for updating sequence numbers.
void	setUserName(java.lang.String name) PUBLIC: The user name is the database login name.
void	setUsesBatchWriting(boolean value) PUBLIC: TopLink can be configured to use batch writing.
void	setUsesBinding(boolean value) Deprecated. replaced by setUsesByteArrayBinding(boolean)
void	setUsesByteArrayBinding(boolean value) PUBLIC: TopLink can be configured to use parameter binding for large binary data.
void	setUsesDirectDriverConnect(boolean usesDirectDriverConnect) Deprecated.
void	setUsesExternalConnectionPooling(boolean usesExternalConnectionPooling) PUBLIC: Return whether TopLink uses some external connection pooling service such as a JDBC 2.0 driver.
void	setUsesExternalTransactionController(boolean usesExternalTransactionController) PUBLIC: Return whether TopLink uses some external transaction service such as JTS.
void	setUsesJDBCBatchWriting(boolean usesJDBCBatchWriting) PUBLIC: Calling this method with an argument of true indicates to TopLink that the JDBC driver supports batch writing.
void	setUsesNativeSequencing(boolean value) PUBLIC: TopLink can be configured to use a sequence table, or native sequencing to generate unique object ids.
void	setUsesNativeSQL(boolean value) PUBLIC: TopLink can be configured to use database specific sql grammar not JDBC specific.
void	setUsesStreamsForBinding(boolean value) PUBLIC: TopLink can be configured to use streams to store large binary data.
void	setUsesStringBinding(boolean usesStringBindingSize) PUBLIC: Used to help bean introspection.
static void	setXMLParserJARFileNames(java.lang.String[] jarFileNames) ADVANCED: Specify the names of the TopLink SDK XML Support JAR files.
boolean	shouldBindAllParameters() PUBLIC: Bind all arguments to any SQL statement.
boolean	shouldCacheAllStatements() PUBLIC: Cache all prepared statements, this requires full parameter binding as well.
boolean	shouldForceFieldNamesToUpperCase() ADVANCED: Can be used if the app expects upper case but the database is not return consistent case, i.e. different databases.
static boolean	shouldIgnoreCaseOnFieldComparisons() ADVANCED: Allow for case in field names to be ignored as some databases are not case sensitive.
boolean	shouldOptimizeDataConversion() PUBLIC: Return if our driver level data conversion optimization is enabled.
boolean	shouldTrimStrings() PUBLIC: By default CHAR field values have trailing blanks trimmed, this can be configured.
boolean	shouldUseBatchWriting() PUBLIC: TopLink can be configured to use batch writing.
boolean	shouldUseBinding() Deprecated. replaced by usesByteArrayBinding()
boolean	shouldUseByteArrayBinding() PUBLIC: TopLink can be configured to use parameter binding for large binary data.
boolean	shouldUseExternalConnectionPooling() PUBLIC: Return whether TopLink uses some external connection pooling (e.g.
boolean	shouldUseExternalTransactionController() PUBLIC: Return whether TopLink uses some external transaction service such as JTS.
boolean	shouldUseJDBCBatchWriting() PUBLIC: Answers true if TopLink has JDBC batch writing enabled.
boolean	shouldUseNativeSequencing() PUBLIC: TopLink can be configured to use a sequence table or native sequencing to generate unique object IDs.
boolean	shouldUseNativeSQL() PUBLIC: TopLink can be configured to use database-specific SQL grammar, as opposed to the JDBC standard grammar.
boolean	shouldUseStreamsForBinding() PUBLIC: TopLink can be configured to use streams to store large binary data.
boolean	shouldUseStringBinding() PUBLIC: TopLink can be configured to bind large strings.
java.lang.String	toString() PUBLIC: Print all of the connection information.
void	useAccess() PUBLIC: Set the database platform to be Access.
void	useBatchWriting() PUBLIC: TopLink can be configured to use batch writing.
void	useBinding() Deprecated. replaced by useByteArrayBinding()
void	useByteArrayBinding() PUBLIC: TopLink can be configured to use parameter binding for large binary data.
void	useCloudscape() PUBLIC: Set the database platform to be Cloudscape.
void	useCloudscapeDriver() PUBLIC: Use the Cloudscape JDBC driver.
void	useDB2() PUBLIC: Set the database platform to be DB2.
void	useDB2JDBCBridge() Deprecated.
void	useDB2JDBCDriver() PUBLIC: Use the IBM DB2 native client interface.
void	useDB2NetJDBCBridge() Deprecated.
void	useDB2NetJDBCDriver() PUBLIC: Use the IBM DB2 thin JDBC driver.
void	useDBase() PUBLIC: Set the database platform to be DBase.
void	useDefaultDriverConnect() PUBLIC: Connect to the JDBC driver via DriverManager.
void	useDefaultDriverConnect(java.lang.String driverClassName, java.lang.String driverURLHeader, java.lang.String databaseURL) PUBLIC: Connect to the JDBC driver via DriverManager.
void	useDirectDriverConnect() PUBLIC: Some JDBC drivers don't support connecting correctly (via DriverManager), but do support connecting incorrectly (e.g.
void	useDirectDriverConnect(java.lang.String driverClassName, java.lang.String driverURLHeader, java.lang.String databaseURL) PUBLIC: Some JDBC drivers don't support connecting correctly (via DriverManager), but do support connecting incorrectly (e.g.
void	useExternalConnectionPooling() PUBLIC: Use external connection pooling, such as WebLogic's JTS driver.
void	useExternalTransactionController() PUBLIC: Use an external transaction controller such as a JTS service
void	useHSQL() PUBLIC: Use the HSQL JDBC driver.
void	useHSQLDriver() PUBLIC: Use the HSQL JDBC driver.
void	useINetSQLServerDriver() PUBLIC: Use the i-net SQL Server JDBC driver.
void	useInformix() PUBLIC: Set the database platform to be Informix.
void	useIntersolvSequeLinkBridge() Deprecated.
void	useIntersolvSequeLinkDriver() PUBLIC: Use the Intersolv/Merant SequeLink JDBC driver.
void	useJConnect50Bridge() Deprecated.
void	useJConnect50Driver() PUBLIC: Use the Sybase JConnect JDBC driver.
void	useJConnectBridge() Deprecated.
void	useJConnectDriver() PUBLIC: Use the Sybase JConnect JDBC driver.
void	useJDBC() PUBLIC: Set the database platform to be JDBC.
void	useJDBCBatchWriting() PUBLIC: TopLink support batch writing in both JDK 1.1 abd JDK 1.2.
void	useJDBCConnectBridge() Deprecated.
void	useJDBCConnectDriver() PUBLIC: Use the Borland JDBCConnect JDBC driver.
void	useJDBCConnectRemoteBridge() Deprecated.
void	useJDBCConnectRemoteDriver() PUBLIC: Use the Borland JDBCConnect JDBC driver.
void	useJDBCODBCBridge() PUBLIC: User the Sun/Merant JDBC-ODBC bridge driver.
void	useNativeSequencing() PUBLIC: TopLink can be configured to use a sequence table or native sequencing to generate unique object IDs.
void	useNativeSQL() PUBLIC: TopLink can be configured to use database-specific SQL grammar, as opposed to the JDBC standard grammar.
void	useOracle() PUBLIC: Set the database platform to be Oracle.
void	useOracle7JDBCBridge() Deprecated.
void	useOracle7JDBCDriver() PUBLIC: Use the Oracle 7.x native OCI JDBC driver.
void	useOracleJDBCBridge() Deprecated.
void	useOracleJDBCDriver() PUBLIC: Use the Oracle 8.x native OCI JDBC driver.
void	useOracleServerJDBCBridge() Deprecated.
void	useOracleServerJDBCDriver() PUBLIC: Use the Oracle server JDBC driver.
void	useOracleThinJDBCBridge() Deprecated.
void	useOracleThinJDBCDriver() PUBLIC: Use the Oracle thin JDBC driver.
void	usePlatform(DatabasePlatform platform) ADVANCED: Set the database platform to be custom platform.
void	usePointBase() PUBLIC: Set the database platform to be PointBase.
void	usePointBaseDriver() PUBLIC: Use the PointBase JDBC driver.
boolean	usesBatchWriting() Deprecated. replaced by shouldUseBatchWriting to avoid confusion with modifier.
boolean	usesBinding() Deprecated. replaced by usesByteArrayBinding()
boolean	usesByteArrayBinding() Deprecated. replaced by shouldUseByteArrayBinding to avoid confusion with modifier.
boolean	usesDirectDriverConnect() Deprecated.
boolean	usesExternalConnectionPooling() Deprecated. replaced by shouldUseExternalConnectionPooling to avoid confusion with modifier.
boolean	usesExternalTransactionController() Deprecated. replaced by shouldUseExternalTransactionController to avoid confusion with modifier.
boolean	usesJDBCBatchWriting() Deprecated. replaced by shouldUseJDBCBatchWriting to avoid confusion with modifier.
boolean	usesNativeSequencing() Deprecated. replaced by shouldUseNativeSequencing to avoid confusion with modifier.
boolean	usesNativeSQL() Deprecated. replaced by shouldUseNativeSQL to avoid confusion with modifier.
void	useSQLServer() PUBLIC: Set the database platform to be SQL Server.
boolean	usesStreamsForBinding() Deprecated. replaced by shouldUseStreamsForBinding to avoid confusion with modifier.
boolean	usesStringBinding() Deprecated. replaced by shouldUseStringBinding to avoid confusion with modifier.
void	useStreamsForBinding() PUBLIC: TopLink can be configured to use streams to store large binary data.
void	useStringBinding() PUBLIC: Bind strings larger than 255 characters.
void	useStringBinding(int size) PUBLIC: Bind strings that are larger than the specified size.
void	useSybase() PUBLIC: Set the database platform to be Sybase.
void	useWebLogicDriverCursoredOutputCode() PUBLIC: Set the prepare cursor code to what the WebLogic Oracle OCI JDBC driver expects.
void	useWebLogicJDBCConnectionPool(java.lang.String poolName) PUBLIC: Set a WebLogic JDBC connection pool (a pool must be defined for the entity beans that are to be deployed)
void	useWebLogicOracleOCIBridge() Deprecated.
void	useWebLogicOracleOCIDriver() PUBLIC: Use the WebLogic Oracle OCI JDBC driver.
void	useWebLogicSQLServerBridge() Deprecated.
void	useWebLogicSQLServerDBLibBridge() Deprecated.
void	useWebLogicSQLServerDBLibDriver() PUBLIC: Use the WebLogic SQL Server dblib JDBC driver.
void	useWebLogicSQLServerDriver() PUBLIC: Use the WebLogic SQL Server JDBC driver.
void	useWebLogicSybaseDBLibBridge() Deprecated.
void	useWebLogicSybaseDBLibDriver() PUBLIC: Use the WebLogic Sybase dblib JDBC driver.
void	useWebLogicThinBridge() Deprecated.
void	useWebLogicThinClientBridge() Deprecated.
void	useWebLogicThinClientDriver() PUBLIC: Use the WebLogic thin client JDBC driver.
void	useWebLogicThinDriver() PUBLIC: Use the WebLogic thin JDBC driver.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

versionString

public static java.lang.String versionString

licensePath

public static java.lang.String licensePath

Deprecated. since 4.6. No direct replacement API.

The String path for locating the license file by default.

studioLicenseFile

public static java.lang.String studioLicenseFile

Deprecated. since 4.6. No direct replacement API.

The license file name for StudioPro4. This should not be changed by user - deprecated since 4.6

licenseFile

public static java.lang.String licenseFile

Deprecated. since 4.6. No direct replacement API.

The license file name for other TopLink products. Should not be changed by user.

CONCURRENT_READ_WRITE

public static final int CONCURRENT_READ_WRITE

Reads and unit of work merges can occur concurrently.

See Also:

Constant Field Values

SYNCHRONIZED_WRITE

public static final int SYNCHRONIZED_WRITE

Reads can occur concurrently but unit of work merges will be serialized.

See Also:

Constant Field Values

SYNCHRONIZED_READ_ON_WRITE

public static final int SYNCHRONIZED_READ_ON_WRITE

Reads and unit of work merges will be serialized.

See Also:

Constant Field Values

TRANSACTION_NONE

public static final int TRANSACTION_NONE

Transactions are not supported.

See Also:

Constant Field Values

TRANSACTION_READ_UNCOMMITTED

public static final int TRANSACTION_READ_UNCOMMITTED

Dirty reads, non-repeatable reads and phantom reads can occur.

See Also:

Constant Field Values

TRANSACTION_READ_COMMITTED

public static final int TRANSACTION_READ_COMMITTED

Dirty reads are prevented; non-repeatable reads and phantom reads can occur.

See Also:

Constant Field Values

TRANSACTION_REPEATABLE_READ

public static final int TRANSACTION_REPEATABLE_READ

Dirty reads and non-repeatable reads are prevented; phantom reads can occur.

See Also:

Constant Field Values

TRANSACTION_SERIALIZABLE

public static final int TRANSACTION_SERIALIZABLE

Dirty reads, non-repeatable reads and phantom reads are prevented.

See Also:

Constant Field Values

xmlParserJARFileNames

public static java.lang.String[] xmlParserJARFileNames

The names of the TopLink SDK XML Support JAR files

Constructor Detail

DatabaseLogin

public DatabaseLogin()

PUBLIC: Create a new login.

DatabaseLogin

public DatabaseLogin(DatabasePlatform databasePlatform)

ADVANCED: Create a new login for the given platform.

Method Detail

addProperty

public void addProperty(java.lang.String propertyName,
                        java.lang.Object propertyValue)

Deprecated. - replaced by setProperty

OBSOLETE:

bindAllParameters

public void bindAllParameters()

PUBLIC: Bind all arguments to any SQL statement.

cacheAllStatements

public void cacheAllStatements()

PUBLIC: Cache all prepared statements, this requires full parameter binding as well.

See Also:

#bindAllStatements()

dontBindAllParameters

public void dontBindAllParameters()

PUBLIC: Do not bind all arguments to any SQL statement.

dontCacheAllStatements

public void dontCacheAllStatements()

PUBLIC: Do not cache all prepared statements.

dontOptimizeDataConversion

public void dontOptimizeDataConversion()

PUBLIC: Disable driver level data conversion optimization. This can be disabled as some drivers perform data conversion themselves incorrectly.

dontUseBatchWriting

public void dontUseBatchWriting()

PUBLIC: TopLink can be configured to use batch writing. This facility allows multiple write operations to be submitted to a database for processing at once. Submitting multiple updates together, instead of individually, can greatly improve performance in some situations.

dontUseBinding

public void dontUseBinding()

Deprecated. replaced by dontUseByteArrayBinding()

OBSOLETE:

See Also:

dontUseByteArrayBinding()

dontUseByteArrayBinding

public void dontUseByteArrayBinding()

PUBLIC: TopLink can be configured to use parameter binding for large binary data. By default TopLink will print this data as hex through the JDBC binary excape clause. Both binding and printing have various limits on all databases (e.g. 5k - 32k).

dontUseExternalConnectionPooling

public void dontUseExternalConnectionPooling()

PUBLIC: Do not use external connection pooling. This is appropriate if using regular TopLink connection pooling and regular JDBC drivers.

See Also:

useExternalConnectionPooling()

dontUseExternalTransactionController

public void dontUseExternalTransactionController()

PUBLIC: Let TopLink control transactions instead of some external transaction service such as JTS.

See Also:

useExternalTransactionController()

dontUseJDBCBatchWriting

public void dontUseJDBCBatchWriting()

PUBLIC: Indicate to TopLink that the JDBC driver does not support batch writing. This will revert to the default behaviour which is to delegate to TopLink's internal batch writing.

See Also:

useJDBCBatchWriting(), setUsesJDBCBatchWriting(boolean usesJDBCBatchWriting)

dontUseNativeSequencing

public void dontUseNativeSequencing()

PUBLIC: TopLink can be configured to use a sequence table or native sequencing to generate unique object IDs. Native sequencing uses the ID generation service provided by the database (e.g. SEQUENCE objects on Oracle and IDENTITY columns on Sybase). By default a sequence table is used. Using a sequence table is recommended as it supports preallocation. (Native sequencing on Sybase/SQL Server/Informix does not support preallocation. Preallocation can be supported on Oracle by setting the increment size of the SEQUENCE object to match the preallocation size.)

dontUseNativeSQL

public void dontUseNativeSQL()

PUBLIC: TopLink can be configured to use database-specific SQL grammar, as opposed to the JDBC standard grammar. This is because, unfortunately, some drivers to not support the full JDBC standard. By default TopLink uses the JDBC SQL grammar.

dontUseStreamsForBinding

public void dontUseStreamsForBinding()

PUBLIC: TopLink can be configured to use streams to store large binary data.

dontUseStringBinding

public void dontUseStringBinding()

PUBLIC: Do not bind strings of any size.

forAccess

public static DatabaseLogin forAccess()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useAccess();

forDB2

public static DatabaseLogin forDB2()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useDB2();

forDBase

public static DatabaseLogin forDBase()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useDBase();

forInformix

public static DatabaseLogin forInformix()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useInformix();

forJDBC

public static DatabaseLogin forJDBC()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useJDBC();

forOracle

public static DatabaseLogin forOracle()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useOracle();

forSQLServer

public static DatabaseLogin forSQLServer()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useSQLServer();

forSybase

public static DatabaseLogin forSybase()

Deprecated.

OBSOLETE: Use oracle.toplink.sessionsDatabaseLogin instead.

See Also:

DatabaseLogin, oracle.toplink.sessions.DatabaseLogin#useSybase();

getCacheTransactionIsolation

public int getCacheTransactionIsolation()

ADVANCED: By default concurrency is optimized and the cache is not locked more than required during reads or writes, This allows for virtual concurrent reading and writing and should never cause any problems. If the application uses no form of locking the last unit of work to merge changes will win, with no locking it is possible only under this senerio for two unit of works to merge changes different than the database although highly unlikely and if occured is the entire purpose of locking and locking is the suggested solution if this is a problem. This property allows for the isolation level of changes to the cache to be configured for sever situations and it is not suggest that this be changed.

Setting are:

• ConcurrentReadWrite - default
• SynchronizedWrite - only allow a single writer (i.e. unit of work merge) to the cache at once
• SynchronizedReadOnWrite - do not allow reading or other unit of work merge ehile a unit of work is in merge

  getConnectionString

  public java.lang.String getConnectionString()
                                       throws ValidationException
  

  PUBLIC: Return the JDBC connection string. This is a combination of the driver-specific URL header and the database URL.

  Throws:

  ValidationException

  getConnector

  public Connector getConnector()
  

  PUBLIC: Return the connector that will instantiate the java.sql.Connection.

  getCursorCode

  public int getCursorCode()
  

  ADVANCED: Return the code for preparing cursored output parameters in a stored procedure

  getDatabaseName

  public java.lang.String getDatabaseName()
  

  PUBLIC: The database name is required when connecting to databases that support multiple databases within a single server instance (e.g. Sybase, SQL Server). This is ONLY used when connecting through ODBC type JDBC drivers. This is NEVER used with Oracle.

  getDatabaseURL

  public java.lang.String getDatabaseURL()
                                  throws ValidationException
  

  PUBLIC: The database URL is the JDBC URL for the database server. The driver header is not be included in this URL (e.g. "dbase files"; not "jdbc:odbc:dbase files").

  Throws:

  ValidationException

  getDataSourceName

  public java.lang.String getDataSourceName()
                                     throws ValidationException
  

  PUBLIC: The data source name is required if connecting through ODBC (JDBC-ODBC, etc.). This is the ODBC name given in the ODBC Data Source Administrator. This is just the database part of the URL.

  Throws:

  ValidationException

  getDriverClassName

  public java.lang.String getDriverClassName()
                                      throws ValidationException
  

  PUBLIC: The driver class is the name of the Java class for the JDBC driver being used (e.g. "sun.jdbc.odbc.JdbcOdbcDriver").

  Throws:

  ValidationException

  getDriverURLHeader

  public java.lang.String getDriverURLHeader()
                                      throws ValidationException
  

  PUBLIC: The driver URL header is the string predetermined by the JDBC driver to be part of the URL connection string, (e.g. "jdbc:odbc:"). This is required to connect to the database.

  Throws:

  ValidationException

  getKey

  public static java.lang.String getKey()
  

  Deprecated. replaced by getLicensePath License keys are no longer used and have been replaced with license files.

  OBSOLETE:

  getLicensePath

  public static java.lang.String getLicensePath()
  

  Deprecated. since 4.6. No direct replacement API.

  OBSOLETE: Return the current TopLink license path.

  getMaxBatchWritingSize

  public int getMaxBatchWritingSize()
  

  PUBLIC: Allow for the max batch writing size to be set. This allows for the batch size to be limited as most database have strict limits. The size is in characters, the default is 32000 but the real value depends on the database configuration.

  getProperty

  public java.lang.Object getProperty(java.lang.String name)
  

  PUBLIC: The properties are additional, driver-specific, connection information to be passed to the JDBC driver.

  NOTE: Do not set the password directly by getting the properties and setting the "password" property directly. Use the method DatabaseLogin.setPassword(String).

  getSequenceCounterFieldName

  public java.lang.String getSequenceCounterFieldName()
  

  PUBLIC: Return the name of the column in the TopLink sequence table that holds the current value for a given sequence (e.g. "SEQ_COUNT"). TopLink uses the sequence table to generate unique object IDs.

  getSequenceCounterName

  public java.lang.String getSequenceCounterName()
  

  Deprecated. replaced by getSequenceCounterFieldName()

  OBSOLETE:

  See Also:

  getSequenceCounterFieldName()

  getSequenceFieldName

  public java.lang.String getSequenceFieldName()
  

  Deprecated. replaced by getSequenceNameFieldName()

  OBSOLETE:

  See Also:

  getSequenceNameFieldName()

  getSequenceNameFieldName

  public java.lang.String getSequenceNameFieldName()
  

  PUBLIC: Return the name of the column in the TopLink sequence table that holds the name for a given sequence (e.g. "SEQ_NAME"). TopLink uses the sequence table to generate unique object IDs.

  getSequencePreallocationSize

  public int getSequencePreallocationSize()
  

  PUBLIC: TopLink supports sequence number preallocation. This improves the performance and concurrency of inserts by selecting new object IDs in batches and caching them on the client. The preallocation size can be configured, and the default is 50. By default a sequence table is used. Using a sequence table is recommended as it supports preallocation. (Native sequencing on Sybase/SQL Server/Informix does not support preallocation. Preallocation can be supported on Oracle by setting the increment size of the SEQUENCE object to match the preallocation size.)

  getQualifiedSequenceTableName

  public java.lang.String getQualifiedSequenceTableName()
  

  PUBLIC: Return the the qualified name of the TOPLink sequence table.

  getSequenceTableName

  public java.lang.String getSequenceTableName()
  

  PUBLIC: Return the name of the TopLink sequence table. TopLink uses a sequence table to generate unique object IDs.

  getServerName

  public java.lang.String getServerName()
  

  PUBLIC: The server name is the name of the database instance. This is ONLY required if using an ODBC JDBC driver and overriding the server name specified in the ODBC Data Source Administrator.

  getShouldBindAllParameters

  public boolean getShouldBindAllParameters()
  

  PUBLIC: Used to help bean introspection.

  getShouldCacheAllStatements

  public boolean getShouldCacheAllStatements()
  

  PUBLIC: Used to help bean introspection.

  getShouldOptimizeDataConversion

  public boolean getShouldOptimizeDataConversion()
  

  PUBLIC: Used to help bean introspection.

  getShouldTrimStrings

  public boolean getShouldTrimStrings()
  

  PUBLIC: Used to help bean introspection.

  getStatementCacheSize

  public int getStatementCacheSize()
  

  PUBLIC: If prepared statement caching is used, return the cache size. The default is 50.

  getStringBindingSize

  public int getStringBindingSize()
  

  PUBLIC: Used to help bean introspection.

  getStudioLicenseFile

  public static java.lang.String getStudioLicenseFile()
  

  Deprecated. since 4.6. No direct replacement API.

  OBSOLETE: Return the TopLink license file name. The license file must be set before connecting.

  getTableQualifier

  public java.lang.String getTableQualifier()
  

  PUBLIC: Return the qualifier for the all of the tables referenced by TopLink. This can be the creator of the table or database name the table exists on. This is required by some databases such as Oracle and DB2. This should only be used if all of the tables have the same qualifier. It can also be set on each descriptor when the table name is specified.

  getLicenseFile

  public static java.lang.String getLicenseFile()
  

  Deprecated. since 4.6. No direct replacement API.

  OBSOLETE: Return the TopLink license file name. The license file must be set before connecting.

  getTransactionIsolation

  public int getTransactionIsolation()
  

  PUBLIC: Return the transaction isolation setting for the connection. Return -1 if it has not been set.

  getUserName

  public java.lang.String getUserName()
  

  PUBLIC: The user name is the database login name. Some databases do not require a user name or the user is obtained from the OS, in this case the user name not be specified.

  Specified by:

  getUserName in interface Login

  getUsesBinding

  public boolean getUsesBinding()
  

  PUBLIC: Used to help bean introspection.

  getUsesNativeSequencing

  public boolean getUsesNativeSequencing()
  

  PUBLIC: Used to help bean introspection.

  getUsesNativeSQL

  public boolean getUsesNativeSQL()
  

  PUBLIC: Used to help bean introspection.

  getUsesStreamsForBinding

  public boolean getUsesStreamsForBinding()
  

  PUBLIC: Used to help bean introspection.

  getUsesStringBinding

  public boolean getUsesStringBinding()
  

  PUBLIC: Used to help bean introspection.

  getVersion

  public static java.lang.String getVersion()
  

  PUBLIC: Return the TopLink version.

  Returns:

  version of TopLink

  getXMLParserJARFileNames

  public static java.lang.String[] getXMLParserJARFileNames()
  

  ADVANCED: Return the names of the TopLink SDK XML Support JAR files

  handleTransactionsManuallyForSybaseJConnect

  public void handleTransactionsManuallyForSybaseJConnect()
  

  PUBLIC: Force TopLink to manually begin transactions instead of using autoCommit. Although autoCommit should be used, and work, under JDBC, some drivers (e.g. Sybase JConnect) do not correctly map autoCommit to transactions, so stored procedures may not work correctly. This property should only be used as a workaround for the Sybase JConnect transaction problem.

  isAnyOracleJDBCBridge

  public boolean isAnyOracleJDBCBridge()
  

  Deprecated.

  OBSOLETE: Return whether an Oracle JDBC driver is being used.

  See Also:

  isAnyOracleJDBCDriver()

  isAnyOracleJDBCDriver

  public boolean isAnyOracleJDBCDriver()
  

  PUBLIC: Return whether an Oracle JDBC driver is being used.

  isCloudscapeJDBCDriver

  public boolean isCloudscapeJDBCDriver()
  

  PUBLIC: Return whether a Cloudscape JDBC driver is being used.

  isDB2JDBCBridge

  public boolean isDB2JDBCBridge()
  

  Deprecated.

  OBSOLETE: Return whether an IBM DB2 native client JDBC driver is being used.

  See Also:

  isDB2JDBCDriver()

  isDB2JDBCDriver

  public boolean isDB2JDBCDriver()
  

  PUBLIC: Return whether an IBM DB2 native client JDBC driver is being used.

  isIntersolvSequeLinkBridge

  public boolean isIntersolvSequeLinkBridge()
  

  Deprecated.

  OBSOLETE: Return whether an Intersolv SeqeLink JDBC driver is being used.

  See Also:

  isIntersolvSequeLinkDriver()

  isIntersolvSequeLinkDriver

  public boolean isIntersolvSequeLinkDriver()
  

  PUBLIC: Return whether an Intersolv SeqeLink JDBC driver is being used.

  isJConnectBridge

  public boolean isJConnectBridge()
  

  Deprecated.

  OBSOLETE: Return whether a Sybase JConnect JDBC driver is being used.

  See Also:

  isJConnectDriver()

  isJConnectDriver

  public boolean isJConnectDriver()
  

  PUBLIC: Return whether a Sybase JConnect JDBC driver is being used.

  isJDBCConnectBridge

  public boolean isJDBCConnectBridge()
  

  Deprecated.

  OBSOLETE: Return whether a Borland JDBCConnect JDBC driver is being used.

  See Also:

  isJDBCConnectDriver()

  isJDBCConnectDriver

  public boolean isJDBCConnectDriver()
  

  PUBLIC: Return whether a Borland JDBCConnect JDBC driver is being used.

  isJDBCConnectRemoteBridge

  public boolean isJDBCConnectRemoteBridge()
  

  Deprecated.

  OBSOLETE: Return whether a Borland JDBCConnect JDBC driver is being used.

  See Also:

  isJDBCConnectRemoteDriver()

  isJDBCConnectRemoteDriver

  public boolean isJDBCConnectRemoteDriver()
  

  PUBLIC: Return whether a Borland JDBCConnect JDBC driver is being used.

  isJDBCODBCBridge

  public boolean isJDBCODBCBridge()
  

  PUBLIC: Return whether a Sun/Merant JDBC-ODBC bridge driver is being used.

  isOracle7JDBCBridge

  public boolean isOracle7JDBCBridge()
  

  Deprecated.

  OBSOLETE: Return whether an Oracle 7.x native OCI JDBC driver is being used.

  See Also:

  isOracle7JDBCDriver()

  isOracle7JDBCDriver

  public boolean isOracle7JDBCDriver()
  

  PUBLIC: Return whether an Oracle native 7.x OCI JDBC driver is being used.

  isOracleJDBCBridge

  public boolean isOracleJDBCBridge()
  

  Deprecated.

  OBSOLETE: Return whether an Oracle 8.x native OCI JDBC driver is being used.

  See Also:

  isOracleJDBCDriver()

  isOracleJDBCDriver

  public boolean isOracleJDBCDriver()
  

  PUBLIC: Return whether an Oracle 8.x native OCI JDBC driver is being used.

  isOracleServerJDBCBridge

  public boolean isOracleServerJDBCBridge()
  

  Deprecated.

  OBSOLETE: Return whether an Oracle thin JDBC driver is being used.

  See Also:

  isOracleServerJDBCDriver()

  isOracleServerJDBCDriver

  public boolean isOracleServerJDBCDriver()
  

  PUBLIC: Return whether an Oracle thin JDBC driver is being used.

  isOracleThinJDBCBridge

  public boolean isOracleThinJDBCBridge()
  

  Deprecated.

  OBSOLETE: Return whether an Oracle thin JDBC driver is being used.

  See Also:

  isOracleThinJDBCDriver()

  isOracleThinJDBCDriver

  public boolean isOracleThinJDBCDriver()
  

  PUBLIC: Return whether an Oracle thin JDBC driver is being used.

  isWebLogicOracleOCIBridge

  public boolean isWebLogicOracleOCIBridge()
  

  Deprecated.

  OBSOLETE: Return whether a WebLogic Oracle OCI JDBC driver is being used.

  See Also:

  isWebLogicOracleOCIDriver()

  isWebLogicOracleOCIDriver

  public boolean isWebLogicOracleOCIDriver()
  

  PUBLIC: Return whether a WebLogic Oracle OCI JDBC driver is being used.

  isWebLogicSQLServerBridge

  public boolean isWebLogicSQLServerBridge()
  

  Deprecated.

  OBSOLETE: Return whether a WebLogic SQL Server JDBC driver is being used.

  See Also:

  isWebLogicSQLServerDriver()

  isWebLogicSQLServerDBLibBridge

  public boolean isWebLogicSQLServerDBLibBridge()
  

  Deprecated.

  OBSOLETE: Return whether a WebLogic SQL Server dblib JDBC driver is being used.

  See Also:

  isWebLogicSQLServerDBLibDriver()

  isWebLogicSQLServerDBLibDriver

  public boolean isWebLogicSQLServerDBLibDriver()
  

  PUBLIC: Return whether a WebLogic SQL Server dblib JDBC driver is being used.

  isWebLogicSQLServerDriver

  public boolean isWebLogicSQLServerDriver()
  

  PUBLIC: Return whether a WebLogic SQL Server JDBC driver is being used.

  isWebLogicSybaseDBLibBridge

  public boolean isWebLogicSybaseDBLibBridge()
  

  Deprecated.

  OBSOLETE: Return whether a WebLogic Sybase dblib JDBC driver is being used.

  See Also:

  isWebLogicSybaseDBLibDriver()

  isWebLogicSybaseDBLibDriver

  public boolean isWebLogicSybaseDBLibDriver()
  

  PUBLIC: Return whether a WebLogic Sybase dblib JDBC driver is being used.

  isWebLogicThinBridge

  public boolean isWebLogicThinBridge()
  

  Deprecated.

  OBSOLETE: Return whether a WebLogic thin JDBC driver is being used.

  See Also:

  isWebLogicThinDriver()

  isWebLogicThinClientBridge

  public boolean isWebLogicThinClientBridge()
  

  Deprecated.

  OBSOLETE: Return whether a WebLogic thin client JDBC driver is being used.

  See Also:

  isWebLogicThinClientDriver()

  isWebLogicThinClientDriver

  public boolean isWebLogicThinClientDriver()
  

  PUBLIC: Return whether a WebLogic thin client JDBC driver is being used.

  isWebLogicThinDriver

  public boolean isWebLogicThinDriver()
  

  PUBLIC: Return whether a WebLogic thin JDBC driver is being used.

  optimizeDataConversion

  public void optimizeDataConversion()
  

  PUBLIC: Enable driver level data conversion optimization. This can be disabled as some drivers perform data conversion themselves incorrectly.

  removeProperty

  public void removeProperty(java.lang.String propertyName)
  

  PUBLIC: Some JDBC drivers don't like the "user" and "password" properties. They can be removed with this method.

  setCacheTransactionIsolation

  public void setCacheTransactionIsolation(int cacheTransactionIsolation)
  

  ADVANCED: By default concurrency is optimized and the cache is not locked more than required during reads or writes, This allows for virtual concurrent reading and writing and should never cause any problems. If the application uses no form of locking the last unit of work to merge changes will win, with no locking it is possible only under this senerio for two unit of works to merge changes different than the database although highly unlikely and if occured is the entire purpose of locking and locking is the suggested solution if this is a problem. This property allows for the isolation level of changes to the cache to be configured for sever situations and it is not suggest that this be changed.

  Setting are:

  • ConcurrentReadWrite - default
  • SynchronizedWrite - only allow a single writer (i.e. unit of work merge) to the cache at once
  • SynchronizedReadOnWrite - do not allow reading or other unit of work merge ehile a unit of work is in merge

    setConnectionString

    public void setConnectionString(java.lang.String url)
                             throws ValidationException
    

    PUBLIC: Set the JDBC connection string. This is the full JDBC connect URL. Normally TopLink breaks this into two parts to allow for the driver header to be automatically set, however sometimes it is easier just to set the entire URL at once.

    Throws:

    ValidationException

    setConnector

    public void setConnector(Connector connector)
    

    PUBLIC: Set the connector that will instantiate the java.sql.Connection. This allows the developer to use a non-JDBC 1.0 compliant connection technique.

    As an example, to use a JNDI-supplied DataSource, use code something like the following:

    session.getLogin().setConnector(new JNDIConnector(context, dataSourceName));
session.login();

    where the context is an instance of a javax.naming.Context and the dataSourceName refers to the name of the DataSource within the context.

    setCursorCode

    public void setCursorCode(int cursorCode)
    

    ADVANCED: Set the code for preparing cursored output parameters in a stored procedure

    setDatabaseName

    public void setDatabaseName(java.lang.String databaseName)
    

    PUBLIC: The database name is required when connecting to databases that support multiple databases within a single server instance (e.g. Sybase, SQL Server). This is ONLY used when connecting through ODBC type JDBC drivers. This is NEVER used with Oracle.

    setDatabaseURL

    public void setDatabaseURL(java.lang.String databaseURL)
                        throws ValidationException
    

    PUBLIC: The database URL is the JDBC URL for the database server. The driver header should not be included in this URL (e.g. "dbase files"; not "jdbc:odbc:dbase files").

    Throws:

    ValidationException

    setDataSourceName

    public void setDataSourceName(java.lang.String dataSourceName)
    

    PUBLIC: The data source name is required if connecting through ODBC (JDBC-ODBC, etc.). This is the ODBC name given in the ODBC Data Source Administrator. This is just the database part of the URL.

    setDefaultNullValue

    public void setDefaultNullValue(java.lang.Class type,
                                    java.lang.Object value)
    

    PUBLIC: The default value to substitute for database NULLs can be configured on a per-class basis. Example: login.setDefaultNullValue(long.class, new Long(0))

    setDriverClass

    public void setDriverClass(java.lang.Class driverClass)
    

    PUBLIC: The driver class is the Java class for the JDBC driver to be used (e.g. sun.jdbc.odbc.JdbcOdbcDriver.class).

    setDriverClassName

    public void setDriverClassName(java.lang.String driverClassName)
                            throws ValidationException
    

    PUBLIC: The name of the JDBC driver class to be used (e.g. "sun.jdbc.odbc.JdbcOdbcDriver").

    Throws:

    ValidationException

    setDriverURLHeader

    public void setDriverURLHeader(java.lang.String driverURLHeader)
                            throws ValidationException
    

    PUBLIC: The driver URL header is the string predetermined by the JDBC driver to be part of the URL connection string, (e.g. "jdbc:odbc:"). This is required to connect to the database.

    Throws:

    ValidationException

    setKey

    public static void setKey(java.lang.String key)
    

    Deprecated. replaced by setLicensePath License keys are no longer used and have been replaced with license files.

    OBSOLETE:

    setKey

    public static void setKey(java.lang.String resourceName,
                              java.lang.String keyName)
                       throws java.util.MissingResourceException
    

    Deprecated. replaced by setLicensePath License keys are no longer used and have been replaced with license files.

    OBSOLETE:

    Throws:

    java.util.MissingResourceException

    setLicensePath

    public static void setLicensePath(java.lang.String path)
    

    Deprecated. since 4.6. No direct replacement API.

    OBSOLETE: Set the TopLink license path. The license file path must be set before connecting.

    setMaxBatchWritingSize

    public void setMaxBatchWritingSize(int maxBatchWritingSize)
    

    PUBLIC: Allow for the max batch writing size to be set. This allows for the batch size to be limited as most database have strict limits. The size is in characters, the default is 32000 but the real value depends on the database configuration.

    setPassword

    public void setPassword(java.lang.String password)
    

    Set the password.

    Specified by:

    setPassword in interface Login

    getPassword

    public java.lang.String getPassword()
    

    Return the password. It will be encrypted.

    Specified by:

    getPassword in interface Login

    setEncryptedPassword

    public void setEncryptedPassword(java.lang.String password)
    

    Set the encrypted password.

    setEncryptionClassName

    public void setEncryptionClassName(java.lang.String encryptionClassName)
    

    Sets the encryption class name

    setProperties

    public void setProperties(java.util.Properties properties)
    

    PUBLIC: The properties are additional, driver-specific, connection information to be passed to the JDBC driver.

    setProperty

    public void setProperty(java.lang.String propertyName,
                            java.lang.Object propertyValue)
    

    PUBLIC: Some JDBC drivers require additional, driver-specific, properties. Add the specified property to those to be passed to the JDBC driver.

    setSelectSequenceNumberQuery

    public void setSelectSequenceNumberQuery(ValueReadQuery selectSequenceNumberQuery)
    

    PUBLIC: Override the default query for reading the sequence numbers. This query must be a valid query that has one parameter, the sequence name. The query should only return the new value. It will be called after the sequence update query. If TopLink is using native sequencing, then the query must both update and return the new sequence value. Additionally, if TopLink is using native sequencing, the query should not define any parameters.

    setSequenceCounterFieldName

    public void setSequenceCounterFieldName(java.lang.String name)
    

    PUBLIC: Set the name of the column in the TopLink sequence table that holds the current value for a given sequence (e.g. "SEQ_COUNT"). TopLink uses the sequence table to generate unique object IDs.

    setSequenceCounterName

    public void setSequenceCounterName(java.lang.String name)
    

    Deprecated. replaced by setSequenceCounterFieldName()

    OBSOLETE:

    See Also:

    #setSequenceCounterFieldName()

    setSequenceFieldName

    public void setSequenceFieldName(java.lang.String name)
    

    Deprecated. replaced by setSequenceNameFieldName()

    OBSOLETE:

    See Also:

    #setSequenceNameFieldName()

    setSequenceNameFieldName

    public void setSequenceNameFieldName(java.lang.String name)
    

    PUBLIC: Set the name of the column in the TopLink sequence table that holds the name for a given sequence (e.g. "SEQ_NAME"). TopLink uses the sequence table to generate unique object IDs.

    setSequencePreallocationSize

    public void setSequencePreallocationSize(int size)
    

    PUBLIC: TopLink supports sequence number preallocation. This improves the performance and concurrency of inserts by selecting new object IDs in batches and caching them on the client. The preallocation size can be configured, and the default is 50. By default a sequence table is used. Using a sequence table is recommended as it supports preallocation. This MUST be 1 if native sequencing is used on Sybase, Informix, or SQL Server. This MUST match the SEQUENCE increment if Oracle native sequencing is used.

    setSequenceTableName

    public void setSequenceTableName(java.lang.String name)
    

    PUBLIC: Set the name of the TopLink sequence table. TopLink uses a sequence table to generate unique object IDs.

    setServerName

    public void setServerName(java.lang.String name)
    

    PUBLIC: The server name is the name of the database instance. This is ONLY used when connecting through ODBC type JDBC drivers, and only if the data source does not specify it already.

    setShouldBindAllParameters

    public void setShouldBindAllParameters(boolean shouldBindAllParameters)
    

    PUBLIC: Set whether to bind all arguments to any SQL statement.

    setShouldCacheAllStatements

    public void setShouldCacheAllStatements(boolean shouldCacheAllStatements)
    

    PUBLIC: Set whether prepared statements should be cached.

    setShouldForceFieldNamesToUpperCase

    public void setShouldForceFieldNamesToUpperCase(boolean shouldForceFieldNamesToUpperCase)
    

    ADVANCED: This setting can be used if the application expects upper case but the database does not return consistent case (e.g. different databases).

    setShouldIgnoreCaseOnFieldComparisons

    public static void setShouldIgnoreCaseOnFieldComparisons(boolean shouldIgnoreCaseOnFieldComparisons)
    

    ADVANCED: Allow for case in field names to be ignored as some databases are not case sensitive. When using custom this can be an issue if the fields in the descriptor have a different case.

    setShouldOptimizeDataConversion

    public void setShouldOptimizeDataConversion(boolean value)
    

    PUBLIC: Set whether driver level data conversion optimization is enabled. This can be disabled as some drivers perform data conversion themselves incorrectly.

    setShouldTrimStrings

    public void setShouldTrimStrings(boolean shouldTrimStrings)
    

    PUBLIC: By default CHAR field values have trailing blanks trimmed, this can be configured.

    setStatementCacheSize

    public void setStatementCacheSize(int size)
    

    PUBLIC: If prepared statement caching is used this configures the cache size. The default is 50.

    setStringBindingSize

    public void setStringBindingSize(int stringBindingSize)
    

    PUBLIC: Used to help bean introspection.

    setTableQualifier

    public void setTableQualifier(java.lang.String qualifier)
    

    PUBLIC: Set the default qualifier for all tables. This can be the creator of the table or database name the table exists on. This is required by some databases such as Oracle and DB2.

    setTimestampQuery

    public void setTimestampQuery(ValueReadQuery timestampQuery)
    

    PUBLIC: Override the default query for returning a timestamp from the server.

    setTransactionIsolation

    public void setTransactionIsolation(int isolationLevel)
    

    PUBLIC: Set the transaction isolation setting for the connection. This is an optional setting. The default isolation level set on the database will apply if it is not set here. Use one of the TRANSACTION_* constants for valid input values. Note: This setting will only take effect upon connection.

    setUpdateSequenceQuery

    public void setUpdateSequenceQuery(DataModifyQuery updateSequenceNumberQuery)
    

    PUBLIC: Override the default query for updating sequence numbers. This allows another query to be used instead of the default, TopLink-generated, one. This is called before the sequence select query and only if TopLink is using non-native sequencing.

    setUserName

    public void setUserName(java.lang.String name)
    

    PUBLIC: The user name is the database login name. Some databases do not require a user name or the user is obtained from the OS, in this case this should not be specified.

    Specified by:

    setUserName in interface Login

    setUsesBatchWriting

    public void setUsesBatchWriting(boolean value)
    

    PUBLIC: TopLink can be configured to use batch writing. This facility allows multiple write operations to be submitted to a database for processing at once. Submitting multiple updates together, instead of individually, can greatly improve performance in some situations.

    setUsesBinding

    public void setUsesBinding(boolean value)
    

    Deprecated. replaced by setUsesByteArrayBinding(boolean)

    OBSOLETE:

    See Also:

    setUsesByteArrayBinding(boolean)

    setUsesByteArrayBinding

    public void setUsesByteArrayBinding(boolean value)
    

    PUBLIC: TopLink can be configured to use parameter binding for large binary data. By default TopLink will print this data as hex through the JDBC binary excape clause. Both binding and printing have various limits on all databases (e.g. 5k - 32k).

    setUsesDirectDriverConnect

    public void setUsesDirectDriverConnect(boolean usesDirectDriverConnect)
    

    Deprecated.

    OBSOLETE: Some JDBC drivers don't support connecting correctly (via DriverManager), but do support connecting incorrectly (e.g. Castanet).

    See Also:

    useDirectDriverConnect(), useDefaultDriverConnect()

    setUsesExternalConnectionPooling

    public void setUsesExternalConnectionPooling(boolean usesExternalConnectionPooling)
    

    PUBLIC: Return whether TopLink uses some external connection pooling service such as a JDBC 2.0 driver.

    setUsesExternalTransactionController

    public void setUsesExternalTransactionController(boolean usesExternalTransactionController)
    

    PUBLIC: Return whether TopLink uses some external transaction service such as JTS.

    setUsesJDBCBatchWriting

    public void setUsesJDBCBatchWriting(boolean usesJDBCBatchWriting)
    

    PUBLIC: Calling this method with an argument of true indicates to TopLink that the JDBC driver supports batch writing. TopLink's internal batch writing is disabled.

    Calling this method with an argument of false indicates to TopLink that the JDBC driver does not support batch writing. This will revert to the default behaviour which is to delegate to TopLink's internal batch writing.

    Parameters:

    usesJDBCBatchWriting - boolean true delegates batch writing to the JDBC driver and false delegates batch writing to TopLink.

    setUsesNativeSequencing

    public void setUsesNativeSequencing(boolean value)
    

    PUBLIC: TopLink can be configured to use a sequence table, or native sequencing to generate unique object ids. Native sequencing uses the id generation service provided by the database, such as "sequence" objects on Oracle and "identity" columns on Sybase. By default a sequence table is used and suggested to be used as it allows for sequence Preallocation which cannot be done through native sequencing.

    setUsesNativeSQL

    public void setUsesNativeSQL(boolean value)
    

    PUBLIC: TopLink can be configured to use database specific sql grammar not JDBC specific. This is because unfortunately some bridges to not support the full JDBC standard. By default TopLink uses the JDBC sql grammar.

    setUsesStreamsForBinding

    public void setUsesStreamsForBinding(boolean value)
    

    PUBLIC: TopLink can be configured to use streams to store large binary data. This can improve the max size for reading/writing on some JDBC drivers.

    setUsesStringBinding

    public void setUsesStringBinding(boolean usesStringBindingSize)
    

    PUBLIC: Used to help bean introspection.

    setXMLParserJARFileNames

    public static void setXMLParserJARFileNames(java.lang.String[] jarFileNames)
    

    ADVANCED: Specify the names of the TopLink SDK XML Support JAR files. This must be used if the application needs different version of the various public XML packages (e.g. org.w3c.dom, org.xml.sax, org.apache.xerces) than those used by TopLink. Example: DatabaseLogin.setXMLParserJARFileNames(new String[] {"xerces.jar", "TopLinkXerces.jar"});

    shouldBindAllParameters

    public boolean shouldBindAllParameters()
    

    PUBLIC: Bind all arguments to any SQL statement.

    shouldCacheAllStatements

    public boolean shouldCacheAllStatements()
    

    PUBLIC: Cache all prepared statements, this requires full parameter binding as well.

    shouldForceFieldNamesToUpperCase

    public boolean shouldForceFieldNamesToUpperCase()
    

    ADVANCED: Can be used if the app expects upper case but the database is not return consistent case, i.e. different databases.

    shouldIgnoreCaseOnFieldComparisons

    public static boolean shouldIgnoreCaseOnFieldComparisons()
    

    ADVANCED: Allow for case in field names to be ignored as some databases are not case sensitive. When using custom this can be an issue if the fields in the descriptor have a different case.

    shouldOptimizeDataConversion

    public boolean shouldOptimizeDataConversion()
    

    PUBLIC: Return if our driver level data conversion optimization is enabled. This can be disabled as some drivers perform data conversion themselves incorrectly.

    shouldTrimStrings

    public boolean shouldTrimStrings()
    

    PUBLIC: By default CHAR field values have trailing blanks trimmed, this can be configured.

    shouldUseBatchWriting

    public boolean shouldUseBatchWriting()
    

    PUBLIC: TopLink can be configured to use batch writing. This facility allows multiple write operations to be submitted to a database for processing at once. Submitting multiple updates together, instead of individually, can greatly improve performance in some situations.

    shouldUseBinding

    public boolean shouldUseBinding()
    

    Deprecated. replaced by usesByteArrayBinding()

    OBSOLETE:

    See Also:

    usesByteArrayBinding()

    shouldUseByteArrayBinding

    public boolean shouldUseByteArrayBinding()
    

    PUBLIC: TopLink can be configured to use parameter binding for large binary data. By default TopLink will print this data as hex through the JDBC binary excape clause. Both binding and printing have various limits on all databases (e.g. 5k - 32k).

    shouldUseExternalConnectionPooling

    public boolean shouldUseExternalConnectionPooling()
    

    PUBLIC: Return whether TopLink uses some external connection pooling (e.g. WebLogic's JTS driver).

    See Also:

    useExternalConnectionPooling(), dontUseExternalConnectionPooling()

    shouldUseExternalTransactionController

    public boolean shouldUseExternalTransactionController()
    

    PUBLIC: Return whether TopLink uses some external transaction service such as JTS.

    See Also:

    useExternalTransactionController(), dontUseExternalTransactionController()

    shouldUseJDBCBatchWriting

    public boolean shouldUseJDBCBatchWriting()
    

    PUBLIC: Answers true if TopLink has JDBC batch writing enabled. This is the case if setUsesJDBCBatchWriting(true) has been called.

    Returns:

    boolean true if batch writing is delegated to the JDBC driver. Returns false if delegated to TopLink.

    See Also:

    useJDBCBatchWriting(), dontUseJDBCBatchWriting(), setUsesJDBCBatchWriting(boolean usesJDBCBatchWriting)

    shouldUseNativeSequencing

    public boolean shouldUseNativeSequencing()
    

    PUBLIC: TopLink can be configured to use a sequence table or native sequencing to generate unique object IDs. Native sequencing uses the ID generation service provided by the database (e.g. SEQUENCE objects on Oracle and IDENTITY columns on Sybase). By default a sequence table is used. Using a sequence table is recommended as it supports preallocation. (Native sequencing on Sybase/SQL Server/Informix does not support preallocation. Preallocation can be supported on Oracle by setting the increment size of the SEQUENCE object to match the preallocation size.)

    shouldUseNativeSQL

    public boolean shouldUseNativeSQL()
    

    PUBLIC: TopLink can be configured to use database-specific SQL grammar, as opposed to the JDBC standard grammar. This is because, unfortunately, some drivers to not support the full JDBC standard. By default TopLink uses the JDBC SQL grammar.

    shouldUseStreamsForBinding

    public boolean shouldUseStreamsForBinding()
    

    PUBLIC: TopLink can be configured to use streams to store large binary data.

    shouldUseStringBinding

    public boolean shouldUseStringBinding()
    

    PUBLIC: TopLink can be configured to bind large strings.

    toString

    public java.lang.String toString()
    

    PUBLIC: Print all of the connection information.

    useAccess

    public void useAccess()
    

    PUBLIC: Set the database platform to be Access.

    useBatchWriting

    public void useBatchWriting()
    

    PUBLIC: TopLink can be configured to use batch writing. This facility allows multiple write operations to be submitted to a database for processing at once. Submitting multiple updates together, instead of individually, can greatly improve performance in some situations.

    useBinding

    public void useBinding()
    

    Deprecated. replaced by useByteArrayBinding()

    OBSOLETE:

    See Also:

    useByteArrayBinding()

    useByteArrayBinding

    public void useByteArrayBinding()
    

    PUBLIC: TopLink can be configured to use parameter binding for large binary data. By default TopLink will print this data as hex through the JDBC binary excape clause. Both binding and printing have various limits on all databases (e.g. 5k - 32k).

    useCloudscape

    public void useCloudscape()
    

    PUBLIC: Set the database platform to be Cloudscape.

    useCloudscapeDriver

    public void useCloudscapeDriver()
    

    PUBLIC: Use the Cloudscape JDBC driver.

    useDB2

    public void useDB2()
    

    PUBLIC: Set the database platform to be DB2.

    useDB2JDBCBridge

    public void useDB2JDBCBridge()
    

    Deprecated.

    OBSOLETE: Use the IBM DB2 native client interface.

    See Also:

    useDB2JDBCDriver()

    useDB2JDBCDriver

    public void useDB2JDBCDriver()
    

    PUBLIC: Use the IBM DB2 native client interface.

    useDB2NetJDBCBridge

    public void useDB2NetJDBCBridge()
    

    Deprecated.

    OBSOLETE: Use the IBM DB2 thin JDBC driver.

    See Also:

    useDB2NetJDBCDriver()

    useDB2NetJDBCDriver

    public void useDB2NetJDBCDriver()
    

    PUBLIC: Use the IBM DB2 thin JDBC driver.

    useDBase

    public void useDBase()
    

    PUBLIC: Set the database platform to be DBase.

    useDefaultDriverConnect

    public void useDefaultDriverConnect()
    

    PUBLIC: Connect to the JDBC driver via DriverManager.

    See Also:

    useDirectDriverConnect()

    useDefaultDriverConnect

    public void useDefaultDriverConnect(java.lang.String driverClassName,
                                        java.lang.String driverURLHeader,
                                        java.lang.String databaseURL)
    

    PUBLIC: Connect to the JDBC driver via DriverManager.

    See Also:

    useDirectDriverConnect(String, String, String)

    useDirectDriverConnect

    public void useDirectDriverConnect()
    

    PUBLIC: Some JDBC drivers don't support connecting correctly (via DriverManager), but do support connecting incorrectly (e.g. Castanet).

    See Also:

    useDirectDriverConnect()

    useDirectDriverConnect

    public void useDirectDriverConnect(java.lang.String driverClassName,
                                       java.lang.String driverURLHeader,
                                       java.lang.String databaseURL)
    

    PUBLIC: Some JDBC drivers don't support connecting correctly (via DriverManager), but do support connecting incorrectly (e.g. Castanet).

    See Also:

    useDefaultDriverConnect(String, String, String)

    useExternalConnectionPooling

    public void useExternalConnectionPooling()
    

    PUBLIC: Use external connection pooling, such as WebLogic's JTS driver.

    See Also:

    dontUseExternalConnectionPooling(), usesExternalConnectionPooling()

    useExternalTransactionController

    public void useExternalTransactionController()
    

    PUBLIC: Use an external transaction controller such as a JTS service

    See Also:

    dontUseExternalTransactionController(), usesExternalTransactionController()

    useHSQL

    public void useHSQL()
    

    PUBLIC: Use the HSQL JDBC driver.

    useHSQLDriver

    public void useHSQLDriver()
    

    PUBLIC: Use the HSQL JDBC driver.

    useINetSQLServerDriver

    public void useINetSQLServerDriver()
    

    PUBLIC: Use the i-net SQL Server JDBC driver.

    useInformix

    public void useInformix()
    

    PUBLIC: Set the database platform to be Informix.

    useIntersolvSequeLinkBridge

    public void useIntersolvSequeLinkBridge()
    

    Deprecated.

    OBSOLETE: Use the Intersolv/Merant SequeLink JDBC driver.

    See Also:

    useIntersolvSequeLinkDriver()

    useIntersolvSequeLinkDriver

    public void useIntersolvSequeLinkDriver()
    

    PUBLIC: Use the Intersolv/Merant SequeLink JDBC driver.

    useJConnect50Bridge

    public void useJConnect50Bridge()
    

    Deprecated.

    OBSOLETE: Use the Sybase JConnect JDBC driver.

    See Also:

    useJConnect50Driver()

    useJConnect50Driver

    public void useJConnect50Driver()
    

    PUBLIC: Use the Sybase JConnect JDBC driver.

    useJConnectBridge

    public void useJConnectBridge()
    

    Deprecated.

    OBSOLETE: Use the Sybase JConnect JDBC driver.

    See Also:

    useJConnectDriver()

    useJConnectDriver

    public void useJConnectDriver()
    

    PUBLIC: Use the Sybase JConnect JDBC driver.

    useJDBC

    public void useJDBC()
    

    PUBLIC: Set the database platform to be JDBC.

    useJDBCBatchWriting

    public void useJDBCBatchWriting()
    

    PUBLIC: TopLink support batch writing in both JDK 1.1 abd JDK 1.2. In JDK 1.2 either the batch support provided by the JDBC driver can be used, or TopLink's built-in support, this allow for this to be set. By default the driver is used in JDK 1.2. Some JDBC 2 drivers to not support batching, so this lets are own batching be used.

    useJDBCConnectBridge

    public void useJDBCConnectBridge()
    

    Deprecated.

    OBSOLETE: Use the Borland JDBCConnect JDBC driver.

    See Also:

    useJDBCConnectDriver()

    useJDBCConnectDriver

    public void useJDBCConnectDriver()
    

    PUBLIC: Use the Borland JDBCConnect JDBC driver.

    useJDBCConnectRemoteBridge

    public void useJDBCConnectRemoteBridge()
    

    Deprecated.

    OBSOLETE: Use the Borland JDBCConnect JDBC driver.

    See Also:

    useJDBCConnectRemoteDriver()

    useJDBCConnectRemoteDriver

    public void useJDBCConnectRemoteDriver()
    

    PUBLIC: Use the Borland JDBCConnect JDBC driver.

    useJDBCODBCBridge

    public void useJDBCODBCBridge()
    

    PUBLIC: User the Sun/Merant JDBC-ODBC bridge driver.

    useNativeSequencing

    public void useNativeSequencing()
    

    PUBLIC: TopLink can be configured to use a sequence table or native sequencing to generate unique object IDs. Native sequencing uses the ID generation service provided by the database (e.g. SEQUENCE objects on Oracle and IDENTITY columns on Sybase). By default a sequence table is used. Using a sequence table is recommended as it supports preallocation. (Native sequencing on Sybase/SQL Server/Informix does not support preallocation. Preallocation can be supported on Oracle by setting the increment size of the SEQUENCE object to match the preallocation size.)

    useNativeSQL

    public void useNativeSQL()
    

    PUBLIC: TopLink can be configured to use database-specific SQL grammar, as opposed to the JDBC standard grammar. This is because, unfortunately, some drivers to not support the full JDBC standard. By default TopLink uses the JDBC SQL grammar.

    useOracle

    public void useOracle()
    

    PUBLIC: Set the database platform to be Oracle.

    useOracle7JDBCBridge

    public void useOracle7JDBCBridge()
    

    Deprecated.

    OBSOLETE: Use the Oracle 7.x native OCI JDBC driver.

    See Also:

    useOracle7JDBCDriver()

    useOracle7JDBCDriver

    public void useOracle7JDBCDriver()
    

    PUBLIC: Use the Oracle 7.x native OCI JDBC driver.

    useOracleJDBCBridge

    public void useOracleJDBCBridge()
    

    Deprecated.

    OBSOLETE: Use the Oracle 8.x native OCI JDBC driver.

    See Also:

    useOracleJDBCDriver()

    useOracleJDBCDriver

    public void useOracleJDBCDriver()
    

    PUBLIC: Use the Oracle 8.x native OCI JDBC driver.

    useOracleServerJDBCBridge

    public void useOracleServerJDBCBridge()
    

    Deprecated.

    OBSOLETE: Use the Oracle server JDBC driver.

    See Also:

    useOracleServerJDBCDriver()

    useOracleServerJDBCDriver

    public void useOracleServerJDBCDriver()
    

    PUBLIC: Use the Oracle server JDBC driver.

    useOracleThinJDBCBridge

    public void useOracleThinJDBCBridge()
    

    Deprecated.

    OBSOLETE: Use the Oracle thin JDBC driver.

    See Also:

    useOracleThinJDBCDriver()

    useOracleThinJDBCDriver

    public void useOracleThinJDBCDriver()
    

    PUBLIC: Use the Oracle thin JDBC driver.

    usePlatform

    public void usePlatform(DatabasePlatform platform)
    

    ADVANCED: Set the database platform to be custom platform.

    usePointBase

    public void usePointBase()
    

    PUBLIC: Set the database platform to be PointBase.

    usePointBaseDriver

    public void usePointBaseDriver()
    

    PUBLIC: Use the PointBase JDBC driver.

    usesBatchWriting

    public boolean usesBatchWriting()
    

    Deprecated. replaced by shouldUseBatchWriting to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseBatchWriting()

    usesBinding

    public boolean usesBinding()
    

    Deprecated. replaced by usesByteArrayBinding()

    OBSOLETE:

    See Also:

    usesByteArrayBinding()

    usesByteArrayBinding

    public boolean usesByteArrayBinding()
    

    Deprecated. replaced by shouldUseByteArrayBinding to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseByteArrayBinding()

    usesDirectDriverConnect

    public boolean usesDirectDriverConnect()
    

    Deprecated.

    OBSOLETE: This was added as some drivers don't support connecting correctly, but can support connecting incorrectly such as Castanet.

    See Also:

    getConnector()

    usesExternalConnectionPooling

    public boolean usesExternalConnectionPooling()
    

    Deprecated. replaced by shouldUseExternalConnectionPooling to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseExternalConnectionPooling()

    usesExternalTransactionController

    public boolean usesExternalTransactionController()
    

    Deprecated. replaced by shouldUseExternalTransactionController to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseExternalTransactionController()

    usesJDBCBatchWriting

    public boolean usesJDBCBatchWriting()
    

    Deprecated. replaced by shouldUseJDBCBatchWriting to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseJDBCBatchWriting()

    usesNativeSequencing

    public boolean usesNativeSequencing()
    

    Deprecated. replaced by shouldUseNativeSequencing to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseNativeSequencing()

    usesNativeSQL

    public boolean usesNativeSQL()
    

    Deprecated. replaced by shouldUseNativeSQL to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseNativeSQL()

    useSQLServer

    public void useSQLServer()
    

    PUBLIC: Set the database platform to be SQL Server.

    usesStreamsForBinding

    public boolean usesStreamsForBinding()
    

    Deprecated. replaced by shouldUseStreamsForBinding to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseStreamsForBinding()

    usesStringBinding

    public boolean usesStringBinding()
    

    Deprecated. replaced by shouldUseStringBinding to avoid confusion with modifier.

    OBSOLETE:

    See Also:

    shouldUseStringBinding()

    useStreamsForBinding

    public void useStreamsForBinding()
    

    PUBLIC: TopLink can be configured to use streams to store large binary data.

    useStringBinding

    public void useStringBinding()
    

    PUBLIC: Bind strings larger than 255 characters.

    useStringBinding

    public void useStringBinding(int size)
    

    PUBLIC: Bind strings that are larger than the specified size. Strings that are smaller will not be bound.

    useSybase

    public void useSybase()
    

    PUBLIC: Set the database platform to be Sybase.

    useWebLogicDriverCursoredOutputCode

    public void useWebLogicDriverCursoredOutputCode()
    

    PUBLIC: Set the prepare cursor code to what the WebLogic Oracle OCI JDBC driver expects.

    useWebLogicJDBCConnectionPool

    public void useWebLogicJDBCConnectionPool(java.lang.String poolName)
    

    PUBLIC: Set a WebLogic JDBC connection pool (a pool must be defined for the entity beans that are to be deployed)

    useWebLogicOracleOCIBridge

    public void useWebLogicOracleOCIBridge()
    

    Deprecated.

    OBSOLETE: Use the WebLogic Oracle OCI JDBC driver.

    See Also:

    useWebLogicOracleOCIDriver()

    useWebLogicOracleOCIDriver

    public void useWebLogicOracleOCIDriver()
    

    PUBLIC: Use the WebLogic Oracle OCI JDBC driver.

    useWebLogicSQLServerBridge

    public void useWebLogicSQLServerBridge()
    

    Deprecated.

    OBSOLETE: Use the WebLogic SQL Server JDBC driver.

    See Also:

    useWebLogicSQLServerDriver()

    useWebLogicSQLServerDBLibBridge

    public void useWebLogicSQLServerDBLibBridge()
    

    Deprecated.

    OBSOLETE: Use the WebLogic SQL Server dblib JDBC driver.

    See Also:

    useWebLogicSQLServerDBLibDriver()

    useWebLogicSQLServerDBLibDriver

    public void useWebLogicSQLServerDBLibDriver()
    

    PUBLIC: Use the WebLogic SQL Server dblib JDBC driver.

    useWebLogicSQLServerDriver

    public void useWebLogicSQLServerDriver()
    

    PUBLIC: Use the WebLogic SQL Server JDBC driver.

    useWebLogicSybaseDBLibBridge

    public void useWebLogicSybaseDBLibBridge()
    

    Deprecated.

    OBSOLETE: Use the WebLogic Sybase dblib JDBC driver.

    See Also:

    useWebLogicSybaseDBLibDriver()

    useWebLogicSybaseDBLibDriver

    public void useWebLogicSybaseDBLibDriver()
    

    PUBLIC: Use the WebLogic Sybase dblib JDBC driver.

    useWebLogicThinBridge

    public void useWebLogicThinBridge()
    

    Deprecated.

    OBSOLETE: Use the WebLogic thin JDBC driver.

    See Also:

    useWebLogicThinDriver()

    useWebLogicThinClientBridge

    public void useWebLogicThinClientBridge()
    

    Deprecated.

    OBSOLETE: Use the WebLogic thin client JDBC driver.

    See Also:

    useWebLogicThinClientDriver()

    useWebLogicThinClientDriver

    public void useWebLogicThinClientDriver()
    

    PUBLIC: Use the WebLogic thin client JDBC driver.

    useWebLogicThinDriver

    public void useWebLogicThinDriver()
    

    PUBLIC: Use the WebLogic thin JDBC driver.