com.prosyst.mprm.backend.dbconnection

Interface ConfigurableDBConnectionService

public interface ConfigurableDBConnectionService

This interface must be registered as service in the mPRM backend framework by DB server connector service(s). The service provides connectivity to database servers used by database service. The service must be registered with the property 'dbserver.type'=. Usually will have values 'JDBC' or 'LDAP', but other db server types are also possible.

Method Summary

Modifier and Type	Method and Description
void	setConfigurations(java.lang.String systemId, java.util.Dictionary[] configurations) This method is invoked by mPRM system service to provide db connector service with the configurations needed for establishing connections to all database servers defined for use by mPRM.
com.prosyst.mprm.data.system.DBCatalogueInfo[]	testConnection(java.util.Dictionary configuration) This method is used to test the database server connectivity using a supplied configuration.
void	writeDBCatalogEntry(java.util.Dictionary configuration, java.lang.String databaseName, java.lang.String systemId, java.lang.String version) Writes DBCatalogueInfo entry in the system database table.

Method Detail

setConfigurations

void setConfigurations(java.lang.String systemId,
                       java.util.Dictionary[] configurations)

This method is invoked by mPRM system service to provide db connector service with the configurations needed for establishing connections to all database servers defined for use by mPRM. Dictionary objects contain properties needed for connecting to a database server. The properties depends on the type of db server. For example configuration of JDBC server connection contains URL, username and password. In addition every configuration has property "dbserver.name" with value - the name of the database server as defined in mPRM configuration process. This name is used by database services to obtain connections to appropriate database servers. In addition mPRM system service sets the property "system.database"="true" in the configuration dictionary of database server which manages system database of mPRM. This configuration is used by connector service for every database service that has not explicitly configured database server name. Properties for connecting some type of databases (f.e. SQL RDBMS) can contain key 'driverLib' with value of type InputStream with zipped driver classes, used by connector service to load driver class. If this property is present, then the dictionary must also contain the property 'driverLibName' with the name of the driver file. Otherwise the driver must be in the classpath of the mPRM backend hosts.

Parameters:

systemId - the mPRM systemId

configurations - array of dictionary objects containing properties for connecting to all database servers of the same type as the connector service, defined during the mPRM configuration process.

testConnection

com.prosyst.mprm.data.system.DBCatalogueInfo[] testConnection(java.util.Dictionary configuration)
                                                       throws ManagementException

This method is used to test the database server connectivity using a supplied configuration. If the connection with the database is successful, the method returns. Otherwise it throws exception. This method only establishes connection and closes it. It does not change configuration of current database server set of properties. Properties for connecting to a database server (f.e. SQL RDBMS) can contain key 'driverLib' with value of type InputStream with zipped driver classes, used by connector service to load driver class. If this property is not present then the driver must be in the classpath of the mPRM backend hosts.

Parameters:

configuration - dictionary object containing connect properties to a database server of the same type as the specified type defined in the mPRM configuration.

Returns:

returns array of database catalogue info entries containing information about

Throws:

ManagementException - if the connection can not be established.

writeDBCatalogEntry

void writeDBCatalogEntry(java.util.Dictionary configuration,
                         java.lang.String databaseName,
                         java.lang.String systemId,
                         java.lang.String version)
                  throws DatabaseException

Writes DBCatalogueInfo entry in the system database table.

Parameters:

configuration - the connection properties

databaseName - the name of the logical database service.

systemId - the mPRM system id.

version - the version of the database service.

Throws:

DatabaseException - if some error occures.