Listing component instances

Call the ComponentInstanceManager.listComponentInstances() method to list all component instances in the CAS Service. In this release, components are Record Store instances that are running in the CAS Service.

The syntax of the method is: 

ComponentInstanceManager.listComponentInstances()

The method returns a list of ComponentInstanceDescriptor objects. Each ComponentInstanceDescriptor object represents a single component (that is, a Record Store instance) and is made up of the following:

To list component instances:

  1. Create a ComponentInstanceManagerLocator by calling create() and specify the host and port of the server running the Component Instance Manager. For example: 

    ComponentInstanceManagerLocator locator = 
   ComponentInstanceManagerLocator.create("localhost", 8500);

  2. Create a ComponentInstanceManager object and call getService() to establish a connection to the server and the Component Instance Manager service itself. For example: 

    ComponentInstanceManager cim = locator.getService();

  3. Call listComponentInstances() and then create a for loop to loop over all component instances. Inside the loop, get the TypeId, InstanceId, and InstanceStatus and print them to system out (or elsewhere). For example: 

    for (ComponentInstanceDescriptor desc : cim.listComponentInstances()) {
	System.out.println(desc.getInstanceId() + " of type " + desc.getTypeId() + " has status " + desc.getInstanceStatus());
}

Copyright © Legal Notices