public Class BasicEmbeddedDataSource40

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getAttributesAsPassword.

Return the value of the attributesAsPassword property, cf. setAttributesAsPassword.

Returns:boolean

the value

Annotations

@Override

Implements javax.sql.DataSource.getConnection.

Attempt to establish a database connection.

Returns:Connection

a Connection to the database

Annotations

@Override

Exceptions

SQLException:

if a database-access error occurs.

Implements javax.sql.DataSource.getConnection.

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.

Parameters

username:String

the database user on whose behalf the Connection is being made

password:String

the user's password

Returns:Connection

a Connection to the database

Annotations

@Override

Exceptions

SQLException:

if a database-access error occurs.

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getConnection.

Get a user connection: minion method.

Parameters

username:String

the user name

password:String

the password

requestPassword:boolean

true if the password came from the getConnection() call with user and password arguments..

Returns:Connection

user connection

Exceptions

SQLException:

Doc from org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getConnection.

on error

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getConnectionAttributes.

Returns:String

the Derby specific connection URL attributes, see setConnectionAttributes.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getCreateDatabase.

Returns:String

The string "create" if create is set, or null if not

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getDatabaseName.

Returns:String

the database name set by setDatabaseName.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getDataSourceName.

Returns:String

data source name as set in setDataSourceName.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getDescription.

Returns:String

the description as set in setDescription.

Annotations

@Override

Implements javax.sql.DataSource.getLoginTimeout.

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.

Returns:int

the data source login time limit

Annotations

@Override

Exceptions

SQLException:

if a database access error occurs.

Implements javax.sql.DataSource.getLogWriter.

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.

Returns:PrintWriter

the log writer for this data source, null if disabled

Annotations

@Override

Exceptions

SQLException:

if a database-access error occurs.

Implements javax.sql.CommonDataSource.getParentLogger.

Doc from javax.sql.CommonDataSource.getParentLogger.

Return the parent Logger of all the Loggers used by this data source. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source. Configuring this Logger will affect all of the log messages generated by the data source. In the worst case, this may be the root Logger.

Returns:java.util.logging.Logger

the parent Logger for this data source

Exceptions

SQLFeatureNotSupportedException:

if the data source does not use java.util.logging

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getPassword.

Returns:String

the password as set in setPassword.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getShutdownDatabase.

Returns:String

the string "shutdown" if shutdown is set, or null if not, cf. setShutdownDatabase.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.getUser.

Returns:String

the user name as set by setUser.

Annotations

@Override

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

Implements java.sql.Wrapper.isWrapperFor.

Returns false unless interFace is implemented.

Parameters

interFace:Class<?>

a class defining an interface

Returns:boolean

true if this implements the interface or directly or indirectly wraps an object that does

Annotations

@Override

Exceptions

SQLException:

if an error occurs while determining whether this is a wrapper for an object with the given interface

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setAttributesAsPassword.

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.

Parameters

attributesAsPassword:boolean

Use true to encode password argument as a set of connection attributes in a connection request.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setConnectionAttributes.

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.

Parameters

prop:String

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.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setCreateDatabase.

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.

Parameters

create:String

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.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setDatabaseName.

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.

Parameters

databaseName:String

the name of the database

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setDataSourceName.

Set the data source name. The property is not mandatory. It is used for informational purposes only.

Parameters

dsn:String

the name of the data source

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setDescription.

Set the data source descripton. This property is not mandatory. It is used for informational purposes only.

Parameters

desc:String

the description of the data source

Annotations

@Override

Implements javax.sql.DataSource.setLoginTimeout.

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.

Parameters

seconds:int

the data source login time limit

Annotations

@Override

Exceptions

SQLException:

if a database access error occurs.

Implements javax.sql.DataSource.setLogWriter.

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.

Parameters

out:PrintWriter

the new log writer; to disable, set to null

Annotations

@Override

Exceptions

SQLException:

if a database-access error occurs.

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setPassword.

Set the password property for the data source.

This is user's password for any data source getConnection() call that takes no arguments.

Parameters

password:String

The password in plain text

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setShutdownDatabase.

Set this property if you wish to shutdown the database identified by databaseName.

Parameters

shutdown:String

if set to the string "shutdown", this data source will shutdown the database if it is running.

Annotations

@Override

Implements org.apache.derby.iapi.jdbc.EmbeddedDataSourceInterface.setUser.

Set the user property for the data source.

This is user name for any data source getConnection() call that takes no arguments.

Parameters

user:String

The user

Annotations

@Override

Implements java.sql.Wrapper.unwrap.

Returns this if this class implements the specified interface.

Parameters

<T>

Doc from java.sql.Wrapper.unwrap. the type of the class modeled by this Class object

iface:Class<T>

a class defining an interface

Returns:T

an object that implements the interface

Annotations

@Override

Exceptions

SQLException:

if no object is found that implements the interface