com.prosyst.mprm.admin.system

Interface Configurator

All Superinterfaces:

BackendBundleInventory, DatabaseConfiguration, DatabaseServerConfiguration, SystemObserver, TreeBrowser

public interface Configurator
extends SystemObserver, TreeBrowser

Enables system operator to change and adjust the mPRM base system configuration database services, management servers, etc. Operations with Configurator object does not change the existing system configuration until apply method is invoked. The changes can be revoked by invoking release method, but it has no effect if successive call on apply has already taken place. After invoking apply configurator resources are also released & configurator instance becomes invalid. It is recommended configurators not supposed to be further used to be released. A configurator object is bound to a specific system database server properties, supplied during the configurator object creation or further with init method, but only if instance is created through ConfiguratorManager.createConfigurator(). Once bound it could not be changed later. In order to change the configuration the latter object must be released and a new one should be created using new db properties.

Version:

1.0.0

Author:

Jordan Simeonov, Rumen Monev

Field Summary

Fields inherited from interface com.prosyst.mprm.admin.system.DatabaseServerConfiguration

BASE_DN, DB_SERVER_NAME, DB_SERVER_TYPE, DB_SERVER_TYPE_JDBC, DB_SERVER_TYPE_LDAP, DRIVER, DRIVER_LIB, DRIVER_LIB_NAME, HOST, MAX_CONNECTIONS, MAX_RO_CONNECTIONS, MAX_STATEMENTS, PASSWORD, PORT, SYSTEM_DB_SERVER, URL, USER

Fields inherited from interface com.prosyst.mprm.admin.system.DatabaseConfiguration

DATABASE_NAME

Method Summary

Modifier and Type	Method and Description
BackendServerHost	addBackendServerHost(java.util.Dictionary hostProperties) Adds backend server host.
void	addDBServer(java.util.Dictionary dbServerData) Adds database server to the set of configurations.
ManagementServer	addManagementServer(java.util.Dictionary properties) Adds new management server.
Network	addNetwork(java.lang.String network) Adds new network to the set of defined networks.
java.lang.String	addNetworkFilter(java.lang.String srcNetwork, java.lang.String dstNetwork, int priority, java.lang.String netAddress, java.lang.String netMask) Adds new network filter to the set of filters for the source network.
void	apply() Applies current configuration.
void	changeBackendServerNetwork(java.lang.String hostId, java.lang.String network) Changes the network of the host.
void	changeNetworkFilterPriority(java.lang.String filterId, int priority) Changes the priority of a network filter identified by the provided identificator.
java.lang.String	createDBServiceFactoryConfiguration(java.lang.String roleId, java.lang.String factoryPid, java.util.Dictionary configuration) Creates factory database configuration for specified target role.
DatabaseCatalogRecord[]	getDBServerCatalog(java.lang.String dbServerName) Returns an array of DatabaseCatalogRecord objects containing info for the names, versions and owners of all databases stored in the specified database server.
java.lang.String	getInitFileVersion() Return the last applied configuration file version.
void	importLastSystemConfiguration() Overwrites current configuration with the last system configuration.
void	init(java.util.Dictionary systemDbServer) Initializes the current instance with system database server data.
boolean	isActive() Returns whether this instance is currently active.
void	release() Causes all resources allocated for this configurator to be released & configurator to be invalidated.
void	removeBackendServerHost(java.lang.String hostId) Removes backend server host.
void	removeDBServer(java.lang.String dbServerName) Removes the db server from the set of available db servers.
void	removeDBServiceConfiguration(java.lang.String roleId, java.lang.String pid) Removes factory database configuration from specified target role.
void	removeManagementServer(java.lang.String msId) Removes a management server from the system configuration.
void	removeManagementServers() Removes all management servers.
void	removeNetwork(java.lang.String network) Removes the provided network from the set of defined networks.
void	removeNetworkFilter(java.lang.String filterId) Removes a network filter identified by the provided identificator.
void	selectWarningOption(java.lang.String warningId, java.lang.String option) Select option from specified configuration warning.
BackendServerHost	setBackendServerHostRoles(java.lang.String hostId, java.lang.String[] hostRoles) This method sets backend server host roles.
void	setBackendServerNetworkURLs(java.lang.String hostId, java.lang.String network, java.lang.String[] urls) Binds the provided urls to the specified host within the target network.
void	setDBServiceConfiguration(java.lang.String roleId, java.util.Dictionary configuration) This method set specific Database configuration in the system configuration which will be used in configuration of the ConfigurableDBService defined by property "database.name" located in this Dictionary and running on management server specified by id.
void	setInitFileVersion(java.lang.String version) Set configuration file version.
void	setSystemProperties(java.util.Dictionary properties) Sets system properties.
void	testDBServerConnection(java.util.Dictionary configuration) This method is used to test the database server connectivity.
void	testDBServerConnection(java.lang.String dbServerName) This method is used to test the database server connectivity.
BackendServerHost	updateBackendServerHostURLs(java.lang.String hostId, java.lang.String[] urls) This method sets backend server host urls.
void	updateManagementServerContext(java.lang.String msId, java.lang.String context) Updates management server context.

Methods inherited from interface com.prosyst.mprm.admin.system.SystemObserver

getBackendServerHost, getBackendServerHostIds, getBackendServerHosts, getBackendServerHosts, getContextManagementServerIds, getContextManagementServers, getManagementServer, getManagementServerIds, getManagementServers, getNetwork, getNetworkBackendServerHosts, getNetworks, getStrictContextManagementServerId, getSystemState, unObservedContexts

Methods inherited from interface com.prosyst.mprm.admin.system.DatabaseServerConfiguration

getDBServerConfiguration, getDBServerNames, getDBServerNames, getDriver, getDriverIds, getSystemDBServer, removeDriver, uploadDriver

Methods inherited from interface com.prosyst.mprm.admin.system.DatabaseConfiguration

getConfigurableDatabases, getDBConfigMetaData, getDBConfiguration, getDBFactoryConfigurations, getPidsOfDBFactoryConfiguration

Methods inherited from interface com.prosyst.mprm.admin.system.BackendBundleInventory

addBundle, addBundlePack, addPermission, createFactoryConfiguration, deleteConfiguration, getBundle, getBundle, getBundlePack, getBundlePacks, getBundles, getBundles, getBundleStream, getConfiguration, getMetaTypeProvider, getMetaTypeProviders, getPermissions, getPidsOfFactoryConfiguration, removeBundle, removeBundlePack, removePermission, setConfiguration, setPermissions, updateBundle, updateBundlePack, updateBundleTargets

Methods inherited from interface com.prosyst.mprm.admin.system.TreeBrowser

createNode, getGroup, getParent, getSubGroups, removeNode

Method Detail

init

void init(java.util.Dictionary systemDbServer)
   throws CommunicationException,
          java.lang.Exception

Initializes the current instance with system database server data. This method must be called only if the instance is created via ConfiguratorManager.createConfigurator(). Calling any other method first will result in error. If once succeeded any later calls on this method will result in error.

Parameters:

systemDbServer - - specifies connect properties for the system database server. System database server will be used for loading system info & stored further. If null the latter system database server will be considered.

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

See Also:

ConfiguratorManager.createConfigurator()

isActive

boolean isActive()
          throws CommunicationException,
                 java.lang.Exception

Returns whether this instance is currently active. Instance is not active till first successive call on init method and If release is called the instance will be non active(usable). Any method call instead isActive & init on non active instance result in java.lang.IllegalStateException.

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

addDBServer

void addDBServer(java.util.Dictionary dbServerData)
          throws CommunicationException,
                 java.lang.Exception

Adds database server to the set of configurations. This method should replace previously defined database server configuration with the same name if & only if it is not the system database server. Already established associations between database servers & database services should be preserved. Properties for connecting SQL RDBMS may contain keys 'driverLib' & 'driverLibName' with values the names of the driver class file & locally stored zip or jar file with JDBC driver classes. The driver library file is used by connector service to load the driver. If this property is not present then the driver library must be already available.

Parameters:

dbServerData - the new database server data

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

removeDBServer

void removeDBServer(java.lang.String dbServerName)
             throws CommunicationException,
                    java.lang.Exception

Removes the db server from the set of available db servers. This method removes repository associations with this db server. It will simply return if configuration identificator matches the system db server 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

testDBServerConnection

void testDBServerConnection(java.lang.String dbServerName)
                     throws CommunicationException,
                            java.lang.Exception

This method is used to test the database server connectivity. If the connection with the database server is successful the method returns. Otherwise it throws exception.

Parameters:

dbServerName - database server 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

testDBServerConnection

void testDBServerConnection(java.util.Dictionary configuration)
                     throws CommunicationException,
                            java.lang.Exception

This method is used to test the database server connectivity. If the connection with the database server is successful the method returns. Otherwise it throws exception.

Parameters:

configuration - database server connection settings.

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

getDBServerCatalog

DatabaseCatalogRecord[] getDBServerCatalog(java.lang.String dbServerName)
                                    throws CommunicationException,
                                           java.lang.Exception

Returns an array of DatabaseCatalogRecord objects containing info for the names, versions and owners of all databases stored in the specified database server. If the connection with the database server fails the methods throws exception.

Parameters:

dbServerName - database server 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

setDBServiceConfiguration

void setDBServiceConfiguration(java.lang.String roleId,
                               java.util.Dictionary configuration)
                        throws CommunicationException,
                               java.lang.Exception

This method set specific Database configuration in the system configuration which will be used in configuration of the ConfigurableDBService defined by property "database.name" located in this Dictionary and running on management server specified by id. If role id is null configuration should be used for configuring of the used service databases at all management servers and for the control center.

Parameters:

roleId - target role identificator

configuration - properties of this 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

createDBServiceFactoryConfiguration

java.lang.String createDBServiceFactoryConfiguration(java.lang.String roleId,
                                                     java.lang.String factoryPid,
                                                     java.util.Dictionary configuration)
                                              throws CommunicationException,
                                                     java.lang.Exception

Creates factory database configuration for specified target role. Returns pid of the created configuration.

Parameters:

roleId - target role identificator

factoryPid - pid of the configuration

configuration - of this 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

removeDBServiceConfiguration

void removeDBServiceConfiguration(java.lang.String roleId,
                                  java.lang.String pid)
                           throws CommunicationException,
                                  java.lang.Exception

Removes factory database configuration from specified target role.

Parameters:

roleId - target role identificator

pid - of the configuration to be removed

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

addManagementServer

ManagementServer addManagementServer(java.util.Dictionary properties)
                              throws CommunicationException,
                                     java.lang.Exception

Adds new management server.

Parameters:

properties - of the management server to be added

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

removeManagementServer

void removeManagementServer(java.lang.String msId)
                     throws CommunicationException,
                            java.lang.Exception

Removes a management server from the system configuration.

Parameters:

msId - management server 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

removeManagementServers

void removeManagementServers()
                      throws CommunicationException,
                             java.lang.Exception

Removes all management servers.

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

updateManagementServerContext

void updateManagementServerContext(java.lang.String msId,
                                   java.lang.String context)
                            throws CommunicationException,
                                   java.lang.Exception

Updates management server context.

Parameters:

msId - the identificator of the Management Server.

context - the context into the managed object tree.

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

addBackendServerHost

BackendServerHost addBackendServerHost(java.util.Dictionary hostProperties)
                                throws CommunicationException,
                                       java.lang.Exception

Adds backend server host.

Parameters:

hostProperties - of the backend server host to be added

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

removeBackendServerHost

void removeBackendServerHost(java.lang.String hostId)
                      throws CommunicationException,
                             java.lang.Exception

Removes backend server host.

Parameters:

hostId - the backend server host 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

setBackendServerHostRoles

BackendServerHost setBackendServerHostRoles(java.lang.String hostId,
                                            java.lang.String[] hostRoles)
                                     throws CommunicationException,
                                            java.lang.Exception

This method sets backend server host roles. Host role can be the constant for remote access server, for the control center or id of the management server which will use this host.

Parameters:

hostId - the backend server host identificator

hostRoles - host roles to be set

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

updateBackendServerHostURLs

BackendServerHost updateBackendServerHostURLs(java.lang.String hostId,
                                              java.lang.String[] urls)
                                       throws CommunicationException,
                                              java.lang.Exception

This method sets backend server host urls.

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

importLastSystemConfiguration

void importLastSystemConfiguration()
                            throws CommunicationException,
                                   java.lang.Exception

Overwrites current configuration with the last system configuration. All changes made in the current configuration will be lost.

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

selectWarningOption

void selectWarningOption(java.lang.String warningId,
                         java.lang.String option)
                  throws CommunicationException,
                         java.lang.Exception

Select option from specified configuration warning.

Parameters:

warningId - unique name of the configuration warning

option - selected option

Throws:

Exception - is thrown if some error occurs.

CommunicationException

java.lang.Exception

apply

void apply()
    throws CommunicationException,
           java.lang.Exception

Applies current 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

release

void release()
      throws CommunicationException,
             java.lang.Exception

Causes all resources allocated for this configurator to be released & configurator to be invalidated.

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

addNetwork

Network addNetwork(java.lang.String network)
            throws CommunicationException,
                   java.lang.Exception

Adds new network to the set of defined networks.

Parameters:

network - the name of the new network

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

removeNetwork

void removeNetwork(java.lang.String network)
            throws CommunicationException,
                   java.lang.Exception

Removes the provided network from the set of defined networks. One should expect defined network filters, backend host URLs for this network also to be removed. This operation must not succeed if the network is the default one Network.DEFAULT_NETWORK or if there is a backend host participant within it.

Parameters:

network - network to be removed

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

addNetworkFilter

java.lang.String addNetworkFilter(java.lang.String srcNetwork,
                                  java.lang.String dstNetwork,
                                  int priority,
                                  java.lang.String netAddress,
                                  java.lang.String netMask)
                           throws CommunicationException,
                                  java.lang.Exception

Adds new network filter to the set of filters for the source network.

Parameters:

srcNetwork - source network.

dstNetwork - destination network.

priority - filter priority.

netAddress - network filter id.

netMask - network mask.

Returns:

network filter identificator.

Throws:

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

Exception - is thrown if there is a filter with the same source address and priority or some other error occurs.

CommunicationException

java.lang.Exception

See Also:

NetworkFilter

changeNetworkFilterPriority

void changeNetworkFilterPriority(java.lang.String filterId,
                                 int priority)
                          throws CommunicationException,
                                 java.lang.Exception

Changes the priority of a network filter identified by the provided identificator.

Parameters:

filterId - network filter id.

priority - new priority to be assigned.

Throws:

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

Exception - is thrown if there is a filter with the same source address and priority or some other error occurs.

CommunicationException

java.lang.Exception

removeNetworkFilter

void removeNetworkFilter(java.lang.String filterId)
                  throws CommunicationException,
                         java.lang.Exception

Removes a network filter identified by the provided identificator.

Parameters:

filterId - network filter id.

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

setBackendServerNetworkURLs

void setBackendServerNetworkURLs(java.lang.String hostId,
                                 java.lang.String network,
                                 java.lang.String[] urls)
                          throws CommunicationException,
                                 java.lang.Exception

Binds the provided urls to the specified host within the target network.

Parameters:

hostId - backend host id.

network - target network.

urls - set of URLs. null is permitted.

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

changeBackendServerNetwork

void changeBackendServerNetwork(java.lang.String hostId,
                                java.lang.String network)
                         throws CommunicationException,
                                java.lang.Exception

Changes the network of the host.

Parameters:

hostId - backend host id.

network - target network

Throws:

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

Exception - is thrown if some of the objects does not exist, the host has no address defined within the target network or some other error occurs.

CommunicationException

java.lang.Exception

setSystemProperties

void setSystemProperties(java.util.Dictionary properties)
                  throws CommunicationException,
                         java.lang.Exception

Sets system properties.

Parameters:

properties - the system properties.

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

getInitFileVersion

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

Return the last applied configuration file version.

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

setInitFileVersion

void setInitFileVersion(java.lang.String version)
                 throws CommunicationException,
                        java.lang.Exception

Set configuration file version.

Parameters:

version - the new configuration file version

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