BasicEmbeddedDataSource40 (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.jdbc.BasicEmbeddedDataSource40

All Implemented Interfaces:

java.io.Serializable, java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource, EmbeddedDataSourceInterface

Direct Known Subclasses:

BasicEmbeddedConnectionPoolDataSource40, BasicEmbeddedXADataSource40, ReferenceableDataSource
```
public class BasicEmbeddedDataSource40
extends java.lang.Object
implements javax.sql.DataSource, java.io.Serializable, EmbeddedDataSourceInterface
```
This data source is suitable for an application using embedded Derby, running on Java 8 Compact Profile 2 or higher.
BasicEmbeddedDataSource40 is similar to EmbeddedDataSource, but does not support JNDI naming, i.e. it does not implement javax.naming.Referenceable.
The standard attributes provided are, cf. e.g. table 9.1 in the JDBC 4.2 specification.
- databaseName
- dataSourceName
- description
- password
- user
These standard attributes are not supported:
- networkProtocol
- portNumber
- roleName
- serverName
The embedded Derby driver also supports these attributes:
- loginTimeout
- logWriter
- createDatabase
- connectionAttributes
- shutdownDatabase
- attributesAsPassword
See the specific Derby DataSource implementation for details on their meaning.
See also the JDBC specifications for more details.
See Also:

EmbeddedDataSource, Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`attributesAsPassword`	Set password to be a set of connection attributes.
`protected java.lang.String`	`connectionAttributes`	Derby specific connection attributes.
`protected java.lang.String`	`createDatabase`	Set to "create" if the database should be created.
`protected java.lang.String`	`databaseName`	Set by `setDatabaseName(java.lang.String)`.
`protected java.lang.String`	`dataSourceName`	Set by `setDataSourceName(java.lang.String)`.
`protected java.lang.String`	`description`	Set by `setDescription(java.lang.String)`.
`protected InternalDriver`	`driver`	Unlike a DataSource, the internal driver is shared by all Derby databases in the same JVM.
`protected java.lang.String`	`jdbcurl`	Instance variable that will not be serialized.
`protected int`	`loginTimeout`	Set by `setLoginTimeout(int)`.
`private java.lang.String`	`password`	Set by `setPassword(java.lang.String)`.
`private java.io.PrintWriter`	`printer`	Instance variable that will not be serialized.
`private static long`	`serialVersionUID`
`private java.lang.String`	`shortDatabaseName`	`shortDatabaseName` has attributes of `databaseName` stripped off.
`protected java.lang.String`	`shutdownDatabase`	Set to "shutdown" if the database should be shutdown.
`private java.lang.String`	`user`	Set by `setUser(java.lang.String)`.

Constructor Summary

Constructors
Constructor Description

BasicEmbeddedDataSource40()
Constructs a basic embedded data source.

Constructors
Constructor	Description
`BasicEmbeddedDataSource40()`	Constructs a basic embedded data source.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object other)`
`(package private) InternalDriver`	`findDriver()`	Return a handle to the internal driver, possibly instantiating it first if it hasn't been booted or if it has been shut down.
`private static java.lang.Object`	`findService(java.lang.String factoryInterface, java.lang.String serviceName)`	Privileged service lookup.
`boolean`	`getAttributesAsPassword()`	Return the value of the `attributesAsPassword` property, cf.
`java.sql.Connection`	`getConnection()`	Attempt to establish a database connection.
`java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password)`	Attempt to establish a database connection with the given username and password.
`(package private) java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password, boolean requestPassword)`	Get a user connection: minion method.
`java.lang.String`	`getConnectionAttributes()`
`java.lang.String`	`getCreateDatabase()`
`java.lang.String`	`getDatabaseName()`
`java.lang.String`	`getDataSourceName()`
`java.lang.String`	`getDescription()`
`int`	`getLoginTimeout()`	Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
`java.io.PrintWriter`	`getLogWriter()`	Get the log writer for this data source.
`private static ModuleFactory`	`getMonitor()`	Privileged Monitor lookup.
`java.util.logging.Logger`	`getParentLogger()`
`java.lang.String`	`getPassword()`
`private java.lang.String`	`getShortDatabaseName()`	Return database name with ant attributes stripped off.
`java.lang.String`	`getShutdownDatabase()`
`java.lang.String`	`getUser()`
`int`	`hashCode()`
`boolean`	`isWrapperFor(java.lang.Class<?> interFace)`	Returns false unless `interFace` is implemented.
`void`	`setAttributesAsPassword(boolean attributesAsPassword)`	Set `attributeAsPassword` property to enable passing connection request attributes in the password argument of `getConnection(String,String)`.
`void`	`setConnectionAttributes(java.lang.String prop)`	Set this property to pass in more Derby specific connection URL attributes.
`void`	`setCreateDatabase(java.lang.String create)`	Set this property to create a new database.
`void`	`setDatabaseName(java.lang.String databaseName)`	Set the database name.
`void`	`setDataSourceName(java.lang.String dsn)`	Set the data source name.
`void`	`setDescription(java.lang.String desc)`	Set the data source descripton.
`void`	`setLoginTimeout(int seconds)`	Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
`void`	`setLogWriter(java.io.PrintWriter out)`	Set the log writer for this data source.
`void`	`setPassword(java.lang.String password)`	Set the `password` property for the data source.
`void`	`setShutdownDatabase(java.lang.String shutdown)`	Set this property if you wish to shutdown the database identified by `databaseName`.
`protected static ResourceAdapter`	`setupResourceAdapter(EmbeddedXADataSourceInterface ds, ResourceAdapter ra, java.lang.String user, java.lang.String password, boolean requestPassword)`	Return a resource adapter.
`void`	`setUser(java.lang.String user)`	Set the `user` property for the data source.
`<T> T`	`unwrap(java.lang.Class<T> iface)`	Returns `this` if this class implements the specified interface.
`protected void`	`update()`	Update `jdbcurl` from attributes set.

Methods inherited from interface javax.sql.CommonDataSource
createShardingKeyBuilder

Methods inherited from interface javax.sql.DataSource
createConnectionBuilder

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - description
```
protected java.lang.String description
```
    Set by setDescription(java.lang.String).
  - dataSourceName
```
protected java.lang.String dataSourceName
```
    Set by setDataSourceName(java.lang.String).
  - databaseName
```
protected java.lang.String databaseName
```
    Set by setDatabaseName(java.lang.String).
  - connectionAttributes
```
protected java.lang.String connectionAttributes
```
    Derby specific connection attributes. Set by setConnectionAttributes(java.lang.String).
  - createDatabase
```
protected java.lang.String createDatabase
```
    Set to "create" if the database should be created. See setCreateDatabase(java.lang.String).
  - shutdownDatabase
```
protected java.lang.String shutdownDatabase
```
    Set to "shutdown" if the database should be shutdown. See setShutdownDatabase(java.lang.String).
  - attributesAsPassword
```
protected boolean attributesAsPassword
```
    Set password to be a set of connection attributes.
  - shortDatabaseName
```
private java.lang.String shortDatabaseName
```
    shortDatabaseName has attributes of databaseName stripped off. See databaseName.
  - password
```
private java.lang.String password
```
    Set by setPassword(java.lang.String).
  - user
```
private java.lang.String user
```
    Set by setUser(java.lang.String).
  - loginTimeout
```
protected int loginTimeout
```
    Set by setLoginTimeout(int).
  - printer
```
private transient java.io.PrintWriter printer
```
    Instance variable that will not be serialized.
  - jdbcurl
```
protected transient java.lang.String jdbcurl
```
    Instance variable that will not be serialized.
  - driver
```
protected transient InternalDriver driver
```
    Unlike a DataSource, the internal driver is shared by all Derby databases in the same JVM.
- Constructor Detail
  - BasicEmbeddedDataSource40
```
public BasicEmbeddedDataSource40()
```
    Constructs a basic embedded data source. See the class Javadoc.
- Method Detail
  - setDatabaseName
```
public void setDatabaseName(java.lang.String databaseName)
```
    Set the database name. Setting this property is mandatory. If a database named wombat at g:/db needs to be accessed, database name should be set to "g:/db/wombat". The database will be booted if it is not already running in the system.
    
    Specified by:
    
    setDatabaseName in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    databaseName - the name of the database
  - getDatabaseName
```
public java.lang.String getDatabaseName()
```
    Specified by:
    
    getDatabaseName in interface EmbeddedDataSourceInterface
    
    Returns:
    
    the database name set by setDatabaseName(java.lang.String).
  - getShortDatabaseName
```
private java.lang.String getShortDatabaseName()
```
    Return database name with ant attributes stripped off.
  - setDataSourceName
```
public void setDataSourceName(java.lang.String dsn)
```
    Set the data source name. The property is not mandatory. It is used for informational purposes only.
    
    Specified by:
    
    setDataSourceName in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    dsn - the name of the data source
  - getDataSourceName
```
public java.lang.String getDataSourceName()
```
    Specified by:
    
    getDataSourceName in interface EmbeddedDataSourceInterface
    
    Returns:
    
    data source name as set in setDataSourceName(java.lang.String).
  - setDescription
```
public void setDescription(java.lang.String desc)
```
    Set the data source descripton. This property is not mandatory. It is used for informational purposes only.
    
    Specified by:
    
    setDescription in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    desc - the description of the data source
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface EmbeddedDataSourceInterface
    
    Returns:
    
    the description as set in setDescription(java.lang.String).
  - setUser
```
public void setUser(java.lang.String user)
```
    Set the user property for the data source.
    This is user name for any data source getConnection() call that takes no arguments.
    
    Specified by:
    
    setUser in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    user - The user
  - getUser
```
public java.lang.String getUser()
```
    Specified by:
    
    getUser in interface EmbeddedDataSourceInterface
    
    Returns:
    
    the user name as set by setUser(java.lang.String).
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Set the password property for the data source.
    This is user's password for any data source getConnection() call that takes no arguments.
    
    Specified by:
    
    setPassword in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    password - The password in plain text
  - getPassword
```
public java.lang.String getPassword()
```
    Specified by:
    
    getPassword in interface EmbeddedDataSourceInterface
    
    Returns:
    
    the password as set in setPassword(java.lang.String).
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws java.sql.SQLException
```
    Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise it means that there is no timeout. When a data source object is created, the login timeout is initially zero. See setLoginTimeout(int).
    
    Specified by:
    
    getLoginTimeout in interface javax.sql.CommonDataSource
    
    Specified by:
    
    getLoginTimeout in interface javax.sql.DataSource
    
    Returns:
    
    the data source login time limit
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs.
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException
```
    Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise it specifies that there is no timeout. When a data source object is created, the login timeout is initially zero.
    Derby currently ignores this property.
    
    Specified by:
    
    setLoginTimeout in interface javax.sql.CommonDataSource
    
    Specified by:
    
    setLoginTimeout in interface javax.sql.DataSource
    
    Parameters:
    
    seconds - the data source login time limit
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs.
  - getLogWriter
```
public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException
```
    Get the log writer for this data source.
    The log writer is a character output stream to which all logging and tracing messages for this data source object instance will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class. When a data source object is created the log writer is initially null, in other words, logging is disabled.
    
    Specified by:
    
    getLogWriter in interface javax.sql.CommonDataSource
    
    Specified by:
    
    getLogWriter in interface javax.sql.DataSource
    
    Returns:
    
    the log writer for this data source, null if disabled
    
    Throws:
    
    java.sql.SQLException - if a database-access error occurs.
  - setLogWriter
```
public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException
```
    Set the log writer for this data source.
    The log writer is a character output stream to which all logging and tracing messages for this data source object instance will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class. When a data source object is created the log writer is initially null, in other words, logging is disabled.
    
    Specified by:
    
    setLogWriter in interface javax.sql.CommonDataSource
    
    Specified by:
    
    setLogWriter in interface javax.sql.DataSource
    
    Parameters:
    
    out - the new log writer; to disable, set to null
    
    Throws:
    
    java.sql.SQLException - if a database-access error occurs.
  - update
```
protected void update()
```
    Update jdbcurl from attributes set.
  - setCreateDatabase
```
public void setCreateDatabase(java.lang.String create)
```
    Set this property to create a new database. If this property is not set, the database (identified by databaseName) is assumed to be already existing.
    
    Specified by:
    
    setCreateDatabase in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    create - if set to the string "create", this data source will try to create a new database of databaseName, or boot the database if one by that name already exists.
  - getCreateDatabase
```
public java.lang.String getCreateDatabase()
```
    Specified by:
    
    getCreateDatabase in interface EmbeddedDataSourceInterface
    
    Returns:
    
    The string "create" if create is set, or null if not
  - findDriver
```
InternalDriver findDriver()
                   throws java.sql.SQLException
```
    Return a handle to the internal driver, possibly instantiating it first if it hasn't been booted or if it has been shut down.
    
    Returns:
    
    The internal driver handle
    
    Throws:
    
    java.sql.SQLException
  - setConnectionAttributes
```
public void setConnectionAttributes(java.lang.String prop)
```
    Set this property to pass in more Derby specific connection URL attributes.
    Any attributes that can be set using a property of this DataSource implementation (e.g user, password) should not be set in connection attributes. Conflicting settings in connection attributes and properties of the DataSource will lead to unexpected behaviour.
    Specified by:
    
    setConnectionAttributes in interface EmbeddedDataSourceInterface
    
    Parameters:
    prop - set to the list of Derby connection attributes separated by semi-colons. E.g., to specify an encryption bootPassword of "x8hhk2adf", and set upgrade to true, do the following:
    ds.setConnectionAttributes("bootPassword=x8hhk2adf;upgrade=true");
    See the Derby documentation for complete list.
  - getConnectionAttributes
```
public java.lang.String getConnectionAttributes()
```
    Specified by:
    
    getConnectionAttributes in interface EmbeddedDataSourceInterface
    
    Returns:
    
    the Derby specific connection URL attributes, see setConnectionAttributes(java.lang.String).
  - setShutdownDatabase
```
public void setShutdownDatabase(java.lang.String shutdown)
```
    Set this property if you wish to shutdown the database identified by databaseName.
    
    Specified by:
    
    setShutdownDatabase in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    shutdown - if set to the string "shutdown", this data source will shutdown the database if it is running.
  - getShutdownDatabase
```
public java.lang.String getShutdownDatabase()
```
    Specified by:
    
    getShutdownDatabase in interface EmbeddedDataSourceInterface
    
    Returns:
    
    the string "shutdown" if shutdown is set, or null if not, cf. setShutdownDatabase(java.lang.String).
  - setAttributesAsPassword
```
public void setAttributesAsPassword(boolean attributesAsPassword)
```
    Set attributeAsPassword property to enable passing connection request attributes in the password argument of getConnection(String,String). If the property is set to true then the password argument of the getConnection(String, String) method call is taken to be a list of connection attributes with the same format as the connectionAttributes property.
    
    Specified by:
    
    setAttributesAsPassword in interface EmbeddedDataSourceInterface
    
    Parameters:
    
    attributesAsPassword - Use true to encode password argument as a set of connection attributes in a connection request.
  - getAttributesAsPassword
```
public boolean getAttributesAsPassword()
```
    Return the value of the attributesAsPassword property, cf. setAttributesAsPassword(boolean).
    
    Specified by:
    
    getAttributesAsPassword in interface EmbeddedDataSourceInterface
    
    Returns:
    
    the value
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    Attempt to establish a database connection.
    
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Returns:
    
    a Connection to the database
    
    Throws:
    
    java.sql.SQLException - if a database-access error occurs.
  - getConnection
```
public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException
```
    Attempt to establish a database connection with the given username and password. If the attributeAsPassword property is set to true then the password argument is taken to be a list of connection attributes with the same format as the connectionAttributes property.
    
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Parameters:
    
    username - the database user on whose behalf the Connection is being made
    
    password - the user's password
    
    Returns:
    
    a Connection to the database
    
    Throws:
    
    java.sql.SQLException - if a database-access error occurs.
  - getConnection
```
final java.sql.Connection getConnection(java.lang.String username,
                                        java.lang.String password,
                                        boolean requestPassword)
                                 throws java.sql.SQLException
```
    Get a user connection: minion method.
    
    Parameters:
    
    username - the user name
    
    password - the password
    
    requestPassword - true if the password came from the getConnection() call with user and password arguments..
    
    Returns:
    
    user connection
    
    Throws:
    
    java.sql.SQLException
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> interFace)
                     throws java.sql.SQLException
```
    Returns false unless interFace is implemented.
    
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
    
    Parameters:
    
    interFace - a class defining an interface
    
    Returns:
    
    true if this implements the interface or directly or indirectly wraps an object that does
    
    Throws:
    
    java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException
```
    Returns this if this class implements the specified interface.
    
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Parameters:
    
    iface - a class defining an interface
    
    Returns:
    
    an object that implements the interface
    
    Throws:
    
    java.sql.SQLException - if no object is found that implements the interface
  - setupResourceAdapter
```
protected static ResourceAdapter setupResourceAdapter(EmbeddedXADataSourceInterface ds,
                                                      ResourceAdapter ra,
                                                      java.lang.String user,
                                                      java.lang.String password,
                                                      boolean requestPassword)
                                               throws java.sql.SQLException
```
    Return a resource adapter. Use ra if non-null and active, else get the one for the data base.
    
    Parameters:
    
    ds - The data source
    
    ra - The cached value if any
    
    user - The user name
    
    password - The password in clear text
    
    requestPassword - If true, use the supplied user and password to boot the database if required
    
    Returns:
    
    the resource adapter
    
    Throws:
    
    java.sql.SQLException - An error occurred
  - getParentLogger
```
public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException
```
    Specified by:
    
    getParentLogger in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLFeatureNotSupportedException
  - getMonitor
```
private static ModuleFactory getMonitor()
```
    Privileged Monitor lookup. Must be private so that user code can't call this entry point.
  - findService
```
private static java.lang.Object findService(java.lang.String factoryInterface,
                                            java.lang.String serviceName)
```
    Privileged service lookup. Must be private so that user code can't call this entry point.

Class BasicEmbeddedDataSource40

Field Summary

Constructor Summary

Method Summary

Methods inherited from interface javax.sql.CommonDataSource

Methods inherited from interface javax.sql.DataSource

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

description

dataSourceName

databaseName

connectionAttributes

createDatabase

shutdownDatabase

attributesAsPassword

shortDatabaseName

password

user

loginTimeout

printer

jdbcurl

driver

Constructor Detail

BasicEmbeddedDataSource40

Method Detail

setDatabaseName

getDatabaseName

getShortDatabaseName

setDataSourceName

getDataSourceName

setDescription

getDescription

setUser

getUser

setPassword

getPassword

getLoginTimeout

setLoginTimeout

getLogWriter

setLogWriter

update

setCreateDatabase

getCreateDatabase

findDriver

setConnectionAttributes

getConnectionAttributes

setShutdownDatabase

getShutdownDatabase

setAttributesAsPassword

getAttributesAsPassword

equals

hashCode

getConnection

getConnection

getConnection

isWrapperFor

unwrap

setupResourceAdapter

getParentLogger

getMonitor

findService