com.prosyst.mprm.admin.system

Interface DatabaseServerConfiguration

All Known Subinterfaces:

Configurator, ConfiguratorManager, SystemObserver

public interface DatabaseServerConfiguration

Provides methods for obtaining configuration properties used by mPRM system for connecting to one or more database servers which maintain mPRM databases.

Version:

1.0.0

Author:

Jordan Simeonov, Rumen Monev

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_DN
static java.lang.String	DB_SERVER_NAME
static java.lang.String	DB_SERVER_TYPE
static java.lang.String	DB_SERVER_TYPE_JDBC
static java.lang.String	DB_SERVER_TYPE_LDAP
static java.lang.String	DRIVER The name of the driver class file.
static java.lang.String	DRIVER_LIB A stream to the jar or zip file of the driver class library.
static java.lang.String	DRIVER_LIB_NAME The name of the jar or zip driver class library file.
static java.lang.String	HOST LDAP database server property names
static java.lang.String	MAX_CONNECTIONS Maximum number of opened Connection per host.
static java.lang.String	MAX_RO_CONNECTIONS Maximum number of opened Read-Only Connection per host.
static java.lang.String	MAX_STATEMENTS Maximum number of opened statement per connection.
static java.lang.String	PASSWORD
static java.lang.String	PORT
static java.lang.String	SYSTEM_DB_SERVER
static java.lang.String	URL Database URL.
static java.lang.String	USER Common database server constants.

Method Summary

Modifier and Type	Method and Description
java.util.Dictionary	getDBServerConfiguration(java.lang.String dbServerName) Returns configuration properties for connecting to a database server with the supplied name.
java.lang.String[]	getDBServerNames() Returns the names of the defined database servers.
java.lang.String[]	getDBServerNames(java.lang.String serverType) Returns the names of the defined database server names filtered by type.
java.io.InputStream	getDriver(java.lang.String driverId) Returns the library stream of the specified driver.
java.lang.String[]	getDriverIds() Returns array of identificators of the available drivers.
java.lang.String	getSystemDBServer() Returns the name of the database server which maintains basic mPRM system information, including configuration of other database servers (if any), database service configurations, defined management servers, etc.
void	removeDriver(java.lang.String driverId) Removes the driver with the specified id from the set of available drivers.
void	uploadDriver(java.lang.String driverId, java.io.InputStream stream) Adds the driver with the specified id from the set of available drivers.

Field Detail

DB_SERVER_TYPE

static final java.lang.String DB_SERVER_TYPE

See Also:

Constant Field Values

DB_SERVER_TYPE_JDBC

static final java.lang.String DB_SERVER_TYPE_JDBC

See Also:

Constant Field Values

DB_SERVER_TYPE_LDAP

static final java.lang.String DB_SERVER_TYPE_LDAP

See Also:

Constant Field Values

DB_SERVER_NAME

static final java.lang.String DB_SERVER_NAME

See Also:

Constant Field Values

SYSTEM_DB_SERVER

static final java.lang.String SYSTEM_DB_SERVER

See Also:

Constant Field Values

HOST

static final java.lang.String HOST

LDAP database server property names

See Also:

Constant Field Values

PORT

static final java.lang.String PORT

See Also:

Constant Field Values

BASE_DN

static final java.lang.String BASE_DN

See Also:

Constant Field Values

URL

static final java.lang.String URL

Database URL. It's format is driver specific.

See Also:

Constant Field Values

DRIVER

static final java.lang.String DRIVER

The name of the driver class file.

See Also:

Constant Field Values

DRIVER_LIB_NAME

static final java.lang.String DRIVER_LIB_NAME

The name of the jar or zip driver class library file.

See Also:

Constant Field Values

DRIVER_LIB

static final java.lang.String DRIVER_LIB

A stream to the jar or zip file of the driver class library.

See Also:

Constant Field Values

MAX_CONNECTIONS

static final java.lang.String MAX_CONNECTIONS

Maximum number of opened Connection per host.

See Also:

Constant Field Values

MAX_RO_CONNECTIONS

static final java.lang.String MAX_RO_CONNECTIONS

Maximum number of opened Read-Only Connection per host.

See Also:

Constant Field Values

MAX_STATEMENTS

static final java.lang.String MAX_STATEMENTS

Maximum number of opened statement per connection.

See Also:

Constant Field Values

USER

static final java.lang.String USER

Common database server constants.

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

See Also:

Constant Field Values

Method Detail

getDBServerNames

java.lang.String[] getDBServerNames()
                             throws CommunicationException,
                                    java.lang.Exception

Returns the names of the defined database servers. A database server manages one or more mPRM databases and is identified by an unique name.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getDBServerNames

java.lang.String[] getDBServerNames(java.lang.String serverType)
                             throws CommunicationException,
                                    java.lang.Exception

Returns the names of the defined database server names filtered by type. Every database server managing one or more mPRM database is identified with unique name.

Parameters:

serverType - the type of the database server.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getDBServerConfiguration

java.util.Dictionary getDBServerConfiguration(java.lang.String dbServerName)
                                       throws CommunicationException,
                                              java.lang.Exception

Returns configuration properties for connecting to a database server with the supplied name.

Parameters:

dbServerName - the name of the database server.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getSystemDBServer

java.lang.String getSystemDBServer()
                            throws CommunicationException,
                                   java.lang.Exception

Returns the name of the database server which maintains basic mPRM system information, including configuration of other database servers (if any), database service configurations, defined management servers, etc.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getDriverIds

java.lang.String[] getDriverIds()
                         throws CommunicationException,
                                java.lang.Exception

Returns array of identificators of the available drivers.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getDriver

java.io.InputStream getDriver(java.lang.String driverId)
                       throws CommunicationException,
                              java.lang.Exception

Returns the library stream of the specified driver.

Parameters:

driverId - the driver identificator.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

removeDriver

void removeDriver(java.lang.String driverId)
           throws CommunicationException,
                  java.lang.Exception

Removes the driver with the specified id from the set of available drivers.

Parameters:

driverId - the driver identificator

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

uploadDriver

void uploadDriver(java.lang.String driverId,
                  java.io.InputStream stream)
           throws CommunicationException,
                  java.lang.Exception

Adds the driver with the specified id from the set of available drivers. If driver with the specified id already exists it is updated.

Parameters:

driverId - the driver identificator

stream - the driver library stream

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception