KB44692: "MonitorManipulationException: Monitor manipulation failed." Error Message Appears when Attempting to Delete User Connections using the MicroStrategy SDK

SYMPTOM:
Using KB38266, standalone code or an external security module (ESM) is implemented to delete user connections based on a condition. The following stack trace inconsistently shows up when attempting to delete the user connections:

com.Strategy.web.objects.admin.monitors.MonitorManipulationException: Monitor manipulation failed.

        at com.Strategy.web.objects.admin.monitors.MonitorManipulatorImpl.checkManipulationResults(Unknown Source)

        at com.Strategy.web.objects.admin.monitors.UserConnectionManipulatorImpl.disconnectUserConn(Unknown Source)

        at com.Strategy.web.objects.admin.monitors.UserConnectionManipulatorImpl.disconnect(Unknown Source)

        at customclasses.DisconnectUserConnections.disconnect(Unknown Source)

        at customclasses.DisconnectUserConnections.main(Unknown Source)

 
CAUSE:
When the UserConnectionSource.getUserConnections() method is used, the Intelligence Server will return the connection information in the form of <session, project>, which means that the result may include multiple items for the same session if users connect to different projects in the session (in fact, multiple items will be returned for one session even if we connect to only one project because the Intelligence Server will return an item for the session itself without a project).
 
By the above reason, when the session info is added into the disconnection list using the UserConnectionManipulator.addDisconnectionTask method, some sessions may be added into the list multiple times, which may result in the unintentional attempt to disconnect a session which was already disconnected when the disconnection manipulation is performed. (When the MonitorManipulationException is received, the IServer returns the following error: "This user session doesn’t exist in server anymore. It might have been closed by the user or by Administrator, or it has exceeded max idle time.")
 
ACTION:
The solution to this problem is to check whether the session is already in the disconnection list or not before the session is added into to the disconnect list. The following code snippet demonstrates how to do this:
 

private static final void killUserConnections() {
   ......

   ArrayList<String> addedSessionList = new ArrayList<String>();

   for (int i = 0; i < results.getCount(); i++) {

      ......

      boolean isDupSession = addedSessionList.contains(sessionID);

      if (!isCurrentSession && !isDupSession) {

         addedSessionList.add(sessionID);

         userManipulator.addDisconnectionTask(sessionID);

      }

   }

   userManipulator.submit();

   .....

}

 
The example provided in this document is provided “as-is” to the user and assumes that the user:

• Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
• Can configure environment variables (e.g. JAR files, property files, etc.)
• Have all the necessary tools to create Java applications (JDK, IDE, etc.)
• Has access to the Strategy SDK documentation.
• Has read the customization warning at the bottom of this document

 
The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.Strategy.com).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@Strategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.Strategy.com/us/services/support/contact.
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.