com.sssw.rts.adminapi
Interface AgiAdmDatabasePlatform

public interface AgiAdmDatabasePlatform

Implemented by objects that represent database platforms.

See Also:

AgiAdmServer

Method Summary

String	getDefaultDatabaseDriver() Get the name of the default database driver that is recommended to be used with the given database platform
String	getDefaultJdbcDriver() Get the name of the default JDBC driver that is recommended to be used with the given database platform
String	getDriverSet() Get the name of the driver set for the given database platform.
String	getJdbcUrlHint() Get the hint for the format of the JDBC URL.
String	getLdsKey() Get the name of the logical data source (LDS) key for the given database platform.
String	getName() Get the name of the database platform.
boolean	isDualDatabaseModeEnforced() Specifies whether the API users can create a single database that contains their system tables or if dual database is needed, i.e.

Method Detail

getName

public String getName()

Get the name of the database platform.

Returns:

the name of the database platform, e.g., "Sybase Adaptive Server Anywhere 6" or "Oracle 8"

Example:

 AgiAdmDatabasePlatform dbpl = ...
 String dbplName = dbpl.getName();
 

getDefaultJdbcDriver

public String getDefaultJdbcDriver()

Get the name of the default JDBC driver that is recommended to be used with the given database platform

Returns:

the name of the default JDBC driver, e.g., "com.sssw.jdbc.mss.odbc.AgOdbcDriver" or "com.sybase.jdbc2.jdbc.SybDriver"

Example:

 AgiAdmDatabasePlatform dbpl = ...
 String dfltJdbcDriver = dbpl.getDefaultJdbcDriver();
 

getDefaultDatabaseDriver

public String getDefaultDatabaseDriver()

Get the name of the default database driver that is recommended to be used with the given database platform

Returns:

the name of the default database driver, e.g., "com.sssw.srv.sql.Sybase.SQLAnywhere6.AgDB" or "com.sssw.srv.sql.Informix.OnLineDynamicServer.AgDB"

Example:

 AgiAdmDatabasePlatform dbpl = ...
 String dfltDatabaseDriver = dbpl.getDefaultDatabaseDriver();
 

isDualDatabaseModeEnforced

public boolean isDualDatabaseModeEnforced()

Specifies whether the API users can create a single database that contains their system tables or if dual database is needed, i.e. there needs to be a separate database where the system tables are stored.

Currently, only the DB2 platform enforces the dual database mode.

Returns:

boolean "true" if the dual database mode is enforced (system tables must be stored separately), "false" if it is not enforced

Example:

 AgiAdmDatabasePlatform dbpl = ...
 boolean isDual = dbpl.isDualDatabaseModeEnforced();
 

getLdsKey

public String getLdsKey()

Get the name of the logical data source (LDS) key for the given database platform.

Returns:

the LDS key, e.g. "InformixV7AgBridge", "IBMDB2V5OS390Client", "MSSQLSvrV6AgBridge"

getDriverSet

public String getDriverSet()

Get the name of the driver set for the given database platform.

Returns:

the name of the driver set, e.g. "SilverStream JDBC-ODBC bridge", "SilverStream JDBC driver", "Sybase jConnect 5.x"

getJdbcUrlHint

public String getJdbcUrlHint()

Get the hint for the format of the JDBC URL.

Returns:

the JDBC URL hint, e.g. "jdbc:sybase:Tds:%HOST%:%PORT%/%DATABASE%", "jdbc:sssw:odbc:%DATA SOURCE NAME%", "jdbc:db2:%DBNAME%"

Usage:

Each %...% part of the hint must be replaced by the appropriate piece of information before the JDBC URL can be used, e.g., in the addChild call off AgiAdmServer in order to add a database.