AdminStructures.idl

Go to the documentation of this file.

/**
 * @file AdminStructures.idl
 * @brief Data structures used by multiple IDL files among web administration
 *
 * @author Dusan Juhas
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <kerio/web/idl/SharedStructures.idl>
#include <kerio/web/idl/IpAddressGroups.idl>
#include <kerio/web/idl/TimeRanges.idl>

module kerio {
module jsonapi {
module admin {

/**
 * Type of authorization
 */
enum UserAuthType {
   UInternalAuth, ///< Internal authorization
   UWindowsNTAuth, ///< Windows NT domain authorization
   UPamAuth, ///< Authorization for linux
   UKerberosAuth, ///< Kerberos authorization
   UAppleAuth, ///< Apple authorization
   ULDAPAuth ///< LDAP authorization
};

/**
 * Type for returning authorization type supported by server
 */
typedef sequence<UserAuthType> AuthTypeList;

/**
*  Type of deleting a user
*/
enum DirectoryServiceDeleteMode {
   DSModeDeactivate, ///< User is deactivated but not deleted
   DSModeDelete      ///< User is deleted
};

/**
 *   Enum type for determine which web component is in use in session
 */
enum WebComponent {
   WebComponentWEBMAIL, ///< WebMail
   WebComponentADMIN,      ///< Web Administration
   WebComponentMINI     ///< WebMail mini
};

/**
 * Message clean out setting
 * Note: all fields must be assigned if used in set methods
 */
struct ActionAfterDays {
   boolean  isEnabled;  ///< is action on/off?
   long  days;    ///< after how many days is an action performed?
};

/**
 * Note: all fields must be assigned if used in set methods
 */
struct Distance {
   long  days;
   long  hours;
   long  minutes;
};

enum DistanceType {
   dtNull,
   dtTimeSpan
};

struct DistanceOrNull {
   DistanceType   type;
   Distance    timeSpan;
};

struct Directories {
   string storePath; ///< Path to the store directory
   string archivePath;  ///< Path to the archive directory
   string backupPath;   ///< Path to the backup directory
};

struct Credentials {
   string username;
   string password;
};

typedef string FileId;

/**
 * source of user data
 */
enum DataSource {
   DSInternalSource, ///< internal source of user data
   DSLDAPSource      ///< LDAP source of user data
};

/**
 *
 * Note: all fields must be assigned if used in set methods
 */
struct TimeHMS {
   long hours;
   long minutes;
   long seconds;
};

enum TimeUnit {
   Minutes,
   Hours,
   Days,
   Weeks
};


/**
 *
 * Note: all fields must be assigned if used in set methods
 */
struct TimeLimit {
   long     value;      ///< how many
   TimeUnit units;      ///< in which units
};

typedef string UtcDateTime; ///< Date+Time according RFC 2445, eg. 19970714T173000Z

/**
* A way how to say client that the server has a constant
*/
struct NamedConstant {
   string   name; ///< constant name
   string   value;   ///< a value of constant
};

typedef sequence<NamedConstant> NamedConstantList;


/**
* Except getAboutInfo() all methods are available for non-authenticated users
*/

enum DirectoryAccessResult {
   directoryExists,        ///< Directory exist, read/write allowed
   directoryDoesNotExist,     ///< Directory does not exist (or unable to create)
   directoryExistAccessDenied, ///< Directory exist, read or write permission not granted
   directoryUnaccessible      ///< Unable to connect network device
};

/**
* Information about directory
*/
struct Directory {
   string name;
   boolean hasSubdirectory;
};

/**
* List of restrictions
*/
typedef sequence<Directory> DirectoryList;


enum BuildType {
   Alpha,
   Beta,
   Rc,
   Final,
   Patch
};

enum DeployedType {
   DeployedStandalone,  ///< Normal instalation    
   DeployedCloud,       ///< Kerio Connect is running in a cloud   
   DeployedKerioVA      ///< Kerio Connect VMWare Virtual Appliance
};

/**
 * Operating System Family
 */
enum ServerOs {
   Windows,
   MacOs,
   Linux
};

enum UpdateCheckerStatus {
   updNoUpdate,   ///< Update status: No update
   updNewVersion,    ///< Update status: New version
   updError    ///< Update status: Error
};

struct UpdateInfo {
   UpdateCheckerStatus result;
   string description;
   string downloadUrl;
   string infoUrl;
};

struct ProductInfo {
   string productName;
   string version;
   string buildNumber;
   string osName;
   ServerOs os;
   BuildType releaseType;
   DeployedType deployedType;
   UpdateInfo updateInfo;
};

struct CustomImage {
   boolean isEnabled;      ///< Is used
   string url;          ///< [READ ONLY]
   string id;           ///< [WRITE ONCE] Id of uploaded image.
};

enum NotificationType {
   notifyOnce,
   notifyEvery
};

struct QuotaNotification {
   NotificationType  type;
   TimeLimit         period;
};

}; }; };//end of namespace

/**
 * @}
 */