com.prosyst.mprm.backend.dbconnection.jdbc

Interface DBServerConnector

public interface DBServerConnector

This service manages JDBC connections to one or more SQL database servers used by mPRM database services.

Method Summary

Modifier and Type	Method and Description
void	closeConnectionManager(ConnectionManager manager) Closes connections to the database server managed by the supplied connection manager.
ConnectionManager	getConnectionManager(java.lang.String dbServerName) Returns connection manager which manages the connections to a database server with a given name.
ConnectionManager	getConnectionManager(java.lang.String systemId, java.util.Dictionary props) Opens a connection to database server defined by the supplied properties and returns connection manager for obtaining SQL connections.

Method Detail

getConnectionManager

ConnectionManager getConnectionManager(java.lang.String dbServerName)
                                throws java.sql.SQLException

Returns connection manager which manages the connections to a database server with a given name. If there is no connection configuration corresponding to the supplied name null is returned. If the supplied argument is null or empty string then the connection manager for the default database server (which stored) mPRM system database) is returned. Database services can use this method to obtain connections to the appropriate database server, but the prefered way for doing this is to register DBConnectionUser service.

Parameters:

dbServerName - the name of the database server as defined in the mPRM database configuration.

Returns:

connection manager object which manages one or more connections to a given database server.

Throws:

java.sql.SQLException - if an error occured while trying to establish connection to the database server

getConnectionManager

ConnectionManager getConnectionManager(java.lang.String systemId,
                                       java.util.Dictionary props)
                                throws java.sql.SQLException

Opens a connection to database server defined by the supplied properties and returns connection manager for obtaining SQL connections. Properties for connecting SQL RDBMS can contain key 'driverLib' with value of type InputStream with zipped JDBC driver classes, used by connector service to load driver class. If this property present then dictionary must also contain property 'driverLibName' with the name of the driver file. If this property does not present then the driver must be in the classpath of the mPRM backend servers. This method is intended for use by mPRM system configuration management services and should not be used by db services or other applicatons.

Parameters:

props - dictionary with properties for connection establishment - URL, user name, password, etc.

Returns:

connection manager object which manages one or more connections to a given database server.

Throws:

java.sql.SQLException - if an error occured while trying to establish connection to the database server

closeConnectionManager

void closeConnectionManager(ConnectionManager manager)

Closes connections to the database server managed by the supplied connection manager. This method is intended for use by mPRM system configuration management services and should not be used by db services or other applicatons.

Parameters:

manager - connection manager representing db server connections being closed.