com.prosyst.mprm.backend.database.system

Interface SystemDatabase

All Superinterfaces:

BackendBundlesDatabase

All Known Subinterfaces:

TransactionalSystemDatabase

public interface SystemDatabase
extends BackendBundlesDatabase

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASE_DIFFERENT Database state value returned by getDBState(), if the tables needed by this database are present on the db server, but with a different structure that cannot be converted.
static int	BASE_EMPTY Database state value returned by getDBState(), if the tables needed by this database are not present on the db server.
static int	BASE_IN_USE Database state value returned by getDBState(), if the tables needed by this database are present on the db server in the needed format, but the database is in use by another mPRM system.
static int	BASE_OK Database state value returned by getDBState(), if the tables needed by this database are present on the db server in the needed format, and the database server is not in use by another mPRM system.
static int	BASE_OLD_IN_USE Database state value returned by getDBState(), if the tables needed by this database are present on the db server in an old format that can be converted, but the database server is in use by another mPRM system.
static int	BASE_OLD_OK Database state value returned by getDBState(), if the tables needed by this database are present on the db server in an old format that can be converted, and the database server is not in use by another mPRM system.
static java.lang.String	DATABASE_NAME The database name used to identify The System Database in Database catalogue.

Method Summary

Modifier and Type	Method and Description
void	addDBServer(com.prosyst.mprm.data.system.DBServerInfo dbServer) Adds a DB server.
void	addDriver(java.lang.String driverId, java.io.InputStream driver) Adds a db driver.
void	addDriver(java.lang.String driverId, java.io.InputStream driver, long length) Adds a db driver.
void	addHost(com.prosyst.mprm.data.system.HostInfo host) Adds a host.
void	addManagementServer(com.prosyst.mprm.data.system.MSInfo msInfo) Adds a management server.
void	addNetwork(java.lang.String network) Adds a network with the specified name into the database.
void	addNetworkFilter(com.prosyst.mprm.data.system.NetworkFilterInfo networkFilter) Adds a network filter to the database.
void	addNetworkFilters(com.prosyst.mprm.data.system.NetworkFilterInfo[] networkFilters) Removes network & its data(associated network filters) with respect to the the specified argument.
void	addNetworks(java.lang.String[] networks) Adds the specified set of network names within the database.
TransactionalSystemDatabase	begin() Returns instance of SystemDatabase which all calls will be treated as a transaction till commit or rollback is called.
void	convertTables() Converts database tables to the required format.
void	createTables() Creates database required tables if not present.
com.prosyst.mprm.data.system.CCInfo	getCCInfo() Returns the ControlCenter information stored into the database.
com.prosyst.mprm.data.system.DBServerInfo	getDBServer(java.lang.String name) Returns the description of the DB server with the specified name.
java.lang.String[]	getDBServerNames() Returns the names of all registered DB servers.
com.prosyst.mprm.data.system.DBServerInfo[]	getDBServers() Returns the descriptions of all registered DB servers.
int	getDBState() Checks and returns the state of the database.
java.io.InputStream	getDriver(java.lang.String driverId) Returns the DB server driver JAR file with the specified id.
java.lang.String[]	getDriverIds()
com.prosyst.mprm.data.system.HostInfo	getHost(java.lang.String id) Returns the host with the specified id.
com.prosyst.mprm.data.system.HostInfo[]	getHosts(java.lang.String[] roles) Returns the hosts with the specified roles.
java.lang.String	getInitFileVersion() Return the last applied configuration file version.
com.prosyst.mprm.data.system.MSInfo	getManagementServer(java.lang.String id) Returns a specific management server.
com.prosyst.mprm.data.system.MSInfo[]	getManagementServers() Returns MSInfos describing all management servers in the database.
com.prosyst.mprm.data.system.NetworkFilterInfo[]	getNetworkFilters(java.lang.String network) Returns all network filters associated with a network.
java.lang.String[]	getNetworks() Returns the network names stored into the database.
DictionaryInfo	getSystemProperties() Returns all system properties.
void	removeDBServer(java.lang.String name) Removes the database server with the specified name.
void	removeDBServers() Removes all DB servers.
void	removeDriver(java.lang.String driverId) Removes the database driver JAR with the specified ID.
void	removeDrivers() Removes all DB driver JARs.
void	removeHost(java.lang.String id) Removes the specified host.
void	removeHosts() Removes all host information.
void	removeManagementServer(java.lang.String msid) Removes the management server with the specified MS ID.
void	removeManagementServers() Removes all management servers.
void	removeNetwork(java.lang.String network) Removes network & its data(associated network filters) with respect to the the specified argument.
void	removeNetworkFilters(java.lang.String network) Removes all network filters on associated with the specified network.
void	setCCInfo(com.prosyst.mprm.data.system.CCInfo info) Stores the information for the ControlCenter into the database.
void	setInitFileVersion(java.lang.String version) Set configuration file version.
void	setSystemProperties(DictionaryInfo properties) Sets system properties.
void	updateHost(com.prosyst.mprm.data.system.HostInfo host) Updates information about a host.

Methods inherited from interface com.prosyst.mprm.backend.database.system.BackendBundlesDatabase

addBundle, addConfig, addDBConfig, addDBMetaTypeProvider, addMetaTypeProvider, addPackage, addPermissions, getBundle, getBundle, getBundleJar, getBundles, getConfigs, getDBConfigs, getDBConfigs, getDBMetaTypeProvider, getDBMetaTypeProviders, getDBMetaTypeProviders, getMetaTypeProvider, getMetaTypeProviders, getMetaTypeProviders, getPackage, getPackageBundles, getPackageNames, getPackages, getPackagesDependentOn, getPermissions, getPermissions, getUserBundles, loadDBMetaTypeProvider, loadMetaTypeProvider, removeBundle, removeBundles, removeConfigs, removeDBConfigs, removeDBConfigs, removeDBMetaTypeProviders, removeMetaTypeProviders, removePackage, removePackageBundles, removePackages, removePermissions, removePermissions, removeUserBundles, setPermissions, updateBundle, updatePackage

Field Detail

DATABASE_NAME

static final java.lang.String DATABASE_NAME

The database name used to identify The System Database in Database catalogue.

See Also:

Constant Field Values

BASE_EMPTY

static final int BASE_EMPTY

Database state value returned by getDBState(), if the tables needed by this database are not present on the db server.

See Also:

Constant Field Values

BASE_OLD_OK

static final int BASE_OLD_OK

Database state value returned by getDBState(), if the tables needed by this database are present on the db server in an old format that can be converted, and the database server is not in use by another mPRM system.

See Also:

Constant Field Values

BASE_OLD_IN_USE

static final int BASE_OLD_IN_USE

Database state value returned by getDBState(), if the tables needed by this database are present on the db server in an old format that can be converted, but the database server is in use by another mPRM system.

See Also:

Constant Field Values

BASE_OK

static final int BASE_OK

Database state value returned by getDBState(), if the tables needed by this database are present on the db server in the needed format, and the database server is not in use by another mPRM system.

See Also:

Constant Field Values

BASE_IN_USE

static final int BASE_IN_USE

Database state value returned by getDBState(), if the tables needed by this database are present on the db server in the needed format, but the database is in use by another mPRM system.

See Also:

Constant Field Values

BASE_DIFFERENT

static final int BASE_DIFFERENT

Database state value returned by getDBState(), if the tables needed by this database are present on the db server, but with a different structure that cannot be converted.

See Also:

Constant Field Values

Method Detail

getDBState

int getDBState()

Checks and returns the state of the database.

Returns:

the state of the database tables.

createTables

void createTables()
           throws DatabaseException

Creates database required tables if not present. This method must be called after getDBState(), if it has returned BASE_EMPTY.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

convertTables

void convertTables()
            throws DatabaseException

Converts database tables to the required format. This method must be called after getDBState(), if it has returned BASE_OLD_OK or BASE_OLD_IN_USE.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

setCCInfo

void setCCInfo(com.prosyst.mprm.data.system.CCInfo info)
        throws DatabaseException

Stores the information for the ControlCenter into the database.

Parameters:

info - the ControlCenter information.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getCCInfo

com.prosyst.mprm.data.system.CCInfo getCCInfo()
                                       throws DatabaseException

Returns the ControlCenter information stored into the database.

Returns:

the stored ControlCenter information.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addDBServer

void addDBServer(com.prosyst.mprm.data.system.DBServerInfo dbServer)
          throws DatabaseException

Adds a DB server.

Parameters:

dbServer - the DB server.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getDBServerNames

java.lang.String[] getDBServerNames()
                             throws DatabaseException

Returns the names of all registered DB servers.

Returns:

the names of all registered DB servers.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getDBServer

com.prosyst.mprm.data.system.DBServerInfo getDBServer(java.lang.String name)
                                               throws DatabaseException

Returns the description of the DB server with the specified name.

Parameters:

name - the name of DB Server.

Returns:

the description of the DB server with the specified name.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getDBServers

com.prosyst.mprm.data.system.DBServerInfo[] getDBServers()
                                                  throws DatabaseException

Returns the descriptions of all registered DB servers.

Returns:

the descriptions of all registered DB servers.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeDBServer

void removeDBServer(java.lang.String name)
             throws DatabaseException

Removes the database server with the specified name.

Parameters:

name - the database server name.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeDBServers

void removeDBServers()
              throws DatabaseException

Removes all DB servers.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addDriver

void addDriver(java.lang.String driverId,
               java.io.InputStream driver)
        throws DatabaseException

Adds a db driver.

Parameters:

driverId - the name of the jar file.

driver - the db driver.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addDriver

void addDriver(java.lang.String driverId,
               java.io.InputStream driver,
               long length)
        throws DatabaseException

Adds a db driver.

Parameters:

driverId - the name of the jar file.

driver - the db driver.

length - the number of bytes in the stream.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getDriverIds

java.lang.String[] getDriverIds()
                         throws DatabaseException

Returns:

the driverIds of all drivers in the database

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getDriver

java.io.InputStream getDriver(java.lang.String driverId)
                       throws DatabaseException

Returns the DB server driver JAR file with the specified id.

Returns:

driverId the id of the driver.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeDriver

void removeDriver(java.lang.String driverId)
           throws DatabaseException

Removes the database driver JAR with the specified ID.

Parameters:

driverId - the database driver JAR ID.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeDrivers

void removeDrivers()
            throws DatabaseException

Removes all DB driver JARs.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addManagementServer

void addManagementServer(com.prosyst.mprm.data.system.MSInfo msInfo)
                  throws DatabaseException

Adds a management server.

Parameters:

msInfo - management server info.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getManagementServer

com.prosyst.mprm.data.system.MSInfo getManagementServer(java.lang.String id)
                                                 throws DatabaseException

Returns a specific management server.

Parameters:

id - management server ID.

Returns:

the management server with the specified ID.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getManagementServers

com.prosyst.mprm.data.system.MSInfo[] getManagementServers()
                                                    throws DatabaseException

Returns MSInfos describing all management servers in the database.

Returns:

all management servers.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeManagementServer

void removeManagementServer(java.lang.String msid)
                     throws DatabaseException

Removes the management server with the specified MS ID.

Parameters:

msid - the MS ID.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeManagementServers

void removeManagementServers()
                      throws DatabaseException

Removes all management servers.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addHost

void addHost(com.prosyst.mprm.data.system.HostInfo host)
      throws DatabaseException

Adds a host.

Parameters:

host - the host to be added.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getHosts

com.prosyst.mprm.data.system.HostInfo[] getHosts(java.lang.String[] roles)
                                          throws DatabaseException

Returns the hosts with the specified roles. If the roles parameter is null, all hosts are returned. To search for hosts with the default role, pass a null element in the roles array.

Parameters:

roles - the roles.

Returns:

the hosts found in the search.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getHost

com.prosyst.mprm.data.system.HostInfo getHost(java.lang.String id)
                                       throws DatabaseException

Returns the host with the specified id.

Parameters:

id - the id.

Returns:

the host found in the search.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

updateHost

void updateHost(com.prosyst.mprm.data.system.HostInfo host)
         throws DatabaseException

Updates information about a host.

Parameters:

host - the host information; all fields must be valid.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeHost

void removeHost(java.lang.String id)
         throws DatabaseException

Removes the specified host.

Parameters:

id - the host id.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeHosts

void removeHosts()
          throws DatabaseException

Removes all host information.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addNetwork

void addNetwork(java.lang.String network)
         throws DatabaseException

Adds a network with the specified name into the database.

Parameters:

network - the name of the network

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addNetworks

void addNetworks(java.lang.String[] networks)
          throws DatabaseException

Adds the specified set of network names within the database.

Parameters:

networks - - network names to be added.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getNetworks

java.lang.String[] getNetworks()
                        throws DatabaseException

Returns the network names stored into the database.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeNetwork

void removeNetwork(java.lang.String network)
            throws DatabaseException

Removes network & its data(associated network filters) with respect to the the specified argument. If null all networks will be removed.

Parameters:

network - the name of the network

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addNetworkFilter

void addNetworkFilter(com.prosyst.mprm.data.system.NetworkFilterInfo networkFilter)
               throws DatabaseException

Adds a network filter to the database.

Parameters:

networkFilter - network filter to be added.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

addNetworkFilters

void addNetworkFilters(com.prosyst.mprm.data.system.NetworkFilterInfo[] networkFilters)
                throws DatabaseException

Removes network & its data(associated network filters) with respect to the the specified argument. If null all networks will be removed.

Parameters:

networkFilters - network filters to be added.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

getNetworkFilters

com.prosyst.mprm.data.system.NetworkFilterInfo[] getNetworkFilters(java.lang.String network)
                                                            throws DatabaseException

Returns all network filters associated with a network.

Parameters:

network - the network name which filters has to be returned.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

removeNetworkFilters

void removeNetworkFilters(java.lang.String network)
                   throws DatabaseException

Removes all network filters on associated with the specified network.

Parameters:

network - the name of the network which associated filters must be removed.

Throws:

{@link - DatabaseException} if an error occurs.

DatabaseException

begin

TransactionalSystemDatabase begin()
                           throws DatabaseException

Returns instance of SystemDatabase which all calls will be treated as a transaction till commit or rollback is called.

Throws:

{@link - DatabaseException} if called an error occurs or method called on TransactionalSystemDatabase instance.

DatabaseException

setSystemProperties

void setSystemProperties(DictionaryInfo properties)
                  throws DatabaseException

Sets system properties.

Parameters:

properties - the system properties.

Throws:

DatabaseException - if an error occurs.

getSystemProperties

DictionaryInfo getSystemProperties()
                            throws DatabaseException

Returns all system properties.

Returns:

system properties

Throws:

DatabaseException - if an error occurs.

getInitFileVersion

java.lang.String getInitFileVersion()
                             throws DatabaseException

Return the last applied configuration file version.

Throws:

DatabaseException - if an error occurs.

setInitFileVersion

void setInitFileVersion(java.lang.String version)
                 throws DatabaseException

Set configuration file version.

Parameters:

version - the new configuration file version

Throws:

DatabaseException - if an error occurs.