Skip navigation links

oracle.toplink.sessions
Interface Login

All Known Implementing Classes:

DatabaseLogin, DatasourceLogin, EISLogin, SDKLogin, XMLFileLogin, XMLLogin, XMLLogin, XMLStreamLogin

public interface Login

Purpose: Define the information required to connect to a TopLink session.

Description: This interface represents a generic concept of a login to be used when connecting to a data-store. It is independant of JDBC so that the TopLink session interface can be used for JCA, XML, non-relational or three-tiered frameworks.

See Also:

DatabaseLogin

Method Summary

oracle.toplink.internal.databaseaccess.Platform	getDatasourcePlatform() Return the datasource platform specific information.
java.lang.String	getPassword() All logins must take a user name and password.
java.lang.Object	getProperty(java.lang.String name) The properties are additional, driver-specific, connection information to be passed to the driver.
java.lang.String	getTableQualifier() Return the qualifier for the all of the tables.
java.lang.String	getUserName() All logins must take a user name and password.
boolean	isConnectionHealthValidatedOnError() This value defaults to false when not on a DatabaseLogin as the functionality has not been implemented for other datasource type.
void	setDatasourcePlatform(oracle.toplink.internal.databaseaccess.Platform platform) Set the database platform specific information.
void	setPassword(java.lang.String password) All logins must take a user name and password.
void	setProperties(java.util.Properties properties) 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) Some JDBC drivers require additional, driver-specific, properties.
void	setUserName(java.lang.String userName) All logins must take a user name and password.
boolean	shouldUseExternalConnectionPooling() Return whether TopLink uses some externally managed connection pooling.
boolean	shouldUseExternalTransactionController() Return whether TopLink uses some externally managed transaction service such as JTS.

Method Detail

getPassword

java.lang.String getPassword()

All logins must take a user name and password.

getUserName

java.lang.String getUserName()

All logins must take a user name and password.

setPassword

void setPassword(java.lang.String password)

All logins must take a user name and password.

setUserName

void setUserName(java.lang.String userName)

All logins must take a user name and password.

shouldUseExternalConnectionPooling

boolean shouldUseExternalConnectionPooling()

Return whether TopLink uses some externally managed connection pooling.

shouldUseExternalTransactionController

boolean shouldUseExternalTransactionController()

Return whether TopLink uses some externally managed transaction service such as JTS.

getDatasourcePlatform

oracle.toplink.internal.databaseaccess.Platform getDatasourcePlatform()

Return the datasource platform specific information. This allows TopLink to configure certain advanced features for the datasource desired. The platform also allows configuration of sequence information.

setDatasourcePlatform

void setDatasourcePlatform(oracle.toplink.internal.databaseaccess.Platform platform)

Set the database platform specific information. This allows TopLink to configure certain advanced features for the database desired. The platform also allows configuration of sequence information.

getTableQualifier

java.lang.String getTableQualifier()

Return the qualifier for the all of the tables.

getProperty

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

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

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

setProperties

void setProperties(java.util.Properties properties)

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

setProperty

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

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

isConnectionHealthValidatedOnError

boolean isConnectionHealthValidatedOnError()

This value defaults to false when not on a DatabaseLogin as the functionality has not been implemented for other datasource type. On an SQL Exception TopLink will ping the database to determine if the connection used can continue to be used for queries. This should have no impact on applications unless the user is using pessimistic locking queries with 'no wait' or are using a query timeout feature. If that is the case and the application is experiencing a performance impact from the health check then this feature can be turned off. Turning this feature off will prevent TopLink from being able to retry queries in the case of database failure.

Skip navigation links