oracle.ifs.common

Class DatabaseUtilities

java.lang.Object

oracle.ifs.common.DatabaseUtilities

public class DatabaseUtilities
extends Object

DatabaseUtilities is a set of utilities to facilitate establishing database connections.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATABASE_TYPE_ORACLE String that identifes the database type to be Oracle.
static String	DATABASE_TYPE_POSTGRES String that identifes the database type to be Postgres.
static String	DATASOURCE_CLASS_ORACLE Oracle Datasource class.
static String	DATASOURCE_CLASS_POSTGRES Postgres Datasource class.
static String	DRIVER_CLASS_ORACLE Default Oracle JDBC driver class.
static String	DRIVER_CLASS_POSTGRES Default Postgres JDBC driver class.
static String	JDBCDRIVERTYPE_OCI8 The JDBC OCI8 driver for Oracle.
static String	JDBCDRIVERTYPE_THIN The JDBC Thin driver for Oracle.

Method Summary

Modifier and Type	Method and Description
static DataSource	constructDataSource(String databaseType, String databaseUrl, String schemaName, String schemaPassword) Constructs the data source.
static String	deriveDatabaseType(String domainName) Derives the effective Database type from the specified domain name.
static String	getDatabaseUrl(String databaseType, String domainName, String jdbcDriverType) Resolves a database type and domain name to a database URL.
static String	getDatabaseUrlPrefix(String databaseType, String jdbcDriverType) Resolves a domain name to the prefix to use for a database URL.
static String	getDatabaseUrlSuffix(String databaseType, String domainName) Resolves a domain name to the suffix to use for a database URL.
static String	getEffectiveDatabaseType(String databaseType, String domainName) Returns the effective Database type.
static String	getSchemaName(String domainName) Resolves a domain name to a schema name.
static boolean	isPostgres(String databaseType) Returns true if the specified Database type indicates Postgres.

Methods inherited from class java.lang.Object

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

Field Detail

DATABASE_TYPE_ORACLE

public static final String DATABASE_TYPE_ORACLE

String that identifes the database type to be Oracle.

See Also:

Constant Field Values

DATABASE_TYPE_POSTGRES

public static final String DATABASE_TYPE_POSTGRES

String that identifes the database type to be Postgres.

See Also:

Constant Field Values

DRIVER_CLASS_ORACLE

public static final String DRIVER_CLASS_ORACLE

Default Oracle JDBC driver class.

See Also:

Constant Field Values

DRIVER_CLASS_POSTGRES

public static final String DRIVER_CLASS_POSTGRES

Default Postgres JDBC driver class.

See Also:

Constant Field Values

DATASOURCE_CLASS_ORACLE

public static final String DATASOURCE_CLASS_ORACLE

Oracle Datasource class.

See Also:

Constant Field Values

DATASOURCE_CLASS_POSTGRES

public static final String DATASOURCE_CLASS_POSTGRES

Postgres Datasource class.

See Also:

Constant Field Values

JDBCDRIVERTYPE_THIN

public static final String JDBCDRIVERTYPE_THIN

The JDBC Thin driver for Oracle.

See Also:

Constant Field Values

JDBCDRIVERTYPE_OCI8

public static final String JDBCDRIVERTYPE_OCI8

The JDBC OCI8 driver for Oracle.

See Also:

Constant Field Values

Method Detail

constructDataSource

public static DataSource constructDataSource(String databaseType,
                                             String databaseUrl,
                                             String schemaName,
                                             String schemaPassword)
                                      throws IfsException

Constructs the data source.

Parameters:

databaseType - database type ("oracle" or "postgres"); if null, default to oracle

databaseUrl - database url

schemaName - name of the schema

schemaPassword - schema password

Returns:

DataSource instance

Throws:

IfsException - if the operation fails

getDatabaseUrl

public static String getDatabaseUrl(String databaseType,
                                    String domainName,
                                    String jdbcDriverType)
                             throws IfsException

Resolves a database type and domain name to a database URL.

A database URL is synthesized from the specified domain name, database type ("oracle" or "postgres"), and JDBC driver type.

Parameters:

databaseType - the database type ("oracle" or "postgres"); if null assume postgres

domainName - the domain name

jdbcDriverType - the JDBC driver type for Oracle; either "thin" or "oci8"

Returns:

the database URL

Throws:

IfsException - (IFS-20130) if the operation fails

(Published)

getDatabaseUrlPrefix

public static String getDatabaseUrlPrefix(String databaseType,
                                          String jdbcDriverType)

Resolves a domain name to the prefix to use for a database URL.

Parameters:

databaseType - the database type ("oracle" or "postgres"); if null assume postgres

jdbcDriverType - the JDBC driver type for Oracle; either "thin" or "oci8"

Returns:

the database URL prefix

(Unpublished)

getDatabaseUrlSuffix

public static String getDatabaseUrlSuffix(String databaseType,
                                          String domainName)
                                   throws IfsException

Resolves a domain name to the suffix to use for a database URL.

Parameters:

databaseType - the database type ("oracle" or "postgres"); if null assume postgres

domainName - the domain name

Returns:

the database URL suffix

Throws:

IfsException - if the operation fails

(Unpublished)

getEffectiveDatabaseType

public static String getEffectiveDatabaseType(String databaseType,
                                              String domainName)

Returns the effective Database type.

If specified value is null, return a type indicating Oracle. Otherwise, the database type must indicate a legal value; if not, a RuntimeException is thrown.

Parameters:

databaseType - the database type

domainName - the domain name; used to create default value for database type if it is not specified

Returns:

the effective database type

deriveDatabaseType

public static String deriveDatabaseType(String domainName)

Derives the effective Database type from the specified domain name.

Parameters:

domainName - the domain name; used to create default value for database type if it is not specified

Returns:

the effective database type

getSchemaName

public static String getSchemaName(String domainName)
                            throws IfsException

Resolves a domain name to a schema name.

Parameters:

domainName - the domain name

Returns:

the schema name

Throws:

IfsException - (IFS-20131) if the operation fails

(Published)

isPostgres

public static boolean isPostgres(String databaseType)

Returns true if the specified Database type indicates Postgres.

Returns:

true if Database type indicates Postgres; false otherwise