Class EmbeddedXADataSource

java.lang.Object
org.apache.derby.jdbc.BasicEmbeddedDataSource40
org.apache.derby.jdbc.ReferenceableDataSource
org.apache.derby.jdbc.EmbeddedDataSource
org.apache.derby.jdbc.EmbeddedXADataSource
All Implemented Interfaces:
Serializable, Wrapper, Referenceable, ObjectFactory, CommonDataSource, DataSource, XADataSource
public class EmbeddedXADataSource extends EmbeddedDataSource

This data source is suitable for an application using embedded Derby, running on full Java SE 6 or higher, corresponding to JDBC 4.0 and higher. EmbeddedXADataSource is an XADataSource implementation.

An XADataSource is a factory for XAConnection objects. It represents a RM in a DTP environment. An object that implements the XADataSource interface is typically registered with a JNDI service provider.

EmbeddedXADataSource automatically supports the correct JDBC specification version for the Java Virtual Machine's environment.

  • JDBC 4.0 - Java SE 6
  • JDBC 4.1 - Java SE 7
  • JDBC 4.2 - full Java SE 8

Use BasicEmbeddedXADataSource40 if your application runs on Java 8 Compact Profile 2.

EmbeddedXADataSource object only works on a local database. There is no client/server support. An EmbeddedXADataSource object must live in the same jvm as the database.

EmbeddedXADataSource is serializable and referenceable.

See EmbeddedDataSource for DataSource properties.

See Also:

  • Constructor Details

    • EmbeddedXADataSource

      public EmbeddedXADataSource()
      no-arg constructor

  • Method Details

    • getXAConnection

      public final XAConnection getXAConnection() throws SQLException
      Attempt to establish a database connection.
      Specified by:
      getXAConnection in interface XADataSource
      Returns:
      a Connection to the database
      Throws:
      SQLException - if a database-access error occurs.

    • getXAConnection

      public final XAConnection getXAConnection(String user, String password) throws SQLException
      Attempt to establish a database connection with the given user name and password.
      Specified by:
      getXAConnection in interface XADataSource
      Parameters:
      user - the database user on whose behalf the Connection is being made
      password - the user's password
      Returns:
      a Connection to the database
      Throws:
      SQLException - if a database-access error occurs.

    • getResourceAdapter

      public org.apache.derby.iapi.jdbc.ResourceAdapter getResourceAdapter()
      Returns:
      The cached ResourceAdapter instance for the underlying database

    • createShardingKeyBuilder

      default ShardingKeyBuilder createShardingKeyBuilder() throws SQLException
      Added by Java 9
      Specified by:
      createShardingKeyBuilder in interface CommonDataSource
      Throws:
      SQLException

    • setDatabaseName

      void setDatabaseName(String databaseName)

    • getDatabaseName

      String getDatabaseName()

    • setDataSourceName

      void setDataSourceName(String dsn)

    • getDataSourceName

      String getDataSourceName()

    • setDescription

      void setDescription(String desc)

    • getDescription

      String getDescription()

    • setUser

      void setUser(String user)

    • getUser

      String getUser()

    • setPassword

      void setPassword(String password)

    • getPassword

      String getPassword()

    • setCreateDatabase

      void setCreateDatabase(String create)

    • getCreateDatabase

      String getCreateDatabase()

    • setConnectionAttributes

      void setConnectionAttributes(String prop)

    • getConnectionAttributes

      String getConnectionAttributes()

    • setShutdownDatabase

      void setShutdownDatabase(String shutdown)

    • getShutdownDatabase

      String getShutdownDatabase()

    • setAttributesAsPassword

      void setAttributesAsPassword(boolean attributesAsPassword)

    • getAttributesAsPassword

      boolean getAttributesAsPassword()

    • getConnection

      Connection getConnection(String username, String password, boolean requestPassword) throws SQLException
      Get a user connection.
      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:
      SQLException - on error