Database

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> derby >> iapi >> [ db overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.derby.iapi.db.Database

SOURCE |

Download org.apache.derby.iapi.db.Database

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.derby.iapi.db
Interface Database

All Superinterfaces:: org.apache.derby.database.Database, org.apache.derby.iapi.services.i18n.LocaleFinder

public interface Database
extends org.apache.derby.database.Database, org.apache.derby.iapi.services.i18n.LocaleFinder

The org.apache.derby.iapi.db.Database interface provides "internal" methods on the database which are not available to JBMS users (org.apache.derby.database.Database, which this interface extends, provides all the externally visible methods).

At the present moment, this file defines methods which will at some point be moved to to the external database interface. There are a bunch of the unimplemninted interface that used to be in this file. They have been moved to old_Database.java. old_Database.java is checked into the codeline but is not built, it is there for reference

Method Summary

org.apache.derby.iapi.jdbc.AuthenticationService getAuthenticationService()
          This method returns the authentication service handle for the database.

int getEngineType()


java.lang.Object getResourceAdapter()
          Get a Resource Adapter - only used by XA system.

boolean isActive()
          Is the database active (open).

void pushDbContext(org.apache.derby.iapi.services.context.ContextManager cm)
          Push a DbContext onto the provided context stack.

void setLocale(java.util.Locale locale)
          Set the Locale that is returned by this LocaleFinder

org.apache.derby.iapi.sql.conn.LanguageConnectionContext setupConnection(org.apache.derby.iapi.services.context.ContextManager cm, java.lang.String user, java.lang.String drdaID, java.lang.String dbname)
          Sets up a connection to the Database, owned by the given user.

Methods inherited from interface org.apache.derby.database.Database

backup, backup, backupAndEnableLogArchiveMode, backupAndEnableLogArchiveMode, checkpoint, disableLogArchiveMode, dropAllJDBCMetaDataSPSes, freeze, getId, getLocale, isReadOnly, unfreeze

Methods inherited from interface org.apache.derby.iapi.services.i18n.LocaleFinder

getCollator, getCurrentLocale, getDateFormat, getTimeFormat, getTimestampFormat

Method Detail

setupConnection

public org.apache.derby.iapi.sql.conn.LanguageConnectionContext setupConnection(org.apache.derby.iapi.services.context.ContextManager cm,
                                                                                java.lang.String user,
                                                                                java.lang.String drdaID,
                                                                                java.lang.String dbname)
                                                                         throws org.apache.derby.iapi.error.StandardException

Sets up a connection to the Database, owned by the given user. The JDBC version of getConnection takes a URL. The purpose of the URL is to tell the driver where the database system is. By the time we get here, we have found the database system (that's how we're making this method call), so the URL is not necessary to establish the connection here. The driver should remember the URL that was used to establish the connection, so it can implement the DatabaseMetaData.getURL() method.

pushDbContext

public void pushDbContext(org.apache.derby.iapi.services.context.ContextManager cm)

Push a DbContext onto the provided context stack. This conext will shut down the database in case of a DatabaseException being cleaned up.

isActive

public boolean isActive()

Is the database active (open).

getEngineType

public int getEngineType()

getAuthenticationService

public org.apache.derby.iapi.jdbc.AuthenticationService getAuthenticationService()

This method returns the authentication service handle for the database. NOTE: There is always a Authentication Service per database and at the system level.

getResourceAdapter

public java.lang.Object getResourceAdapter()

Get a Resource Adapter - only used by XA system. There is one and only one resource adapter per cloudscape database.

setLocale

public void setLocale(java.util.Locale locale)

Set the Locale that is returned by this LocaleFinder