Interface UserConnectionManipulator

  • All Superinterfaces:
    MonitorManipulator

    public interface UserConnectionManipulator
    extends MonitorManipulator
    The interface UserConnectionManipulator contains operations to disconnect user connections.
    Since:
    MicroStrategy Web 9.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void addDisconnectionTask​(java.lang.String sessionID)
      Adds a task to the user disconnection task list for batch operation.
      void addDisconnectionTask​(java.lang.String sessionID, int projectID)
      Adds a task to the user disconnection task list for batch operation.
      void addDisconnectionTaskPerNode​(java.util.Map<java.lang.String,​java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,​java.lang.Integer>>> connectionIds)
      Deprecated.
      void disconnect​(java.lang.String sessionID)
      Disconnects user connections with the specified session ID.
      void disconnect​(java.lang.String sessionID, int projectID)
      Disconnects a user connection with the specified project ID and session ID.
      void disconnectOnSpecificIServerNode​(java.lang.String sessionID, java.lang.String iServerNode, int projectID)
      THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
      void submitDisconnectionPerNode​(java.lang.String iServerNode)
      For cluster environment, we need to submit disconnection session request to specific I-server node.
    • Method Detail

      • disconnect

        void disconnect​(java.lang.String sessionID,
                        int projectID)
                 throws MonitorManipulationException,
                        WebObjectsAdminException
        Disconnects a user connection with the specified project ID and session ID. A user connection can be uniquely identified by by a session ID and a project ID.
        Parameters:
        sessionID - the session ID of a user connection.
        projectID - the project ID of a user connection.
        Throws:
        MonitorManipulationException - thrown if there is any failure in disconnecting user connections.
        WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.
      • disconnectOnSpecificIServerNode

        void disconnectOnSpecificIServerNode​(java.lang.String sessionID,
                                             java.lang.String iServerNode,
                                             int projectID)
                                      throws MonitorManipulationException,
                                             WebObjectsAdminException
        THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT. Disconnects a user connection on an specific iServer node with the specified project ID and session ID. A user connection can be uniquely identified by by a session ID and a project ID.
        Parameters:
        iServerNode - an specific iServer node
        sessionID - the session ID of a user connection
        projectID - the project ID of a user connection
        Throws:
        MonitorManipulationException - thrown if there is any failure in disconnecting user connections.
        WebObjectsAdminException - thrown if there is any fatal error preventing this operation, such as network error, server crash, etc.
      • addDisconnectionTask

        void addDisconnectionTask​(java.lang.String sessionID)
        Adds a task to the user disconnection task list for batch operation.
        Parameters:
        sessionID - the session ID of a user connection.
      • addDisconnectionTask

        void addDisconnectionTask​(java.lang.String sessionID,
                                  int projectID)
        Adds a task to the user disconnection task list for batch operation.
        Parameters:
        sessionID - the session ID of a user connection.
        projectID - the project ID of a user connection.
      • disconnect

        void disconnect​(java.lang.String sessionID)
                 throws MonitorManipulationException,
                        WebObjectsAdminException
        Disconnects user connections with the specified session ID. All projects associated with this session will be disconnected.
        Parameters:
        sessionID - the session ID of a user connection.
        Throws:
        MonitorManipulationException - thrown if there is any failure in disconnecting user connections.
        WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.
      • addDisconnectionTaskPerNode

        @Deprecated
        void addDisconnectionTaskPerNode​(java.util.Map<java.lang.String,​java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,​java.lang.Integer>>> connectionIds)
                                  throws MonitorManipulationException,
                                         WebObjectsAdminException
        Deprecated.
        Adds a task to the user disconnection task list for batch operation per iServer node for cluster environment. Disconnect a user session on an specific iServer node with the specified project ID and session ID. A user connection can be uniquely identified by by a session Id and a project Id.
        Parameters:
        connectionIds - Key is iServerNode name and value is list of pair of session id and project id
        Throws:
        MonitorManipulationException - thrown if there is any failure in disconnecting user connections.
        WebObjectsAdminException - thrown if there is any fatal error preventing this operation, such as network error, server crash, etc.
      • submitDisconnectionPerNode

        void submitDisconnectionPerNode​(java.lang.String iServerNode)
                                 throws MonitorManipulationException,
                                        WebObjectsAdminException
        For cluster environment, we need to submit disconnection session request to specific I-server node.
        Parameters:
        iServerNode - iServerNode name
        Throws:
        MonitorManipulationException - thrown if there is any failure in killing jobs or disconnecting connections.
        WebObjectsAdminException - thrown if there is any fatal error preventing this operation, such as network error, server crash, etc.