MBeans for process retrievers

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Each JMX MBean for process retrievers has a specific Object Name, some attributes that you can access, and operations that you can invoke.

MBean objectName

Every JMX MBean associated with a BPD retriever has an Object Name with a name. The syntax for the Object Name is com.ibm.bpm.federation.server:type=Retrievers,subtype=BpdRetrievers,name=retrieverUniqueID.

retrieverUniqueID is a string based on the ID of the process retrievers and of the federated system they refer to in the Process Federation Server server.xml file, and has the following format: federatedSystemID.retrieverID.

federatedSystemID is the value of the id attribute of the ibmPfs_federatedSystem element, and retrieverID is the value of the id attribute of the ibmPfs_bpdRetriever element.

If no id attribute is specified for the process retriever, then Liberty assigns a default value with the format default-n, where n is a positive integer that starts at 0. In that case, the retrieverUniqueID string corresponds to the federatedSystemID.default-n.

Example 1: One retriever with no retriever ID indexing a federated system with bpm1 as id is defined in the server.xml file:
<ibmPfs_federatedSystem  id="bpm1" .../>
<ibmPfs_bpdRetriever federatedSystemRef="bpm1" .../>
At runtime, one MBean is created with bpm1.default-0 as the retrieverUniqueID. The resulting object name for this MBean is: com.ibm.bpm.federation.server:type=Retrievers,subtype=BpdRetrievers,name=bpm1.default-0.
Example 2: Two retrievers with idx1 and idx2 as retriever IDs indexing one federated system with bpm1 as id are defined in the server.xml file:
<ibmPfs_federatedSystem  id="bpm1" .../>
<ibmPfs_bpdRetriever id=idx1 federatedSystemRef="bpm1" .../>
<ibmPfs_bpdRetriever id=idx2 federatedSystemRef="bpm1" .../>
At runtime, two MBeans are created. The first one with bpm1.idx1 as the retrieverUniqueID, and the second one with bpm1.idx2 as the retrieverUniqueID. The resulting object names for these MBeans are: com.ibm.bpm.federation.server:type=Retrievers,subtype=BpdRetrievers,name=bpm1.idx1, and com.ibm.bpm.federation.server:type=Retrievers,subtype=BpdRetrievers,name=bpm1.idx2.
Note: If more than one process retriever refers to the same federated system, and if you explicitly specify an id attribute for each of these retrievers, you must ensure that each value is unique, otherwise the MBeans cannot be successfully registered.

MBean attributes

Attribute name Description Nature Type Return value
connectionTimeout The maximum amount of time in milliseconds during which the retrieval service waits to connect to the federated system. Read only Java.lang.String An integer value
readTimeout The maximum amount of time in milliseconds during which the retrieval service waits to read data from the federated system. Read only Java.lang.String An integer value
internalRestUrlPrefix The REST service URL that is used to communicate with the federated system. Read only Java.lang.String An URL
federatedSystemInfo Information about the federated system. Read only Java.lang.String {numberOfShards=number, indexExists=boolean, numberOfReplicas=number, allowedOrigins=[origins], launchListPriority=number, id=systemName}
federatedSystemStatusInfo Last known federated system status information. Read only Java.util.List
  • A list of items in the following format: {statusCode=status,statusTime=yyyy-MM-dd HH:MM:ss.SSS,user="username",version=federatedSystemVersion}
  • [] if the retriever has not yet been called.
lastSavedSearch Last known saved search execution information. Read only Java.lang.String
  • undefined if no saved search was executed.
  • action=string,beginTime=yyyy-MM-dd HH:MM:ss.SSS,endTime= yyyy-MM-dd HH:MM:ss.SSS,id=number,name=string