com.prosyst.mprm.admin.procedures (Bosch IoT Remote Manager 7.1 Generic Device Management Package API)

Interface Summary
Interface	Description
Argument	Provides all the characteristics of a parameterized procedure argument.
Folder	Procedures can be arranged in folders.
Procedure	A procedure is characterized with some mandatory and some optional fields.
ProcedureEvent	Holds information about change of a procedure or folder, which has been occurred in the procedure inventory.
ProcedureInventory	The Procedure Inventory service.
ProcedureListener	Applications interested in receiving procedure events may implement this interface and register the listener via the `ProcedureInventory.addProcedureListener(ProcedureListener)` method.

Package com.prosyst.mprm.admin.procedures Description

Provides API for managing the Procedure Inventory. Procedures are management commands written in mPRM Script Language. The Procedure Inventory is a convenience module that provides functionality for persistently storing of the created procedures, for organizing them in a tree structure in folders, thus providing the ability for reusing them multiple times.

The API's basic interface is ProcedureInventory and it can be accessed in two ways:

As a service on the backend framework - It is accessible to the other bundles through methods defined by the OSGi Framework specification.

Example :

import com.prosyst.mprm.admin.procedures.ProcedureInventory;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceReference;

.....

  public ProcedureInventory getProcedureInventory(BundleContext context) {
    ProcedureInventory pi = null;
    ServiceReference piRef = context.getServiceReference("com.prosyst.mprm.admin.procedures.ProcedureInventory");
    if (piRef != null) {
      pi = (ProcedureInventory)context.getService(piRef);
    }
    return pi;
  }

.....

As a stand-alone application, not depending on OSGi Framework - it is accessible by using com.prosyst.mprm.rac.RemoteAccessClient. An external stand-alone application can use this package by including system-rac.jar and gm-rac.jar in its classpath.

Example :

import com.prosyst.mprm.procedures.ProcedureInventory;
import com.prosyst.mprm.rac.RemoteAccessClient;
import java.util.Hashtable;

.....

  public ProcedureInventory getProcedureInventory(RemoteAccessClient rac) {
    ProcedureInventory pi = null;
    if (rac != null) {
      pi = (ProcedureInventory)rac.getService("com.prosyst.mprm.admin.procedures.ProcedureInventory");
    }
    return pi;
  }

.....

  public static void main(String[] args) {

    //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);
    ...

    //Now the application can access mPRM ProcedureInventory service
    ProcedureInventory pInventory = getProcedureInventory(rac);

    ...
    //closing session
    rac.close();
  }

.....