oracle.javatools.db

Class DatabaseRegistry

java.lang.Object

oracle.javatools.db.DatabaseRegistry

public final class DatabaseRegistry
extends java.lang.Object

Registry of information about the Database implementations supported by the API. Registration of a database implementation is done by type and version, providing the Database implementation class that matches a given type/version with a translated name representing that database.

Use the registerDatabase(java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, java.lang.ClassLoader) method to register a new database version.

Since:

12.1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseRegistry.DatabaseVersion Registration information for a particular database version.

Method Summary

Methods

Modifier and Type	Method and Description
DatabaseDescriptor	getDatabaseDescriptor(java.lang.String type, int version) Gets the DatabaseDescriptor for the given type and version.
java.lang.String	getDatabaseName(java.lang.String type, int ver) Gets a translated string that describes the given database class name to the nearest supported version.
static DatabaseRegistry	getInstance() Gets the single registry instance.
boolean	isLegacyVersion(java.lang.String type, int version) Tests whether the given database type/version is a legacy version in the API.
java.util.Collection<java.lang.String>	listDatabaseTypes() Gets all the types of database that are registered with the API.
java.util.List<java.lang.Integer>	listDatabaseVersions(java.lang.String type) Gets all the versions for the given database type that are registered with the API.
java.util.List<java.lang.Integer>	listDatabaseVersions(java.lang.String type, boolean incLegacy) Gets all the versions for the given database type that are registered with the API.
java.lang.Class<? extends Database>	loadDatabaseClass(java.lang.String clzName) Attempts to load the given database class name.
void	registerDatabase(java.lang.String type, int version, java.lang.String nlsName, java.lang.String databaseImplName, java.lang.String databaseCreatorClassName, java.lang.ClassLoader classLoader) Deprecated. use registerDatabases(java.lang.String, java.lang.String, java.lang.ClassLoader, oracle.javatools.db.extension.ConnectionMatcher, oracle.javatools.db.DatabaseRegistry.DatabaseVersion...)
void	registerDatabases(java.lang.String type, java.lang.String databaseCreatorClassName, java.lang.ClassLoader classLoader, ConnectionMatcher matcher, DatabaseRegistry.DatabaseVersion... infos) Registers the given connection creator with its classloader and all the database versions that it supports.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

registerDatabase

@Deprecated
public void registerDatabase(java.lang.String type,
                               int version,
                               java.lang.String nlsName,
                               java.lang.String databaseImplName,
                               java.lang.String databaseCreatorClassName,
                               java.lang.ClassLoader classLoader)

Deprecated. use registerDatabases(java.lang.String, java.lang.String, java.lang.ClassLoader, oracle.javatools.db.extension.ConnectionMatcher, oracle.javatools.db.DatabaseRegistry.DatabaseVersion...)

registerDatabases

public void registerDatabases(java.lang.String type,
                     java.lang.String databaseCreatorClassName,
                     java.lang.ClassLoader classLoader,
                     ConnectionMatcher matcher,
                     DatabaseRegistry.DatabaseVersion... infos)

Registers the given connection creator with its classloader and all the database versions that it supports.

Parameters:

type - the database type

databaseCreatorClass - the DatabaseFactory.DatabaseCreator that creates instances of the Database class, and also creates its descriptor.

classLoader - the ClassLoader for the class (can be null if the class is in db-api or db-api-impl.

matcher - the ConnectionMatcher used to identify whether a given Connection could be of interest to the databaseCreatorClass.

infos - the database version information that the connection creator supports.

listDatabaseTypes

public java.util.Collection<java.lang.String> listDatabaseTypes()

Gets all the types of database that are registered with the API.

Returns:

all available database types

See Also:

Database.getDatabaseType(), DatabaseDescriptor.getDatabaseType()

listDatabaseVersions

public java.util.List<java.lang.Integer> listDatabaseVersions(java.lang.String type)

Gets all the versions for the given database type that are registered with the API. The returned list is sorted in ascending order. Legacy versions will be included.

Parameters:

type - the type of database to get the versions for

Returns:

all available versions of the given database type

See Also:

listDatabaseTypes(), Database.getDatabaseVersion(), DatabaseDescriptor.getDatabaseVersion()

listDatabaseVersions

public java.util.List<java.lang.Integer> listDatabaseVersions(java.lang.String type,
                                                     boolean incLegacy)

Gets all the versions for the given database type that are registered with the API. The returned list is sorted in ascending order.

Parameters:

type - the type of database to get the versions for

incLegacy - whether to include legacy versions

Returns:

all available versions of the given database type

See Also:

listDatabaseTypes(), Database.getDatabaseVersion(), DatabaseDescriptor.getDatabaseVersion()

getDatabaseDescriptor

public DatabaseDescriptor getDatabaseDescriptor(java.lang.String type,
                                       int version)

Gets the DatabaseDescriptor for the given type and version.

Parameters:

type - the database type

version - the database version

Returns:

a descriptor for the given type/version, or null if none is registered.

isLegacyVersion

public boolean isLegacyVersion(java.lang.String type,
                      int version)

Tests whether the given database type/version is a legacy version in the API. If true this means that the version is no longer supported (e.g. for creation of new DBObjectProviders) and exists only for legacy support and migration.

Parameters:

type - the database type to test

version - the database version to test

Returns:

true if this the described database support is legacy (or the type/version are known)

loadDatabaseClass

public java.lang.Class<? extends Database> loadDatabaseClass(java.lang.String clzName)

Attempts to load the given database class name. If the class is not in the api the given name must have been registered with a ClassLoader via registerProviderClass for this to work.

Parameters:

clzName - the name of the class to load

Returns:

the loaded Database implementation, or null if the class cannot be found or is not a valid Database implementation.

getDatabaseName

public java.lang.String getDatabaseName(java.lang.String type,
                               int ver)

Gets a translated string that describes the given database class name to the nearest supported version. If no supported version is available, this will return "Generic JDBC Database" - i.e. we assume that there is no better support.

Parameters:

type - the databse type

ver - the database version

Returns:

a name for the given type (and version) of database.

getInstance

public static DatabaseRegistry getInstance()

Gets the single registry instance.

Returns:

the DatabaseRegistry instance