WebInterface.idl

Go to the documentation of this file.

/**
 * @file     WebInterface.idl
 * @brief    Web Interface API
 * @version  2
 */

#import <common.idl>

module webadmin {

/**
 * Certificates (Secured Web Interface and SSL-VPN) will be handled by CertificateManager
 */

/** not applicable on Linux */
struct SslVpnConfig {
   boolean enabled;
   long port;
   IdReference certificate;
};

struct CustomizedBrand {
   boolean enabled;  /**< use custom brand on login, deny pages and in e-mail alerts */
   string pageTitle; /**< used as page title on login, deny pages and as a brand name on deny page */
};

struct WebInterfaceConfig {
   boolean useSsl;
   SslVpnConfig sslConfig; /** not applicable on Linux */
   kerio::web::OptionalString hostname;
   string detectedHostname;
   string adminPath; /** "admin" */
   long port;
   long sslPort;
   IdReference certificate;
   CustomizedBrand customizedBrand;
};

interface WebInterface {

   /**
    * Returns actual values for Web Interface and Kerio Clientless SSL-VPN configuration in WebAdmin
    * @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." \n
    */
   void get(out WebInterfaceConfig config);

   /**
    * Stores configuration
    * @param config - structure with settings for webinterface module
    * @param revertTimeout - If client doesn't confirm config to this timeout, configuration is reverted (0 - revert disabled)
    * @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." \n
    */
   void set(in WebInterfaceConfig config, in long revertTimeout);

   /**
    * Uploaded image which will need to be apply/reset
    * @param fileId - according to spec 390.
    * @param isFavicon - true = the image is favicon, false = the image is product logo
    * @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 uploadImage(in string fileId, in boolean isFavicon);

   /**
    * discard uploaded images
    * @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 reset();
};

}; //webadmin