Class InternalDriver
- All Implemented Interfaces:
Driver
,ModuleControl
- Direct Known Subclasses:
Driver42
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
Thread factory to produce daemon threads which don't block VM shutdown.static final class
This code is called in a thread which puts time limits on it. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ExecutorService
An executor service used for executing connection attempts when a login timeout has been specified.protected boolean
private static InternalDriver
private AuthenticationService
private static final String[]
private ContextService
private static boolean
Tells whether or notAutoloadedDriver
should deregister itself on shutdown.private Object
private static final Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
acceptsURL
(String url) static final InternalDriver
void
boot
(boolean create, Properties properties) Boot this module with the given properties.private static void
checkBoolean
(Properties set, String attribute) private static void
checkEnumeration
(Properties set, String attribute, String[] choices) private void
Checks for shutdown System Privileges.void
checkSystemPrivileges
(String user, Permission perm) Checks for System Privileges.connect
(String url, Properties info) connect
(String url, Properties info, int loginTimeoutSeconds) static boolean
private static Object
findService
(String factoryInterface, String serviceName) Privileged service lookup.protected FormatableProperties
getAttributes
(String url, Properties info) Convert all the attributes in the url into properties and combine them with the set provided.private ConnectionContext
private static ContextService
Privileged lookup of the ContextService.final ContextService
private ContextManager
static String
getDatabaseName
(String url, Properties info) Get the database name from the url.(package private) static boolean
Check whetherAutoloadedDriver
should deregister itself on shutdown.int
int
private static ModuleFactory
Privileged Monitor lookup.(package private) EmbedConnection
getNewEmbedConnection
(String url, Properties info) Get a new nested connection.protected PooledConnection
getNewPooledConnection
(BasicEmbeddedDataSource40 eds, String user, String password, boolean requestPassword) Create and return an EmbedPooledConnection from the received instance of EmbeddedDataSource.protected XAConnection
getNewXAConnection
(BasicEmbeddedDataSource40 eds, ResourceAdapter ra, String user, String password, boolean requestPassword) Create and return an EmbedXAConnection from the received instance of BasicEmbeddedDataSource40.getPropertyInfo
(String url, Properties info) The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database.private static Object
getSystemModule
(String factoryInterface) Privileged module lookup.boolean
isActive()
Return true if this driver is active.boolean
(package private) BrokeredConnection
Return a new BrokeredConnection for this implementation.newEmbedCallableStatement
(EmbedConnection conn, String stmt, int resultSetType, int resultSetConcurrency, int resultSetHoldability) newEmbedDatabaseMetaData
(EmbedConnection conn, String dbname) Return a new java.sql.DatabaseMetaData instance for this implementation.newEmbedPreparedStatement
(EmbedConnection conn, String stmt, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability, int autoGeneratedKeys, int[] columnIndexes, String[] columnNames) newEmbedResultSet
(EmbedConnection conn, ResultSet results, boolean forMetaData, EmbedStatement statement, boolean isAtomic) Return a new java.sql.ResultSet instance for this implementation.newEmbedResultSetMetaData
(ResultColumnDescriptor[] columnInfo) Returns a new java.sql.ResultSetMetaData for this implementationnewEmbedStatement
(EmbedConnection conn, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability) private SQLException
Process exceptions raised while running a timed login.(package private) static void
setDeregister
(boolean deregister) Indicate toAutoloadedDriver
whether it should deregister itself on shutdown.void
stop()
Stop the module.private EmbedConnection
timeLogin
(String url, Properties info, int loginTimeoutSeconds) Enforce the login timeout.
-
Field Details
-
syncMe
-
activeDriver
-
mbean
-
active
protected boolean active -
contextServiceFactory
-
authenticationService
-
deregister
private static boolean deregisterTells whether or notAutoloadedDriver
should deregister itself on shutdown. This flag is true unless the deregister attribute has been set to false by the user (DERBY-2905). -
_executorPool
An executor service used for executing connection attempts when a login timeout has been specified.
DERBY-6107: Core pool size and keep alive timeout should be zero so that no threads are cached. By creating a fresh thread each time a task is submitted, we make sure that the task will run in a thread with the same context class loader as the thread that submitted the task. This is important for example when connecting to a database using the classpath subsubprotocol, and the database lives in the context class loader. If threads are cached, a task may execute in a thread that has a different context class loader.
-
BOOLEAN_CHOICES
-
-
Constructor Details
-
InternalDriver
public InternalDriver()
-
-
Method Details
-
activeDriver
-
boot
Description copied from interface:ModuleControl
Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned.An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.
When create is true the contents of the properties object will be written to the service.properties of the persistent service. Thus any code that requires an entry in service.properties must explicitly place the value in this properties set using the put method.
Typically the properties object contains one or more default properties sets, which are not written out to service.properties. These default sets are how callers modify the create process. In a JDBC connection database create the first set of defaults is a properties object that contains the attributes that were set on the jdbc:derby: URL. This attributes properties set has the second default properties set as its default. This set (which could be null) contains the properties that the user set on their DriverManager.getConnection() call, and are thus not owned by Derby code, and thus must not be modified by Derby code.When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases.
Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.
- Specified by:
boot
in interfaceModuleControl
- Throws:
StandardException
- Module cannot be started.- See Also:
-
stop
public void stop()Description copied from interface:ModuleControl
Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.- Specified by:
stop
in interfaceModuleControl
- See Also:
-
acceptsURL
- Specified by:
acceptsURL
in interfaceDriver
- Throws:
SQLException
-
embeddedDriverAcceptsURL
- Throws:
SQLException
-
connect
- Throws:
SQLException
-
timeLogin
private EmbedConnection timeLogin(String url, Properties info, int loginTimeoutSeconds) throws SQLException Enforce the login timeout.- Throws:
SQLException
-
processException
Process exceptions raised while running a timed login. -
checkSystemPrivileges
Checks for System Privileges.- Parameters:
user
- The user to be checked for having the permissionperm
- The permission to be checked- Throws:
AccessControlException
- if permissions are missing
-
checkShutdownPrivileges
Checks for shutdown System Privileges. To perform this check the following policy grant is required- to run the encapsulated test: permission javax.security.auth.AuthPermission "doAsPrivileged";
In addition, for the test to succeed
- the given user needs to be covered by a grant: principal org.apache.derby.authentication.SystemPrincipal "..." {}
- that lists a shutdown permission: permission org.apache.derby.security.SystemPermission "shutdown";
- Parameters:
user
- The user to be checked for shutdown privileges- Throws:
SQLException
- if the privileges check fails
-
getMajorVersion
public int getMajorVersion()- Specified by:
getMajorVersion
in interfaceDriver
-
getMinorVersion
public int getMinorVersion()- Specified by:
getMinorVersion
in interfaceDriver
-
jdbcCompliant
public boolean jdbcCompliant()- Specified by:
jdbcCompliant
in interfaceDriver
-
getAttributes
Convert all the attributes in the url into properties and combine them with the set provided.
If the caller passed in a set of attributes (info != null) then we set that up as the default of the returned property set as the user's set. This means we can easily break the link with the user's set, ensuring that we don't hang onto the users object. It also means that we don't add our attributes into the user's own property object.- Throws:
SQLException
- thrown if URL form bad
-
checkBoolean
- Throws:
SQLException
-
checkEnumeration
private static void checkEnumeration(Properties set, String attribute, String[] choices) throws SQLException - Throws:
SQLException
-
getDatabaseName
Get the database name from the url. Copes with three forms jdbc:derby:dbname jdbc:derby:dbname;... jdbc:derby:;subname=dbname- Parameters:
url
- The url being used for the connectioninfo
- The properties set being used for the connection, must include the properties derived from the attributes in the url- Returns:
- a String containing the database name or an empty string ("") if no database name is present in the URL.
-
getContextServiceFactory
-
getAuthenticationService
-
getNewEmbedConnection
- Throws:
SQLException
-
getConnectionContext
-
getCurrentContextManager
-
isActive
public boolean isActive()Return true if this driver is active. Package private method. -
getNewNestedConnection
Get a new nested connection.- Parameters:
conn
- The EmbedConnection.- Returns:
- A nested connection object.
-
newEmbedStatement
public Statement newEmbedStatement(EmbedConnection conn, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability) -
newEmbedPreparedStatement
public PreparedStatement newEmbedPreparedStatement(EmbedConnection conn, String stmt, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability, int autoGeneratedKeys, int[] columnIndexes, String[] columnNames) throws SQLException - Throws:
SQLException
- if fails to create statement
-
newEmbedCallableStatement
public CallableStatement newEmbedCallableStatement(EmbedConnection conn, String stmt, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException - Throws:
SQLException
- if fails to create statement
-
newEmbedDatabaseMetaData
public DatabaseMetaData newEmbedDatabaseMetaData(EmbedConnection conn, String dbname) throws SQLException Return a new java.sql.DatabaseMetaData instance for this implementation.- Throws:
SQLException
- on failure to create.
-
newEmbedResultSet
public EmbedResultSet newEmbedResultSet(EmbedConnection conn, ResultSet results, boolean forMetaData, EmbedStatement statement, boolean isAtomic) throws SQLException Return a new java.sql.ResultSet instance for this implementation.- Parameters:
conn
- Owning connectionresults
- Top level of language result set treeforMetaData
- Is this for meta-datastatement
- The statement that is creating the SQL ResultSetisAtomic
-- Returns:
- a new java.sql.ResultSet
- Throws:
SQLException
-
newEmbedResultSetMetaData
Returns a new java.sql.ResultSetMetaData for this implementation- Parameters:
columnInfo
- a ResultColumnDescriptor that stores information about the columns in a ResultSet
-
newBrokeredConnection
Return a new BrokeredConnection for this implementation.- Throws:
SQLException
-
getNewPooledConnection
protected PooledConnection getNewPooledConnection(BasicEmbeddedDataSource40 eds, String user, String password, boolean requestPassword) throws SQLException Create and return an EmbedPooledConnection from the received instance of EmbeddedDataSource.- Throws:
SQLException
-
getNewXAConnection
protected XAConnection getNewXAConnection(BasicEmbeddedDataSource40 eds, ResourceAdapter ra, String user, String password, boolean requestPassword) throws SQLException Create and return an EmbedXAConnection from the received instance of BasicEmbeddedDataSource40.- Throws:
SQLException
-
getPropertyInfo
The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database. Note that depending on the values the human has supplied so far, additional values may become necessary, so it may be necessary to iterate though several calls to getPropertyInfo.
- Specified by:
getPropertyInfo
in interfaceDriver
- Parameters:
url
- The URL of the database to connect to.info
- A proposed list of tag/value pairs that will be sent on connect open.- Returns:
- An array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required.
- Throws:
SQLException
- if a database-access error occurs.
-
connect
- Specified by:
connect
in interfaceDriver
- Throws:
SQLException
-
getParentLogger
- Specified by:
getParentLogger
in interfaceDriver
- Throws:
SQLFeatureNotSupportedException
-
setDeregister
static void setDeregister(boolean deregister) Indicate toAutoloadedDriver
whether it should deregister itself on shutdown.- Parameters:
deregister
- whether or notAutoloadedDriver
should deregister itself
-
getDeregister
static boolean getDeregister()Check whetherAutoloadedDriver
should deregister itself on shutdown.- Returns:
- the deregister value
-
getContextService
Privileged lookup of the ContextService. Must be private so that user code can't call this entry point. -
getMonitor
Privileged Monitor lookup. Must be private so that user code can't call this entry point. -
getSystemModule
Privileged module lookup. Must be private so that user code can't call this entry point. -
findService
Privileged service lookup. Must be private so that user code can't call this entry point.
-