oracle.toplink.sessions
Interface Login

All Known Implementing Classes:

DatasourceLogin

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() PUBLIC: Return the datasource platform specific information.
java.lang.String	getPassword() PUBLIC: All logins must take a user name and password.
java.lang.Object	getProperty(java.lang.String name) PUBLIC: The properties are additional, driver-specific, connection information to be passed to the driver.
java.lang.String	getTableQualifier() PUBLIC: Return the qualifier for the all of the tables.
java.lang.String	getUserName() PUBLIC: All logins must take a user name and password.
void	setDatasourcePlatform(oracle.toplink.internal.databaseaccess.Platform platform) PUBLIC: Set the database platform specific information.
void	setPassword(java.lang.String password) PUBLIC: All logins must take a user name and 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	setUserName(java.lang.String userName) PUBLIC: All logins must take a user name and password.
boolean	shouldUseExternalConnectionPooling() PUBLIC: Return whether TopLink uses some externally managed connection pooling.
boolean	shouldUseExternalTransactionController() PUBLIC: Return whether TopLink uses some externally managed transaction service such as JTS.

Method Detail

getPassword

public java.lang.String getPassword()

PUBLIC: All logins must take a user name and password.

getUserName

public java.lang.String getUserName()

PUBLIC: All logins must take a user name and password.

setPassword

public void setPassword(java.lang.String password)

PUBLIC: All logins must take a user name and password.

setUserName

public void setUserName(java.lang.String userName)

PUBLIC: All logins must take a user name and password.

shouldUseExternalConnectionPooling

public boolean shouldUseExternalConnectionPooling()

PUBLIC: Return whether TopLink uses some externally managed connection pooling.

shouldUseExternalTransactionController

public boolean shouldUseExternalTransactionController()

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

getDatasourcePlatform

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

PUBLIC: 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

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

PUBLIC: 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

public java.lang.String getTableQualifier()

PUBLIC: Return the qualifier for the all of the tables.

getProperty

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

PUBLIC: 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

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.