Package org.apache.derby.jdbc
Class BasicEmbeddedDataSource40
- java.lang.Object
-
- org.apache.derby.jdbc.BasicEmbeddedDataSource40
-
- All Implemented Interfaces:
java.io.Serializable
,java.sql.Wrapper
,javax.sql.CommonDataSource
,javax.sql.DataSource
,org.apache.derby.jdbc.EmbeddedDataSourceInterface
- Direct Known Subclasses:
BasicEmbeddedConnectionPoolDataSource40
,BasicEmbeddedXADataSource40
,org.apache.derby.jdbc.ReferenceableDataSource
public class BasicEmbeddedDataSource40 extends java.lang.Object implements javax.sql.DataSource, java.io.Serializable, org.apache.derby.jdbc.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 implementjavax.naming.Referenceable
. The standard attributes provided are, cf. e.g. table 9.1 in the JDBC 4.2 specification.- databaseName
- dataSourceName
- description
- password
- user
- networkProtocol
- portNumber
- roleName
- serverName
- loginTimeout @see javax.sql.CommonDataSource set/get
- logWriter @see javax.sql.CommonDataSource set/get
- 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
-
-
Constructor Summary
Constructors Constructor Description BasicEmbeddedDataSource40()
Constructs a basic embedded data source.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object other)
boolean
getAttributesAsPassword()
Return the value of theattributesAsPassword
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.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.java.util.logging.Logger
getParentLogger()
java.lang.String
getPassword()
java.lang.String
getShutdownDatabase()
java.lang.String
getUser()
int
hashCode()
boolean
isWrapperFor(java.lang.Class<?> interFace)
Returns false unlessinterFace
is implemented.void
setAttributesAsPassword(boolean attributesAsPassword)
SetattributeAsPassword
property to enable passing connection request attributes in the password argument ofgetConnection(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 thepassword
property for the data source.void
setShutdownDatabase(java.lang.String shutdown)
Set this property if you wish to shutdown the database identified bydatabaseName
.void
setUser(java.lang.String user)
Set theuser
property for the data source.<T> T
unwrap(java.lang.Class<T> iface)
Returnsthis
if this class implements the specified interface.
-
-
-
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 interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Parameters:
databaseName
- the name of the database
-
getDatabaseName
public java.lang.String getDatabaseName()
- Specified by:
getDatabaseName
in interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Returns:
- the database name set by
setDatabaseName(java.lang.String)
.
-
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 interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Parameters:
dsn
- the name of the data source
-
getDataSourceName
public java.lang.String getDataSourceName()
- Specified by:
getDataSourceName
in interfaceorg.apache.derby.jdbc.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 interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Parameters:
desc
- the description of the data source
-
getDescription
public java.lang.String getDescription()
- Specified by:
getDescription
in interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Returns:
- the description as set in
setDescription(java.lang.String)
.
-
setUser
public void setUser(java.lang.String user)
Set theuser
property for the data source. This is user name for any data sourcegetConnection()
call that takes no arguments.- Specified by:
setUser
in interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Parameters:
user
- The user
-
getUser
public java.lang.String getUser()
- Specified by:
getUser
in interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Returns:
- the user name as set by
setUser(java.lang.String)
.
-
setPassword
public void setPassword(java.lang.String password)
Set thepassword
property for the data source. This is user's password for any data sourcegetConnection()
call that takes no arguments.- Specified by:
setPassword
in interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Parameters:
password
- The password in plain text
-
getPassword
public java.lang.String getPassword()
- Specified by:
getPassword
in interfaceorg.apache.derby.jdbc.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. SeesetLoginTimeout(int)
.- Specified by:
getLoginTimeout
in interfacejavax.sql.CommonDataSource
- Specified by:
getLoginTimeout
in interfacejavax.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 interfacejavax.sql.CommonDataSource
- Specified by:
setLoginTimeout
in interfacejavax.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 thejava.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 interfacejavax.sql.CommonDataSource
- Specified by:
getLogWriter
in interfacejavax.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 thejava.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 interfacejavax.sql.CommonDataSource
- Specified by:
setLogWriter
in interfacejavax.sql.DataSource
- Parameters:
out
- the new log writer; to disable, set to null- Throws:
java.sql.SQLException
- if a database-access error occurs.
-
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 bydatabaseName
) is assumed to be already existing.- Specified by:
setCreateDatabase
in interfaceorg.apache.derby.jdbc.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 interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Returns:
- The string
"create"
if create is set, ornull
if not
-
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 interfaceorg.apache.derby.jdbc.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 interfaceorg.apache.derby.jdbc.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 bydatabaseName
.- Specified by:
setShutdownDatabase
in interfaceorg.apache.derby.jdbc.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 interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Returns:
- the string
"shutdown"
if shutdown is set, or null if not, cf.setShutdownDatabase(java.lang.String)
.
-
setAttributesAsPassword
public void setAttributesAsPassword(boolean attributesAsPassword)
SetattributeAsPassword
property to enable passing connection request attributes in the password argument ofgetConnection(String,String)
. If the property is set totrue
then thepassword
argument of thegetConnection(String, String)
method call is taken to be a list of connection attributes with the same format as theconnectionAttributes
property.- Specified by:
setAttributesAsPassword
in interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Parameters:
attributesAsPassword
- Usetrue
to encode password argument as a set of connection attributes in a connection request.
-
getAttributesAsPassword
public boolean getAttributesAsPassword()
Return the value of theattributesAsPassword
property, cf.setAttributesAsPassword(boolean)
.- Specified by:
getAttributesAsPassword
in interfaceorg.apache.derby.jdbc.EmbeddedDataSourceInterface
- Returns:
- the value
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getConnection
public java.sql.Connection getConnection() throws java.sql.SQLException
Attempt to establish a database connection.- Specified by:
getConnection
in interfacejavax.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 theattributeAsPassword
property is set to true then the password argument is taken to be a list of connection attributes with the same format as theconnectionAttributes
property.- Specified by:
getConnection
in interfacejavax.sql.DataSource
- Parameters:
username
- the database user on whose behalf the Connection is being madepassword
- the user's password- Returns:
- a Connection to the database
- Throws:
java.sql.SQLException
- if a database-access error occurs.
-
isWrapperFor
public boolean isWrapperFor(java.lang.Class<?> interFace) throws java.sql.SQLException
Returns false unlessinterFace
is implemented.- Specified by:
isWrapperFor
in interfacejava.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
Returnsthis
if this class implements the specified interface.- Specified by:
unwrap
in interfacejava.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
-
getParentLogger
public java.util.logging.Logger getParentLogger() throws java.sql.SQLFeatureNotSupportedException
- Specified by:
getParentLogger
in interfacejavax.sql.CommonDataSource
- Throws:
java.sql.SQLFeatureNotSupportedException
-
-