FileDocCategorySizeDatePackage
Login.javaAPI DocGlassfish v2 API7085Tue May 22 16:54:52 BST 2007oracle.toplink.essentials.sessions

Login

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
DatabaseLogin

Fields Summary
Constructors Summary
Methods Summary
public oracle.toplink.essentials.internal.databaseaccess.AccessorbuildAccessor()
INTERNAL: Build the correct datasource Accessor for this login instance.

public java.lang.Objectclone()
INTERNAL: Clone the login.

public java.lang.ObjectconnectToDatasource(oracle.toplink.essentials.internal.databaseaccess.Accessor accessor)
INTERNAL: Connect to the datasource, and return the driver level connection object.

public oracle.toplink.essentials.internal.databaseaccess.PlatformgetDatasourcePlatform()
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.

public java.lang.StringgetPassword()
PUBLIC: All logins must take a user name and password.

public oracle.toplink.essentials.internal.databaseaccess.DatabasePlatformgetPlatform()
INTERNAL: Return 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. NOTE: this must only be used for relational specific usage and will not work for non-relational datasources.

public java.lang.ObjectgetProperty(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).

public java.lang.StringgetTableQualifier()
PUBLIC: Return the qualifier for the all of the tables.

public java.lang.StringgetUserName()
PUBLIC: All logins must take a user name and password.

public voidsetDatasourcePlatform(oracle.toplink.essentials.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.

public voidsetPassword(java.lang.String password)
PUBLIC: All logins must take a user name and password.

public voidsetPlatform(oracle.toplink.essentials.internal.databaseaccess.Platform platform)
INTERNAL: 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.

public voidsetProperties(java.util.Properties properties)
PUBLIC: The properties are additional, driver-specific, connection information to be passed to the JDBC driver.

public voidsetProperty(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.

public voidsetUserName(java.lang.String userName)
PUBLIC: All logins must take a user name and password.

public booleanshouldAllowConcurrentReadWrite()
INTERNAL: Used for cache isolation.

public booleanshouldSynchronizeObjectLevelReadWrite()
INTERNAL: Used for Cache Isolation. Causes TopLink to lock at the object level on cache updates and cache access.

public booleanshouldSynchronizeObjectLevelReadWriteDatabase()
INTERNAL: Used for Cache Isolation. Causes TopLink to lock at the object level on cache updates and cache access, based on database transaction.

public booleanshouldSynchronizeWrites()
INTERNAL: Used for Cache Isolation. Causes TopLink to lock at the class level on cache updates.

public booleanshouldSynchronizedReadOnWrite()
INTERNAL: Used for cache isolation.

public booleanshouldUseExternalConnectionPooling()
PUBLIC: Return whether TopLink uses some externally managed connection pooling.

public booleanshouldUseExternalTransactionController()
PUBLIC: Return whether TopLink uses some externally managed transaction service such as JTS.