Package org.eclipse.persistence.sessions
Class DefaultConnector
- java.lang.Object
-
- org.eclipse.persistence.sessions.DefaultConnector
-
- All Implemented Interfaces:
Serializable,Cloneable,Connector
- Direct Known Subclasses:
DirectConnector
public class DefaultConnector extends Object implements Connector
Purpose:Use this Connector to build a java.sql.Connection in the "standard" fashion, via the DriverManager.
- Since:
- TOPLink/Java 2.1
- Author:
- Big Country
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultConnector()PUBLIC: Construct a Connector with default settings The database URL will still need to be set.DefaultConnector(String driverClassName, String driverURLHeader, String databaseURL)PUBLIC: Construct a Connector with the specified settings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearDriverClassAndDriver()INTERNAL: Discard the cached driver class and driver.Objectclone()INTERNAL: Clone the connector.Connectionconnect(Properties properties, Session session)INTERNAL: Connect with the specified properties and session.StringgetConnectionDetails()PUBLIC: Provide the details of my connection information.StringgetConnectionString()PUBLIC: Return the JDBC connection string.StringgetDatabaseURL()PUBLIC: The database URL is the JDBC URL for the database server.StringgetDriverClassName()PUBLIC: The driver class is the name of the Java class for the JDBC driver being used (e.g.StringgetDriverURLHeader()PUBLIC: The driver URL header is the string predetermined by the JDBC driver to be part of the URL connection string, (e.g.voidsetDatabaseURL(String databaseURL)PUBLIC: The database URL is the JDBC URL for the database server.voidsetDriverClassName(String driverClassName)PUBLIC: The driver class is the name of the Java class for the JDBC driver being used (e.g.voidsetDriverURLHeader(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.booleanshouldUseDriverManager(Properties properties, Session session)INTERNAL: Indicates whether DriverManager should be used.StringtoString()PUBLIC: Print connection string.voidtoString(PrintWriter writer)INTERNAL: Print something useful on the log.
-
-
-
Method Detail
-
clone
public Object clone()
INTERNAL: Clone the connector.
-
connect
public Connection connect(Properties properties, Session session) throws DatabaseException
INTERNAL: Connect with the specified properties and session. Return the Connection.- Specified by:
connectin interfaceConnector- Returns:
- java.sql.Connection
- Throws:
DatabaseException
-
shouldUseDriverManager
public boolean shouldUseDriverManager(Properties properties, Session session)
INTERNAL: Indicates whether DriverManager should be used.- Returns:
- boolean
-
getConnectionString
public String getConnectionString()
PUBLIC: Return the JDBC connection string. This is a combination of the driver-specific URL header and the database URL.
-
getConnectionDetails
public String getConnectionDetails()
PUBLIC: Provide the details of my connection information. This is primarily for JMX runtime services.- Specified by:
getConnectionDetailsin interfaceConnector- Returns:
- java.lang.String
-
getDatabaseURL
public String getDatabaseURL()
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").
-
getDriverClassName
public String getDriverClassName()
PUBLIC: The driver class is the name of the Java class for the JDBC driver being used (e.g. "sun.jdbc.odbc.JdbcOdbcDriver").
-
getDriverURLHeader
public 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. "jdbc:odbc:"). This is required to connect to the database.
-
setDatabaseURL
public void setDatabaseURL(String databaseURL)
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").
-
setDriverClassName
public void setDriverClassName(String driverClassName)
PUBLIC: The driver class is the name of the Java class for the JDBC driver being used (e.g. "sun.jdbc.odbc.JdbcOdbcDriver").
-
setDriverURLHeader
public void setDriverURLHeader(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. "jdbc:odbc:"). This is required to connect to the database.
-
toString
public String toString()
PUBLIC: Print connection string.
-
toString
public void toString(PrintWriter writer)
INTERNAL: Print something useful on the log.
-
clearDriverClassAndDriver
public void clearDriverClassAndDriver()
INTERNAL: Discard the cached driver class and driver.
-
-