common.idl

Go to the documentation of this file.

/**
 * @file     common.idl
 * @brief    Common Kerio Control structures, enums and types
 */

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

module webadmin {

struct OptionalStringList {
   boolean enabled;
   kerio::web::StringList value;
};

typedef kerio::web::OptionalString OptionalIpAddress;
typedef OptionalStringList OptionalIpAddressList;

struct CredentialsConfig {
   string userName;

   /** it should never be filled by get() method and transferred to the client */
   string password;

   /** if true (user has changed the password), set() method write password to configuration, otherwise let it untouched */
   boolean passwordChanged;
};

struct IdReference {
   kerio::web::KId id;
   string name; /** read only */
   boolean invalid; /** read only, intergrity error */
};

typedef sequence<IdReference> IdReferenceList;

struct OptionalIdReference {
   boolean     enabled;
   IdReference value;
};

struct DataStatistic {
   double            today;
   double            todayIn;
   double            todayOut;
   double            week;
   double            weekIn;
   double            weekOut;
   double            month;
   double            monthIn;
   double            monthOut;
   double            total;
   double            totalIn;
   double            totalOut;
};

struct TimeHMS {
   long hour;
   long min;
   long sec;
};

struct DateTimeConfig {
   kerio::web::Date date;
   TimeHMS time;
};

struct TimeSpan {
   boolean isValid;     // false - time span cannot be computed (no update yet, update is in the future)
   long days;
   long hours;
   long minutes;
};

enum RuleAction {
   Allow,
   Deny,
   Drop,
   NotSet
};

enum VpnType {
   VpnKerio,
   VpnIpsec
};

struct HistogramData {
   double inbound;     /**< in Units per second  */
   double outbound;    /**< in Units per second  */
};

typedef sequence<HistogramData> HistogramDataList;

struct Histogram {
   kerio::web::ByteUnits units;
   double                  averageIn;  /**< in Units per second  */
   double                  averageOut; /**< in Units per second  */
   double                  maxIn;      /**< in Units per second  */
   double                  maxOut;     /**< in Units per second  */
   HistogramDataList      data;       /**< in Units per second, samples sorted from NOW to PAST, 0s on end are discarted */
};

enum RuleConditionType {
   RuleAny,
   RuleSelectedEntities,
   RuleInvalidCondition     ///< nothing
};

typedef string Ip6Address;
typedef sequence<Ip6Address> Ip6AddressList;

struct Collision {
   IdReference rule;
   IdReference overlappedRule;
};

struct Password {
   string value;
   boolean isSet;          //< engine tells to WA, if value is not empty in config.
};

typedef sequence<Collision> CollisionList;


struct FilenameGroup {
   string name;
   string pattern;
};

typedef sequence<FilenameGroup> FilenameGroupList;

interface FilenameGroups {
   /**
    * Returns the list of filename groups
    * @param groups - list of filename groups
    * @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 FilenameGroupList groups);

};

}; //webadmin