com.prosyst.mprm.admin.system

Interface ConfiguratorManager

All Superinterfaces:

BackendBundleInventory, DatabaseConfiguration, DatabaseServerConfiguration, SystemObserver

public interface ConfiguratorManager
extends SystemObserver

The purpose of the interface is to expose convenient methods for mPRM system configuration observation and accessing Configurator interface for preconfiguration. This interface is exposed as service in terms of OSGi on the Control Center framework.

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
void	addConfigurationListener(ConfigurationListener listener) Adds configuration listener.
void	addHostListener(HostListener listener) Adds HostListener object to the queue of listeners.
Configurator	createConfigurator() Returns Configurator interface which can be used to change the current system configurations & backend modules.
BackendBundleAdmin	getBackendBundleAdmin(java.lang.String hostId) Returns BackendBundleAdmin interface responsible for the runtime administration of the bundles on the backend server host.
Configurator	getConfigurator() Deprecated.
Configurator	getConfigurator(java.util.Dictionary configuration) Deprecated.
void	removeConfigurationListener(ConfigurationListener listener) Removes configuration listener.
void	removeHostListener(HostListener listener) Removes HostListener object from the queue of listeners.
void	shutdown() Causes the mPRM system to stop operation by shutting down all backend hosts.
void	shutdown(java.lang.String hostId) Causes to shutting a single specified backend host.

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

Method Detail

getConfigurator

Configurator getConfigurator()
                      throws CommunicationException,
                             java.lang.Exception

Deprecated.

Returns Configurator interface which can be used to edit current system configurations & backend modules. Returned configurator uses the current properties for connecting to system database server. If the system database configuration is not have been already set this method throws an exception.

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

getConfigurator

Configurator getConfigurator(java.util.Dictionary configuration)
                      throws CommunicationException,
                             java.lang.Exception

Deprecated.

Returns Configurator interface which can be used to change the current system configurations & backend modules.

Parameters:

configuration - become system database 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

createConfigurator

Configurator createConfigurator()
                         throws CommunicationException,
                                java.lang.Exception

Returns Configurator interface which can be used to change the current system configurations & backend modules. The retrieved instance must be further initialized through Configurator.init(java.util.Dictionary)

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:

Configurator.init(java.util.Dictionary)

getBackendBundleAdmin

BackendBundleAdmin getBackendBundleAdmin(java.lang.String hostId)
                                  throws CommunicationException,
                                         java.lang.Exception

Returns BackendBundleAdmin interface responsible for the runtime administration of the bundles on the backend server host.

Parameters:

hostId - identificator of host

Returns:

BackendBundleAdmin object for administrating specified backend server host.

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

shutdown

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

Causes the mPRM system to stop operation by shutting down all backend hosts.

Throws:

CommunicationException - is thrown if communication with the remote Control Center fails.

java.lang.Exception - is thrown if some other error occurs.

CommunicationException

shutdown

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

Causes to shutting a single specified backend host.

Parameters:

hostId - identifier of the backend host to be shutdown

Throws:

CommunicationException - is thrown if communication with the remote Control Center fails.

java.lang.Exception - is thrown if some other error occurs.

CommunicationException

addConfigurationListener

void addConfigurationListener(ConfigurationListener listener)

Adds configuration listener. When configuration changes this listener will be notified

Parameters:

listener - listener to be added

See Also:

ConfigurationListener

removeConfigurationListener

void removeConfigurationListener(ConfigurationListener listener)

Removes configuration listener.

Parameters:

listener - listener to be removed

See Also:

ConfigurationListener

addHostListener

void addHostListener(HostListener listener)

Adds HostListener object to the queue of listeners.

Parameters:

listener - listener to be added

removeHostListener

void removeHostListener(HostListener listener)

Removes HostListener object from the queue of listeners. Note: If this service is unregistered all listeners will be removed!

Parameters:

listener - listener to be removed