com.prosyst.mprm.admin.system

Interface SystemObserver

All Superinterfaces:

BackendBundleInventory, DatabaseConfiguration, DatabaseServerConfiguration

All Known Subinterfaces:

Configurator, ConfiguratorManager

public interface SystemObserver
extends DatabaseServerConfiguration, DatabaseConfiguration, BackendBundleInventory

This interface enables monitoring runtime state and base configuration of the mPRM backend system.

Version:

1.1.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	getBackendServerHost(java.lang.String hostId) Returns particular backend server host within the mPRM system.
java.lang.String[]	getBackendServerHostIds() Returns identificators of backend server hosts within the mPRM system.
BackendServerHost[]	getBackendServerHosts() Returns backend server hosts within the mPRM system.
BackendServerHost[]	getBackendServerHosts(java.lang.String roleId) Returns backend server hosts within the mPRM system performing the specified role.
java.lang.String[]	getContextManagementServerIds(java.lang.String context) Returns identificators of management servers managing the supplied context.
ManagementServer[]	getContextManagementServers(java.lang.String context) Returns management servers managing the supplied context.
ManagementServer	getManagementServer(java.lang.String msId) Returns particular management server within the mPRM system.
java.lang.String[]	getManagementServerIds() Returns identificators of management servers within the mPRM system.
ManagementServer[]	getManagementServers() Returns management servers within the mPRM system.
Network	getNetwork(java.lang.String name) Returns network specified by the name parameter.
BackendServerHost[]	getNetworkBackendServerHosts(java.lang.String network) Returns backend server hosts defined to be located into the specified network.
Network[]	getNetworks() Returns all available networks.
java.lang.String	getStrictContextManagementServerId(java.lang.String context) Returns the identificator of the management server which manages this context.
SystemState	getSystemState() Returns detailed system state information.
java.lang.String[]	unObservedContexts() Returns paths within the gateways tree where no management server is defined to operate.

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

getSystemState

SystemState getSystemState()
                    throws CommunicationException,
                           java.lang.Exception

Returns detailed system state information. return SystemState object representing the current state of The mPRM system.

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

getNetwork

Network getNetwork(java.lang.String name)
            throws CommunicationException,
                   java.lang.Exception

Returns network specified by the name parameter.

Returns:

Network object.

Throws:

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

Exception - is thrown if network with this name not defined or some other error occurs.

CommunicationException

java.lang.Exception

getNetworks

Network[] getNetworks()
               throws CommunicationException,
                      java.lang.Exception

Returns all available networks.

Returns:

The array of Network objects.

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

getManagementServerIds

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

Returns identificators of management servers within the mPRM system.

Returns:

The array of management server identificators.

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

getStrictContextManagementServerId

java.lang.String getStrictContextManagementServerId(java.lang.String context)
                                             throws CommunicationException,
                                                    java.lang.Exception

Returns the identificator of the management server which manages this context.

Returns:

The identificator of management 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

getContextManagementServerIds

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

Returns identificators of management servers managing the supplied context.

Returns:

The array of management server identificators.

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

getContextManagementServers

ManagementServer[] getContextManagementServers(java.lang.String context)
                                        throws CommunicationException,
                                               java.lang.Exception

Returns management servers managing the supplied context.

Returns:

The array of management server identificators.

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

getManagementServer

ManagementServer getManagementServer(java.lang.String msId)
                              throws CommunicationException,
                                     java.lang.Exception

Returns particular management server within the mPRM system.

Parameters:

msId - The id of the wanted management server

Returns:

management server specified by msId.

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

getManagementServers

ManagementServer[] getManagementServers()
                                 throws CommunicationException,
                                        java.lang.Exception

Returns management servers within the mPRM system.

Returns:

The array of 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

getBackendServerHostIds

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

Returns identificators of backend server hosts within the mPRM system.

Returns:

The array of backend server host identificators.

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

getBackendServerHosts

BackendServerHost[] getBackendServerHosts()
                                   throws CommunicationException,
                                          java.lang.Exception

Returns backend server hosts within the mPRM system.

Returns:

The array of backend server hosts.

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

getBackendServerHosts

BackendServerHost[] getBackendServerHosts(java.lang.String roleId)
                                   throws CommunicationException,
                                          java.lang.Exception

Returns backend server hosts within the mPRM system performing the specified role. Host role id can be one of Roles.CC for control center, Roles.RAS for all remote access servers, Roles.MS for all management servers or the id of single management server.

Parameters:

roleId - identificator of role

Returns:

The array of backend server hosts.

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

getNetworkBackendServerHosts

BackendServerHost[] getNetworkBackendServerHosts(java.lang.String network)
                                          throws CommunicationException,
                                                 java.lang.Exception

Returns backend server hosts defined to be located into the specified network.

Returns:

The array of backend server hosts.

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

getBackendServerHost

BackendServerHost getBackendServerHost(java.lang.String hostId)
                                throws CommunicationException,
                                       java.lang.Exception

Returns particular backend server host within the mPRM system.

Parameters:

hostId - The id of the wanted backend server host

Returns:

Specified backend server hosts.

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

unObservedContexts

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

Returns paths within the gateways tree where no management server is defined to operate. A node is considered observed if any of the cases takes place: - a management server is defined to operate on it or any of his parents. - there are no gateways immediately under it & all of its immediate subgroups are observed.

Returns:

The array of unobserved gateway group paths.

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