KB38266: How to Delete a User Connection Based on Connectivity Time Using the Microstrategy Web SDK 9.4.1

Using the following code sample, it is possible to delete a user connection based on how long the connection has existed:
 
 

Package customclasses.misc;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.admin.WebObjectsAdminException;
import com.Strategy.web.objects.admin.monitors.EnumWebMonitorType;
import com.Strategy.web.objects.admin.monitors.MonitorManipulationException;
import com.Strategy.web.objects.admin.monitors.MonitorSort;
import com.Strategy.web.objects.admin.monitors.UserConnection;
import com.Strategy.web.objects.admin.monitors.UserConnectionManipulator;
import com.Strategy.web.objects.admin.monitors.UserConnectionResults;
import com.Strategy.web.objects.admin.monitors.UserConnectionSource;
import com.Strategy.webapi.EnumDSSXMLAuthModes;
import com.Strategy.webapi.EnumDSSXMLLevelFlags;
import com.Strategy.webapi.EnumDSSXMLOrder;
import com.Strategy.webapi.EnumDSSXMLUserConnectionInfo;
public class DeleteUserConnections {
 
 public static void main(String[] args) {  
  WebObjectsFactory objectFactory = WebObjectsFactory.getInstance();   
        WebIServerSession serverSession = objectFactory.getIServerSession();   
        serverSession.setServerPort(0);   
        serverSession.setAuthMode(EnumDSSXMLAuthModes.DssXmlAuthStandard);   
        serverSession.setProjectName("PROJECTNAME");   
        serverSession.setLogin("USER_ID");   
        serverSession.setPassword("");   
        serverSession.setServerName("SERVER_NAME");      
          
        try {   
            
         //Create a session on the I-server    
   String SessionID = serverSession.getSessionID();   
   System.out.println("Welcome " + serverSession.getLogin());   
   System.out.println("SessionID: " + SessionID);   
      
   // create a WebObjectsFactory instance   
    WebObjectsFactory factory = serverSession.getFactory();   
      
    // Get the User Connection source object   
    UserConnectionSource  source = (UserConnectionSource) factory.getMonitorSource(EnumWebMonitorType.WebMonitorTypeUserConnection);   
      
    // Obtain the User manipulator object   
    UserConnectionManipulator userManipulator = source.getManipulator();   
     
    
    
    // Set up the sort condition to sort on the open jobs field in descending order
    MonitorSort msort = source.getSortCriteria();
    msort.add(EnumDSSXMLUserConnectionInfo.DssXmlUserConnDuration, EnumDSSXMLOrder.DssXmlDescending);
    
    
 // Set up the flag to obtain browsing information
    source.setLevel(EnumDSSXMLLevelFlags.DssXmlBrowsingLevel);  
    
      
    try {   
     
     // Sends the request to Intelligence Server to retrieve user connection information
        UserConnectionResults results = source.getUserConnections();
        
     // Loop through the results to print out user connection information, such as
        // the user name, project name, session ID
        
        UserConnection singleConn = null;
        for (int i=0; i < results.getCount(); i++) {
             singleConn = results.get(i);
             System.out.print("User: " + singleConn.getUserName());
             System.out.print(", project: " + singleConn.getProjectName());
             System.out.print(", sessionID: " + singleConn.getSessionID());
             System.out.print(", Session duration: " + singleConn.getDuration());             
             
             if(singleConn.getDuration()> 300 ){ //12 hours:  43200 
              System.out.println(singleConn.getSessionID()+"session added to disconnect task list");
              //add session to the task list to be disconnected later in batch
              userManipulator.addDisconnectionTask(singleConn.getSessionID());
             }
        }
         // Sends the request to Intelligence Server to disconnect the user sessions specified above    
     
     userManipulator.submit();             
           
    } catch (WebObjectsAdminException woae) {   
             woae.printStackTrace();   
    } catch (MonitorManipulationException mme) {                
                
    }          
            
        }catch (WebObjectsException ex) {   
   System.out.println(ex.getMessage());   
   ex.printStackTrace();   
  }  
 

 }
}

 
 
ADDITIONAL INFORMATION:
 
The Strategy SDK allows you to customize the standard Strategy Web interface, and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy Web products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy Web architecture or the process of customizing Strategy Web, please refer to Strategy Developer Zone (https://resource.microstrategy.com/msdz/).
 
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@microstrategy.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 http://www.microstrategy.com/Support/ContactUs.asp.
 
 
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.