com.prosyst.mprm.admin.system

Interface DatabaseConfiguration

All Known Subinterfaces:

Configurator, ConfiguratorManager, ManagementServer, SystemObserver

public interface DatabaseConfiguration

Provides methods for obtaining configuration properties of mPRM database services. Each database service provides facilities to operate with data from a particular database, for example gateways database, bundle inventory database, user database, etc. Each database is stored and maintained by a database server, which can be different for different databases. It is also possible one database to be optionally distributed over more than one database server. For example each Management Server can operate its subset of gateways data in separate DB server. The user database service can provide interface to existing user information from directory server and so on. That's why mPRM allows different configurations to be used for every database service. To be flexible enough the mechanism provides ability every database service to provide metadata for its configuration, so the system will allow adding of new repository services without the need to change the implementation of system configuration services.

Version:

1.0.0

Author:

Jordan Simeonov, Rumen Monev

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATABASE_NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getConfigurableDatabases() Returns the names of all database names used by current set of backend bundles.
DBMetaTypeProviderExtension[]	getDBConfigMetaData(java.lang.String databaseName) Returns configuration metadata of a database service operating on database with a given name.
RoleConfig	getDBConfiguration(java.lang.String pid) Returns current properties of a configuration with a supplied pid.
java.util.Dictionary[]	getDBFactoryConfigurations(java.lang.String factoryPid) Returns all configurations of a configuration factory with a supplied factoryPid.
java.lang.String[]	getPidsOfDBFactoryConfiguration(java.lang.String factoryPid) Returns array of String objects representing pids of configurations which belongs to a configuration group of particular factory pid.

Field Detail

DATABASE_NAME

static final java.lang.String DATABASE_NAME

See Also:

Constant Field Values

Method Detail

getConfigurableDatabases

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

Returns the names of all database names used by current set of backend bundles. Note that these are names of logical databases (like 'gateway db', 'certificates db', etc.) not the names of database services which manage those databases.

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

getDBConfigMetaData

DBMetaTypeProviderExtension[] getDBConfigMetaData(java.lang.String databaseName)
                                           throws CommunicationException,
                                                  java.lang.Exception

Returns configuration metadata of a database service operating on database with a given name. If null all metatype providers are considered.

Parameters:

databaseName - the name of the desired database metadata.

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

getPidsOfDBFactoryConfiguration

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

Returns array of String objects representing pids of configurations which belongs to a configuration group of particular factory pid.

Parameters:

factoryPid - the specified factory pid.

Returns:

array of pids belonging to the supplied factory pid.

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

getDBConfiguration

RoleConfig getDBConfiguration(java.lang.String pid)
                       throws CommunicationException,
                              java.lang.Exception

Returns current properties of a configuration with a supplied pid.

Parameters:

pid - the pid of the configuration.

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

getDBFactoryConfigurations

java.util.Dictionary[] getDBFactoryConfigurations(java.lang.String factoryPid)
                                           throws CommunicationException,
                                                  java.lang.Exception

Returns all configurations of a configuration factory with a supplied factoryPid.

Parameters:

factoryPid - the factory pid of the configurations.

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