ActiveConnections.idl

Go to the documentation of this file.

/**
 * @file     ActiveConnections.idl
 * @brief    Active Connections API
 * @version  2
 */

#import <kerio/web/idl/SharedStructures.idl>

module webadmin {

enum ConnectionDirection {
  ConnectionDirectionInbound,
  ConnectionDirectionOutbound,
  ConnectionDirectionLocal
};

struct ConnectionPoint {
  string host;
  kerio::web::IpAddress ip;
  long port;
};

struct ActiveConnection {
  kerio::web::KId id;
  ConnectionPoint src;
  ConnectionPoint dst;
  string protocol;
  long timeout;
  long age;
  string rx;        /**< in KB, obsolete */
  string tx;        /**< in KB, obsolete */
  double rxNum;      /**< in KB */
  double txNum;      /**< in KB */
  string info;
  boolean active;
  ConnectionDirection direction;
  string trafficRule;
  string service;
  string internetLink;
  string bandwidthRuleName;
};

typedef sequence<ActiveConnection> ActiveConnectionList;

interface ActiveConnections {

   /**
    * Returns Active Connections data
    *
    * @param list - output data
    * @param totalItems - all data count
    * @param query - filter/sort query \n
    *     Hide local connections is solved as: \n
    *         operandValue = 'direction' \n
    *         isColumnName = true \n
    *       comparator = NotEq \n
    *         operandValue = ConnectionDirectionLocal \n
    *         isColumnName = false   
    *           
    * @param refresh - true in case, that data snapshot have to be refreshed
    * @param hostId - return data only for this host id
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied    - "Insufficient rights to perform the requested operation." 
    */    
   void get(out ActiveConnectionList list, out long totalItems, in kerio::web::SearchQuery query, in boolean refresh, in kerio::web::KId hostId);
   
   /**
    * Kills connections specified in ids list
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied    - "Insufficient rights to perform the requested operation."   
    */    
   void kill(in kerio::web::KIdList ids);
   
};

};//webadmin