com.prosyst.mprm.admin.system (Bosch IoT Remote Manager 7.1 System Package API)

Interface Summary
Interface	Description
BackendBundle	Represents a bundle stored in the system database.
BackendBundleAdmin	This interface is responsible for the runtime administration of the bundles on the backend server hosts.
BackendBundleInventory	Enables system operator to observe and change the mPRM base backend bundles configuration - bundle packages, bundles, bundle configurations & permissions.
BackendBundlePack	Represents a bundle package(pack) stored in the system database.
BackendServerHost	Represents a mPRM backend server host.
ConfigurationListener	Objects implementing this interface will be notified when the system configuration has been changed.
Configurator	Enables system operator to change and adjust the mPRM base system configuration database services, management servers, etc.
ConfiguratorManager	The purpose of the interface is to expose convenient methods for mPRM system configuration observation and accessing `Configurator` interface for preconfiguration.
DatabaseCatalogRecord	Represents a single record in a database server's catalog.
DatabaseConfiguration	Provides methods for obtaining configuration properties of mPRM database services.
DatabaseServerConfiguration	Provides methods for obtaining configuration properties used by mPRM system for connecting to one or more database servers which maintain mPRM databases.
DBMetaTypeProviderExtension	Extends MetaTypeProviderExtension with database configuration specific methods.
DeployedBackendBundle	This interface represents a bundle installed on a mPRM backend.
GatewayGroup	Represents gateway group within the gateway's tree.
HostListener	Components interested in hosts state change event should implements this interface and registered themselves as listeners through `ConfiguratorManager.addHostListener(HostListener)`.
ManagementServer	Represents the properties of a Management Server within the mPRM system.
MetaTypeProviderExtension	This interface extends the MetaTypeProvider interface with some facility methods.
Network	Represents logical set of IP addresses.
NetworkFilter
SystemObserver	This interface enables monitoring runtime state and base configuration of the mPRM backend system.
SystemState	Represents current state of a backend host.
TreeBrowser	Manipulates The Gateway Tree.

Class Summary
Class	Description
HostEvent	Instances of this class encapsulate information about a host state change event.
NetworkHelper
RoleConfig
Roles	Backend role constants.

Exception Summary
Exception	Description
CommunicationException	Represents exception occurred when admin APIs communicate with remote Control Center APIs.
ConfigurationWarning	Thrown during The mPRM configuration process in order to mark state not considered normal.

Package com.prosyst.mprm.admin.system Description

The purpose of this package is to expose convenient API for observing mPRM system configuration through ConfiguratorManager interface. This interface is available as service in terms of OSGI on every Backend Server framework. Through Configurator interface initial system configuration can be set or existing configuration can be changed. This functionality is available only via not configured Backend Server Hosts or already running ControlCenter.

An external stand-alone application can use this package by including system-rac.jar in its classpath. Management Console must have installed systemmc.jar in order to use it, while other Backend Hosts use acm.jar. They both are included into the mPRM System package.

Here is an example of using the ConfiguratorManager:

import com.prosyst.mprm.rac.RemoteAccessClient;
import com.prosyst.mprm.admin.system.*;
import java.util.Hashtable;

.....

  public static void main(String[] args) throws Exception {

    //Open session using the system account.
    Hashtable credentials = new Hashtable();
    credentials.put(RemoteAccessClient.USER_PASSWORD, "system");
    RemoteAccessClient rac = RemoteAccessClient.connect("socket://mprm.acme.com:11449", "system", credentials, null);

    //Access the mPRM ConfiguratorManager service
    String serviceName = "com.prosyst.mprm.admin.system.ConfiguratorManager";
    Object service = rac.getService(serviceName);

    //Print current system state
    if (service != null) {
     System.out.println(((ConfiguratorManager) service).getSystemState());
    } else {
     System.out.println("Service " + serviceName + " is not avaliable.");
    }
    //closing session
    rac.close();
  }

.....